player - Windower/packages GitHub Wiki
The player library provides information about the player character.
local player = require('player')
❗ Dependency Required
To use this library, you must include
player
in themanifest.xml
file for your package:<dependency>player</dependency>
The player
table has the following entries:
- player.job_levels : Job levels (table)
- player.skills : Skill information (table)
- player.pos : Character position information (table)
-
player.model : Character Model information (table)
-
player.name : character name
- player.id : character ID
-
player.index : index in entities array
- player.hp : Current HP
- player.hp_max : Max hit point count
-
player.hp_percent : Current HP percentage. 0 to 100
- player.mp : Current mana point count
- player.mp_max : Max MP
-
player.mp_percent : Current MP percentage. 0 to 100
-
player.tp : Current TP
- player.main_job_id : Current main job id
- player.main_job_level : Current main job level
- player.sub_job_id : Current sub job id
- player.sub_job_level : Current sub job level
- player.superior_level : Superior level
- player.item_level : Current Item level
- player.exp : Current experience
-
player.exp_required : Required experience to next level
- player.target_index : Current target's index in entities array
- player.movement_speed : Current movement speed
-
player.animation_speed : Current animation speed
- player.title_id : Current title's ID
- player.nation_id : Current Nation's ID
- player.nation_rank : Current rank in nation
- player.nation_rank_points : Current rank points in nation
-
player.home_point_zone_id : Current home point zone ID