Player
The Player class represent the currently logged in character.
TODO: Player Constructors
Properties
Player
.
AR
Int32
Player
.
AR
Int32
Resistance to Phisical damage.
Player
.
Backpack
Item
Player
.
Backpack
Item
Player backpack, as Item object.
Player
.
Bank
Item
Player
.
Bank
Item
Player bank chest, as Item object.
Player
.
Body
Int32
Player
.
Body
Int32
Player Body or MobileID (see: Mobile.Body)
Player
.
Buffs
List[String]
Player
.
Buffs
List[String]
List of Player active buffs: Meditation Agility Animal Form Arcane Enpowerment Arcane Enpowerment (new) Arch Protection Armor Pierce Attunement Aura of Nausea Bleed Bless Block Bload Oath (caster) Bload Oath (curse) BloodWorm Anemia City Trade Deal Clumsy Confidence Corpse Skin Counter Attack Criminal Cunning Curse Curse Weapon Death Strike Defense Mastery Despair Despair (target) Disarm (new) Disguised Dismount Prevention Divine Fury Dragon Slasher Fear Enchant Enemy Of One Enemy Of One (new) Essence Of Wind Ethereal Voyage Evasion Evil Omen Faction Loss Fan Dancer Fan Fire Feeble Mind Feint Force Arrow Berserk Fly Gaze Despair Gift Of Life Gift Of Renewal Healing Heat Of Battle Hiding Hiryu Physical Malus Hit Dual Wield Hit Lower Attack Hit Lower Defense Honorable Execution Honored Horrific Beast Hawl Of Cacophony Immolating Weapon Incognito Inspire Invigorate Invisibility Lich Form Lighting Strike Magic Fish Magic Reflection Mana Phase Mass Curse Medusa Stone Mind Rot Momentum Strike Mortal Strike Night Sight NoRearm Orange Petals Pain Spike Paralyze Perfection Perseverance Poison Poison Resistance Polymorph Protection Psychic Attack Consecrate Weapon Rage Rage Focusing Rage Focusing (target) Reactive Armor Reaper Form Resilience Rose Of Trinsic Rotworm Blood Disease Rune Beetle Corruption Skill Use Delay Sleep Spell Focusing Spell Focusing (target) Spell Plague Splintering Effect Stone Form Strangle Strength Surge Swing Speed Talon Strike Vampiric Embrace Weaken Wraith Form
Player
.
ColdResistance
Int32
Player
.
ColdResistance
Int32
Resistance to Cold damage.
Player
.
DamageChanceIncrease
Int32
Player
.
DamageChanceIncrease
Int32
Get total Damage Chance Increase.
Player
.
DefenseChanceIncrease
Int32
Player
.
DefenseChanceIncrease
Int32
Get total Defense Chance Increase.
Player
.
Dex
Int32
Player
.
Dex
Int32
Stats value for Dexterity.
Player
.
DexterityIncrease
Int32
Player
.
DexterityIncrease
Int32
Get total Dexterity Increase.
Player
.
Direction
String
Player
.
Direction
String
Player current direction, as text.
Player
.
EnergyResistance
Int32
Player
.
EnergyResistance
Int32
Resistance to Energy damage.
Player
.
EnhancePotions
Int32
Player
.
EnhancePotions
Int32
Get total Enhance Potions.
Player
.
FasterCastRecovery
Int32
Player
.
FasterCastRecovery
Int32
Get total Faster Cast Recovery.
Player
.
FasterCasting
Int32
Player
.
FasterCasting
Int32
Get total Faster Casting.
Player
.
Female
Boolean
Player
.
Female
Boolean
Player is a female.
Player
.
FireResistance
Int32
Player
.
FireResistance
Int32
Resistance to Fire damage.
Player
.
Followers
Int32
Player
.
Followers
Int32
Player current amount of pet/followers.
Player
.
FollowersMax
Int32
Player
.
FollowersMax
Int32
Player maximum amount of pet/followers.
Player
.
Gold
Int32
Player
.
Gold
Int32
Player total gold, in the backpack.
Player
.
HasPrimarySpecial
Boolean
Player
.
HasPrimarySpecial
Boolean
Player
.
HasSecondarySpecial
Boolean
Player
.
HasSecondarySpecial
Boolean
Player
.
HasSpecial
Boolean
Player
.
HasSpecial
Boolean
Player have a special abilities active.
Player
.
HitPointsIncrease
Int32
Player
.
HitPointsIncrease
Int32
Get total Hit Points Increase.
Player
.
HitPointsRegeneration
Int32
Player
.
HitPointsRegeneration
Int32
Get total Hit Points Regeneration.
Player
.
Hits
Int32
Player
.
Hits
Int32
Current hit points.
Player
.
HitsMax
Int32
Player
.
HitsMax
Int32
Maximum hit points.
Player
.
InParty
Boolean
Player
.
InParty
Boolean
Player is in praty.
Player
.
Int
Int32
Player
.
Int
Int32
Stats value for Intelligence.
Player
.
IntelligenceIncrease
Int32
Player
.
IntelligenceIncrease
Int32
Get total Intelligence Increase.
Player
.
IsGhost
Boolean
Player
.
IsGhost
Boolean
Player is a Ghost
Player
.
LowerManaCost
Int32
Player
.
LowerManaCost
Int32
Get total Lower Mana Cost.
Player
.
LowerReagentCost
Int32
Player
.
LowerReagentCost
Int32
Get total Lower Reagent Cost.
Player
.
Luck
Int32
Player
.
Luck
Int32
Player total luck.
Player
.
Mana
Int32
Player
.
Mana
Int32
Current mana.
Player
.
ManaIncrease
Int32
Player
.
ManaIncrease
Int32
Get total Mana Increase.
Player
.
ManaMax
Int32
Player
.
ManaMax
Int32
Maximum mana.
Player
.
ManaRegeneration
Int32
Player
.
ManaRegeneration
Int32
Get total Mana Regeneration.
Player
.
Map
Int32
Player
.
Map
Int32
Player current map, or facet.
Player
.
MaxWeight
Int32
Player
.
MaxWeight
Int32
Player maximum weight.
Player
.
MaximumHitPointsIncrease
Int32
Player
.
MaximumHitPointsIncrease
Int32
Get total Maximum Hit Points Increase.
Player
.
MaximumManaIncrease
Int32
Player
.
MaximumManaIncrease
Int32
Get total Maximum Mana Increase.
Player
.
MaximumStaminaIncrease
Int32
Player
.
MaximumStaminaIncrease
Int32
Get total Maximum Stamina Increase.
Player
.
MobileID
Int32
Player
.
MobileID
Int32
Player MobileID or Body (see: Mobile.MobileID)
Player
.
Mount
Item
Player
.
Mount
Item
Player current Mount, as Item object. NOTE: On some server the Serial return by this function doesn't match the mount serial.
Player
.
Name
String
Player
.
Name
String
Player name.
Player
.
Notoriety
Byte
Player
.
Notoriety
Byte
Player notoriety 1: blue, innocent 2: green, friend 3: gray, neutral 4: gray, criminal 5: orange, enemy 6: red, hostile 6: yellow, invulnerable
Player
.
Paralized
Boolean
Player
.
Paralized
Boolean
Player is Paralized. True also while frozen because of casting of spells.
Player
.
PoisonResistance
Int32
Player
.
PoisonResistance
Int32
Resistance to Poison damage.
Player
.
Poisoned
Boolean
Player
.
Poisoned
Boolean
Player is Poisoned
Player
.
Position
Point3D
Player
.
Position
Point3D
Current Player position as Point3D object.
Player
.
PrimarySpecial
UInt32
Player
.
PrimarySpecial
UInt32
Player
.
Quiver
Item
Player
.
Quiver
Item
Player quiver, as Item object.
Player
.
ReflectPhysicalDamage
Int32
Player
.
ReflectPhysicalDamage
Int32
Get total Reflect Physical Damage.
Player
.
SecondarySpecial
UInt32
Player
.
SecondarySpecial
UInt32
Player
.
Serial
Int32
Player
.
Serial
Int32
Player unique Serial.
Player
.
SpellDamageIncrease
Int32
Player
.
SpellDamageIncrease
Int32
Get total Spell Damage Increase.
Player
.
Stam
Int32
Player
.
Stam
Int32
Current stamina.
Player
.
StamMax
Int32
Player
.
StamMax
Int32
Maximum stamina.
Player
.
StaminaIncrease
Int32
Player
.
StaminaIncrease
Int32
Get total Stamina Increase.
Player
.
StaminaRegeneration
Int32
Player
.
StaminaRegeneration
Int32
Get total Stamina Regeneration.
Player
.
StatCap
Int32
Player
.
StatCap
Int32
Get the stats cap.
Player
.
StaticMount
Int32
Player
.
StaticMount
Int32
Retrieves serial of mount set in Filter/Mount GUI.
Player
.
Str
Int32
Player
.
Str
Int32
Stats value for Strenght.
Player
.
StrengthIncrease
Int32
Player
.
StrengthIncrease
Int32
Get total Strength Increase.
Player
.
SwingSpeedIncrease
Int32
Player
.
SwingSpeedIncrease
Int32
Get total Swing Speed Increase.
Player
.
Visible
Boolean
Player
.
Visible
Boolean
Player is visible, false if hidden.
Player
.
WarMode
Boolean
Player
.
WarMode
Boolean
Player has war mode active.
Player
.
Weight
Int32
Player
.
Weight
Int32
Player current weight.
Player
.
YellowHits
Boolean
Player
.
YellowHits
Boolean
Player HP bar is not blue, but yellow.
Methods
Player
.
Area
()
Player
.
Area
()
Get the name of the area in which the Player is currently in. (Ex: Britain, Destard, Vesper, Moongate, etc) Regions are defined inside by Config/regions.json.
Return
String
Name of the area. Unknown if not recognized.
Player
.
Attack
(
serial
)
Player
.
Attack
(
serial
)
Attack a Mobile.
Parameters
serial
Int32
Mobile
Serial or Mobile to attack.
Return
Void

