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

List of all members.

Public Member Functions

 SpecialEventPostMessage ()
void Setup (BasePiece[] pieces, int timeTakes, Microsoft.Xna.Framework.Vector3 endPos, bool allowSettling, Microsoft.Xna.Framework.Graphics.GraphicsDevice device, Libraries.AssetManager assetM)
override void Update (int timePassedM, Libraries.AssetManager assetM)
override void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
override Libraries.StringType GetEventType ()
 SpecialEventPostMessage ()
void Setup (BasePiece[] pieces, int timeTakes, Microsoft.Xna.Framework.Vector3 endPos, bool allowSettling, Microsoft.Xna.Framework.Graphics.GraphicsDevice device, Libraries.AssetManager assetM)
override void Update (int timePassedM, Libraries.AssetManager assetM)
override void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
override bool IsFinished ()
override Libraries.StringType GetEventType ()

Protected Attributes

int m_timePassed
 How long the action has been running.
BasePiece[] m_pieces
 Stores the pieces to handle.
Microsoft.Xna.Framework.Vector3 m_endPos
 Where the pieces are moving to.
Libraries.Movement.TimePointOnLine3D[] m_linesToEnd
 Timed lines to get from the start to the end.
string m_posterID
 ID of the poster posting the message.

Static Private Attributes

static Libraries.StringType s_specialEventType = new Libraries.StringType("special_event_post_message")
 Type that refers to the event.

Detailed Description

Post game message event. Pieces move from their location to the opponent.


Constructor & Destructor Documentation

TheForum.GameCode.SpecialEvents.SpecialEventPostMessage.SpecialEventPostMessage ( )

Default constructor.

TheForum.GameCode.SpecialEvents.SpecialEventPostMessage.SpecialEventPostMessage ( )

Default constructor.


Member Function Documentation

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

Gets the type of the event.

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

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

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

Gets the type of the event.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

override bool TheForum.GameCode.SpecialEvents.SpecialEventPostMessage.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.SpecialEventPostMessage.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.SpecialEventPostMessage.Render ( Microsoft.Xna.Framework.Graphics.GraphicsDevice  device) [virtual]

Renders the event.

device - Device to render with.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

void TheForum.GameCode.SpecialEvents.SpecialEventPostMessage.Setup ( BasePiece[]  pieces,
int  timeTakes,
Microsoft.Xna.Framework.Vector3  endPos,
bool  allowSettling,
Microsoft.Xna.Framework.Graphics.GraphicsDevice  device,
Libraries.AssetManager  assetM 
)

Setup the action.

pieces - Pieces to handle.
timeTakes - How long it takes for the pieces to get from their positions to the end position.
endPos - Where all the pieces move to.
allowSettling - Wether the no piece settle flag should be used for the event. Value is true if it should, false if not.
device - Graphics device to use.
assetM - Asset manager to use as needed.
void TheForum.GameCode.SpecialEvents.SpecialEventPostMessage.Setup ( BasePiece[]  pieces,
int  timeTakes,
Microsoft.Xna.Framework.Vector3  endPos,
bool  allowSettling,
Microsoft.Xna.Framework.Graphics.GraphicsDevice  device,
Libraries.AssetManager  assetM 
)

Setup the action.

pieces - Pieces to handle.
timeTakes - How long it takes for the pieces to get from their positions to the end position.
endPos - Where all the pieces move to.
allowSettling - Wether the no piece settle flag should be used for the event. Value is true if it should, false if not.
device - Graphics device to use.
assetM - Asset manager to use as needed.
override void TheForum.GameCode.SpecialEvents.SpecialEventPostMessage.Update ( int  timePassedM,
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.SpecialEventPostMessage.Update ( int  timePassedM,
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

Microsoft Xna Framework Vector3 TheForum::GameCode::SpecialEvents.SpecialEventPostMessage::m_endPos [protected]

Where the pieces are moving to.

Timed lines to get from the start to the end.

Stores the pieces to handle.

ID of the poster posting the message.

How long the action has been running.

static Libraries StringType TheForum::GameCode::SpecialEvents.SpecialEventPostMessage::s_specialEventType = new Libraries.StringType("special_event_post_message") [static, private]

Type that refers to the event.


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