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

List of all members.

Public Member Functions

 FrogSirenItem ()
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 timeWait, UInt64 timeFrogAnim)
override void RemoveFromPiece (BasePiece piece)
override bool IsItemType (Libraries.StringType type)
override Libraries.StringType GetItemType ()
 FrogSirenItem ()
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 timeWait, UInt64 timeFrogAnim)
override void RemoveFromPiece (BasePiece piece)

Static Public Attributes

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

Private Attributes

Libraries.Timers.BaseTimer m_timer
 Timer that tracks the item lifespan before triggering.
Libraries.Timers.BaseTimer m_animStartTimer
 Timer that tracks when the frog animation should start.

Static Private Attributes

static readonly string s_frogAnimID = "frog_anim_ID"
 ID to use for the frog texture animation on the piece.
static readonly string s_frogTexID = "frog_tex_ID"
 ID to use for the frog texture property on the piece.

Detailed Description

Game piece item that attaches to a game piece. Runs for a set amount of time and then goes off. When it goes off, all the pieces are changed to be red, green and blue. Removing it from the board stops it from going off.


Constructor & Destructor Documentation

TheForum.GameCode.Items.FrogSirenItem.FrogSirenItem ( )
TheForum.GameCode.Items.FrogSirenItem.FrogSirenItem ( )

Member Function Documentation

override Libraries.StringType TheForum.GameCode.Items.FrogSirenItem.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 bool TheForum.GameCode.Items.FrogSirenItem.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.FrogSirenItem.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.FrogSirenItem.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.FrogSirenItem.Render ( GraphicsDevice  device) [virtual]

Render the piece.

device - Device to render whatever with.

Implements TheForum.GameCode.Items.BasePieceItem.

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

Render the piece.

device - Device to render whatever with.

Implements TheForum.GameCode.Items.BasePieceItem.

void TheForum.GameCode.Items.FrogSirenItem.Setup ( BasePiece  piece,
Libraries.AssetManager  assetM,
UInt64  timeWait,
UInt64  timeFrogAnim 
)

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.FrogSirenItem.Setup ( BasePiece  piece,
Libraries.AssetManager  assetM,
UInt64  timeWait,
UInt64  timeFrogAnim 
)

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.FrogSirenItem.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.FrogSirenItem.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

Libraries Timers BaseTimer TheForum::GameCode::Items.FrogSirenItem::m_animStartTimer [private]

Timer that tracks when the frog animation should start.

Libraries Timers BaseTimer TheForum::GameCode::Items.FrogSirenItem::m_timer [private]

Timer that tracks the item lifespan before triggering.

static readonly Libraries StringType TheForum::GameCode::Items.FrogSirenItem::s_eventType = new Libraries.StringType("item_siren_frog") [static]
static readonly string TheForum::GameCode::Items.FrogSirenItem::s_frogAnimID = "frog_anim_ID" [static, private]

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

static readonly string TheForum::GameCode::Items.FrogSirenItem::s_frogTexID = "frog_tex_ID" [static, private]

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


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