C# Class Aura.Channel.World.Dungeons.Puzzles.PuzzlePlace

Place on a tile in a dungeon that contains a part of a puzzle.

Show file Open project: aura-project/aura Class Usage Examples

Public Methods

Method	Description
AddProp ( Aura.Channel.World.Dungeons.Props.DungeonProp prop, Placement positionType ) : void	Adds prop to place.
CloseAllDoors ( ) : void	Closes all doors at this place.
DeclareLock ( bool lockSelf = false ) : void	Makes it a locked place with a locked door.
DeclareLockSelf ( ) : void	Makes it a locked place with a locked door that doesn't need an unlock place.
DeclareUnlock ( PuzzlePlace lockPlace ) : void	This place will precede locked place and contain some means to unlock it.
GetLockDoor ( ) : Door	Returns locked door of this place.
GetPosition ( Placement placement, int border = -1 ) : int[]	Returns position and direction for placement.
GetRoomPosition ( ) : Aura.Channel.World.Dungeons.Generation.Position	Returns the room's position.
GetWorldPosition ( ) : Aura.Channel.World.Dungeons.Generation.Position	Returns the position of the place in world coordinates.
LockPlace ( ) : void	Locks this place.
LockPlace ( Item key ) : void	Locks this place with the given key.
Open ( ) : void	Opens locked place.
OpenAllDoors ( ) : void	Opens all doors at this place.
PuzzlePlace ( Aura.Channel.World.Dungeons.Generation.DungeonFloorSection section, Aura.Channel.World.Dungeons.Puzzles.Puzzle puzzle, string name ) : System.Collections.Generic	Creates new puzzle place.
ReserveDoors ( ) : void	Declares this place to be a room. Doors of this place won't be locked with a key.
ReservePlace ( ) : void	Declares that this place is not to be used by any other puzzles. If we didn't declare this place to be something, reserve random place.
SpawnSingleMob ( string mobGroupName, int raceId, int amount, Placement placement = Placement.Random ) : void	Creates mob in puzzle, in place.
SpawnSingleMob ( string mobGroupName, string mobToSpawn = null, Placement placement = Placement.Random ) : void	Creates mob in puzzle, in this place.

Private Methods

Method	Description
AddDoor ( int direction, DungeonBlockType doorType ) : void	Adds door to place.
UpdatePosition ( ) : void	Updates world position of place.

Method Details

AddProp() public method

Adds prop to place.

public AddProp ( Aura.Channel.World.Dungeons.Props.DungeonProp prop, Placement positionType ) : void
prop	Aura.Channel.World.Dungeons.Props.DungeonProp
positionType	Placement
return	void

CloseAllDoors() public method

Closes all doors at this place.

public CloseAllDoors ( ) : void
return	void

DeclareLock() public method

Makes it a locked place with a locked door.

public DeclareLock ( bool lockSelf = false ) : void
lockSelf	bool
return	void

DeclareLockSelf() public method

Makes it a locked place with a locked door that doesn't need an unlock place.

public DeclareLockSelf ( ) : void
return	void

DeclareUnlock() public method

This place will precede locked place and contain some means to unlock it.

public DeclareUnlock ( PuzzlePlace lockPlace ) : void
lockPlace	PuzzlePlace
return	void

GetLockDoor() public method

Returns locked door of this place.

Thrown if there is no lock or no door.

public GetLockDoor ( ) : Door
return	Aura.Channel.World.Dungeons.Props.Door

GetPosition() public method

Returns position and direction for placement.

public GetPosition ( Placement placement, int border = -1 ) : int[]
placement	Placement
border	int
return	int[]

GetRoomPosition() public method

Returns the room's position.

public GetRoomPosition ( ) : Aura.Channel.World.Dungeons.Generation.Position
return	Aura.Channel.World.Dungeons.Generation.Position

GetWorldPosition() public method

Returns the position of the place in world coordinates.

public GetWorldPosition ( ) : Aura.Channel.World.Dungeons.Generation.Position
return	Aura.Channel.World.Dungeons.Generation.Position

LockPlace() public method

Locks this place.

public LockPlace ( ) : void
return	void

LockPlace() public method

Locks this place with the given key.

public LockPlace ( Item key ) : void
key	Item
return	void

Open() public method

Opens locked place.

public Open ( ) : void
return	void

OpenAllDoors() public method

Opens all doors at this place.

public OpenAllDoors ( ) : void
return	void

PuzzlePlace() public method

Creates new puzzle place.

public PuzzlePlace ( Aura.Channel.World.Dungeons.Generation.DungeonFloorSection section, Aura.Channel.World.Dungeons.Puzzles.Puzzle puzzle, string name ) : System.Collections.Generic
section	Aura.Channel.World.Dungeons.Generation.DungeonFloorSection
puzzle	Aura.Channel.World.Dungeons.Puzzles.Puzzle
name	string
return	System.Collections.Generic

ReserveDoors() public method

Declares this place to be a room. Doors of this place won't be locked with a key.

public ReserveDoors ( ) : void
return	void

ReservePlace() public method

Declares that this place is not to be used by any other puzzles. If we didn't declare this place to be something, reserve random place.

public ReservePlace ( ) : void
return	void

SpawnSingleMob() public method

Creates mob in puzzle, in place.

public SpawnSingleMob ( string mobGroupName, int raceId, int amount, Placement placement = Placement.Random ) : void
mobGroupName	string	Name of the mob, for reference.
raceId	int	Race to spawn.
amount	int	Number of monsters to spawn.
placement	Placement
return	void

SpawnSingleMob() public method

Creates mob in puzzle, in this place.

public SpawnSingleMob ( string mobGroupName, string mobToSpawn = null, Placement placement = Placement.Random ) : void
mobGroupName	string	Name of the mob, for reference.
mobToSpawn	string	Mob to spawn (Mob1-3), leave as null for auto select.
placement	Placement
return	void