RE API v0.8.2.220
Player
The Player class represent the currently logged in character.
TODO: Player Constructors
Properties
Player.ARInt32
Player.ARInt32
Resistance to Phisical damage.
Player.BackpackItem
Player.BackpackItem
Player backpack, as Item object.
Player.BankItem
Player.BankItem
Player bank chest, as Item object.
Player.BodyInt32
Player.BodyInt32
Player Body or MobileID (see: Mobile.Body)
Player.BuffsList[String]
Player.BuffsList[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.ColdResistanceInt32
Player.ColdResistanceInt32
Resistance to Cold damage.
Player.ConnectedBoolean
Player.ConnectedBoolean
Retrieves Connected State
Player.CorpsesHashSet[Item]
Player.CorpsesHashSet[Item]
Each Death Player corpse item is added here
Player.DamageChanceIncreaseInt32
Player.DamageChanceIncreaseInt32
Get total Damage Chance Increase.
Player.DefenseChanceIncreaseInt32
Player.DefenseChanceIncreaseInt32
Get total Defense Chance Increase.
Player.DexInt32
Player.DexInt32
Stats value for Dexterity.
Player.DexterityIncreaseInt32
Player.DexterityIncreaseInt32
Get total Dexterity Increase.
Player.DirectionString
Player.DirectionString
Player current direction, as text.
Player.EnergyResistanceInt32
Player.EnergyResistanceInt32
Resistance to Energy damage.
Player.EnhancePotionsInt32
Player.EnhancePotionsInt32
Get total Enhance Potions.
Player.FasterCastRecoveryInt32
Player.FasterCastRecoveryInt32
Get total Faster Cast Recovery.
Player.FasterCastingInt32
Player.FasterCastingInt32
Get total Faster Casting.
Player.FemaleBoolean
Player.FemaleBoolean
Player is a female.
Player.FireResistanceInt32
Player.FireResistanceInt32
Resistance to Fire damage.
Player.FollowersInt32
Player.FollowersInt32
Player current amount of pet/followers.
Player.FollowersMaxInt32
Player.FollowersMaxInt32
Player maximum amount of pet/followers.
Player.GoldInt32
Player.GoldInt32
Player total gold, in the backpack.
Player.HasPrimarySpecialBoolean
Player.HasPrimarySpecialBoolean
Player.HasSecondarySpecialBoolean
Player.HasSecondarySpecialBoolean
Player.HasSpecialBoolean
Player.HasSpecialBoolean
Player have a special abilities active.
Player.HitPointsIncreaseInt32
Player.HitPointsIncreaseInt32
Get total Hit Points Increase.
Player.HitPointsRegenerationInt32
Player.HitPointsRegenerationInt32
Get total Hit Points Regeneration.
Player.HitsInt32
Player.HitsInt32
Current hit points.
Player.HitsMaxInt32
Player.HitsMaxInt32
Maximum hit points.
Player.InPartyBoolean
Player.InPartyBoolean
Player is in praty.
Player.IntInt32
Player.IntInt32
Stats value for Intelligence.
Player.IntelligenceIncreaseInt32
Player.IntelligenceIncreaseInt32
Get total Intelligence Increase.
Player.IsGhostBoolean
Player.IsGhostBoolean
Player is a Ghost
Player.LowerManaCostInt32
Player.LowerManaCostInt32
Get total Lower Mana Cost.
Player.LowerReagentCostInt32
Player.LowerReagentCostInt32
Get total Lower Reagent Cost.
Player.LuckInt32
Player.LuckInt32
Player total luck.
Player.ManaInt32
Player.ManaInt32
Current mana.
Player.ManaIncreaseInt32
Player.ManaIncreaseInt32
Get total Mana Increase.
Player.ManaMaxInt32
Player.ManaMaxInt32
Maximum mana.
Player.ManaRegenerationInt32
Player.ManaRegenerationInt32
Get total Mana Regeneration.
Player.MapInt32
Player.MapInt32
Player current map, or facet.
Player.MaxWeightInt32
Player.MaxWeightInt32
Player maximum weight.
Player.MaximumHitPointsIncreaseInt32
Player.MaximumHitPointsIncreaseInt32
Get total Maximum Hit Points Increase.
Player.MaximumStaminaIncreaseInt32
Player.MaximumStaminaIncreaseInt32
Get total Maximum Stamina Increase.
Player.MobileIDInt32
Player.MobileIDInt32
Player MobileID or Body (see: Mobile.MobileID)
Player.MountItem
Player.MountItem
Player current Mount, as Item object. NOTE: On some server the Serial return by this function doesn't match the mount serial.
Player.NameString
Player.NameString
Player name.
Player.NotorietyByte
Player.NotorietyByte
Player notoriety 1: blue, innocent 2: green, friend 3: gray, neutral 4: gray, criminal 5: orange, enemy 6: red, hostile 6: yellow, invulnerable
Player.ParalizedBoolean
Player.ParalizedBoolean
Player is Paralized. True also while frozen because of casting of spells.
Player.PetsList[Mobile]
Player.PetsList[Mobile]
Finds all neutral pets in the area that can be renamed. This isn't the server information on your pets, but its good enough for most cases
Player.PoisonResistanceInt32
Player.PoisonResistanceInt32
Resistance to Poison damage.
Player.PoisonedBoolean
Player.PoisonedBoolean
Player is Poisoned
Player.PositionPoint3D
Player.PositionPoint3D
Current Player position as Point3D object.
Player.PrimarySpecialUInt32
Player.PrimarySpecialUInt32
Player.QuiverItem
Player.QuiverItem
Player quiver, as Item object.
Player.ReflectPhysicalDamageInt32
Player.ReflectPhysicalDamageInt32
Get total Reflect Physical Damage.
Player.SecondarySpecialUInt32
Player.SecondarySpecialUInt32
Player.SerialInt32
Player.SerialInt32
Player unique Serial.
Player.SpellDamageIncreaseInt32
Player.SpellDamageIncreaseInt32
Get total Spell Damage Increase.
Player.StamInt32
Player.StamInt32
Current stamina.
Player.StamMaxInt32
Player.StamMaxInt32
Maximum stamina.
Player.StaminaIncreaseInt32
Player.StaminaIncreaseInt32
Get total Stamina Increase.
Player.StaminaRegenerationInt32
Player.StaminaRegenerationInt32
Get total Stamina Regeneration.
Player.StatCapInt32
Player.StatCapInt32
Get the stats cap.
Player.StaticMountInt32
Player.StaticMountInt32
Retrieves serial of mount set in Filter/Mount GUI.
Player.StrInt32
Player.StrInt32
Stats value for Strenght.
Player.StrengthIncreaseInt32
Player.StrengthIncreaseInt32
Get total Strength Increase.
Player.SwingSpeedIncreaseInt32
Player.SwingSpeedIncreaseInt32
Get total Swing Speed Increase.
Player.VisibleBoolean
Player.VisibleBoolean
Player is visible, false if hidden.
Player.WarModeBoolean
Player.WarModeBoolean
Player has war mode active.
Player.WeightInt32
Player.WeightInt32
Player current weight.
Player.YellowHitsBoolean
Player.YellowHitsBoolean
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
serialInt32 Mobile
Serial or Mobile to attack.
Return
Void
Player.AttackLast()
Player.AttackLast()
Attack last target.
Return
Void
Player.AttackType(graphic, rangemax, selector, color, notoriety)
Player.AttackType(graphic, rangemax, selector, color, notoriety)
Parameters
graphicList[Int32] Int32 rangemaxInt32 selectorString colorList[Int32] notorietyList[Byte]
Return
Boolean
Player.BuffTime(buffname)
Player.BuffTime(buffname)
Parameters
buffnameString
Return
Int32
Player.BuffsExist(buffname)
Player.BuffsExist(buffname)
Check if a buff is active, by buff name.
Parameters
buffnameString
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
msgInt32 String
Message to send.
Return
Void
Player.ChatChannel(msg)
Player.ChatChannel(msg)
Send an chat channel message.
Parameters
msgInt32 String
Message to send.
Return
Void
Player.ChatEmote(color, msg)
Player.ChatEmote(color, msg)
Send an emote in game.
Parameters
colorInt32
Color of the text
 msgInt32 String
Message to send.
Return
Void
Player.ChatGuild(msg)
Player.ChatGuild(msg)
Send message to the guild chat.
Parameters
msgInt32 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
msgString
Text to send.
 recepient_serialInt32
Optional: Target of private message.
Return
Void
Player.ChatSay(color, msg)
Player.ChatSay(color, msg)
Send message in game. Send message in game using 1153 for color.
Parameters
colorString Int32
Message to send. Color of the text
 msgInt32 String
Message to send.
Return
Void
Player.ChatWhisper(color, msg)
Player.ChatWhisper(color, msg)
Send an wishper message.
Parameters
colorInt32
Color of the text
 msgInt32 String
Message to send.
Return
Void
Player.ChatYell(color, msg)
Player.ChatYell(color, msg)
Send an yell message.
Parameters
colorInt32
Color of the text
 msgInt32 String
Message to send.
Return
Void
Player.CheckLayer(layer)
Player.CheckLayer(layer)
Check if a Layer is equipped by the Item.
Parameters
layerString
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.ClearCorpseList()
Player.ClearCorpseList()
Clear the Player corpse item list
Return
Void
Player.DistanceTo(target)
Player.DistanceTo(target)
Returns the distance between the Player and a Mobile or an Item.
Parameters
targetInt32 UOEntity
The other Mobile or Item
Return
Int32
Distance in number of tiles.
Player.EmoteAction(action)
Player.EmoteAction(action)
Parameters
actionString
Return
Void
Player.EquipItem(serial)
Player.EquipItem(serial)
Equip an Item
Parameters
serialItem Int32
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
serialsList[Int32]
Return
Void
Player.Fly(status)
Player.Fly(status)
Enable or disable Gargoyle Flying.
Parameters
statusBoolean
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
layerString
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
indexInt32
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
nameString
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
skillnameString
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
skillnameString
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
skillnameString
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
skillnameString
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
statnameString
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
colorInt32
Color of the Text.
 msgInt32 String
Text of the message.
Return
Void
Player.InRange(entity, range)
Player.InRange(entity, range)
Check if the mobile or item is within a certain range (<=). Check if the serial is within a certain range (<=).
Parameters
entityInt32 UOEntity rangeInt32
Maximum distance in tiles.
Return
Boolean
True: Item is in range - False: otherwise. True: serial is in range - False: otherwise.
Player.InRangeItem(item, range)
Player.InRangeItem(item, range)
Check if the Item is within a certain range (<=).
Parameters
itemItem Int32
Serial or Item object.
 rangeInt32
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 (<=). Check if the mobile is within a certain range (<=).
Parameters
mobileInt32 Mobile
Serial or Mobile object.
 rangeInt32
Maximum distance in tiles.
Return
Boolean
True: Mobile is in range - False: otherwise. True: Item is in range - False: otherwise.
Player.InvokeVirtue(virtue)
Player.InvokeVirtue(virtue)
Invoke a virtue by name. Invoke a virtue by name.
Parameters
virtueInt32 String
Honor Sacrifice Valor Compassion Honesty Humility Justice Spirituality
Return
Void
Player.KickMember(serial)
Player.KickMember(serial)
Kick a member from party by serial. Only for party leader
Parameters
serialInt32
Serial of the Mobile to remove.
Return
Void
Player.LeaveParty(force)
Player.LeaveParty(force)
Leaves a party.
Parameters
forceBoolean
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
msgInt32 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_serialInt32
Optional: Serial to accept party from.( in case of multiple offers )
 forceBoolean
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
CanLootBoolean
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
xInt32 Point3D
X map coordinates or Point3D
 yInt32
Y map coordinates
 zInt32
Z map coordinates
Return
Void
Player.QuestButton()
Player.QuestButton()
Press the Quest menu button in the paperdoll.
Return
Void
Player.Run(direction)
Player.Run(direction)
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. Info: Walking: 5 tiles/sec (~200ms between each step) Running: 10 tiles/sec (~100ms between each step)
Parameters
directionString
North South East West Up Down Left Right
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
skillnameString
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
 statusInt32
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
statnameString
Strength Dexterity Intelligence
 statusInt32
Lock status: 0: Up 1: Down 2: Locked
Return
Void
Player.SetStaticMount(serial)
Player.SetStaticMount(serial)
Sets serial of mount set in Filter/Mount GUI.
Parameters
serialInt32
Return
Void
Player.SetWarMode(warflag)
Player.SetWarMode(warflag)
Set war Mode on on/off.
Parameters
warflagBoolean
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
spellnameString
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
attributenameString
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.TrackingArrow(x, y, display, target)
Player.TrackingArrow(x, y, display, target)
Display a fake tracking arrow
Parameters
xUInt16
X coordinate.
 yUInt16
Y coordinate.
 displayBoolean
True = On, False = off
 targetUInt32
object serial targeted
Return
Void
Player.UnEquipItemByLayer(layer, wait)
Player.UnEquipItemByLayer(layer, wait)
Unequip the Item associated with a specific Layer.
Parameters
layerString
Layers: RightHand LeftHand Shoes Pants Shirt Head Gloves Ring Neck Hair Waist InnerTorso Bracelet FacialHair MiddleTorso Earrings Arms Cloak OuterTorso OuterLegs InnerLegs Talisman
 waitBoolean
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
skillnameString
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
 targetBoolean Item Int32 Mobile
Optional: Serial, Mobile or Item to target. (default: null)
 waitBoolean
Optional: True: wait for confirmation from the server (default: False)
Return
Void
Player.UseSkillOnly(skillname, wait)
Player.UseSkillOnly(skillname, wait)
Parameters
skillnameString waitBoolean
Return
Void
Player.Walk(direction)
Player.Walk(direction)
Parameters
directionString
Return
Boolean
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