ORK Framework  2.29.3
API Documentation
ORKFramework.BattleLoot Class Reference
Inheritance diagram for ORKFramework.BattleLoot:
ORKFramework.ISaveData

Public Member Functions

virtual void Clear ()
 
virtual void Clear (bool loot, bool exp, bool normalSV)
 
virtual void AddLoot (IShortcut item)
 Adds loot to the battle loot. More...
 
virtual void AddExperience (int statusID, int exp, int level, int classLevel, Combatant forCombatant)
 Adds experience to the battle loot. More...
 
virtual void ChangeExperience (int statusID, float change, FormulaOperator op, Combatant forCombatant)
 Changes the current experience int the battle loot. More...
 
virtual void AddNormalStatusValue (int statusID, int value)
 Adds a 'Normal' type status value reward to the battle loot. More...
 
virtual void ChangeNormalStatusValue (int statusID, float change, FormulaOperator op)
 Changes the current 'Normal' type status value reward in the battle loot. More...
 
virtual void GetGainsFrom (Combatant combatant)
 Collects the loot, experience and 'Normal' type status value rewards of a combatant. More...
 
virtual DataObject SaveGame ()
 Used to save the data - you need to add the data to a ORKFramework.DataObject. More...
 
virtual void LoadGame (DataObject data)
 Used to load the data - you need to get the data from the ORKFramework.DataObject. More...
 

Protected Attributes

List< IShortcutloot = new List<IShortcut>()
 
Dictionary< int, List< ExperienceLoot > > expGains = new Dictionary<int, List<ExperienceLoot>>()
 
Dictionary< int, int > normalSVGains = new Dictionary<int, int>()
 

Properties

virtual bool Has [get]
 
virtual List< IShortcutLoot [get]
 
virtual Dictionary< int, List< ExperienceLoot > > Experience [get]
 
virtual Dictionary< int, int > NormalStatusValue [get]
 

Member Function Documentation

◆ AddExperience()

virtual void ORKFramework.BattleLoot.AddExperience ( int  statusID,
int  exp,
int  level,
int  classLevel,
Combatant  forCombatant 
)
virtual

Adds experience to the battle loot.

Parameters
statusIDThe ID of the status value.
expThe experience that will be added.
levelThe level of the source combatant.
classLevelThe class level of the source combatant.
forCombatantThe combatant the experience is for, or null if not for a specific combatant.

◆ AddLoot()

virtual void ORKFramework.BattleLoot.AddLoot ( IShortcut  item)
virtual

Adds loot to the battle loot.

Parameters
itemThe loot item/equipment that will be added

◆ AddNormalStatusValue()

virtual void ORKFramework.BattleLoot.AddNormalStatusValue ( int  statusID,
int  value 
)
virtual

Adds a 'Normal' type status value reward to the battle loot.

Parameters
statusIDThe ID of the status value.
valueThe value that will be added.

◆ ChangeExperience()

virtual void ORKFramework.BattleLoot.ChangeExperience ( int  statusID,
float  change,
FormulaOperator  op,
Combatant  forCombatant 
)
virtual

Changes the current experience int the battle loot.

Parameters
statusIDThe ID of the status value.
changeThe value used to change the experience.
opThe operator used, e.g. add or multiply.
forCombatantThe combatant who's experience will be changed, or null if not using a specific combatant.

◆ ChangeNormalStatusValue()

virtual void ORKFramework.BattleLoot.ChangeNormalStatusValue ( int  statusID,
float  change,
FormulaOperator  op 
)
virtual

Changes the current 'Normal' type status value reward in the battle loot.

Parameters
statusIDThe ID of the status value.
changeThe value used to change the reward.
opThe operator used, e.g. add or multiply.

◆ GetGainsFrom()

virtual void ORKFramework.BattleLoot.GetGainsFrom ( Combatant  combatant)
virtual

Collects the loot, experience and 'Normal' type status value rewards of a combatant.

Parameters
combatantThe combatant.

◆ LoadGame()

virtual void ORKFramework.BattleLoot.LoadGame ( DataObject  data)
virtual

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.

◆ SaveGame()

virtual DataObject ORKFramework.BattleLoot.SaveGame ( )
virtual

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.