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

List of all members.

Public Member Functions

 UserPost (string ID, string posterName)
void Create (int numC, int numR, Vector3 startLoc, Vector3 pieceOffset, Point screenDims, Libraries.AssetManager assetM, GraphicsDevice device)
override void Update (int timePassed, Libraries.AssetManager assetM)
override void Render (GraphicsDevice device)
void RenderSprites (GraphicsDevice device)
override BaseGameBoard GetBoard ()
void HandleGameMessageDelegate (object message)
void HandleItemMessageDelegate (object message)
void HandleProbationItemMessage (MessageSystems.ItemMessage message, Libraries.AssetManager assetM)
void HandleTaxFraudItemMessage (MessageSystems.ItemMessage message, Libraries.AssetManager assetM)
void HandlePermabanMessage (MessageSystems.GameMessages.PermabanMessage data, Libraries.AssetManager assetM)
void HandleStorePiecesMessage (MessageSystems.GameMessage message, bool processGameMessage, Libraries.AssetManager assetM)
 UserPost (string ID, string posterName)
void Create (int numC, int numR, Vector3 startLoc, Vector3 pieceOffset, Point screenDims, Libraries.AssetManager assetM, GraphicsDevice device)
override void Update (int timePassed, Libraries.AssetManager assetM)
override void Render (GraphicsDevice device)
void RenderSprites (GraphicsDevice device)
override BaseGameBoard GetBoard ()
void HandleGameMessageDelegate (object message)
void HandleItemMessageDelegate (object message)
void HandleProbationItemMessage (MessageSystems.ItemMessage message, Libraries.AssetManager assetM)
void HandlePermabanMessage (MessageSystems.GameMessages.PermabanMessage data, Libraries.AssetManager assetM)
void HandleStorePiecesMessage (MessageSystems.GameMessage message, bool processGameMessage, Libraries.AssetManager assetM)

Protected Member Functions

override void ProcessGameMessage (object message, bool storeIfNotUsed)
MessageSystems.GameMessage FindStoredMessageType (Libraries.StringType type)
override void ProcessGameMessage (object message, bool storeIfNotUsed)
MessageSystems.GameMessage FindStoredMessageType (Libraries.StringType type)

Private Member Functions

int GetSelectorMovementScale ()

Private Attributes

BackgroundBoard m_backgroundBoard
 Background board displayed behind the game board.
UserReplyToPostBackground m_background
 Background behind the user post screen. All of the rects and whatnot.
BasicGameBoard m_gameBoard
 The game board that contains pieces the game is being played with.
Libraries.AssetManager m_assetM
 Asset manager to use.
Libraries.ScreenPicking.ScreenPicker m_picker3D
 3D picker to use. Used to determine which if any 3D object is clicked on when the mouse is clicked. Converts a mouse position from screen and checks with it.
TheForum.GameCode.Poster.UserPostButtons m_buttons
 Buttons to display for the poster.
Microsoft.Xna.Framework.Graphics.SpriteBatch m_spriteBatch
 Sprite drawing handler.

Detailed Description

Display and handle the user posts in game. Shows graphics, pieces that make up a user post.


Constructor & Destructor Documentation

