fCraft  0.638
Custom Minecraft Server
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Events
fCraft.Drawing.NormalBrush Class Reference

Brush that creates a solid, single-block fill. More...

+ Inheritance diagram for fCraft.Drawing.NormalBrush:
+ Collaboration diagram for fCraft.Drawing.NormalBrush:

Public Member Functions

 NormalBrush (params Block[] blocks)
 
bool Begin (Player player, DrawOperation state)
 
Block NextBlock (DrawOperation state)
 
void End ()
 
- Public Member Functions inherited from fCraft.Drawing.IBrushInstance
bool Begin ([NotNull] Player player,[NotNull] DrawOperation op)
 Called when the DrawOperation starts. Should be used to verify that the brush is ready for use. Resources used by the brush should be obtained here.
 
Block NextBlock ([NotNull] DrawOperation op)
 Provides the next Block type for the given DrawOperation.
 
void End ()
 Called when the DrawOperation is done or cancelled. Resources used by the brush should be freed/disposed here.
 

Properties

Block[] Blocks [get, set]
 
string InstanceDescription [get]
 
IBrush Brush [get]
 
int AlternateBlocks [get]
 
- Properties inherited from fCraft.Drawing.IBrushInstance
IBrush Brush [get]
 Configured brush that created this instance.
 
string InstanceDescription [get]
 A compact readable summary of brush type, configuration, and state.
 
int AlternateBlocks [get]
 Whether the brush is capable of providing alternate blocks (e.g. for filling hollow DrawOps).
 

Detailed Description

Brush that creates a solid, single-block fill.

Constructor & Destructor Documentation

fCraft.Drawing.NormalBrush.NormalBrush ( params Block[]  blocks)

Member Function Documentation

bool fCraft.Drawing.NormalBrush.Begin ( Player  player,
DrawOperation  state 
)
void fCraft.Drawing.NormalBrush.End ( )
Block fCraft.Drawing.NormalBrush.NextBlock ( DrawOperation  state)

Property Documentation

int fCraft.Drawing.NormalBrush.AlternateBlocks
get
Block [] fCraft.Drawing.NormalBrush.Blocks
getset
IBrush fCraft.Drawing.NormalBrush.Brush
get
string fCraft.Drawing.NormalBrush.InstanceDescription
get

The documentation for this class was generated from the following file: