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

List of all members.

Public Member Functions

 WordsItem ()
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)
override void RemoveFromPiece (BasePiece piece)
override void HandlePosted (BasePiece piece)
override bool IsItemType (Libraries.StringType type)
 WordsItem ()
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)
override void RemoveFromPiece (BasePiece piece)
override void HandlePosted (BasePiece piece)

Static Public Attributes

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

Static Private Attributes

static readonly string s_itemAnimID = "item_anim_ID"
 ID to use for the item texture animation on the piece.
static readonly string s_itemTexID = "item_tex_ID"
 ID to use for the item texture property on the piece.

Detailed Description

Game piece item that attaches to a game piece. When used in a group, all the pieces on the board of the item's color get posted along with it, even if they aren't in groups.


Constructor & Destructor Documentation

TheForum.GameCode.Items.WordsItem.WordsItem ( )
TheForum.GameCode.Items.WordsItem.WordsItem ( )

Member Function Documentation

override void TheForum.GameCode.Items.WordsItem.HandlePosted ( BasePiece  piece) [virtual]

Handle any special triggering that should occur if the piece the item is with gets posted.

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

Reimplemented from TheForum.GameCode.Items.BasePieceItem.

override void TheForum.GameCode.Items.WordsItem.HandlePosted ( BasePiece  piece) [virtual]

Handle any special triggering that should occur if the piece the item is with gets posted.

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

Reimplemented from TheForum.GameCode.Items.BasePieceItem.

override bool TheForum.GameCode.Items.WordsItem.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.WordsItem.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 ;)

piece - Piece to remove the item from.

Implements TheForum.GameCode.Items.BasePieceItem.

override void TheForum.GameCode.Items.WordsItem.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 ;)

piece - Piece to remove the item from.

Implements TheForum.GameCode.Items.BasePieceItem.

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

Render the piece.

device - Device to render whatever with.

Implements TheForum.GameCode.Items.BasePieceItem.

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

Render the piece.

device - Device to render whatever with.

Implements TheForum.GameCode.Items.BasePieceItem.

void TheForum.GameCode.Items.WordsItem.Setup ( BasePiece  piece,
Libraries.AssetManager  assetM 
)

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. timeWait - How long to wait before triggering the frog animation.
timeFrogAnim - How long to wait to trigger the event once the animation starts.
void TheForum.GameCode.Items.WordsItem.Setup ( BasePiece  piece,
Libraries.AssetManager  assetM 
)

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. timeWait - How long to wait before triggering the frog animation.
timeFrogAnim - How long to wait to trigger the event once the animation starts.
override void TheForum.GameCode.Items.WordsItem.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.WordsItem.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

static readonly Libraries StringType TheForum::GameCode::Items.WordsItem::s_eventType = new Libraries.StringType("item_words") [static]
static readonly string TheForum::GameCode::Items.WordsItem::s_itemAnimID = "item_anim_ID" [static, private]

ID to use for the item texture animation on the piece.

static readonly string TheForum::GameCode::Items.WordsItem::s_itemTexID = "item_tex_ID" [static, private]

ID to use for the item texture property on the piece.


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