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

List of all members.

Public Member Functions

 SpecialEventLowContent ()
 SpecialEventLowContent (string ID)
bool Setup (Libraries.AssetManager assetM, Libraries.StringType posterID)
override Libraries.StringType GetEventType ()
override void Update (int timePassed, Libraries.AssetManager assetM)
override void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
void LowContentPostOccured (int col, int row)
 SpecialEventLowContent ()
 SpecialEventLowContent (string ID)
bool Setup (Libraries.AssetManager assetM, Libraries.StringType posterID)
override Libraries.StringType GetEventType ()
override void Update (int timePassed, Libraries.AssetManager assetM)
override void Render (Microsoft.Xna.Framework.Graphics.GraphicsDevice device)
override bool IsFinished ()
void LowContentPostOccured (int col, int row)

Static Public Attributes

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

Private Attributes

Libraries.StringType m_posterID
 ID of the poster who posted low content.
Poster.PostText3D m_warningPost
 Display the warning post.
Libraries.AssetManager m_assetM
 Asset manager to use.
int m_numLowContentPosts
 How many low content posts have occured while the event is running.
Libraries.Timers.BaseTimer m_timer
 Timer to used to handle the event's run time.
Libraries.Timers.BaseTimer m_lowContentWarningTimer
Poster.Post m_warningPost
 Display the warning post.
bool m_isFinished
 wether the event is finished. Value is true if it is, false if not.

Detailed Description

Low content event. Occurs when a user posts messages that are too small, have too little content. When in the low content event, additional low content can trigger a probation. event. Even move low content events can trigger a ban or even a permaban. Low content displays a warning that the user is in the low content state.


Constructor & Destructor Documentation

TheForum.GameCode.SpecialEvents.SpecialEventLowContent.SpecialEventLowContent ( )

Default constructor.

TheForum.GameCode.SpecialEvents.SpecialEventLowContent.SpecialEventLowContent ( string  ID)

Constructor.

ID - ID to use for the event.
TheForum.GameCode.SpecialEvents.SpecialEventLowContent.SpecialEventLowContent ( )

Default constructor.

TheForum.GameCode.SpecialEvents.SpecialEventLowContent.SpecialEventLowContent ( string  ID)

Constructor.

ID - ID to use for the event.

Member Function Documentation

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

Gets the type of the event.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

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

Gets the type of the event.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

override bool TheForum.GameCode.SpecialEvents.SpecialEventLowContent.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.

void TheForum.GameCode.SpecialEvents.SpecialEventLowContent.LowContentPostOccured ( int  col,
int  row 
)

Call this if a low content post occured while the low content event was running. The event can decide wether another event, like probation or a ban should occur.

col, row - Unused.
void TheForum.GameCode.SpecialEvents.SpecialEventLowContent.LowContentPostOccured ( int  col,
int  row 
)

Call this if a low content post occured while the low content event was running. The event can decide wether another event, like probation or a ban should occur.

override void TheForum.GameCode.SpecialEvents.SpecialEventLowContent.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.SpecialEventLowContent.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.SpecialEventLowContent.Setup ( Libraries.AssetManager  assetM,
Libraries.StringType  posterID 
)

Setup and start the event.

assetM - Asset manager to use.
posterID - ID of the poster who posted low content.

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

Setup and start the event.

assetM - Asset manager to use.
posterID - ID of the poster who posted low content.

Return:
Value is true if setup was successful, false if not.
override void TheForum.GameCode.SpecialEvents.SpecialEventLowContent.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.SpecialEventLowContent.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

Asset manager to use.

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

Reimplemented from TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

How many low content posts have occured while the event is running.

ID of the poster who posted low content.

Timer to used to handle the event's run time.

Display the warning post.

Display the warning post.

static readonly Libraries StringType TheForum::GameCode::SpecialEvents.SpecialEventLowContent::s_specialEventType = new Libraries.StringType("special_event_lowcontent") [static]

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