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

Brush that replaces all blocks EXCEPT those of given type(s) with a replacement blocktype. More...

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

Public Member Functions

 ReplaceNotBrush ()
 
 ReplaceNotBrush (Block[] blocks, Block replacement)
 
 ReplaceNotBrush ([NotNull] ReplaceNotBrush other)
 
IBrushInstance MakeInstance (Player player, CommandReader cmd, DrawOperation op)
 
bool Begin (Player player, DrawOperation op)
 
Block NextBlock (DrawOperation op)
 
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.
 
- Public Member Functions inherited from fCraft.Drawing.IBrush
IBrushInstance MakeInstance ([NotNull] Player player,[NotNull] CommandReader cmd,[NotNull] DrawOperation op)
 Creates an instance for this configured brush, for use with a specific DrawOperation.
 

Properties

Block[] Blocks [get, set]
 
Block Replacement [get, set]
 
IBrushFactory Factory [get]
 
string Description [get]
 
IBrush Brush [get]
 
int AlternateBlocks [get]
 
string InstanceDescription [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).
 
- Properties inherited from fCraft.Drawing.IBrush
IBrushFactory Factory [get]
 IBrushFactory associated with this brush type.
 
string Description [get]
 A compact readable summary of brush type and configuration.
 

Detailed Description

Brush that replaces all blocks EXCEPT those of given type(s) with a replacement blocktype.

Constructor & Destructor Documentation

fCraft.Drawing.ReplaceNotBrush.ReplaceNotBrush ( )
fCraft.Drawing.ReplaceNotBrush.ReplaceNotBrush ( Block[]  blocks,
Block  replacement 
)
fCraft.Drawing.ReplaceNotBrush.ReplaceNotBrush ( [NotNull] ReplaceNotBrush  other)

Member Function Documentation

bool fCraft.Drawing.ReplaceNotBrush.Begin ( Player  player,
DrawOperation  op 
)
void fCraft.Drawing.ReplaceNotBrush.End ( )
IBrushInstance fCraft.Drawing.ReplaceNotBrush.MakeInstance ( Player  player,
CommandReader  cmd,
DrawOperation  op 
)
Block fCraft.Drawing.ReplaceNotBrush.NextBlock ( DrawOperation  op)

Property Documentation

int fCraft.Drawing.ReplaceNotBrush.AlternateBlocks
get
Block [] fCraft.Drawing.ReplaceNotBrush.Blocks
getset
IBrush fCraft.Drawing.ReplaceNotBrush.Brush
get
string fCraft.Drawing.ReplaceNotBrush.Description
get
IBrushFactory fCraft.Drawing.ReplaceNotBrush.Factory
get
string fCraft.Drawing.ReplaceNotBrush.InstanceDescription
get
Block fCraft.Drawing.ReplaceNotBrush.Replacement
getset

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