hoa_global::GlobalSkill Class Reference

A class for representing skills used in the game. More...

#include <global_skills.h>

Collaboration diagram for hoa_global::GlobalSkill:

Public Member Functions

void BattleExecute (hoa_battle::private_battle::BattleActor *target, hoa_battle::private_battle::BattleActor *instigator)

Calls the script function which executes the skill for battles.

GlobalSkill (uint32 id)

Parameters:

The identification number of the skill to construct

bool IsExecutableInBattle () const

Returns true if the skill can be executed in battles.

bool IsExecutableInMenu () const

Returns true if the skill can be executed in menus.

void MenuExecute (GlobalCharacter *target, GlobalCharacter *instigator)

Calls the script function which executes the skill for menus.

~GlobalSkill ()

Class member access functions

Note:: No set functiosn are defined because the class members should only be defined by the Lua script.

uint32 GetCooldownTime () const

hoa_utils::ustring GetDescription () const

uint32 GetID () const

hoa_utils::ustring GetName () const

uint32 GetSPRequired () const

GLOBAL_TARGET GetTargetType () const

uint8 GetType () const

GLOBAL_USE GetUsage () const

uint32 GetWarmupTime () const

bool IsTargetAlly () const

Private Attributes

ScriptObject * _battle_execute_function

A pointer to the skill's execution function for battles.

uint32

_cooldown_time

The amount of time that must expire after a skill can be used before the actor can regain their stamina After a character or enemy uses a skill, this member tells how many milliseconds must pass before the invoker can recover and begin re-filling their stamina bar. It is acceptable for this member to be zero.

hoa_utils::ustring

_description

A short description of the skill.

uint32

_id

The unique identifier number of the skill.

ScriptObject * _menu_execute_function

A pointer to the skill's execution function for menus.

hoa_utils::ustring

_name

The name of the skill as it will be displayed on the screen.

uint32

_sp_required

The amount of skill points (SP) that the skill requires to be used Zero is a valid value for this member and simply means that no skill points are required to use the skill. These are called "innate skills".

bool _target_ally

If set to true, the target should be an ally. If not, the target should be a foe.

GLOBAL_TARGET

_target_type

The type of target that the skill is executed upon.

GLOBAL_SKILL

_type

The type identifier for the skill Refer to the Skill Types constants defined in this file.

GLOBAL_USE

_usage

Indicates when the skill may be used (in battles, menus, etc.).

uint32

_warmup_time

The amount of time that must expire before a skill can be used from when it is selected When a character or enemy is determined to use a skill, this member tells how many milliseconds must pass before the skill can be used (in otherwords, before it can be placed in the action queue in a battle). It is acceptable for this member to be zero.

Detailed Description

A class for representing skills used in the game.

****************************************************************************

Skills are one representation of actions that a character or enemy may take in battle. The actual execution of a skill is done by a Lua function, which this class manages pointers to. Typically skills are not shared between characters and enemies, primarily because characters are fully animated when executing actions, while enemies are not animated. Skills can be used in contexts other than battles. For instance, using a healing skill on the party from the character management menu.

There are three types of skills: attack, defend, and support. The way that this class is initialized is by defining the "script ID" of the skill. When this information is known, it seeks a Lua file that contains the data to set the members of this class as well as the script functions that actually perform the execution of the skill.