C#Code
C#Code
Public Member Functions | Public Attributes
TheForum.GameCode.PosterProfiles.PieceUseData Class Reference

List of all members.

Public Member Functions

 PieceUseData ()
 PieceUseData (String pieceType, int chance)
virtual object Clone ()

Public Attributes

string m_pieceType
 ID of the piece to use.
int m_chance = 0
 Chance the piece will be selected out of all possible choices.

Detailed Description

Information on a possible piece choice. Stores the type of the piece and what the chance is that it will be used. If all pieces have the chance of 1, then the all have the same probability of being selected. If there are two pieces, and one has a 1 and the other has a 2, then they have a 1/3 and 2/3 chances of being selected, respectively


Constructor & Destructor Documentation

TheForum.GameCode.PosterProfiles.PieceUseData.PieceUseData ( )

Default constructor.

TheForum.GameCode.PosterProfiles.PieceUseData.PieceUseData ( String  pieceType,
int  chance 
)

Constructor.

pieceType - Piece deffinition ID.
chance - Chance the piece has of being created. Is combined with other chances.

Member Function Documentation

virtual object TheForum.GameCode.PosterProfiles.PieceUseData.Clone ( ) [virtual]

Clone the object.

Return:
Value is the clone.


Member Data Documentation

Chance the piece will be selected out of all possible choices.

ID of the piece to use.


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