ffse::SaveSlot Class Reference

#include <SaveSlot.hh>

List of all members.


Detailed Description

Class to encapsulate SRAM data and provide I/O within its framework.

Definition at line 114 of file SaveSlot.hh.

Public Member Functions

 SaveSlot (const char *nvram)
 Constructor for a SaveSlot.
 ~SaveSlot ()
 Destructor for a SaveSlot.
bool isValid ()
 Checks if this SaveSlot is valid.
bool isModified ()
 Checks if this SaveSlot has been modified;.
unsigned char checksum ()
 Generates a checksum for the current game data.
wxInt32 getGold ()
 Gets the current amount of gold help by the party.
void setGold (wxInt32 value)
 Sets the current amount of gold help by the party.
int getItem (int item)
 Gets the current amount of a particular item.
void setItem (int item, unsigned char value=1)
 Sets the current amount of a particular item.
wxString getName (int member)
 Gets the name for a particular party member.
void setName (int member, wxString &value)
 Sets the name for a particular party member.
int getClass (int member)
 Gets the class of a particular party member.
void setClass (int member, unsigned char value)
 Sets the class of a particular party member.
int getCondition (int member)
 Gets the condition of a party member.
void setCondition (int member, unsigned char value)
 Sets the condition of a party member.
wxInt32 getExperience (int member)
 Gets the experience of a party member.
wxInt16 getCurrentHP (int member)
 Gets the current HP of a party member.
void setCurrentHP (int member, wxInt16 value)
 Sets the current HP of a party member.
wxInt16 getMaxHP (int member)
 Gets the max HP of a party member.
void setMaxHP (int member, wxInt16 value)
 Sets the max HP of a party member.
void setExperience (int member, wxInt32 value)
 Sets the experience of a party member.
int getStrength (int member)
 Gets the strength of a party member.
void setStrength (int member, unsigned char value)
 Sets the strength of a party member.
int getAgility (int member)
 Gets the agility of a party member.
void setAgility (int member, unsigned char value)
 Sets the agility of a party member.
int getIntelligence (int member)
 Gets the intelligence of a party member.
void setIntelligence (int member, unsigned char value)
 Sets the intelligence of a party member.
int getVitality (int member)
 Gets the vitality of a party member.
void setVitality (int member, unsigned char value)
 Sets the vitality of a party member.
int getLuck (int member)
 Gets the luck of a party member.
void setLuck (int member, unsigned char value)
 Sets the luck of a party member.
int getDamage (int member)
 Gets the damage of a party member.
void setDamage (int member, unsigned char value)
 Sets the damage of a party member.
int getHitPercent (int member)
 Gets the hit percent of a party member.
void setHitPercent (int member, unsigned char value)
 Sets the hit percent of a party member.
int getWeapon (int member, int slot)
 Gets the weapon of a party member at a given slot.
void setWeapon (int member, int slot, unsigned char value)
 Sets the weapon of a party member at a given slot.
int getArmor (int member, int slot)
 Gets the armor of a party member at a given slot.
void setArmor (int member, int slot, unsigned char value)
 Sets the armor of a party member at a given slot.
int getCurrentMagic (int member, int level)
 Gets the current magic of a party member at a given level.
void setCurrentMagic (int member, int level, unsigned char value)
 Sets the current magic of a party member at a given level.
int getMaxMagic (int member, int level)
 Gets the max magic of a party member at a given level.
void setMaxMagic (int member, int level, unsigned char value)
 Sets the max magic of a party member at a given level.
int getMagic (int member, int level, int slot)
 Gets the magic of a party member at a given level.
void setMagic (int member, int level, int slot, unsigned char value)
 Sets the magic of a party member at a given level.

Private Member Functions

unsigned char adc (unsigned char current, unsigned char value)
 Performs an add with carry operation.
void setCarry (bool set=true)
 Sets or clears the carry flag used by adc.
void setModified (bool modified=true)
 Sets whether this SaveSlot has been modified or not.

Static Private Member Functions

static unsigned char toNES (char letter)
 Translates a character from ASCII to the Final Fantasy alphabet.
static char fromNES (unsigned char letter)
 Translates a character from the Final Fantasy alphabet to ASCII.

Private Attributes

unsigned char * nvram
int carry
bool valid
bool modified

Friends

class MainFrame


Constructor & Destructor Documentation

SaveSlot::SaveSlot ( const char *  nvram  ) 

Constructor for a SaveSlot.

Parameters:
nvram The SRAM game data, which must be 0x400 bytes long.

Definition at line 41 of file SaveSlot.cc.

SaveSlot::~SaveSlot (  ) 

Destructor for a SaveSlot.

Definition at line 53 of file SaveSlot.cc.


Member Function Documentation

bool ffse::SaveSlot::isValid (  )  [inline]

Checks if this SaveSlot is valid.

Returns:
true if valid; false otherwise.

Definition at line 135 of file SaveSlot.hh.

bool ffse::SaveSlot::isModified (  )  [inline]

Checks if this SaveSlot has been modified;.

Returns:
true if modified; false otherwise.

