ORK Framework  2.24.0
API Documentation
ORKFramework.Combatants.CombatantClass Class Reference
Inheritance diagram for ORKFramework.Combatants.CombatantClass:
ORKFramework.ISaveData

Public Member Functions

 CombatantClass (Combatant owner)
 
void Clear ()
 
int GetLevel (int classID)
 
void Init (int classID, int classLevel)
 
void Change (int classID, bool unequipAll, bool forgetAbilities, bool learnAbilities, bool resetClassLevel, bool removeOldBonus, bool statusBonus, bool resetAtkAttrStart, bool resetDefAttrStart)
 Changes the combatant's class. More...
 
string ForceLevelUp ()
 
string LevelUp ()
 
DataObject SaveGame ()
 Used to save the data - you need to add the data to a ORKFramework.DataObject. More...
 
void LoadGame (DataObject data)
 Used to load the data - you need to get the data from the ORKFramework.DataObject. More...
 

Properties

LevelChanged LevelChanged
 
ClassChanged Changed
 
Class Current [get]
 
int ID [get]
 
int Level [get]
 
int MaxLevel [get]
 

Member Function Documentation

void ORKFramework.Combatants.CombatantClass.Change ( int  classID,
bool  unequipAll,
bool  forgetAbilities,
bool  learnAbilities,
bool  resetClassLevel,
bool  removeOldBonus,
bool  statusBonus,
bool  resetAtkAttrStart,
bool  resetDefAttrStart 
)

Changes the combatant's class.

Parameters
classIDThe ID (index) of the class.
unequipAlltrue if all equipmeht should be unequipped before changing class; otherwise, false.
forgetAbilitiestrue if the abilities learned from the previous class should be forgotten; otherwise, false.
learnAbilitiestrue if the abilities of the new class should be learned; otherwise, false.
resetClassLeveltrue if the class level of the new class should be reset to the start class level; otherwise, false.
removeOldBonustrue if the bonuses of the previous class should be forgotten; otherwise, false.
statusBonustrue if the bonuses of the new class should be learned; otherwise, false.
resetAtkAttrStarttrue if the attack attribute start values of the previous class should be forgotten; otherwise, false.
resetDefAttrStarttrue if the defence attribute start values of the previous class should be forgotten; otherwise, false.
void ORKFramework.Combatants.CombatantClass.LoadGame ( DataObject  data)

Used to load the data - you need to get the data from the ORKFramework.DataObject.

Parameters
dataA ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.

DataObject ORKFramework.Combatants.CombatantClass.SaveGame ( )

Used to save the data - you need to add the data to a ORKFramework.DataObject.

Returns
A ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.