Player
.
AttackLast
()
Player
.
AttackLast
()
Attack last target.
Return
Void

Player
.
BuffsExist
(
buffname
)
Player
.
BuffsExist
(
buffname
)
Check if a buff is active, by buff name.
Parameters
buffname
String
Meditation Agility Animal Form Arcane Enpowerment Arcane Enpowerment (new) Arch Protection Armor Pierce Attunement Aura of Nausea Bleed Bless Block Bload Oath (caster) Bload Oath (curse) BloodWorm Anemia City Trade Deal Clumsy Confidence Corpse Skin Counter Attack Criminal Cunning Curse Curse Weapon Death Strike Defense Mastery Despair Despair (target) Disarm (new) Disguised Dismount Prevention Divine Fury Dragon Slasher Fear Enchant Enemy Of One Enemy Of One (new) Essence Of Wind Ethereal Voyage Evasion Evil Omen Faction Loss Fan Dancer Fan Fire Feeble Mind Feint Force Arrow Berserk Fly Gaze Despair Gift Of Life Gift Of Renewal Healing Heat Of Battle Hiding Hiryu Physical Malus Hit Dual Wield Hit Lower Attack Hit Lower Defense Honorable Execution Honored Horrific Beast Hawl Of Cacophony Immolating Weapon Incognito Inspire Invigorate Invisibility Lich Form Lighting Strike Magic Fish Magic Reflection Mana Phase Mass Curse Medusa Stone Mind Rot Momentum Strike Mortal Strike Night Sight NoRearm Orange Petals Pain Spike Paralyze Perfection Perseverance Poison Poison Resistance Polymorph Protection Psychic Attack Consecrate Weapon Rage Rage Focusing Rage Focusing (target) Reactive Armor Reaper Form Resilience Rose Of Trinsic Rotworm Blood Disease Rune Beetle Corruption Skill Use Delay Sleep Spell Focusing Spell Focusing (target) Spell Plague Splintering Effect Stone Form Strangle Strength Surge Swing Speed Talon Strike Vampiric Embrace Weaken Wraith Form
Return
Boolean
True: if the buff is active - False: otherwise.
Player
.
ChatAlliance
(
msg
)
Player
.
ChatAlliance
(
msg
)
Send message to the alliace chat.
Parameters
msg
Int32
String
Message to send.
Return
Void

