Describes a stack of cards to be drawn in the BankUI. If a RuleSet adds additional resource cards or another type of cards to the game, it is important that the user have a visual representation of how many of those cards are left in the bank. The struct BankData provides a way for RuleSets to detail to the BankUI not only what image to use to draw the card stack, but also where in the Game data the current number of cards in that stack are located.
NOTE: BankData should be created via the <IMPLEMENT_BANK_DATA> macro in <RuleSetDatabase>.
BankData.h
Describes a stack of cards to be drawn in the BankUI. | |
The BankData constructor. | |
The location in the Game IntHash map where the card amount data is stored. | |
The type of data within the data location. | |
The ImageSet key for the group of images that the card image resides in. | |
The name of the image within the ImageSet group key. |
|
The BankData constructor. Stores the given locations of data and image information.
| loc | The location of the bank data in the Game IntHash. |
| type | The type of bank data within the location. |
| key | The ImageSet key of the image to draw the card stack. |
| name | The image name of the image to draw the card stack. |
| wxString mDataLocation |
The location in the Game IntHash map where the card amount data is stored.
| wxString mDataType |
The type of data within the data location. It must be an existing hash entry in the IntHash specified by mDataLocation, or an error message will be thrown to the screen by the Data class.
| wxString mImageKey |
The ImageSet key for the group of images that the card image resides in.
| wxString mImageName |
The name of the image within the ImageSet group key.
|
| wxString mDataLocation |
| wxString mDataType |
| wxString mImageKey |
| wxString mImageName |