C#Code
C#Code
Public Member Functions | Properties | Private Attributes | Static Private Attributes
TheForum.GameCode.Poster.PosterRegister Class Reference

List of all members.

Public Member Functions

 PosterRegister ()
void SetLocalUserID (string ID)
void SetLocalOpponentID (string ID)
Libraries.StringType GetLocalUserID ()
Libraries.StringType GetLocalOpponentID ()
bool RegisterPoster (BasePost poster)
BasePost GetPoster (Libraries.StringType ID)
List< Libraries.StringTypeGetActivePlayers ()
void Clear ()
 PosterRegister ()
void SetLocalUserID (string ID)
void SetLocalOpponentID (string ID)
Libraries.StringType GetLocalUserID ()
Libraries.StringType GetLocalOpponentID ()
bool RegisterPoster (BasePost poster)
BasePost GetPoster (Libraries.StringType ID)
List< Libraries.StringTypeGetActivePlayers ()

Properties

static PosterRegister Instance [get]

Private Attributes

Libraries.StringType m_localUserID
 Store the ID of the user.
Libraries.StringType m_localOpponentID
 Store the ID of the opponet.
List< BasePostm_posters
 Stores the registered posters.

Static Private Attributes

static PosterRegister s_instance
 Singleton instance of the class.

Detailed Description

Object to store the different posters in the game. Gives a one stop way to access any poster. This does not do anything with the posters themselves, it just gives access via the poster ID.


Constructor & Destructor Documentation

TheForum.GameCode.Poster.PosterRegister.PosterRegister ( )

Default constructor.

TheForum.GameCode.Poster.PosterRegister.PosterRegister ( )

Default constructor.


Member Function Documentation

void TheForum.GameCode.Poster.PosterRegister.Clear ( )

Clear allocations and registrations.

List<Libraries.StringType> TheForum.GameCode.Poster.PosterRegister.GetActivePlayers ( )

Look for the posters who haven't lost or won.

Return:
Value is the IDs of all active players.

List<Libraries.StringType> TheForum.GameCode.Poster.PosterRegister.GetActivePlayers ( )

Look for the posters who haven't lost or won.

Libraries.StringType TheForum.GameCode.Poster.PosterRegister.GetLocalOpponentID ( )

Retrive the ID of the local opponent.

Return:
Value is the local user ID.

Libraries.StringType TheForum.GameCode.Poster.PosterRegister.GetLocalOpponentID ( )

Retrive the ID of the local opponent.

Return:
Value is the local user ID.

Libraries.StringType TheForum.GameCode.Poster.PosterRegister.GetLocalUserID ( )

Retrive the ID of the local user.

Return:
Value is the local user ID.

Libraries.StringType TheForum.GameCode.Poster.PosterRegister.GetLocalUserID ( )

Retrive the ID of the local user.

Return:
Value is the local user ID.

BasePost TheForum.GameCode.Poster.PosterRegister.GetPoster ( Libraries.StringType  ID)

Retrive the specified poster.

ID - ID of the poster to retrive.

Return:
Value is the poster if a match was found, null if not.
BasePost TheForum.GameCode.Poster.PosterRegister.GetPoster ( Libraries.StringType  ID)

Retrive the specified poster.

ID - ID of the poster to retrive.

Return:
Value is the poster if a match was found, null if not.
bool TheForum.GameCode.Poster.PosterRegister.RegisterPoster ( BasePost  poster)

Register the given poster. If a poster with the same ID already exists, nothing happens.

poster - Poster to register.

Return
Value is true if the poster was added, false if not.
bool TheForum.GameCode.Poster.PosterRegister.RegisterPoster ( BasePost  poster)

Register the given poster. If a poster with the same ID already exists, nothing happens.

poster - Poster to register.

Return
Value is true if the poster was added, false if not.
void TheForum.GameCode.Poster.PosterRegister.SetLocalOpponentID ( string  ID)

Store the ID of the local opponent. This way the game can know who not to effect if everybody but the opponent should be affected.

void TheForum.GameCode.Poster.PosterRegister.SetLocalOpponentID ( string  ID)

Store the ID of the local opponent. This way the game can know who not to effect if everybody but the opponent should be affected.

ID - ID to store.
void TheForum.GameCode.Poster.PosterRegister.SetLocalUserID ( string  ID)

Store the ID of the local user. This way the game can know who not to effect if everybody but the user should be affected.

ID - ID to store.
void TheForum.GameCode.Poster.PosterRegister.SetLocalUserID ( string  ID)

Store the ID of the local user. This way the game can know who not to effect if everybody but the user should be affected.


Member Data Documentation

Store the ID of the opponet.

Store the ID of the user.

Stores the registered posters.

Singleton instance of the class.


Property Documentation

static PosterRegister TheForum::GameCode::Poster.PosterRegister::Instance [static, get]

Get the singleton instance of the class.


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