C#Code
C#Code
Public Member Functions | Static Public Attributes | Protected Attributes
TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale Class Reference
Inheritance diagram for TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale:
TheForum.GameCode.SpecialEvents.BaseSpecialEvent TheForum.GameCode.SpecialEvents.BaseSpecialEvent

List of all members.

Public Member Functions

 SpecialEventReceivePiecesScale ()
bool Setup (string posterReceive, BasePiece[] pieces, Vector3 startScale, int timeTakes)
override void Update (int timePassed, Libraries.AssetManager assetM)
override void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
override Libraries.StringType GetEventType ()
 SpecialEventReceivePiecesScale ()
bool Setup (string posterReceive, BasePiece[] pieces, Vector3 startScale, int timeTakes)
override void Update (int timePassed, Libraries.AssetManager assetM)
override void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
override bool IsFinished ()
override Libraries.StringType GetEventType ()

Static Public Attributes

static Libraries.StringType s_specialEventType = new Libraries.StringType("special_event_receive_pieces_scale")
 Type that represents the special event.

Protected Attributes

BasePiece[] m_pieces
 Stores the pieces to handle.
Libraries.StringType m_posterToSet
 ID of the poster who the event is sending pieces to.
Libraries.Movement.TimedPointOnLine3D[] m_scaling
 Timed scaling to apply to the pieces.
bool m_finished
 Whether the event has finished. Value is true if it has, false if not.

Detailed Description

Used to handle a player receiving pieces from a attack. Puts the pieces on the board, checks for the player having lost. Pieces disapear from the opponent and appear at the top of the board. They scale into existance and drop when the scaling finishes. If a game piece ends up in a spot where a piece is trying to spawn, then the game is over.

Used to handle a player recieving pieces from a attack. Puts the pieces on the board, checks for the player having lost. Pieces disapear from the opponent and appear at the top of the board. They scale into existance and drop when the scaling finishes. If a game piece ends up in a spot where a piece is trying to spawn, then the game is over.


Constructor & Destructor Documentation

TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.SpecialEventReceivePiecesScale ( )

Default constructor.

TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.SpecialEventReceivePiecesScale ( )

Default constructor.


Member Function Documentation

override Libraries.StringType TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.GetEventType ( ) [virtual]

Gets the type of the event.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

override Libraries.StringType TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.GetEventType ( ) [virtual]

Gets the type of the event.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

override bool TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.IsFinished ( )

Gets wether the event is finished.

Return:
Value is true if the event is finished, false if not.

Reimplemented from TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

override void TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.Render ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device) [virtual]

Renders the event.

device - Device to render with.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

override void TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.Render ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device) [virtual]

Renders the event.

device - Device to render with.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

bool TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.Setup ( string  posterReceive,
BasePiece[]  pieces,
Vector3  startScale,
int  timeTakes 
)

Setup the sepecial event to handle receiving pieces for a board. Received pieces could come from a opponent post, maybe something else.

posterReceive - Poster the event is for, who the pieces are meant for.
pieces - Rows of pieces to post. Rows should be the same size as the board being posted to. The first entry is the first piece in the first row, second piece is the second piece in the first row, etc. There has to be a entry for every slot, so if there is only one piece in the row, fill the rest of the spots with null.
startScale - Starting scale to apply.
timeTakes - How long it takes to go from the starting scale to the pieces original.

Return:
Value is true if setup was successful, false if not.
bool TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.Setup ( string  posterReceive,
BasePiece[]  pieces,
Vector3  startScale,
int  timeTakes 
)

Setup the sepecial event to handle receiving pieces for a board. Received pieces could come from a opponent post, maybe something else.

posterReceive - Poster the event is for, who the pieces are meant for.
pieces - Rows of pieces to post. Rows should be the same size as the board being posted to. The first entry is the first piece in the first row, second piece is the second piece in the first row, etc. There has to be a entry for every slot, so if there is only one piece in the row, fill the rest of the spots with null.
startScale - Starting scale to apply.
timeTakes - How long it takes to go from the starting scale to the pieces original.

Return:
Value is true if setup was successful, false if not.
override void TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.Update ( int  timePassed,
Libraries.AssetManager  assetM 
) [virtual]

Update the piece.

timePassed - How long the update is for, in milliseconds.
assetM - Asset Manager to use.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

override void TheForum.GameCode.SpecialEvents.SpecialEventReceivePiecesScale.Update ( int  timePassed,
Libraries.AssetManager  assetM 
) [virtual]

Update the piece.

timePassed - How long the update is for, in milliseconds.
assetM - Asset Manager to use.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.


Member Data Documentation

Whether the event has finished. Value is true if it has, false if not.

Stores the pieces to handle.

ID of the poster who the event is sending pieces to.

Timed scaling to apply to the pieces.

static Libraries StringType TheForum::GameCode::SpecialEvents.SpecialEventReceivePiecesScale::s_specialEventType = new Libraries.StringType("special_event_receive_pieces_scale") [static]

Type that represents the special event.


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