ORK Framework  2.29.3
API Documentation
ORKFramework.BattleAccessHandler Class Reference

Public Member Functions

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 in 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 void CollectGains (bool collectLoot, bool collectExp, bool showGains, float autoClose, bool autoCloseControlable, bool useItemBox, bool itemBoxAddType, string itemBoxID, BaseEvent baseEvent, int next, bool immediateCollection)
 Collects the current battle loot. More...
 
virtual void ShowMissFlyingText (string info, Combatant combatant, IContentSimple content)
 
virtual void ShowBlockFlyingText (string info, Combatant combatant, IContentSimple content)
 
virtual void ShowBlockFlyingText (string info, Combatant combatant, GameObject gameObject, IContentSimple content)
 
virtual void ShowCastCancelFlyingText (string info, Combatant combatant, IContentSimple content)
 
virtual void ShowLevelUpFlyingText (string info, Combatant combatant)
 
virtual void ShowClassLevelUpFlyingText (string info, Combatant combatant)
 

Member Function Documentation

◆ AddExperience()

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

Adds loot to the battle loot.

Parameters
itemThe loot item/equipment that will be added

◆ AddNormalStatusValue()

virtual void ORKFramework.BattleAccessHandler.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.BattleAccessHandler.ChangeExperience ( int  statusID,
float  change,
FormulaOperator  op,
Combatant  forCombatant 
)
virtual

Changes the current experience in 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.BattleAccessHandler.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.

◆ CollectGains()

virtual void ORKFramework.BattleAccessHandler.CollectGains ( bool  collectLoot,
bool  collectExp,
bool  showGains,
float  autoClose,
bool  autoCloseControlable,
bool  useItemBox,
bool  itemBoxAddType,
string  itemBoxID,
BaseEvent  baseEvent,
int  next,
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.
baseEventThe event that started the loot collection, or null if no event was used or should be notified.
nextThe index of the event node that should be started after the loot collection finished.
immediateCollectiontrue if this loot collection is an immediate collection (i.e. not at the end of the battle).

◆ GetGainsFrom()

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

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

Parameters
combatantThe combatant.