GameObject
GameObject
The main object type representing players, monsters, and NPCs. Obtained via GetUser(aIndex) or as callback parameters.
Identity
| Property |
Type |
Description |
Index |
number (readonly) |
Object index |
AccountIndex |
number (readonly) |
Account database index |
CharacterIndex |
number (readonly) |
Character database index |
DBNumber |
number |
Database number |
Account |
string |
Account name |
Name |
string |
Character name |
PersonalCode |
string |
Personal security code |
IpAddr |
string |
IP address |
HardwareId |
string |
Hardware ID |
Status
| Property |
Type |
Description |
Connected |
number |
Connection state |
Live |
number |
Alive state |
Type |
number |
Object type (OBJECT_USER, etc.) |
State |
number |
Current state |
Rest |
number |
Resting state |
ViewState |
number |
View state flags |
Character Info
| Property |
Type |
Description |
Class |
number |
Character class |
DBClass |
number |
Database class |
ChangeUp |
number |
Class evolution stage |
Level |
number |
Character level |
MasterLevel |
number |
Master level |
MasterPoint |
number |
Available master points |
MasterExperience |
number |
Current master experience |
MasterNextExperience |
number |
Next master level experience |
Experience |
number |
Current experience |
NextExperience |
number |
Next level experience |
LevelUpPoint |
number |
Available stat points |
FruitAddPoint |
number |
Fruit stat add points used |
FruitSubPoint |
number |
Fruit stat sub points used |
Reset |
number |
Reset count |
MasterReset |
number |
Master reset count |
EnhanceReset |
number |
Enhance reset count |
Stats
| Property |
Type |
Description |
Strength |
number |
Base strength |
Dexterity |
number |
Base dexterity |
Vitality |
number |
Base vitality |
Energy |
number |
Base energy |
Leadership |
number |
Base leadership |
AddStrength |
number |
Bonus strength (items/effects) |
AddDexterity |
number |
Bonus dexterity |
AddVitality |
number |
Bonus vitality |
AddEnergy |
number |
Bonus energy |
AddLeadership |
number |
Bonus leadership |
AddMasterStrength |
number |
Master tree bonus STR (v401+) |
AddMasterDexterity |
number |
Master tree bonus DEX (v401+) |
AddMasterVitality |
number |
Master tree bonus VIT (v401+) |
AddMasterEnergy |
number |
Master tree bonus ENE (v401+) |
AddMasterLeadership |
number |
Master tree bonus CMD (v401+) |
Life / Mana / Shield
| Property |
Type |
Description |
Life |
number |
Current HP |
MaxLife |
number |
Maximum HP |
ScriptMaxLife |
number |
Script-set max HP |
AddLife |
number |
Bonus HP |
Mana |
number |
Current mana |
MaxMana |
number |
Maximum mana |
AddMana |
number |
Bonus mana |
BP |
number |
Current AG |
MaxBP |
number |
Maximum AG |
AddBP |
number |
Bonus AG |
Shield |
number |
Current SD |
MaxShield |
number |
Maximum SD |
AddShield |
number |
Bonus SD |
VitalityToLife |
number |
HP per VIT ratio |
EnergyToMana |
number |
Mana per ENE ratio |
Position
| Property |
Type |
Description |
Map |
number |
Current map number |
X |
number |
Current X coordinate |
Y |
number |
Current Y coordinate |
Dir |
number |
Facing direction |
StartX |
number |
Spawn X |
StartY |
number |
Spawn Y |
OldX |
number |
Previous X |
OldY |
number |
Previous Y |
TX |
number |
Target X |
TY |
number |
Target Y |
MTX |
number |
Move target X |
MTY |
number |
Move target Y |
Combat Stats
| Property |
Type |
Description |
PhysiDamageMin |
number |
Min physical damage |
PhysiDamageMax |
number |
Max physical damage |
MagicDamageMin |
number |
Min magic damage |
MagicDamageMax |
number |
Max magic damage |
CurseDamageMin |
number |
Min curse damage |
CurseDamageMax |
number |
Max curse damage |
Defense |
number |
Total defense |
MagicDefense |
number |
Magic defense |
BaseDefense |
number |
Base defense |
AttackSuccessRate |
number |
Attack success rate |
DefenseSuccessRate |
number |
Defense success rate |
PhysiSpeed |
number |
Physical attack speed |
MagicSpeed |
number |
Magic attack speed |
AttackRange |
number |
Attack range |
AttackType |
number |
Attack type |
ViewRange |
number |
View range |
MoveSpeed |
number |
Movement speed |
MoveRange |
number |
Movement range |
Combat Rates
| Property |
Type |
Description |
CriticalDamageRate |
number |
Critical hit chance |
CriticalDamage |
number |
Critical damage bonus |
ExcellentDamageRate |
number |
Excellent hit chance |
ExcellentDamage |
number |
Excellent damage bonus |
DoubleDamageRate |
number |
Double damage chance |
TripleDamageRate |
number |
Triple damage chance |
IgnoreDefenseRate |
number |
Ignore defense chance |
IgnoreShieldGaugeRate |
number |
Ignore SD chance |
DamageReduction |
number |
Flat damage reduction |
DamageReflect |
number |
Damage reflect amount |
ExperienceRate |
number |
Experience rate bonus |
MasterExperienceRate |
number |
Master exp rate bonus |
ItemDropRate |
number |
Item drop rate bonus |
Recovery
| Property |
Type |
Description |
HPRecovery |
number |
HP recovery amount |
MPRecovery |
number |
MP recovery amount |
BPRecovery |
number |
AG recovery amount |
SDRecovery |
number |
SD recovery amount |
HPRecoveryRate |
number |
HP recovery rate |
MPRecoveryRate |
number |
MP recovery rate |
PK System
| Property |
Type |
Description |
PKCount |
number |
PK kill count |
PKLevel |
number |
PK level (3=hero, 4=commoner, 5+=outlaw) |
PKTime |
number |
PK time counter |
PKTickCount |
number |
PK timer tick |
Currency
| Property |
Type |
Description |
Money |
number |
Current Zen |
RuudMoney |
number |
Current Ruud (v1003+) |
Party / Guild
| Property |
Type |
Description |
PartyNumber |
number |
Party number (-1 if none) |
GuildNumber |
number |
Guild number |
GuildName |
string |
Guild name |
GuildStatus |
number |
Guild rank/status |
Inventory Access
| Property |
Type |
Description |
Inventory[slot] |
GameItem |
Main inventory (slot 0-11 = equipped) |
Trade[slot] |
GameItem |
Trade window items |
Warehouse[slot] |
GameItem |
Warehouse items |
ChaosBox[slot] |
GameItem |
Chaos Machine items |
EventInventory[slot] |
GameItem |
Event inventory (v802+) |
MuunInventory[slot] |
GameItem |
Muun inventory (v803+) |
Effect System
| Property |
Type |
Description |
EffectOption |
GameEffectOption |
Accumulated effect bonuses |
Effect[slot] |
GameCEffect |
Active effect at slot |
Note: The full GameObject has 300+ properties. The above covers the most commonly used ones.
Help