Player

Properties

  • Player.AR Int32 Resistance to Phisical damage.

  • Player.Backpack Item Player backpack, as Item object.

  • Player.Bank Item Player bank chest, as Item object.

  • Player.Body Int32 Player Body or MobileID (see: Mobile.Body)

  • 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 Resistance to Cold damage.

  • Player.DamageChanceIncrease Int32 Get total Damage Chance Increase.

  • Player.DefenseChanceIncrease Int32 Get total Defense Chance Increase.

  • Player.Dex Int32 Stats value for Dexterity.

  • Player.DexterityIncrease Int32 Get total Dexterity Increase.

  • Player.Direction String Player current direction, as text.

  • Player.EnergyResistance Int32 Resistance to Energy damage.

  • Player.EnhancePotions Int32 Get total Enhance Potions.

  • Player.FasterCasting Int32 Get total Faster Casting.

  • Player.FasterCastRecovery Int32 Get total Faster Cast Recovery.

  • Player.Female Boolean Player is a female.

  • Player.FireResistance Int32 Resistance to Fire damage.

  • Player.Followers Int32 Player current amount of pet/followers.

  • Player.FollowersMax Int32 Player maximum amount of pet/followers.

  • Player.Gold Int32 Player total gold, in the backpack.

  • Player.HasSpecial Boolean Player have a special abilities active.

  • Player.HitPointsIncrease Int32 Get total Hit Points Increase.

  • Player.HitPointsRegeneration Int32 Get total Hit Points Regeneration.

  • Player.Hits Int32 Current hit points.

  • Player.HitsMax Int32 Maximum hit points.

  • Player.InParty Boolean Player is in praty.

  • Player.Int Int32 Stats value for Intelligence.

  • Player.IntelligenceIncrease Int32 Get total Intelligence Increase.

  • Player.IsGhost Boolean Player is a Ghost

  • Player.LowerManaCost Int32 Get total Lower Mana Cost.

  • Player.LowerReagentCost Int32 Get total Lower Reagent Cost.

  • Player.Luck Int32 Player total luck.

  • Player.Mana Int32 Current mana.

  • Player.ManaIncrease Int32 Get total Mana Increase.

  • Player.ManaMax Int32 Maximum mana.

  • Player.ManaRegeneration Int32 Get total Mana Regeneration.

  • Player.Map Int32 Player current map, or facet.

  • Player.MaximumHitPointsIncrease Int32 Get total Maximum Hit Points Increase.

  • Player.MaximumManaIncrease Int32 Get total Maximum Mana Increase.

  • Player.MaximumStaminaIncrease Int32 Get total Maximum Stamina Increase.

  • Player.MaxWeight Int32 Player maximum weight.

  • Player.MobileID Int32 Player MobileID or Body (see: Mobile.MobileID)

  • 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.

  • 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 is Paralized. True also while frozen because of casting of spells.

  • Player.Poisoned Boolean Player is Poisoned

  • Player.PoisonResistance Int32 Resistance to Poison damage.

  • Player.Position Point3D Current Player position as Point3D object.

  • Player.Quiver Item Player quiver, as Item object.

  • Player.ReflectPhysicalDamage Int32 Get total Reflect Physical Damage.

  • Player.Serial Int32 Player unique Serial.

  • Player.SpellDamageIncrease Int32 Get total Spell Damage Increase.

  • Player.Stam Int32 Current stamina.

  • Player.StaminaIncrease Int32 Get total Stamina Increase.

  • Player.StaminaRegeneration Int32 Get total Stamina Regeneration.

  • Player.StamMax Int32 Maximum stamina.

  • Player.StatCap Int32 Get the stats cap.

  • Player.StaticMount Int32 Retrieves serial of mount set in Filter/Mount GUI.

  • Player.Str Int32 Stats value for Strenght.

  • Player.StrengthIncrease Int32 Get total Strength Increase.

  • Player.SwingSpeedIncrease Int32 Get total Swing Speed Increase.

  • Player.Visible Boolean Player is visible, false if hidden.

  • Player.WarMode Boolean Player has war mode active.

  • Player.Weight Int32 Player current weight.

  • Player.YellowHits Boolean Player HP bar is not blue, but yellow.