Player
.
ChatChannel
(
msg
)
Player
.
ChatChannel
(
msg
)
Send an chat channel message.
Parameters
msg
Int32
String
Message to send.
Return
Void

Player
.
ChatEmote
(
color
,
msg
)
Player
.
ChatEmote
(
color
,
msg
)
Send an emote in game.
Parameters
color
Int32
Color of the text
msg
Int32
String
Message to send.
Return
Void

Player
.
ChatGuild
(
msg
)
Player
.
ChatGuild
(
msg
)
Send message to the guild chat.
Parameters
msg
Int32
String
Message to send.
Return
Void

Player
.
ChatParty
(
msg
,
recepient_serial
)
Player
.
ChatParty
(
msg
,
recepient_serial
)
Send message in arty chat. If a recepient_serial is specified, the message is private.
Parameters
msg
String
Text to send.
recepient_serial
Int32
Optional: Target of private message.
Return
Void

Player
.
ChatSay
(
color
,
msg
)
Player
.
ChatSay
(
color
,
msg
)
Send message in game.
Parameters
color
Int32
Color of the text
msg
Int32
String
Message to send.
Return
Void

Player
.
ChatWhisper
(
color
,
msg
)
Player
.
ChatWhisper
(
color
,
msg
)
Send an wishper message.
Parameters
color
Int32
Color of the text
msg
Int32
String
Message to send.
Return
Void

