TurnExtensions Class Reference

Static Public Member Functions
static void	SetTurn (this Room room, int turn, bool setStartTime=false)
	Sets the turn. More...
static int	GetTurn (this RoomInfo room)
	Gets the current turn from a RoomInfo More...
static int	GetTurnStart (this RoomInfo room)
	Returns the start time when the turn began. This can be used to calculate how long it's going on. More...
static int	GetFinishedTurn (this Player player)
	gets the player's finished turn (from the ROOM properties) More...
static void	SetFinishedTurn (this Player player, int turn)
	Sets the player's finished turn (in the ROOM properties) More...

Static Public Attributes
static readonly string	TurnPropKey = "Turn"
	currently ongoing turn number More...
static readonly string	TurnStartPropKey = "TStart"
	start (server) time for currently ongoing turn (used to calculate end) More...
static readonly string	FinishedTurnPropKey = "FToA"
	Finished Turn of Actor (followed by number) More...

Member Function Documentation

GetFinishedTurn()

static int GetFinishedTurn ( this Player  player )

static

gets the player's finished turn (from the ROOM properties)

Returns

The finished turn index

Parameters

player

Player reference

GetTurn()

static int GetTurn ( this RoomInfo  room )

static

Gets the current turn from a RoomInfo

Returns

The turn index

Parameters

room	RoomInfo reference

GetTurnStart()

static int GetTurnStart ( this RoomInfo  room )

static

Returns the start time when the turn began. This can be used to calculate how long it's going on.

Returns

The turn start.

Parameters

room

Room.

SetFinishedTurn()

static void SetFinishedTurn ( this Player  player, int  turn  )

static

Sets the player's finished turn (in the ROOM properties)

Parameters

player	Player Reference
turn	Turn Index

SetTurn()

static void SetTurn ( this Room  room, int  turn, bool  setStartTime = false  )

static

Sets the turn.

Parameters

room	Room reference
turn	Turn index
setStartTime	If set to true set start time.

Member Data Documentation

FinishedTurnPropKey

readonly string FinishedTurnPropKey = "FToA"

static

Finished Turn of Actor (followed by number)

TurnPropKey

readonly string TurnPropKey = "Turn"

static

currently ongoing turn number

TurnStartPropKey

readonly string TurnStartPropKey = "TStart"

static

start (server) time for currently ongoing turn (used to calculate end)