Definition at line 142 of file SaveSlot.hh.

unsigned char SaveSlot::checksum (  ) 

Generates a checksum for the current game data.

Returns:
The generated checksum.

Definition at line 59 of file SaveSlot.cc.

wxInt32 SaveSlot::getGold (  ) 

Gets the current amount of gold help by the party.

Returns:
The current gold.

Definition at line 78 of file SaveSlot.cc.

void SaveSlot::setGold ( wxInt32  value  ) 

Sets the current amount of gold help by the party.

Parameters:
value The new value.

Definition at line 94 of file SaveSlot.cc.

int SaveSlot::getItem ( int  item  ) 

Gets the current amount of a particular item.

Parameters:
item The item whose amount to retrieve. Valid values are any of the Items enumeration.
Returns:
The current amount of the item.

Definition at line 104 of file SaveSlot.cc.

void SaveSlot::setItem ( int  item,
unsigned char  value = 1 
)

Sets the current amount of a particular item.

Parameters:
item The item whose amount to set. Valid values are any of the Items enumeration.
value The new amount.

Definition at line 108 of file SaveSlot.cc.

wxString SaveSlot::getName ( int  member  ) 

Gets the name for a particular party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The name.

Definition at line 114 of file SaveSlot.cc.

void SaveSlot::setName ( int  member,
wxString &  value 
)

Sets the name for a particular party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 125 of file SaveSlot.cc.

int SaveSlot::getClass ( int  member  ) 

Gets the class of a particular party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The class.

Definition at line 143 of file SaveSlot.cc.

void SaveSlot::setClass ( int  member,
unsigned char  value 
)

Sets the class of a particular party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 147 of file SaveSlot.cc.

int SaveSlot::getCondition ( int  member  ) 

Gets the condition of a party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The condition.

Definition at line 153 of file SaveSlot.cc.

void SaveSlot::setCondition ( int  member,
unsigned char  value 
)

Sets the condition of a party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 157 of file SaveSlot.cc.

wxInt32 SaveSlot::getExperience ( int  member  ) 

Gets the experience of a party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The experience.

Definition at line 191 of file SaveSlot.cc.

wxInt16 SaveSlot::getCurrentHP ( int  member  ) 

Gets the current HP of a party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The current HP.

Definition at line 163 of file SaveSlot.cc.

void SaveSlot::setCurrentHP ( int  member,
wxInt16  value 
)

Sets the current HP of a party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 170 of file SaveSlot.cc.

wxInt16 SaveSlot::getMaxHP ( int  member  ) 

Gets the max HP of a party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The max HP.

Definition at line 178 of file SaveSlot.cc.

void SaveSlot::setMaxHP ( int  member,
wxInt16  value 
)

Sets the max HP of a party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 184 of file SaveSlot.cc.

void SaveSlot::setExperience ( int  member,
wxInt32  value 
)

Sets the experience of a party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 207 of file SaveSlot.cc.

int SaveSlot::getStrength ( int  member  ) 

Gets the strength of a party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The strength.

Definition at line 219 of file SaveSlot.cc.

void SaveSlot::setStrength ( int  member,
unsigned char  value 
)

Sets the strength of a party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 223 of file SaveSlot.cc.

int SaveSlot::getAgility ( int  member  ) 

Gets the agility of a party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The agility.

Definition at line 229 of file SaveSlot.cc.

void SaveSlot::setAgility ( int  member,
unsigned char  value 
)

Sets the agility of a party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 233 of file SaveSlot.cc.

int SaveSlot::getIntelligence ( int  member  ) 

Gets the intelligence of a party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The intelligence.

Definition at line 239 of file SaveSlot.cc.

void SaveSlot::setIntelligence ( int  member,
unsigned char  value 
)

Sets the intelligence of a party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 243 of file SaveSlot.cc.

int SaveSlot::getVitality ( int  member  ) 

Gets the vitality of a party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The vitality.

Definition at line 249 of file SaveSlot.cc.

void SaveSlot::setVitality ( int  member,
unsigned char  value 
)

Sets the vitality of a party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 253 of file SaveSlot.cc.

int SaveSlot::getLuck ( int  member  ) 

Gets the luck of a party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The luck.

Definition at line 259 of file SaveSlot.cc.

void SaveSlot::setLuck ( int  member,
unsigned char  value 
)

Sets the luck of a party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 263 of file SaveSlot.cc.

int SaveSlot::getDamage ( int  member  ) 

Gets the damage of a party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The damage.

Definition at line 269 of file SaveSlot.cc.

void SaveSlot::setDamage ( int  member,
unsigned char  value 
)

Sets the damage of a party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 273 of file SaveSlot.cc.

int SaveSlot::getHitPercent ( int  member  ) 

Gets the hit percent of a party member.

Parameters:
member The party member. Valid values are 0-3.
Returns:
The hit percent.

Definition at line 279 of file SaveSlot.cc.

void SaveSlot::setHitPercent ( int  member,
unsigned char  value 
)

Sets the hit percent of a party member.

Parameters:
member The party member. Valid values are 0-3.
value The new value.