Player
.
ChatYell
(
color
,
msg
)
Player
.
ChatYell
(
color
,
msg
)
Send an yell message.
Parameters
color
Int32
Color of the text
msg
Int32
String
Message to send.
Return
Void

Player
.
CheckLayer
(
layer
)
Player
.
CheckLayer
(
layer
)
Check if a Layer is equipped by the Item.
Parameters
layer
String
Layers: RightHand LeftHand Shoes Pants Shirt Head Gloves Ring Neck Hair Waist InnerTorso Bracelet FacialHair MiddleTorso Earrings Arms Cloak OuterTorso OuterLegs InnerLegs Talisman
Return
Boolean
True: the Layer is occupied by an Item - False: otherwise.
Player
.
DistanceTo
(
target
)
Player
.
DistanceTo
(
target
)
Returns the distance between the Player and a Mobile or an Item.
Parameters
target
Mobile
Item
The other Mobile or Item
Return
Int32
Distance in number of tiles.
Player
.
EmoteAction
(
action
)
Player
.
EmoteAction
(
action
)
Parameters
action
String
Return
Void

Player
.
EquipItem
(
serial
)
Player
.
EquipItem
(
serial
)
Equip an Item
Parameters
serial
Int32
Item
Serial or Item to equip.
Return
Void

Player
.
EquipLastWeapon
()
Player
.
EquipLastWeapon
()
Equip the last used weapon
Return
Void

Player
.
EquipUO3D
(
serials
)
Player
.
EquipUO3D
(
serials
)
Parameters
serials
List[Int32]
Return
Void

Player
.
Fly
(
status
)
Player
.
Fly
(
status
)
Enable or disable Gargoyle Flying.
Parameters
status
Boolean
True: Gargoyle Fly ON - False: Gargoyle fly OFF
Return
Void