Methods

Player.Area() → String

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.

Player.Attack(serial) → Void

  • serial: Int32 Serial or Mobile to attack.

Attack a Mobile.

Player.Attack(mobile) → Void
Player.AttackLast() → Void

Attack last target.

Player.BuffsExist(buffname) → Boolean

  • 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

Check if a buff is active, by buff name.

Player.ChatAlliance(msg) → Void

  • msg: Int32

Player.ChatAlliance(msg) → Void

  • msg: String Message to send.

Send message to the alliace chat.

Player.ChatChannel(msg) → Void

  • msg: Int32

Player.ChatChannel(msg) → Void

  • msg: String Message to send.

Send an chat channel message.

Player.ChatEmote(color, msg) → Void

  • color: Int32 Color of the text

  • msg: String Message to send.

Send an emote in game.

Player.ChatEmote(color, msg) → Void

  • color: Int32

  • msg: Int32

Player.ChatGuild(msg) → Void

  • msg: Int32

Player.ChatGuild(msg) → Void

  • msg: String Message to send.

Send message to the guild chat.

Player.ChatParty(msg, recepient_serial) → Void

  • msg: String Text to send.

  • recepient_serial: Int32 Optional: Target of private message.

Send message in arty chat. If a recepient_serial is specified, the message is private.

Player.ChatSay(color, msg) → Void

  • color: Int32 Color of the text

  • msg: String Message to send.

Send message in game.

Player.ChatSay(color, msg) → Void

  • color: Int32

  • msg: Int32

Player.ChatWhisper(color, msg) → Void

  • color: Int32 Color of the text

  • msg: String Message to send.

Send an wishper message.

Player.ChatWhisper(color, msg) → Void

  • color: Int32

  • msg: Int32

Player.ChatYell(color, msg) → Void

  • color: Int32

  • msg: Int32

Player.ChatYell(color, msg) → Void

  • color: Int32 Color of the text

  • msg: String Message to send.

Send an yell message.

Player.CheckLayer(layer) → Boolean
  • 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

Check if a Layer is equipped by the Item.

Player.DistanceTo(target) → Int32

  • target: Mobile The other Mobile or Item

Returns the distance between the Player and a Mobile or an Item.

Player.DistanceTo(target) → Int32
Player.EquipItem(item) → Void
Player.EquipItem(serial) → Void

  • serial: Int32 Serial or Item to equip.

Equip an Item

Player.EquipUO3D(serials) → Void

  • serials: List[Int32]

Player.Fly(status) → Void

  • status: Boolean True: Gargoyle Fly ON - False: Gargoyle fly OFF

Enable or disable Gargoyle Flying.

Player.GetItemOnLayer(layer) → Item
  • 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

Returns the Item associated with a Mobile Layer.

Player.GetPropStringByIndex(index) → String

  • index: Int32 Line number, start from 0.

Get a single line of Properties of the Player, from the tooltip, as text.

Player.GetPropStringList() → List[String]

Get the list of Properties of the Player, as list of lines of the tooltip.

Player.GetPropValue(name) → Int32

  • name: String Name of the property.

Get the numeric value of a specific Player property, from the tooltip.

Player.GetRealSkillValue(skillname) → Double

  • 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

Get the base/real value of the skill for the given the skill name.

Player.GetSkillCap(skillname) → Double

  • 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

Get the skill cap for the given the skill name.

Player.GetSkillStatus(skillname) → Int32

  • 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

Get lock status for a specific skill.

Player.GetSkillValue(skillname) → Double

  • 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

Get the value of the skill, with modifiers, for the given the skill name.

Player.GetStatStatus(statname) → Int32

  • statname: String Strength

Dexterity Intelligence

Get lock status for a specific stats.

Player.GuildButton() → Void

Press the Guild menu button in the paperdoll.

Player.HeadMessage(color, msg) → Void

  • color: Int32

  • msg: Int32

Player.HeadMessage(color, msg) → Void

  • color: Int32 Color of the Text.

  • msg: String Text of the message.

Display a message above the Player. Visible only by the Player.

