fCraft.Drawing.IBrush Interface Reference

Class that describes a configured brush, and allows creating instances for specific DrawOperations. Configuration-free brush types may combine IBrushFactory and IBrushType into one class. More...

Inheritance diagram for fCraft.Drawing.IBrush:

Public Member Functions
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
IBrushFactory	Factory [get]
	IBrushFactory associated with this brush type.
string	Description [get]
	A compact readable summary of brush type and configuration.

Detailed Description

Class that describes a configured brush, and allows creating instances for specific DrawOperations. Configuration-free brush types may combine IBrushFactory and IBrushType into one class.

Member Function Documentation

IBrushInstance fCraft.Drawing.IBrush.MakeInstance	(	[NotNull] Player	player,
		[NotNull] CommandReader	cmd,
		[NotNull] DrawOperation	op
	)

Creates an instance for this configured brush, for use with a specific DrawOperation.

Parameters

player	Player who will be using this brush. Errors and warnings about the brush creation should be communicated by messaging the player.
cmd	Parameters passed to the DrawOperation. If any are given, these parameters should generally replace any stored configuration.
op	DrawOperation that will be using this brush.

Returns

A newly-made brush, or null if there was some problem with parameters/permissions.

Property Documentation

string fCraft.Drawing.IBrush.Description

get

A compact readable summary of brush type and configuration.

IBrushFactory fCraft.Drawing.IBrush.Factory

get

IBrushFactory associated with this brush type.

---

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

• fCraft/Drawing/IBrush.cs