Player
.
GetItemOnLayer
(
layer
)
Player
.
GetItemOnLayer
(
layer
)
Returns the Item associated with a Mobile Layer.
Parameters
layer
String
Layers: RightHand LeftHand Shoes Pants Shirt Head Gloves Ring Neck Hair Waist InnerTorso Bracelet FacialHair MiddleTorso Earrings Arms Cloak OuterTorso OuterLegs InnerLegs Talisman
Return
Item
Item for the layer. Return null if not found or Layer invalid.
Player
.
GetPropStringByIndex
(
index
)
Player
.
GetPropStringByIndex
(
index
)
Get a single line of Properties of the Player, from the tooltip, as text.
Parameters
index
Int32
Line number, start from 0.
Return
String
Single line of text.
Player
.
GetPropStringList
()
Player
.
GetPropStringList
()
Get the list of Properties of the Player, as list of lines of the tooltip.
Return
List[String]
List of text lines.
Player
.
GetPropValue
(
name
)
Player
.
GetPropValue
(
name
)
Get the numeric value of a specific Player property, from the tooltip.
Parameters
name
String
Name of the property.
Return
Int32
n: value of the propery 0: property not found. 1: property found, but not numeric.
Player
.
GetRealSkillValue
(
skillname
)
Player
.
GetRealSkillValue
(
skillname
)
Get the base/real value of the skill for the given the skill name.
Parameters
skillname
String
Alchemy Anatomy Animal Lore Item ID Arms Lore Parry Begging Blacksmith Fletching Peacemaking Camping Carpentry Cartography Cooking Detect Hidden Discordance EvalInt Healing Fishing Forensics Herding Hiding Provocation Inscribe Lockpicking Magery Magic Resist Mysticism Tactics Snooping Musicianship Poisoning Archery Spirit Speak Stealing Tailoring Animal Taming Taste ID Tinkering Tracking Veterinary Swords Macing Fencing Wrestling Lumberjacking Mining Meditation Stealth Remove Trap Necromancy Focus Chivalry Bushido Ninjitsu Spell Weaving Imbuing
Return
Double
Value of the skill.
Player
.
GetSkillCap
(
skillname
)
Player
.
GetSkillCap
(
skillname
)
Get the skill cap for the given the skill name.
Parameters
skillname
String
Alchemy Anatomy Animal Lore Item ID Arms Lore Parry Begging Blacksmith Fletching Peacemaking Camping Carpentry Cartography Cooking Detect Hidden Discordance EvalInt Healing Fishing Forensics Herding Hiding Provocation Inscribe Lockpicking Magery Magic Resist Mysticism Tactics Snooping Musicianship Poisoning Archery Spirit Speak Stealing Tailoring Animal Taming Taste ID Tinkering Tracking Veterinary Swords Macing Fencing Wrestling Lumberjacking Mining Meditation Stealth Remove Trap Necromancy Focus Chivalry Bushido Ninjitsu Spell Weaving Imbuing
Return
Double
Value of the skill cap.
Player
.
GetSkillStatus
(
skillname
)
Player
.
GetSkillStatus
(
skillname
)
Get lock status for a specific skill.
Parameters
skillname
String
Alchemy Anatomy Animal Lore Item ID Arms Lore Parry Begging Blacksmith Fletching Peacemaking Camping Carpentry Cartography Cooking Detect Hidden Discordance EvalInt Healing Fishing Forensics Herding Hiding Provocation Inscribe Lockpicking Magery Magic Resist Mysticism Tactics Snooping Musicianship Poisoning Archery Spirit Speak Stealing Tailoring Animal Taming Taste ID Tinkering Tracking Veterinary Swords Macing Fencing Wrestling Lumberjacking Mining Meditation Stealth Remove Trap Necromancy Focus Chivalry Bushido Ninjitsu Spell Weaving Imbuing
Return
Int32
Lock status: 0: Up 1: Down 2: Locked -1: Error
Player
.
GetSkillValue
(
skillname
)
Player
.
GetSkillValue
(
skillname
)
Get the value of the skill, with modifiers, for the given the skill name.
Parameters
skillname
String
Alchemy Anatomy Animal Lore Item ID Arms Lore Parry Begging Blacksmith Fletching Peacemaking Camping Carpentry Cartography Cooking Detect Hidden Discordance EvalInt Healing Fishing Forensics Herding Hiding Provocation Inscribe Lockpicking Magery Magic Resist Mysticism Tactics Snooping Musicianship Poisoning Archery Spirit Speak Stealing Tailoring Animal Taming Taste ID Tinkering Tracking Veterinary Swords Macing Fencing Wrestling Lumberjacking Mining Meditation Stealth Remove Trap Necromancy Focus Chivalry Bushido Ninjitsu Spell Weaving Imbuing
Return
Double
Value of the skill.
Player
.
GetStatStatus
(
statname
)
Player
.
GetStatStatus
(
statname
)
Get lock status for a specific stats.
Parameters
statname
String
Strength Dexterity Intelligence
Return
Int32
Lock status: 0: Up 1: Down 2: Locked
Player
.
GuildButton
()
Player
.
GuildButton
()
Press the Guild menu button in the paperdoll.
Return
Void

Player
.
HeadMessage
(
color
,
msg
)
Player
.
HeadMessage
(
color
,
msg
)
Display a message above the Player. Visible only by the Player.
Parameters
color
Int32
Color of the Text.
msg
Int32
String
Text of the message.
Return
Void

Player
.
InRangeItem
(
item
,
range
)
Player
.
InRangeItem
(
item
,
range
)
Check if the Item is within a certain range (<=).
Parameters
item
Int32
Item
Serial or Item object.
range
Int32
Maximum distance in tiles.
Return
Boolean
True: Item is in range - False: otherwise.
Player
.
InRangeMobile
(
mobile
,
range
)
Player
.
InRangeMobile
(
mobile
,
range
)
Check if the Mobile is within a certain range (<=).
Parameters
mobile
Int32
Mobile
Serial or Mobile object.
range
Int32
Maximum distance in tiles.
Return
Boolean
True: Mobile is in range - False: otherwise.
Player
.
InvokeVirtue
(
virtue
)
Player
.
InvokeVirtue
(
virtue
)
Invoke a virtue by name.
Parameters
virtue
String
Honor Sacrifice Valor Compassion Honesty Humility Justice
Return
Void

