C#Code
C#Code
Public Member Functions | Static Public Attributes | Private Attributes
TheForum.GameCode.Items.ProbationItem Class Reference
Inheritance diagram for TheForum.GameCode.Items.ProbationItem:
TheForum.GameCode.Items.BasePieceItem TheForum.GameCode.Items.BasePieceItem

List of all members.

Public Member Functions

 ProbationItem ()
override void Update (int timePassed, BasePiece piece, GameCode.BaseGameBoard board, Libraries.AssetManager assetM)
override void Render (GraphicsDevice device)
void Setup (BasePiece piece, Libraries.AssetManager assetM, UInt64 probationTime)
override void RemoveFromPiece (BasePiece piece)
override void HandleSwapOccured (int col, int row)
override bool IsItemType (Libraries.StringType type)
override Libraries.StringType GetItemType ()
 ProbationItem ()
override void Update (int timePassed, BasePiece piece, GameCode.BaseGameBoard board, Libraries.AssetManager assetM)
override void Render (GraphicsDevice device)
void Setup (BasePiece piece, Libraries.AssetManager assetM, UInt64 probationTime)
override void RemoveFromPiece (BasePiece piece)
override void HandleSwapOccured (int col, int row)

Static Public Attributes

static readonly
Libraries.StringType 
s_eventType = new Libraries.StringType("item_probation")

Private Attributes

UInt64 m_probationTime
 How long the probation lasts.

Detailed Description

Game piece item that attaches to a game piece. Triggers if the user clicks on it. Puts the user into the probation state.


Constructor & Destructor Documentation

TheForum.GameCode.Items.ProbationItem.ProbationItem ( )
TheForum.GameCode.Items.ProbationItem.ProbationItem ( )

Member Function Documentation

override Libraries.StringType TheForum.GameCode.Items.ProbationItem.GetItemType ( ) [virtual]

Get the ID that represents the item type.

Return:
Value is the ID that represents the item type.

Implements TheForum.GameCode.Items.BasePieceItem.

override void TheForum.GameCode.Items.ProbationItem.HandleSwapOccured ( int  col,
int  row 
) [virtual]

Piece was swapped, which should trigger the probation event.

col, row - Column and row the piece was at.

Reimplemented from TheForum.GameCode.Items.BasePieceItem.

override void TheForum.GameCode.Items.ProbationItem.HandleSwapOccured ( int  col,
int  row 
) [virtual]

Piece was swapped, which should trigger the probation event.

col, row - Column and row the piece was at.

Reimplemented from TheForum.GameCode.Items.BasePieceItem.

override bool TheForum.GameCode.Items.ProbationItem.IsItemType ( Libraries.StringType  type) [virtual]

Check if the item type matches the given item type.

type - Type to check against.

Return:
Value is true if the item type matched, false if not.

Implements TheForum.GameCode.Items.BasePieceItem.

override void TheForum.GameCode.Items.ProbationItem.RemoveFromPiece ( BasePiece  piece) [virtual]

Remove the the item from the given piece. Set everything back to the way it was in the piece. Make sure it is actually the piece that contains the item ;)

Implements TheForum.GameCode.Items.BasePieceItem.

override void TheForum.GameCode.Items.ProbationItem.RemoveFromPiece ( BasePiece  piece) [virtual]

Remove the the item from the given piece. Set everything back to the way it was in the piece. Make sure it is actually the piece that contains the item ;)

Implements TheForum.GameCode.Items.BasePieceItem.

override void TheForum.GameCode.Items.ProbationItem.Render ( GraphicsDevice  device) [virtual]

Render the piece.

device - Device to render whatever with.

Implements TheForum.GameCode.Items.BasePieceItem.

override void TheForum.GameCode.Items.ProbationItem.Render ( GraphicsDevice  device) [virtual]

Render the piece.

device - Device to render whatever with.

Implements TheForum.GameCode.Items.BasePieceItem.

void TheForum.GameCode.Items.ProbationItem.Setup ( BasePiece  piece,
Libraries.AssetManager  assetM,
UInt64  probationTime 
)

Setup the item, attaching to the given piece and setting whatever is needed in it.

piece - Piece that will contain the item.
assetM - Asset manager to use for a any loading.
probationTime - How long the probation lasts.
void TheForum.GameCode.Items.ProbationItem.Setup ( BasePiece  piece,
Libraries.AssetManager  assetM,
UInt64  probationTime 
)

Setup the item, attaching to the given piece and setting whatever is needed in it.

piece - Piece that will contain the item.
assetM - Asset manager to use for a any loading.
probationTime - How long the probation lasts.
override void TheForum.GameCode.Items.ProbationItem.Update ( int  timePassed,
BasePiece  piece,
GameCode.BaseGameBoard  board,
Libraries.AssetManager  assetM 
)

Update the item and the piece as needed.

timePassed - How long has passed since the previous update.
piece - Piece that contains the item.
board - Board the piece is on.
assetM - Asset manager to use.
override void TheForum.GameCode.Items.ProbationItem.Update ( int  timePassed,
BasePiece  piece,
GameCode.BaseGameBoard  board,
Libraries.AssetManager  assetM 
)

Update the item and the piece as needed.

timePassed - How long has passed since the previous update.
piece - Piece that contains the item.
board - Board the piece is on.
assetM - Asset manager to use.

Member Data Documentation

How long the probation lasts.

static readonly Libraries StringType TheForum::GameCode::Items.ProbationItem::s_eventType = new Libraries.StringType("item_probation") [static]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Properties