fCraft.Zone Class Reference

A bounding box selection that is designated as a sub area within a world. Zones can have restriction just like worlds on access, and block modification. More...

Inheritance diagram for fCraft.Zone:

Collaboration diagram for fCraft.Zone:

Public Member Functions
void	Create ([NotNull] BoundingBox bounds,[NotNull] PlayerInfo createdBy)
	Creates the zone boundaries, and sets CreatedDate/CreatedBy.
void	OnEdited ([NotNull] string editedBy)
	Sets EditedBy and EditedDate fields, and raises Changed event.
	Zone ()
	Zone ([NotNull] string raw,[CanBeNull] World world)

Public Attributes
readonly SecurityController	Controller = new SecurityController()
	Zone build permission controller.

Properties
BoundingBox	Bounds [get, set]
	Zone boundaries.
string	Name [get, set]
	Zone name (case-preserving but case-insensitive).
PlayerExceptions	ExceptionList [get]
	List of exceptions (included and excluded players).
DateTime	CreatedDate [get, set]
	Zone creation date, UTC.
DateTime	EditedDate [get, set]
	Zone editing date, UTC.
string	CreatedBy [get, set]
	Player who created this zone. May be null if unknown.
string	CreatedByClassy [get]
	Classy name of the player who created this zone. Returns "?" if CreatedBy name is unknown, unrecognized, or null.
string	EditedBy [get, set]
	Player who was the last to edit this zone. May be null if unknown.
string	EditedByClassy [get]
	Decorated name of the player who was the last to edit this zone. Returns "?" if EditedBy name is unknown, unrecognized, or null.
Map	Map [get, set]
	Map that this zone is on.
string	ClassyName [get]
Properties inherited from fCraft.IClassy
string	ClassyName [get]
	Name optionally formatted with minecraft color codes or other decorations.

Events
EventHandler	Changed
Events inherited from fCraft.INotifiesOnChange
EventHandler	Changed

Detailed Description

A bounding box selection that is designated as a sub area within a world. Zones can have restriction just like worlds on access, and block modification.

Constructor & Destructor Documentation

fCraft.Zone.Zone

(

)

fCraft.Zone.Zone	(	[NotNull] string	raw,
		[CanBeNull] World	world
	)

Member Function Documentation

void fCraft.Zone.Create	(	[NotNull] BoundingBox	bounds,
		[NotNull] PlayerInfo	createdBy
	)

Creates the zone boundaries, and sets CreatedDate/CreatedBy.

Parameters

bounds	New zone boundaries.
createdBy	Player who created this zone.

void fCraft.Zone.OnEdited

(

[NotNull] string

editedBy

)

Sets EditedBy and EditedDate fields, and raises Changed event.

Parameters

editedBy

Name of player or entity who edited this zone.

Exceptions

ArgumentNullException

editedBy is null.

Member Data Documentation

readonly SecurityController fCraft.Zone.Controller = new SecurityController()

Zone build permission controller.

Property Documentation

BoundingBox fCraft.Zone.Bounds

getset

Zone boundaries.

string fCraft.Zone.ClassyName

get

string fCraft.Zone.CreatedBy

getset

Player who created this zone. May be null if unknown.

string fCraft.Zone.CreatedByClassy

get

Classy name of the player who created this zone. Returns "?" if CreatedBy name is unknown, unrecognized, or null.

DateTime fCraft.Zone.CreatedDate

getset

Zone creation date, UTC.

string fCraft.Zone.EditedBy

getset

Player who was the last to edit this zone. May be null if unknown.

string fCraft.Zone.EditedByClassy

get

Decorated name of the player who was the last to edit this zone. Returns "?" if EditedBy name is unknown, unrecognized, or null.

DateTime fCraft.Zone.EditedDate

getset

Zone editing date, UTC.

PlayerExceptions fCraft.Zone.ExceptionList

get

List of exceptions (included and excluded players).

Map fCraft.Zone.Map

getset

Map that this zone is on.

string fCraft.Zone.Name

getset

Zone name (case-preserving but case-insensitive).

Event Documentation

EventHandler fCraft.Zone.Changed

---

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

• fCraft/World/Zone.cs