Definition at line 283 of file SaveSlot.cc.

int SaveSlot::getWeapon ( int  member,
int  slot 
)

Gets the weapon of a party member at a given slot.

Parameters:
member The party member. Valid values are 0-3.
slot The slot. Valid values are 0-3.
Returns:
The weapon.

Definition at line 289 of file SaveSlot.cc.

void SaveSlot::setWeapon ( int  member,
int  slot,
unsigned char  value 
)

Sets the weapon of a party member at a given slot.

Parameters:
member The party member. Valid values are 0-3.
slot The slot. Valid values are 0-3.
value The new value.

Definition at line 293 of file SaveSlot.cc.

int SaveSlot::getArmor ( int  member,
int  slot 
)

Gets the armor of a party member at a given slot.

Parameters:
member The party member. Valid values are 0-3.
slot The slot. Valid values are 0-3.
Returns:
The armor.

Definition at line 299 of file SaveSlot.cc.

void SaveSlot::setArmor ( int  member,
int  slot,
unsigned char  value 
)

Sets the armor of a party member at a given slot.

Parameters:
member The party member. Valid values are 0-3.
slot The slot. Valid values are 0-3.
value The new value.

Definition at line 303 of file SaveSlot.cc.

int SaveSlot::getCurrentMagic ( int  member,
int  level 
)

Gets the current magic of a party member at a given level.

Parameters:
member The party member. Valid values are 0-3.
level The magic level. Valid values are 0-7.
Returns:
The current magic.

Definition at line 309 of file SaveSlot.cc.

void SaveSlot::setCurrentMagic ( int  member,
int  level,
unsigned char  value 
)

Sets the current magic of a party member at a given level.

Parameters:
member The party member. Valid values are 0-3.
level The magic level. Valid values are 0-7.
value The new value.

Definition at line 313 of file SaveSlot.cc.

int SaveSlot::getMaxMagic ( int  member,
int  level 
)

Gets the max magic of a party member at a given level.

Parameters:
member The party member. Valid values are 0-3.
level The magic level. Valid values are 0-7.
Returns:
The max magic.

Definition at line 319 of file SaveSlot.cc.

void SaveSlot::setMaxMagic ( int  member,
int  level,
unsigned char  value 
)

Sets the max magic of a party member at a given level.

Parameters:
member The party member. Valid values are 0-3.
level The magic level. Valid values are 0-7.
value The new value.

Definition at line 323 of file SaveSlot.cc.

int SaveSlot::getMagic ( int  member,
int  level,
int  slot 
)

Gets the magic of a party member at a given level.

Parameters:
member The party member. Valid values are 0-3.
level The magic level. Valid values are 0-7.
slot The slot. Valid values are 0-2.
Returns:
The magic.

Definition at line 329 of file SaveSlot.cc.

void SaveSlot::setMagic ( int  member,
int  level,
int  slot,
unsigned char  value 
)

Sets the magic of a party member at a given level.

Parameters:
member The party member. Valid values are 0-3.
level The magic level. Valid values are 0-7.
slot The slot. Valid values are 0-2.
value The new value.

Definition at line 336 of file SaveSlot.cc.

unsigned char SaveSlot::adc ( unsigned char  current,
unsigned char  value 
) [private]

Performs an add with carry operation.

Parameters:
current The current value.
value The value to add.
Returns:
The combined value plus the carry value, if applicable.

Definition at line 344 of file SaveSlot.cc.

void ffse::SaveSlot::setCarry ( bool  set = true  )  [inline, private]

Sets or clears the carry flag used by adc.

Parameters:
set Whether to set the carry flag or not.

Definition at line 518 of file SaveSlot.hh.

void SaveSlot::setModified ( bool  modified = true  )  [private]

Sets whether this SaveSlot has been modified or not.

Parameters:
modified true if modified; false otherwise.

Definition at line 361 of file SaveSlot.cc.

unsigned char SaveSlot::toNES ( char  letter  )  [static, private]

Translates a character from ASCII to the Final Fantasy alphabet.

Parameters:
letter The letter to translate.
Returns:
The translated letter.

Definition at line 369 of file SaveSlot.cc.

char SaveSlot::fromNES ( unsigned char  letter  )  [static, private]

Translates a character from the Final Fantasy alphabet to ASCII.

Parameters:
letter The letter to translate.
Returns:
The translated letter.

Definition at line 395 of file SaveSlot.cc.


Friends And Related Function Documentation

friend class MainFrame [friend]

Definition at line 115 of file SaveSlot.hh.


Member Data Documentation

unsigned char* ffse::SaveSlot::nvram [private]

Definition at line 545 of file SaveSlot.hh.

int ffse::SaveSlot::carry [private]

Definition at line 546 of file SaveSlot.hh.

bool ffse::SaveSlot::valid [private]

Definition at line 547 of file SaveSlot.hh.

bool ffse::SaveSlot::modified [private]

Definition at line 547 of file SaveSlot.hh.


Generated on Sun Feb 25 07:02:52 2007 for ffse by  doxygen 1.5.1-p1