C#Code
C#Code
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes
TheForum.GameCode.Poster.BasePost Class Reference
Inheritance diagram for TheForum.GameCode.Poster.BasePost:
TheForum.GameCode.OpponentPost TheForum.GameCode.OpponentPost TheForum.GameCode.PuzzleTaxForm TheForum.GameCode.TaxForm TheForum.GameCode.UserPost TheForum.GameCode.UserPost TheForum.GameCode.RegularTaxForm

List of all members.

Public Member Functions

 BasePost (string ID, string posterName)
PostAvatar GetAvatar ()
string GetUserName ()
virtual void Update (int timePassed, Libraries.AssetManager assetM)
bool CheckIsID (Libraries.StringType ID)
Libraries.StringType GetID ()
virtual void Render (GraphicsDevice device)
virtual BaseGameBoard GetBoard ()
Libraries.StringType GetEventState ()
void SetEventState (Libraries.StringType state)
void SetupUserDisplay (Vector3 startLoc, string avatarFile, bool isModerator, Libraries.AssetManager assetM, GraphicsDevice device, Libraries.StringType shaderID)
 BasePost (string ID, string posterName)
PostAvatar GetAvatar ()
string GetUserName ()
virtual void Update (int timePassed, Libraries.AssetManager assetM)
bool CheckIsID (Libraries.StringType ID)
Libraries.StringType GetID ()
virtual void Render (GraphicsDevice device)
virtual BaseGameBoard GetBoard ()
Libraries.StringType GetEventState ()
void SetEventState (Libraries.StringType state)
void SetupUserDisplay (Vector3 startLoc, string avatarFile, bool isModerator, Libraries.AssetManager assetM, GraphicsDevice device)

Protected Member Functions

abstract void ProcessGameMessage (object message, bool storeIfNotUsed)
void ProcessStoredGameMessages ()
abstract void ProcessGameMessage (object message, bool storeIfNotUsed)
void ProcessStoredGameMessages ()

Protected Attributes

List< MessageSystems.GameMessagem_storedMessages
 Stores messages the user was not able to handle at the time they were received. Messages can then be handled later.

Private Attributes

Poster m_poster
 Display the poster, things like avatar and user name.
Libraries.StringType m_postID
 ID that repesents the post.
Libraries.StringType m_eventState
 The current event state (things like probation) the poster is in. Should be null if not in a state.

Detailed Description

Base class to derive posts from. A post is where gamplay occurs and is displayed.


Constructor & Destructor Documentation

TheForum.GameCode.Poster.BasePost.BasePost ( string  ID,
string  posterName 
)

Constructor.

ID - ID to use for the post.
posterName - Name to use for the poster. Should have a corresponding profile.
TheForum.GameCode.Poster.BasePost.BasePost ( string  ID,
string  posterName 
)

Constructor.

ID - ID to use for the post.
posterName - Name to use for the poster. Should have a corresponding profile.

Member Function Documentation

bool TheForum.GameCode.Poster.BasePost.CheckIsID ( Libraries.StringType  ID)

Check if the given ID matches the ID in the post.

ID - ID to check the post ID against.

Return:
Value is true if the ID matched, false if not.
bool TheForum.GameCode.Poster.BasePost.CheckIsID ( Libraries.StringType  ID)

Check if the given ID matches the ID in the post.

ID - ID to check the post ID against.

Return:
Value is true if the ID matched, false if not.
PostAvatar TheForum.GameCode.Poster.BasePost.GetAvatar ( )

Get the post avatar.

Return:
Value is the post avatar.

PostAvatar TheForum.GameCode.Poster.BasePost.GetAvatar ( )

Get the post avatar.

Return:
Value is the post avatar.

virtual BaseGameBoard TheForum.GameCode.Poster.BasePost.GetBoard ( ) [virtual]

Retrive the board the post uses.

Return: Value is the board, null if no board is set.

Reimplemented in TheForum.GameCode.PuzzleTaxForm, TheForum.GameCode.TaxForm, TheForum.GameCode.UserPost, and TheForum.GameCode.UserPost.

virtual BaseGameBoard TheForum.GameCode.Poster.BasePost.GetBoard ( ) [virtual]

Retrive the board the post uses.

Return: Value is the board, null if no board is set.

Reimplemented in TheForum.GameCode.PuzzleTaxForm, TheForum.GameCode.TaxForm, TheForum.GameCode.UserPost, and TheForum.GameCode.UserPost.

Libraries.StringType TheForum.GameCode.Poster.BasePost.GetEventState ( )

Get the event state (like probation) the poster is in. It is null if it isn't in a state.

Return:
Value represents the state the post is in.

Libraries.StringType TheForum.GameCode.Poster.BasePost.GetEventState ( )

Get the event state (like probation) the poster is in. It is null if it isn't in a state.

Libraries.StringType TheForum.GameCode.Poster.BasePost.GetID ( )

Get the poster ID.

Return:
Value is the ID of the poster.

Libraries.StringType TheForum.GameCode.Poster.BasePost.GetID ( )

Get the poster ID.

Return:
Value is the ID of the poster.

string TheForum.GameCode.Poster.BasePost.GetUserName ( )

Get the poster's name.

Return:
Value is the poster's name.

string TheForum.GameCode.Poster.BasePost.GetUserName ( )

