Class Zone
In-game zones.
Inheritance
System.Object
Zone
Implements
Namespace: Mannequin.Bindings
Assembly: Collapse.dll
Syntax
public class Zone : object, Killable
Constructors
Zone(Scene, Rectangle, EZoneType, Color, String, String)
Create a Zone.
Declaration
public Zone(Scene scene, Rectangle atRectangle, EZoneType type, Color color, string name = "Untitled", string description = "No description")
Parameters
Type | Name | Description |
---|---|---|
Scene | scene | The Scene to place this Zone in |
Rectangle | atRectangle | A Rectangle that defines the area of this Zone |
EZoneType | type | This Zone's type (purpose) |
Color | color | This Zone's color (default: PURPLE) |
System.String | name | The name of this Zone (default: "Untitled") |
System.String | description | The description of this Zone (default: "No description provided") |
Properties
Category
What this Zone is used for
Declaration
public EZoneType Category { get; set; }
Property Value
Type | Description |
---|---|
EZoneType |
Center
The center point of this Zone.
Declaration
public Point Center { get; }
Property Value
Type | Description |
---|---|
Point |
Description
A description of this Zone.
Declaration
public string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Location
A rectangle representing this zone on the map
Declaration
public Rectangle Location { get; }
Property Value
Type | Description |
---|---|
Rectangle |
Name
The name of this Zone.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Scene
The Scene this Zone is in
Declaration
public Scene Scene { get; }
Property Value
Type | Description |
---|---|
Scene |
Methods
GetClutter(Boolean)
Get all of the Clutter in this Zone
Declaration
public List<Clutter> GetClutter(bool shouldRefreshContent = false)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | shouldRefreshContent | Ignore the internal cache and get new results immediately |
Returns
Type | Description |
---|---|
List<Clutter> | All of the Clutter in this zone |
GetRandomTile()
Get a random Tile within this Zone
Declaration
public Tile GetRandomTile()
Returns
Type | Description |
---|---|
Tile | A random Tile within this Zone |
GetTiles()
Get all of the Tiles in this Zone
Declaration
public List<Tile> GetTiles()
Returns
Type | Description |
---|---|
List<Tile> | All of the Tiles in this Zone |
Kill()
Remove this Zone from the Scene
Declaration
public void Kill()