fCraft.Drawing.IBrushFactory Interface Reference

Class that desribes a type of brush in general, and allows creating new brushes with /Brush. One instance of IBrushFactory for each type of brush is kept by the BrushManager. More...

Inheritance diagram for fCraft.Drawing.IBrushFactory:

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

Properties
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.

Detailed Description

Class that desribes a type of brush in general, and allows creating new brushes with /Brush. One instance of IBrushFactory for each type of brush is kept by the BrushManager.

Member Function Documentation

IBrush fCraft.Drawing.IBrushFactory.MakeBrush	(	[NotNull] Player	player,
		[NotNull] CommandReader	cmd
	)

Creates a new brush for a player, based on given parameters.

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 /Brush command (after the brush name).

Returns

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

Property Documentation

string [] fCraft.Drawing.IBrushFactory.Aliases

get

List of aliases/alternate names for this brush. May be null.

string fCraft.Drawing.IBrushFactory.Help

get

Information printed to the player when they call "/help brush ThisBrushesName". Should include description and usage information.

string fCraft.Drawing.IBrushFactory.Name

get

Name of the brush. Should be unique.

---

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

• fCraft/Drawing/IBrush.cs