ORK Framework  2.27.1
API Documentation
ORKFramework.ActionAccessHandler Class Reference

Public Member Functions

virtual void AddActionToCombatant (Combatant user, BaseAction action, bool newTurn)
 Adds a battle action to a combatant, and after checks adding it to the battle system's action handler. More...
 
virtual bool UseShortcut (IShortcut shortcut, Combatant user, List< Combatant > targets, bool useAction)
 Calls the 'Use' function of an IShortcut implementation. More...
 
virtual void SpendExperience (Combatant user, ILevelUpSpend levelUp)
 Spends experience points on something that can be leveled up (e.g. an ability). More...
 

Member Function Documentation

◆ AddActionToCombatant()

virtual void ORKFramework.ActionAccessHandler.AddActionToCombatant ( Combatant  user,
BaseAction  action,
bool  newTurn 
)
virtual

Adds a battle action to a combatant, and after checks adding it to the battle system's action handler.

Parameters
userThe user combatant the action will be added to.
actionThe battle action that will be added.
newTurntrue if the user should start a new turn (action fails if a new turn can't be started).

◆ SpendExperience()

virtual void ORKFramework.ActionAccessHandler.SpendExperience ( Combatant  user,
ILevelUpSpend  levelUp 
)
virtual

Spends experience points on something that can be leveled up (e.g. an ability).

Parameters
userThe combatant that spends the experience.
levelUpThe content that will level up.

◆ UseShortcut()

virtual bool ORKFramework.ActionAccessHandler.UseShortcut ( IShortcut  shortcut,
Combatant  user,
List< Combatant targets,
bool  useAction 
)
virtual

Calls the 'Use' function of an IShortcut implementation.

Parameters
shortcutThe shortcut that will be used.
userThe user combatant.
targetsThe target combatants.
useActiontrue if a battle action will be used to animate the use/action.
Returns
true if the shortcut was used.