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

List of all members.

Public Member Functions

 SpecialEventProbation ()
bool Setup (UInt64 probationTime, Point boardLoc, Libraries.AssetManager assetM, Libraries.StringType posterID)
override void Update (int timePassed, Libraries.AssetManager assetM)
override void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
override Libraries.StringType GetEventType ()
 SpecialEventProbation ()
bool Setup (UInt64 probationTime, Point boardLoc, Libraries.AssetManager assetM, Libraries.StringType posterID)
override void Update (int timePassed, Libraries.AssetManager assetM)
override void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
override bool IsFinished ()
override Libraries.StringType GetEventType ()

Private Attributes

Libraries.Timers.BaseTimer m_timer
 Timer to determine when the probation should end.
Libraries.StringType m_posterID
 ID of the poster the event affects.
Libraries._3D.BaseObj3D m_probationMessage
 Displays the message that a probation event occured.
Libraries.Movement.TimedPointOnLine3D m_moveMessage
 Used to move the movement message.
Poster.PostText3D m_probationPost
 Message to display.
Poster.Post m_probationPost
 Message to display.

Static Private Attributes

static readonly
Libraries.StringType 
s_probationTextureProp = new Libraries.StringType("ProbationTexture")
 Property name to use for the probation avatar texture.
static Libraries.StringType s_specialEventType = new Libraries.StringType("special_event_probation")
 Type that refers to the event.

Detailed Description

Probation event. User can't post until the probation ends. User icon is replaced by a probation sign. There can be only one probation at a time.


Constructor & Destructor Documentation

TheForum.GameCode.SpecialEvents.SpecialEventProbation.SpecialEventProbation ( )

Default constructor.

TheForum.GameCode.SpecialEvents.SpecialEventProbation.SpecialEventProbation ( )

Default constructor.


Member Function Documentation

override Libraries.StringType TheForum.GameCode.SpecialEvents.SpecialEventProbation.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.SpecialEventProbation.GetEventType ( ) [virtual]

Gets the type of the event.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

override bool TheForum.GameCode.SpecialEvents.SpecialEventProbation.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.SpecialEventProbation.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.SpecialEventProbation.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.SpecialEventProbation.Setup ( UInt64  probationTime,
Point  boardLoc,
Libraries.AssetManager  assetM,
Libraries.StringType  posterID 
)

Setup and start the event.

probationTime - How long the probation should last.
boardLoc - Location on the board the piece was at.
assetM - Asset manager to use.

Return:
Value is true if setup was successful, false if not.
bool TheForum.GameCode.SpecialEvents.SpecialEventProbation.Setup ( UInt64  probationTime,
Point  boardLoc,
Libraries.AssetManager  assetM,
Libraries.StringType  posterID 
)

Setup and start the event.

probationTime - How long the probation should last.
boardLoc - Location on the board the piece was at.
assetM - Asset manager to use.
posterID - ID of the poster the event is for.

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

Update the event.

timePassed - How much time to use for the update.
assetM - Asset manager to use.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

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

Update the event.

timePassed - How much time to use for the update.
assetM - Asset manager to use.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.


Member Data Documentation

Libraries Movement TimedPointOnLine3D TheForum::GameCode::SpecialEvents.SpecialEventProbation::m_moveMessage [private]

Used to move the movement message.

ID of the poster the event affects.

Displays the message that a probation event occured.

Message to display.

Message to display.

Timer to determine when the probation should end.

static readonly Libraries StringType TheForum::GameCode::SpecialEvents.SpecialEventProbation::s_probationTextureProp = new Libraries.StringType("ProbationTexture") [static, private]

Property name to use for the probation avatar texture.

static Libraries StringType TheForum::GameCode::SpecialEvents.SpecialEventProbation::s_specialEventType = new Libraries.StringType("special_event_probation") [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