Violet

Skill Book

On this page

Provides access to skill information. For skill usage, see input.

Skill Properties
  • id - Unique identifier
  • name - Readable skill name
  • level - Current level
  • max_level - Effective maximum (master) level

Functions

core.skill_book.get_skill(skill_id: number) -> skill | nil

Returns a skill object or nil if not found.

core.skill_book.get_skills() -> table<skill>

Returns all skills in the skill book.

core.skill_book.get_skill_level(skill_id: number) -> number

Returns the current level of the specified skill.

core.skill_book.get_skill_max_level(skill_id: number) -> number | nil

Returns the skill's effective maximum (master) level, accounting for hyper and 5th-job caps. Returns nil if the skill isn't in the skill book.

core.skill_book.is_skill_on_cooldown(skill_id: number) -> boolean

Returns true if the skill is on cooldown.

core.skill_book.can_use(skill_id: number) -> boolean | nil

Returns true if the skill can be cast right now: it is learned, its cost and state requirements are met, and it isn't on cooldown. Uses the client's own pre-cast check, so it also covers reasons the cooldown functions can't see. Returns nil if there is no local player.

core.skill_book.get_skill_cooldown_remaining(skill_id: number) -> number

Returns the skill's remaining cooldown in milliseconds, or 0 when it is off cooldown. Reads the same cooldown data as is_skill_on_cooldown, so the two always agree — and it reports the true server cooldown even while No Delay is enabled.