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 void	Choose (Combatant combatant, bool newTurn, bool autoCallMenu)
	Starts a combatant's action selection. For the player, this'll bring up the battle menu (if used), for AI controlled combatants it'll use the battle AI. More...
virtual void	ChooseAuto (Combatant combatant, bool newTurn)
	Starts a combatant's auto action selection (using battle AI). More...
virtual void	AddActionToBattle (BaseAction action)
	Adds a battle action to the battle system's action handler. More...
virtual void	UnshiftActionToBattle (BaseAction action)
	Adds a battle action to the battle system's action handler as the next action that will be performed. 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...
virtual void	UseItem (ItemShortcut item, Combatant user, List< Combatant > target, GameObject flyingTextTargetObject, bool fromAction, bool animate, bool doConsume, float damageFactor, float damageMultiplier, VariableHandler localVariables, SelectedDataHandler selectedData, ActionCalculationFinished notify, ItemAction action)
virtual void	UseAbility (AbilityShortcut ability, Combatant user, List< Combatant > target, GameObject flyingTextTargetObject, bool fromAction, bool animate, bool doCounter, bool doUseCosts, float damageFactor, float damageMultiplier, VariableHandler localVariables, SelectedDataHandler selectedData, ActionCalculationFinished notify, AbilityAction action)

Member Function Documentation

AddActionToBattle()

virtual void ORKFramework.ActionAccessHandler.AddActionToBattle ( BaseAction  action )

virtual

Adds a battle action to the battle system's action handler.

Parameters

action

The battle action that will be added.

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

user	The user combatant the action will be added to.
action	The battle action that will be added.
newTurn	true if the user should start a new turn (action fails if a new turn can't be started).

Choose()

virtual void ORKFramework.ActionAccessHandler.Choose ( Combatant  combatant, bool  newTurn, bool  autoCallMenu  )

virtual

Starts a combatant's action selection. For the player, this'll bring up the battle menu (if used), for AI controlled combatants it'll use the battle AI.

Parameters

combatant	The combatant selecting actions.
newTurn	true if the combatant should start a new turn.
autoCallMenu	true if the battle menu should be called automatically.

ChooseAuto()

virtual void ORKFramework.ActionAccessHandler.ChooseAuto ( Combatant  combatant, bool  newTurn  )

virtual

Starts a combatant's auto action selection (using battle AI).

Parameters

combatant	The combatant selecting actions.
newTurn	true if the combatant should start a new turn.

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

user	The combatant that spends the experience.
levelUp	The content that will level up.

UnshiftActionToBattle()

virtual void ORKFramework.ActionAccessHandler.UnshiftActionToBattle ( BaseAction  action )

virtual

Adds a battle action to the battle system's action handler as the next action that will be performed.

Parameters

action

The battle action that will be added.

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

shortcut	The shortcut that will be used.
user	The user combatant.
targets	The target combatants.
useAction	true if a battle action will be used to animate the use/action.

Returns

true if the shortcut was used.