ORK Framework  3.10.0
API Documentation
GamingIsLove.ORKFramework.BattleAccessHandler Class Reference

Public Member Functions

virtual void AddLoot (IShortcut item)
 Adds loot to the battle loot. More...
 
virtual void AddExperience (StatusValueSetting statusValue, int exp, int level, int classLevel, Combatant forCombatant)
 Adds experience to the battle loot. More...
 
virtual void ChangeExperience (StatusValueSetting statusValue, float change, FloatOperator op, Combatant forCombatant)
 Changes the current experience in the battle loot. More...
 
virtual void AddNormalStatusValue (StatusValueSetting statusValue, int value)
 Adds a 'Normal' type status value reward to the battle loot. More...
 
virtual void ChangeNormalStatusValue (StatusValueSetting statusValue, float change, FloatOperator 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 void GetGainsFrom (Combatant combatant, List< IShortcut > list, bool useStackType)
 Collects the loot, experience and 'Normal' type status value rewards of a combatant. Loot will be added to a provided list instead of the battle loot. More...
 
virtual void CollectGains (bool collectLoot, bool collectExp, bool showGains, float autoClose, bool autoCloseControlable, bool useItemBox, bool itemBoxAddType, string itemBoxID, Notify notifyFinished, bool immediateCollection)
 Collects the current battle loot. More...
 
virtual void ShowMissFlyingText (string info, Combatant combatant, GameObject targetObject, IContent content)
 
virtual void ShowBlockFlyingText (string info, Combatant combatant, GameObject targetObject, IContent content)
 
virtual void ShowCastCancelFlyingText (string info, Combatant combatant, GameObject targetObject, IContent content)
 
virtual void ShowLevelUpFlyingText (string info, Combatant combatant, GameObject targetObject)
 
virtual void ShowClassLevelUpFlyingText (string info, Combatant combatant, GameObject targetObject)
 

Member Function Documentation

◆ AddExperience()

virtual void GamingIsLove.ORKFramework.BattleAccessHandler.AddExperience ( StatusValueSetting  statusValue,
int  exp,
int  level,
int  classLevel,
Combatant  forCombatant 
)
virtual

Adds experience to the battle loot.

Parameters
statusValueThe 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 GamingIsLove.ORKFramework.BattleAccessHandler.AddLoot ( IShortcut  item)
virtual

Adds loot to the battle loot.

Parameters
itemThe loot item/equipment that will be added

◆ AddNormalStatusValue()

virtual void GamingIsLove.ORKFramework.BattleAccessHandler.AddNormalStatusValue ( StatusValueSetting  statusValue,
int  value 
)
virtual

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

Parameters
statusValueThe status value.
valueThe value that will be added.

◆ ChangeExperience()

virtual void GamingIsLove.ORKFramework.BattleAccessHandler.ChangeExperience ( StatusValueSetting  statusValue,
float  change,
FloatOperator  op,
Combatant  forCombatant 
)
virtual

Changes the current experience in the battle loot.

Parameters
statusValueThe 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 GamingIsLove.ORKFramework.BattleAccessHandler.ChangeNormalStatusValue ( StatusValueSetting  statusValue,
float  change,
FloatOperator  op 
)
virtual

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

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

◆ CollectGains()

virtual void GamingIsLove.ORKFramework.BattleAccessHandler.CollectGains ( bool  collectLoot,
bool  collectExp,
bool  showGains,
float  autoClose,
bool  autoCloseControlable,
bool  useItemBox,
bool  itemBoxAddType,
string  itemBoxID,
Notify  notifyFinished,
bool  immediateCollection 
)
virtual

Collects the current battle loot.

Parameters
collectLootLoot will be collected (e.g. items, equipment, etc.).
collectExpExperience and 'Normal' type status value rewards will be collected.
showGainsThe loot dialogue will be displayed.
autoCloseThe auto close time for the loot dialoge, use a value below 0 to not use auto closing.
autoCloseControlabletrue if auto close loot dialogues can still be accepted to close them sooner.
useItemBoxStore the loot into an item box.
itemBoxAddTypeUse the item stacking options when storing loot in an item box.
itemBoxIDThe box ID of the item box.
notifyFinishedDelegate to call when the collection finished.
immediateCollectiontrue if this loot collection is an immediate collection (i.e. not at the end of the battle).

◆ GetGainsFrom() [1/2]

virtual void GamingIsLove.ORKFramework.BattleAccessHandler.GetGainsFrom ( Combatant  combatant)
virtual

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

Parameters
combatantThe combatant.

◆ GetGainsFrom() [2/2]

virtual void GamingIsLove.ORKFramework.BattleAccessHandler.GetGainsFrom ( Combatant  combatant,
List< IShortcut list,
bool  useStackType 
)
virtual

Collects the loot, experience and 'Normal' type status value rewards of a combatant. Loot will be added to a provided list instead of the battle loot.

Parameters
combatantThe combatant
listThe list the loot wil be added to.
useStackTypetrue if item stacking is used (based on the stacking setup for the item).