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

List of all members.

Public Member Functions

 SpecialEventPermaban ()
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)
 SpecialEventPermaban ()
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 ()

Private Attributes

Libraries.StringType m_posterID
 ID of the poster the event affects.
bool m_isFinished
 wether the event is finished. Value is true if it is, false if not.

Static Private Attributes

static readonly
Libraries.StringType 
s_permabanTextureProp = new Libraries.StringType("PermabanTexture")
 Property name to use for the permaban avatar texture.
static Libraries.StringType s_specialEventType = new Libraries.StringType("special_event_permaban")
 Type that refers to the event.

Detailed Description

Permaban event. The user has lost and the game is going to end. User icon is replaced by a permaban sign.


Constructor & Destructor Documentation

TheForum.GameCode.SpecialEvents.SpecialEventPermaban.SpecialEventPermaban ( )

Default constructor.

TheForum.GameCode.SpecialEvents.SpecialEventPermaban.SpecialEventPermaban ( )

Default constructor.


Member Function Documentation

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

Gets the type of the event.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

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

Gets the type of the event.

Implements TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

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

Setup and start the event.

assetM - Asset manager to use.

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

Setup and start the event.

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

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

Reimplemented from TheForum.GameCode.SpecialEvents.BaseSpecialEvent.

ID of the poster the event affects.

static readonly Libraries StringType TheForum::GameCode::SpecialEvents.SpecialEventPermaban::s_permabanTextureProp = new Libraries.StringType("PermabanTexture") [static, private]

Property name to use for the permaban avatar texture.

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