Player
.
KickMember
(
serial
)
Player
.
KickMember
(
serial
)
Kick a member from party by serial. Only for party leader
Parameters
serial
Int32
Serial of the Mobile to remove.
Return
Void

Player
.
LeaveParty
(
force
)
Player
.
LeaveParty
(
force
)
Leaves a party.
Parameters
force
Boolean
True: Leave the party invite even you notin any party.
Return
Void

Player
.
MapSay
(
msg
)
Player
.
MapSay
(
msg
)
Send message in the Map chat.
Parameters
msg
Int32
String
Message to send
Return
Void

Player
.
OpenPaperDoll
()
Player
.
OpenPaperDoll
()
Open Player's Paperdoll
Return
Void

Player
.
PartyAccept
(
from_serial
,
force
)
Player
.
PartyAccept
(
from_serial
,
force
)
Accept an incoming party offer. In case of multiple party oebnding invitation, from_serial is specified,
Parameters
from_serial
Int32
Optional: Serial to accept party from.( in case of multiple offers )
force
Boolean
True: Accept the party invite even you are already in a party.
Return
Boolean
True: if you are now in a party - False: otherwise.
Player
.
PartyCanLoot
(
CanLoot
)
Player
.
PartyCanLoot
(
CanLoot
)
Set the Party loot permissions.
Parameters
CanLoot
Boolean
Return
Void

Player
.
PartyInvite
()
Player
.
PartyInvite
()
Invite a person to a party. Prompt for a in-game Target.
Return
Void

Player
.
PathFindTo
(
x
,
y
,
z
)
Player
.
PathFindTo
(
x
,
y
,
z
)
Go to the given coordinates using Client-provided pathfinding.
Parameters
x
Int32
Point3D
X map coordinates or Point3D
y
Int32
Y map coordinates
z
Int32
Z map coordinates
Return
Void

Player
.
QuestButton
()
Player
.
QuestButton
()
Press the Quest menu button in the paperdoll.
Return
Void

Player
.
Run
(
direction
,
checkPosition
)
Player
.
Run
(
direction
,
checkPosition
)
Run one step in the specified direction and wait for the confirmation of the new position by the server. If the character is not facing the direction, the first step only "turn" the Player in the required direction. Optional: When checkPosition is True allow for slower but safe walking, the new position confirmed at each step via return value. When checkPosition is Flase allow for faster walking/running, but requires custom delay and position checking. Info: Walking: 5 tiles/sec (~200ms between each step) Running: 10 tiles/sec (~100ms between each step)
Parameters
direction
String
North South East West Up Down Left Right
checkPosition
Boolean
True: Wait until the server confirm the new Player.Position - False: Don't wait.
Return
Boolean
True: Destination reached - False: Coudn't reach the destination.
Player
.
SetSkillStatus
(
skillname
,
status
)
Player
.
SetSkillStatus
(
skillname
,
status
)
Set lock status for a specific skill.
Parameters
skillname
String
Alchemy Anatomy Animal Lore Item ID Arms Lore Parry Begging Blacksmith Fletching Peacemaking Camping Carpentry Cartography Cooking Detect Hidden Discordance EvalInt Healing Fishing Forensics Herding Hiding Provocation Inscribe Lockpicking Magery Magic Resist Mysticism Tactics Snooping Musicianship Poisoning Archery Spirit Speak Stealing Tailoring Animal Taming Taste ID Tinkering Tracking Veterinary Swords Macing Fencing Wrestling Lumberjacking Mining Meditation Stealth Remove Trap Necromancy Focus Chivalry Bushido Ninjitsu Spell Weaving Imbuing
status
Int32
Lock status: 0: Up 1: Down 2: Locked
Return
Void

Player
.
SetStatStatus
(
statname
,
status
)
Player
.
SetStatStatus
(
statname
,
status
)
Set lock status for a specific skill.
Parameters
statname
String
Strength Dexterity Intelligence
status
Int32
Lock status: 0: Up 1: Down 2: Locked
Return
Void

Player
.
SetWarMode
(
warflag
)
Player
.
SetWarMode
(
warflag
)
Set war Mode on on/off.
Parameters
warflag
Boolean
True: War - False: Peace
Return
Void