TheForum.GameCode.UserPost.UserPost ( 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.UserPost.UserPost ( 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

void TheForum.GameCode.UserPost.Create ( int  numC,
int  numR,
Vector3  startLoc,
Vector3  pieceOffset,
Point  screenDims,
Libraries.AssetManager  assetM,
GraphicsDevice  device 
)

Create the user post. Makes the game board, user avatar, etc.

numC, numR - Number of columns and rows to have for the user board.
startLock - Start location of the post.
pieceOffest - Offset from the start position that the board should be at.
screenDims -
assetM - Asset manager to use.
device - Graphics device to use for rendering text, etc in the creation.
void TheForum.GameCode.UserPost.Create ( int  numC,
int  numR,
Vector3  startLoc,
Vector3  pieceOffset,
Point  screenDims,
Libraries.AssetManager  assetM,
GraphicsDevice  device 
)

Create the user post. Makes the game board, user avatar, etc.

numC, numR - Number of columns and rows to have for the user board.
startLock - Start location of the post.
pieceOffest - Offset from the start position that the board should be at.
screenDims -
assetM - Asset manager to use.
device - Graphics device to use for rendering text, etc in the creation.
MessageSystems.GameMessage TheForum.GameCode.UserPost.FindStoredMessageType ( Libraries.StringType  type) [protected]

NOT SETUP YET!!! Checks for and returns the first stored message that is the given type.

type - Type of message to find.
MessageSystems.GameMessage TheForum.GameCode.UserPost.FindStoredMessageType ( Libraries.StringType  type) [protected]

NOT SETUP YET!!! Checks for and returns the first stored message that is the given type.

type - Type of message to find.
override BaseGameBoard TheForum.GameCode.UserPost.GetBoard ( ) [virtual]

Retrive the board the post uses.

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

Reimplemented from TheForum.GameCode.Poster.BasePost.

override BaseGameBoard TheForum.GameCode.UserPost.GetBoard ( ) [virtual]

Retrive the board the post uses.

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

Reimplemented from TheForum.GameCode.Poster.BasePost.

int TheForum.GameCode.UserPost.GetSelectorMovementScale ( ) [private]

Check if scaled movement should be applied to moving the selector, and returns the current scale. Scale can be used to move the selector more then one slot at a time when using the keyboard, controller.

Return:
Value is the scale amount.

void TheForum.GameCode.UserPost.HandleGameMessageDelegate ( object  message)

Used for a delegate to handle game messages.

message - Message to handle.
void TheForum.GameCode.UserPost.HandleGameMessageDelegate ( object  message)

Used for a delegate to handle game messages.

message - Message to handle.
void TheForum.GameCode.UserPost.HandleItemMessageDelegate ( object  message)

Used for a delegate to handle a item messages.

message - Message to handle. Should be of type KeyboardInputMessage.
void TheForum.GameCode.UserPost.HandleItemMessageDelegate ( object  message)

Used for a delegate to handle a item messages.

message - Message to handle. Should be of type KeyboardInputMessage.
void TheForum.GameCode.UserPost.HandlePermabanMessage ( MessageSystems.GameMessages.PermabanMessage  data,
Libraries.AssetManager  assetM 
)

Do whatever is needed for the given probation item message. Only handle the probation if the game is in a state that allows it.

data - Message to handle.
assetM - Asset manager to use.
void TheForum.GameCode.UserPost.HandlePermabanMessage ( MessageSystems.GameMessages.PermabanMessage  data,
Libraries.AssetManager  assetM 
)

Do whatever is needed for the given probation item message. Only handle the probation if the game is in a state that allows it.

message - Message to handle.
assetM - Asset manager to use.
void TheForum.GameCode.UserPost.HandleProbationItemMessage ( MessageSystems.ItemMessage  message,
Libraries.AssetManager  assetM 
)

Do whatever is needed for the given probation item message. Only handle the probation if the game is in a state that allows it.

message - Message to handle.
assetM - Asset manager to use.
void TheForum.GameCode.UserPost.HandleProbationItemMessage ( MessageSystems.ItemMessage  message,
Libraries.AssetManager  assetM 
)

Do whatever is needed for the given probation item message. Only handle the probation if the game is in a state that allows it.

message - Message to handle.
assetM - Asset manager to use.
void TheForum.GameCode.UserPost.HandleStorePiecesMessage ( MessageSystems.GameMessage  message,
bool  processGameMessage,
Libraries.AssetManager  assetM 
)

If the message can be handled right away, then it starts the store pieces event. If it can't start right away then it store the message for later.

message - Message to handle.
processGameMessage - Whether the message should be handled right away. True if it should, false if not.
assetM - Asset manager to use.
void TheForum.GameCode.UserPost.HandleStorePiecesMessage ( MessageSystems.GameMessage  message,
bool  processGameMessage,
Libraries.AssetManager  assetM 
)

If the message can be handled right away, then it starts the store pieces event. If it can't start right away then it store the message for later.

message - Message to handle.
assetM - Asset manager to use.
void TheForum.GameCode.UserPost.HandleTaxFraudItemMessage ( MessageSystems.ItemMessage  message,
Libraries.AssetManager  assetM 
)

Do whatever is needed for the given tax fraud item message. Only handle the tax fraud if the game is in a state that allows it.

message - Message to handle.
assetM - Asset manager to use.
override void TheForum.GameCode.UserPost.ProcessGameMessage ( object  message,
bool  storeIfNotUsed 
) [protected, 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.

Implements TheForum.GameCode.Poster.BasePost.

override void TheForum.GameCode.UserPost.ProcessGameMessage ( object  message,
bool  storeIfNotUsed 
) [protected, 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.

Implements TheForum.GameCode.Poster.BasePost.

override void TheForum.GameCode.UserPost.Render ( GraphicsDevice  device) [virtual]

Render 3D, whatever else is needed..

device - Device to render with.

Reimplemented from TheForum.GameCode.Poster.BasePost.

override void TheForum.GameCode.UserPost.Render ( GraphicsDevice  device) [virtual]

Render 3D, whatever else is needed..

device - Device to render with.

Reimplemented from TheForum.GameCode.Poster.BasePost.

void TheForum.GameCode.UserPost.RenderSprites ( GraphicsDevice  device)

Render post 3D sprites. 3D should have all be drawn before this call. That way the sprites will end up on top of everything 3D.

void TheForum.GameCode.UserPost.RenderSprites ( GraphicsDevice  device)

Render post 3D sprites. 3D should have all be drawn before this call. That way the sprites will end up on top of everything 3D.

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

Update everything.

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

Reimplemented from TheForum.GameCode.Poster.BasePost.

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

Update everything.

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

Reimplemented from TheForum.GameCode.Poster.BasePost.


Member Data Documentation

Libraries AssetManager TheForum::GameCode.UserPost::m_assetM [private]

Asset manager to use.

Background behind the user post screen. All of the rects and whatnot.

Background board displayed behind the game board.

TheForum GameCode Poster UserPostButtons TheForum::GameCode.UserPost::m_buttons [private]

Buttons to display for the poster.

The game board that contains pieces the game is being played with.

Libraries ScreenPicking ScreenPicker TheForum::GameCode.UserPost::m_picker3D [private]

3D picker to use. Used to determine which if any 3D object is clicked on when the mouse is clicked. Converts a mouse position from screen and checks with it.

Microsoft Xna Framework Graphics SpriteBatch TheForum::GameCode.UserPost::m_spriteBatch [private]

Sprite drawing handler.


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