Brush that creates a diagonal rainbow pattern, using Red, Orange, Yellow, Green, Aqua, Blue, and Violet blocks. More...

Inheritance diagram for fCraft.Drawing.RainbowBrush:

Collaboration diagram for fCraft.Drawing.RainbowBrush:

Public Member Functions
IBrush	MakeBrush (Player player, CommandReader cmd)

IBrushInstance	MakeInstance (Player player, CommandReader cmd, DrawOperation state)

bool	Begin (Player player, DrawOperation state)

Block	NextBlock (DrawOperation state)

void	End ()

Public Member Functions inherited from fCraft.Drawing.IBrushFactory
IBrush	MakeBrush ([NotNull] Player player,[NotNull] CommandReader cmd)
	Creates a new brush for a player, based on given parameters.

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.

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.

Static Public Attributes
static readonly RainbowBrush	Instance = new RainbowBrush()

Properties
string	Name `[get]`

int	AlternateBlocks `[get]`

string[]	Aliases `[get]`

string	Help `[get]`

string	Description `[get]`

IBrushFactory	Factory `[get]`

string	InstanceDescription `[get]`

IBrush	Brush `[get]`

Properties inherited from fCraft.Drawing.IBrushFactory
string	Name `[get]`
	Name of the brush. Should be unique.

string	Help `[get]`
	Information printed to the player when they call "/help brush ThisBrushesName". Should include description and usage information.

string[]	Aliases `[get]`
	List of aliases/alternate names for this brush. May be null.

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.

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 diagonal rainbow pattern, using Red, Orange, Yellow, Green, Aqua, Blue, and Violet blocks.

Member Function Documentation

bool fCraft.Drawing.RainbowBrush.Begin	(	Player	player,
		DrawOperation	state
	)

void fCraft.Drawing.RainbowBrush.End ( )

IBrush fCraft.Drawing.RainbowBrush.MakeBrush	(	Player	player,
		CommandReader	cmd
	)

IBrushInstance fCraft.Drawing.RainbowBrush.MakeInstance	(	Player	player,
		CommandReader	cmd,
		DrawOperation	state
	)

Block fCraft.Drawing.RainbowBrush.NextBlock ( DrawOperation state )

readonly RainbowBrush fCraft.Drawing.RainbowBrush.Instance = new RainbowBrush()

static

string [] fCraft.Drawing.RainbowBrush.Aliases

get

int fCraft.Drawing.RainbowBrush.AlternateBlocks

get

IBrush fCraft.Drawing.RainbowBrush.Brush

get

string fCraft.Drawing.RainbowBrush.Description

get

IBrushFactory fCraft.Drawing.RainbowBrush.Factory

get

string fCraft.Drawing.RainbowBrush.Help

get

string fCraft.Drawing.RainbowBrush.InstanceDescription

get

string fCraft.Drawing.RainbowBrush.Name

get

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