Player
.
SpellIsEnabled
(
spellname
)
Player
.
SpellIsEnabled
(
spellname
)
Check if spell is active using the spell name (for spells that have this function).
Parameters
spellname
String
Name of the spell.
Return
Boolean
True: the spell is enabled - False: otherwise,.
Player
.
SumAttribute
(
attributename
)
Player
.
SumAttribute
(
attributename
)
Scan all the equipped Item, returns the total value of a specific property. (ex: Lower Reagent Cost ) NOTE: This function is slow.
Parameters
attributename
String
Name of the property.
Return
Single
The total value as number.
Player
.
ToggleAlwaysRun
()
Player
.
ToggleAlwaysRun
()
Toggle on/off the awlays run flag. NOTE: Works only on OSI client.
Return
Void

Player
.
UnEquipItemByLayer
(
layer
,
wait
)
Player
.
UnEquipItemByLayer
(
layer
,
wait
)
Unequip the Item associated with a specific Layer.
Parameters
layer
String
Layers: RightHand LeftHand Shoes Pants Shirt Head Gloves Ring Neck Hair Waist InnerTorso Bracelet FacialHair MiddleTorso Earrings Arms Cloak OuterTorso OuterLegs InnerLegs Talisman
wait
Boolean
Wait for confirmation from the server.
Return
Void

Player
.
UseSkill
(
skillname
,
target
,
wait
)
Player
.
UseSkill
(
skillname
,
target
,
wait
)
Use a specific skill, and optionally apply that skill to the target specified.
Parameters
skillname
String
Alchemy Anatomy Animal Lore Item ID Arms Lore Parry Begging Blacksmith Fletching Peacemaking Camping Carpentry Cartography Cooking Detect Hidden Discordance EvalInt Healing Fishing Forensics Herding Hiding Provocation Inscribe Lockpicking Magery Magic Resist Mysticism Tactics Snooping Musicianship Poisoning Archery Spirit Speak Stealing Tailoring Animal Taming Taste ID Tinkering Tracking Veterinary Swords Macing Fencing Wrestling Lumberjacking Mining Meditation Stealth Remove Trap Necromancy Focus Chivalry Bushido Ninjitsu Spell Weaving Imbuing
target
Int32
Mobile
Item
Boolean
Optional: Serial, Mobile or Item to target. (default: null)
wait
Boolean
Optional: True: wait for confirmation from the server (default: False)
Return
Void

Player
.
UseSkillOnly
(
skillname
,
wait
)
Player
.
UseSkillOnly
(
skillname
,
wait
)
Parameters
skillname
String
wait
Boolean
Return
Void

Player
.
Walk
(
direction
,
checkPosition
)
Player
.
Walk
(
direction
,
checkPosition
)
Walk one step in the specified direction and wait for the confirmation of the new position by the server. If the character is not facing the direction, the first step only "turn" the Player in the required direction. Optional: When checkPosition is True allow for slower but safe walking, the new position confirmed at each step via return value. When checkPosition is Flase allow for faster walking/running, but requires custom delay and position checking. Info: Walking: 5 tiles/sec (~200ms between each step) Running: 10 tiles/sec (~100ms between each step)
Parameters
direction
String
North South East West Up Down Left Right
checkPosition
Boolean
True: Wait until the server confirm the new Player.Position - False: Don't wait.
Return
Boolean
True: Destination reached - False: Coudn't reach the destination.
Player
.
WeaponClearSA
()
Player
.
WeaponClearSA
()
Disable any active Special Ability of the weapon.
Return
Void

Player
.
WeaponDisarmSA
()
Player
.
WeaponDisarmSA
()
Toggle Disarm Ability.
Return
Void

Player
.
WeaponPrimarySA
()
Player
.
WeaponPrimarySA
()
Toggle on/off the primary Special Ability of the weapon.
Return
Void

Player
.
WeaponSecondarySA
()
Player
.
WeaponSecondarySA
()
Toggle on/off the secondary Special Ability of the weapon.
Return
Void

Player
.
WeaponStunSA
()
Player
.
WeaponStunSA
()
Toggle Stun Ability.
Return
Void

Player
.
Zone
()
Player
.
Zone
()
Get the type of zone in which the Player is currently in. Regions are defined inside by Config/regions.json.
Return
String
Towns Dungeons Guarded Forest Unknown