Player.InRangeItem(item, range) → Boolean

  • item: Item

  • range: Int32

Player.InRangeItem(item, range) → Boolean

  • item: Int32

  • range: Int32

Player.InRangeMobile(mobile, range) → Boolean

  • mobile: Int32

  • range: Int32

Player.InRangeMobile(mobile, range) → Boolean
Player.InvokeVirtue(virtue) → Void

  • virtue: String Honor

Sacrifice Valor Compassion Honesty Humility Justice

Invoke a virtue by name.

Player.KickMember(serial) → Void

  • serial: Int32 Serial of the Mobile to remove.

Kick a member from party by serial. Only for party leader

Player.LeaveParty(force) → Void

  • force: Boolean True: Leave the party invite even you notin any party.

Leaves a party.

Player.MapSay(msg) → Void

  • msg: String Message to send

Send message in the Map chat.

Player.MapSay(msg) → Void

  • msg: Int32

Player.PartyAccept(from_serial, force) → Boolean

  • 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.

Accept an incoming party offer. In case of multiple party oebnding invitation, from_serial is specified,

Player.PartyCanLoot(CanLoot) → Void

  • CanLoot: Boolean

Set the Party loot permissions.

Player.PartyInvite() → Void

Invite a person to a party. Prompt for a in-game Target.

Player.PathFindTo(x, y, z) → Void

  • x: Int32 X map coordinates or Point3D

  • y: Int32 Y map coordinates

  • z: Int32 Z map coordinates

Go to the given coordinates using Client-provided pathfinding.

Player.PathFindTo(Location) → Void
Player.QuestButton() → Void

Press the Quest menu button in the paperdoll.

Player.Run(direction, checkPosition) → Boolean

  • 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.

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)

Player.SetSkillStatus(skillname, status) → Void

  • 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

Set lock status for a specific skill.

Player.SetStatStatus(statname, status) → Void

  • statname: String

  • status: Int32 Lock status:

    0: Up 1: Down 2: Locked

Set lock status for a specific skill.

Player.SetWarMode(warflag) → Void

  • warflag: Boolean True: War - False: Peace

Set war Mode on on/off.

Player.SpellIsEnabled(spellname) → Boolean

  • spellname: String Name of the spell.

Check if spell is active using the spell name (for spells that have this function).

Player.SumAttribute(attributename) → Single

  • attributename: String Name of the property.

Scan all the equipped Item, returns the total value of a specific property. (ex: Lower Reagent Cost ) NOTE: This function is slow.

Player.ToggleAlwaysRun() → Void

Toggle on/off the awlays run flag. NOTE: Works only on OSI client.

Player.UnEquipItemByLayer(layer, wait) → Void
  • 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.

Unequip the Item associated with a specific Layer.

Player.UseSkill(skillname, target, wait) → Void

  • skillname: String

  • target: Item

  • wait: Boolean

Player.UseSkill(skillname, wait) → Void

  • skillname: String

  • wait: Boolean

Player.UseSkill(skillname, target, wait) → Void

  • 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 Optional: Serial, Mobile or Item to target. (default: null) * wait: Boolean Optional: True: wait for confirmation from the server (default: False)

Use a specific skill, and optionally apply that skill to the target specified.

Player.UseSkill(skillname, target, wait) → Void

  • skillname: String

  • target: Mobile

  • wait: Boolean

Player.UseSkill(skillname) → Void

  • skillname: String

Player.UseSkillOnly(skillname, wait) → Void

  • skillname: String

  • wait: Boolean

Player.Walk(direction, checkPosition) → Boolean

  • 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.

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)

Player.WeaponClearSA() → Void

Disable any active Special Ability of the weapon.

Player.WeaponDisarmSA() → Void

Toggle Disarm Ability.

Player.WeaponPrimarySA() → Void

Toggle on/off the primary Special Ability of the weapon.

Player.WeaponSecondarySA() → Void

Toggle on/off the secondary Special Ability of the weapon.

Player.WeaponStunSA() → Void

Toggle Stun Ability.

Player.Zone() → String

Get the type of zone in which the Player is currently in. Regions are defined inside by Config/regions.json.