Get the poster's name..

Return:
Value is the poster's name.

abstract void TheForum.GameCode.Poster.BasePost.ProcessGameMessage ( object  message,
bool  storeIfNotUsed 
) [protected, pure virtual]

Handles the given game message. Passes it along to where it needs to go.

message - Message to handle.
storeIfNotUsed - Wether the message should be stored if it can't be handled. This way if the message is already stored, you don't have to store it again.

Implemented in TheForum.GameCode.OpponentPost, TheForum.GameCode.PuzzleTaxForm, TheForum.GameCode.RegularTaxForm, TheForum.GameCode.TaxForm, TheForum.GameCode.UserPost, TheForum.GameCode.OpponentPost, and TheForum.GameCode.UserPost.

abstract void TheForum.GameCode.Poster.BasePost.ProcessGameMessage ( object  message,
bool  storeIfNotUsed 
) [protected, pure virtual]

Handles the given game message. Passes it along to where it needs to go.

message - Message to handle.
storeIfNotUsed - Wether the message should be stored if it can't be handled. This way if the message is already stored, you don't have to store it again.

Implemented in TheForum.GameCode.OpponentPost, TheForum.GameCode.PuzzleTaxForm, TheForum.GameCode.RegularTaxForm, TheForum.GameCode.TaxForm, TheForum.GameCode.UserPost, TheForum.GameCode.OpponentPost, and TheForum.GameCode.UserPost.

void TheForum.GameCode.Poster.BasePost.ProcessStoredGameMessages ( ) [protected]

Process the stored game messages. Handle them, start events, whatever, if possible. Remove messages that have been used.

void TheForum.GameCode.Poster.BasePost.ProcessStoredGameMessages ( ) [protected]

Process the stored game messages. Handle them, start events, whatever, if possible. Remove messages that have been used.

virtual void TheForum.GameCode.Poster.BasePost.Render ( GraphicsDevice  device) [virtual]
virtual void TheForum.GameCode.Poster.BasePost.Render ( GraphicsDevice  device) [virtual]
void TheForum.GameCode.Poster.BasePost.SetEventState ( Libraries.StringType  state)

Get the event state (like probation) the poster is in. It is null if it isn't in a state.

Return:
Value is the event state the poster is in.

void TheForum.GameCode.Poster.BasePost.SetEventState ( Libraries.StringType  state)

Get the event state (like probation) the poster is in. It is null if it isn't in a state.

Return:
Value is the event state the poster is in.

void TheForum.GameCode.Poster.BasePost.SetupUserDisplay ( Vector3  startLoc,
string  avatarFile,
bool  isModerator,
Libraries.AssetManager  assetM,
GraphicsDevice  device 
)

Setup the user display portion of the post. User name, avatar, etc.

startLoc - Top left cornor of the post the avatar is in.
userName - User name to display for the poster.
avatarFile - Path to the avatar image to use. Null if no avatar is needed.
isModerator - True if the poster is a moderator, false if not. Moderators have extra stuff in the post.
assetM - Asset manager to use.
device - Graphics device to use.
void TheForum.GameCode.Poster.BasePost.SetupUserDisplay ( Vector3  startLoc,
string  avatarFile,
bool  isModerator,
Libraries.AssetManager  assetM,
GraphicsDevice  device,
Libraries.StringType  shaderID 
)

Setup the user display portion of the post. User name, avatar, etc.

startLoc - Top left cornor of the post the avatar is in.
userName - User name to display for the poster.
avatarFile - Path to the avatar image to use. Null if no avatar is needed.
isModerator - True if the poster is a moderator, false if not. Moderators have extra stuff in the post.
assetM - Asset manager to use.
device - Graphics device to use.
shaderID - ID of the shader to use.
virtual void TheForum.GameCode.Poster.BasePost.Update ( int  timePassed,
Libraries.AssetManager  assetM 
) [virtual]

Update everything.

timePassed - How long has passed since the previous update.
assetM - Asset manager to use.

Reimplemented in TheForum.GameCode.OpponentPost, TheForum.GameCode.PuzzleTaxForm, TheForum.GameCode.RegularTaxForm, TheForum.GameCode.TaxForm, TheForum.GameCode.UserPost, TheForum.GameCode.OpponentPost, and TheForum.GameCode.UserPost.

virtual void TheForum.GameCode.Poster.BasePost.Update ( int  timePassed,
Libraries.AssetManager  assetM 
) [virtual]

Update everything.

timePassed - How long has passed since the previous update.
assetM - Asset manager to use.

Reimplemented in TheForum.GameCode.OpponentPost, TheForum.GameCode.PuzzleTaxForm, TheForum.GameCode.RegularTaxForm, TheForum.GameCode.TaxForm, TheForum.GameCode.UserPost, TheForum.GameCode.OpponentPost, and TheForum.GameCode.UserPost.


Member Data Documentation

Libraries StringType TheForum::GameCode::Poster.BasePost::m_eventState [private]

The current event state (things like probation) the poster is in. Should be null if not in a state.

Display the poster, things like avatar and user name.

Libraries StringType TheForum::GameCode::Poster.BasePost::m_postID [private]

ID that repesents the post.

Stores messages the user was not able to handle at the time they were received. Messages can then be handled later.


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