Player

The Player class represent the currently logged in character.

Table of Contents

Properties

AR

Syntax: Player.AR
Returns: Int32

Resistance to Phisical damage.

Backpack

Syntax: Player.Backpack
Returns: Item

Player backpack, as Item object.

Bank

Syntax: Player.Bank
Returns: Item

Player bank chest, as Item object.

Body

Syntax: Player.Body
Returns: Int32

Player Body or MobileID (see: Mobile.Body)

Buffs

Syntax: Player.Buffs
Returns: 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

BuffsInfo

Syntax: Player.BuffsInfo
Returns: List[BuffInfo]

Returns a list with every detailed active buff

ColdResistance

Syntax: Player.ColdResistance
Returns: Int32

Resistance to Cold damage.

Connected

Syntax: Player.Connected
Returns: Boolean

Retrieves Connected State

Corpses

Syntax: Player.Corpses
Returns: HashSet[Item]

Each Death Player corpse item is added here

DamageChanceIncrease

Syntax: Player.DamageChanceIncrease
Returns: Int32

Get total Damage Chance Increase.

DefenseChanceIncrease

Syntax: Player.DefenseChanceIncrease
Returns: Int32

Get total Defense Chance Increase.

Dex

Syntax: Player.Dex
Returns: Int32

Stats value for Dexterity.

DexterityIncrease

Syntax: Player.DexterityIncrease
Returns: Int32

Get total Dexterity Increase.

Direction

Syntax: Player.Direction
Returns: String

Player current direction, as text.

EnergyResistance

Syntax: Player.EnergyResistance
Returns: Int32

Resistance to Energy damage.

EnhancePotions

Syntax: Player.EnhancePotions
Returns: Int32

Get total Enhance Potions.

Fame

Syntax: Player.Fame
Returns: Int32

Fame has to be reverse engineered from the title so it is just ranges: 0: neutral - 3 is highest fame

FasterCastRecovery

Syntax: Player.FasterCastRecovery
Returns: Int32

Get total Faster Cast Recovery.

FasterCasting

Syntax: Player.FasterCasting
Returns: Int32

Get total Faster Casting.

Female

Syntax: Player.Female
Returns: Boolean

Player is a female.

FireResistance

Syntax: Player.FireResistance
Returns: Int32

Resistance to Fire damage.

Followers

Syntax: Player.Followers
Returns: Int32

Player current amount of pet/followers.

FollowersMax

Syntax: Player.FollowersMax
Returns: Int32

Player maximum amount of pet/followers.

Gold

Syntax: Player.Gold
Returns: Int32

Player total gold, in the backpack.

HasPrimarySpecial

Syntax: Player.HasPrimarySpecial
Returns: Boolean

HasSecondarySpecial

Syntax: Player.HasSecondarySpecial
Returns: Boolean

HasSpecial

Syntax: Player.HasSpecial
Returns: Boolean

Player have a special abilities active.

HitChanceIncrease

Syntax: Player.HitChanceIncrease
Returns: Int32

Get total Hit Chance Increase.

HitPointsIncrease

Syntax: Player.HitPointsIncrease
Returns: Int32

Get total Hit Points Increase.

HitPointsRegeneration

Syntax: Player.HitPointsRegeneration
Returns: Int32

Get total Hit Points Regeneration.

Hits

Syntax: Player.Hits
Returns: Int32

Current hit points.

HitsMax

Syntax: Player.HitsMax
Returns: Int32

Maximum hit points.

InParty

Syntax: Player.InParty
Returns: Boolean

Player is in praty.

Int

Syntax: Player.Int
Returns: Int32

Stats value for Intelligence.

IntelligenceIncrease

Syntax: Player.IntelligenceIncrease
Returns: Int32

Get total Intelligence Increase.

IsGhost

Syntax: Player.IsGhost
Returns: Boolean

Player is a Ghost

Karma

Syntax: Player.Karma
Returns: Int32

Karma has to be reverse engineered from the title so it is just ranges: -5: most evil, 0: neutral, 5 most good

KarmaTitle

Syntax: Player.KarmaTitle
Returns: String

This is the title string returned from the server

LowerManaCost

Syntax: Player.LowerManaCost
Returns: Int32

Get total Lower Mana Cost.

LowerReagentCost

Syntax: Player.LowerReagentCost
Returns: Int32

Get total Lower Reagent Cost.

Luck

Syntax: Player.Luck
Returns: Int32

Player total luck.

Mana

Syntax: Player.Mana
Returns: Int32

Current mana.

ManaIncrease

Syntax: Player.ManaIncrease
Returns: Int32

Get total Mana Increase.

ManaMax

Syntax: Player.ManaMax
Returns: Int32

Maximum mana.

ManaRegeneration

Syntax: Player.ManaRegeneration
Returns: Int32

Get total Mana Regeneration.

Map

Syntax: Player.Map
Returns: Int32

Player current map, or facet.

MaxWeight

Syntax: Player.MaxWeight
Returns: Int32

Player maximum weight.

MaximumHitPointsIncrease

Syntax: Player.MaximumHitPointsIncrease
Returns: Int32

Get total Maximum Hit Points Increase.

MaximumStaminaIncrease

Syntax: Player.MaximumStaminaIncrease
Returns: Int32

Get total Maximum Stamina Increase.

MobileID

Syntax: Player.MobileID
Returns: Int32

Player MobileID or Body (see: Mobile.MobileID)

Mount

Syntax: Player.Mount
Returns: Item

Player current Mount, as Item object. NOTE: On some server the Serial return by this function doesn't match the mount serial.

Name

Syntax: Player.Name
Returns: String

Player name.

Notoriety

Syntax: Player.Notoriety
Returns: Byte

Player notoriety 1: blue, innocent 2: green, friend 3: gray, neutral 4: gray, criminal 5: orange, enemy 6: red, hostile 6: yellow, invulnerable

Paralized

Syntax: Player.Paralized
Returns: Boolean

Player is Paralyzed. True also while frozen because of casting of spells.

Pets

Syntax: Player.Pets
Returns: List[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

PoisonResistance

Syntax: Player.PoisonResistance
Returns: Int32

Resistance to Poison damage.

Poisoned

Syntax: Player.Poisoned
Returns: Boolean

Player is Poisoned

Position

Syntax: Player.Position
Returns: Point3D

Current Player position as Point3D object.

PrimarySpecial

Syntax: Player.PrimarySpecial
Returns: UInt32

Quiver

Syntax: Player.Quiver
Returns: Item

Player quiver, as Item object.

ReflectPhysicalDamage

Syntax: Player.ReflectPhysicalDamage
Returns: Int32

Get total Reflect Physical Damage.

SecondarySpecial

Syntax: Player.SecondarySpecial
Returns: UInt32

Serial

Syntax: Player.Serial
Returns: Int32

Player unique Serial.

SpellDamageIncrease

Syntax: Player.SpellDamageIncrease
Returns: Int32

Get total Spell Damage Increase.

Stam

Syntax: Player.Stam
Returns: Int32

Current stamina.

StamMax

Syntax: Player.StamMax
Returns: Int32

Maximum stamina.

StaminaIncrease

Syntax: Player.StaminaIncrease
Returns: Int32

Get total Stamina Increase.

StaminaRegeneration

Syntax: Player.StaminaRegeneration
Returns: Int32

Get total Stamina Regeneration.

StatCap

Syntax: Player.StatCap
Returns: Int32

Get the stats cap.

StaticMount

Syntax: Player.StaticMount
Returns: Int32

Retrieves serial of mount set in Filter/Mount GUI.

Str

Syntax: Player.Str
Returns: Int32

Stats value for Strenght.

StrengthIncrease

Syntax: Player.StrengthIncrease
Returns: Int32

Get total Strength Increase.

SwingSpeedIncrease

Syntax: Player.SwingSpeedIncrease
Returns: Int32

Get total Swing Speed Increase.

Visible

Syntax: Player.Visible
Returns: Boolean

Player is visible, false if hidden.

WarMode

Syntax: Player.WarMode
Returns: Boolean

Player has war mode active.

Weight

Syntax: Player.Weight
Returns: Int32

Player current weight.

YellowHits

Syntax: Player.YellowHits
Returns: Boolean

Player HP bar is not blue, but yellow.

Methods

Area

Syntax: 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 Persistence/regions.json.

Returns: String

Attack

Syntax: Player.Attack(serial)

Attack a Mobile.

Parameters:
  • serial (Int32): Serial or Mobile to attack.
Returns: Void

AttackLast

Syntax: Player.AttackLast()

Attack last target.

Returns: Void

AttackType

Syntax: Player.AttackType(graphic, rangemax, selector, color, notoriety)
Parameters:
  • graphic (Int32)
  • rangemax (Int32)
  • selector (String)
  • color (List[Int32])
  • notoriety (List[Byte])
Returns: Boolean

BuffTime

Syntax: Player.BuffTime(buffname)
Parameters:
  • buffname (String)
Returns: Int32

BuffsExist

Syntax: Player.BuffsExist(buffname, okayToGuess)

Check if a buff is active, by buff name.

Parameters:
  • buffname (String)
  • okayToGuess (Boolean)
Returns: Boolean

ChatAlliance

Syntax: Player.ChatAlliance(msg)

Send message to the alliace chat.

Parameters:
  • msg (String): Message to send.
Returns: Void

ChatChannel

Syntax: Player.ChatChannel(msg)

Send an chat channel message.

Parameters:
  • msg (String): Message to send.
Returns: Void

ChatEmote

Syntax: Player.ChatEmote(color, msg)

Send an emote in game.

Parameters:
  • color (Int32): Color of the text
  • msg (String): Message to send.
Returns: Void

ChatGuild

Syntax: Player.ChatGuild(msg)

Send message to the guild chat.

Parameters:
  • msg (String): Message to send.
Returns: Void

ChatParty

Syntax: 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.
Returns: Void

ChatSay

Syntax: Player.ChatSay(color, msg)

Send message in game. Send message in game using 1153 for color.

Parameters:
  • color (Int32): Color of the text
  • msg (String): Message to send.
Returns: Void

ChatWhisper

Syntax: Player.ChatWhisper(color, msg)

Send an wishper message.

Parameters:
  • color (Int32): Color of the text
  • msg (String): Message to send.
Returns: Void

ChatYell

Syntax: Player.ChatYell(color, msg)

Send an yell message.

Parameters:
  • color (Int32): Color of the text
  • msg (String): Message to send.
Returns: Void

CheckLayer

Syntax: 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
Returns: Boolean

ClearCorpseList

Syntax: Player.ClearCorpseList()

Clear the Player corpse item list

Returns: Void

DistanceTo

Syntax: Player.DistanceTo(target)

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

Parameters:
  • target (UOEntity): The other Mobile or Item
Returns: Int32

EmoteAction

Syntax: Player.EmoteAction(action)
Parameters:
  • action (String)
Returns: Void

EquipItem

Syntax: Player.EquipItem(serial)

Equip an Item

Parameters:
  • serial (Int32): Serial or Item to equip.
Returns: Void

EquipLastWeapon

Syntax: Player.EquipLastWeapon()

Equip the last used weapon

Returns: Void

EquipUO3D

Syntax: Player.EquipUO3D(serials)

Equip a python list of item by using UO3D packet.

Parameters:
  • serials (List[Int32])
Returns: Void

Fly

Syntax: Player.Fly(status)

Enable or disable Gargoyle Flying.

Parameters:
  • status (Boolean): True: Gargoyle Fly ON - False: Gargoyle fly OFF
Returns: Void

GetBuffInfo

Syntax: Player.GetBuffInfo(buffName, okayToGuess)

Check if buff information is active by buff name and returns it.

Parameters:
  • buffName (String)
  • okayToGuess (Boolean)
Returns: BuffInfo

GetItemOnLayer

Syntax: 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
Returns: Item

GetPropStringByIndex

Syntax: 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.
Returns: String

GetPropStringList

Syntax: Player.GetPropStringList()

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

Returns: List[String]

GetPropValue

Syntax: Player.GetPropValue(name)

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

Parameters:
  • name (String): Name of the property.
Returns: Int32

GetRealSkillValue

Syntax: 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
Returns: Double

GetSkillCap

Syntax: 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
Returns: Double

GetSkillStatus

Syntax: 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
Returns: Int32

GetSkillValue

Syntax: 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
Returns: Double

GetStatStatus

Syntax: Player.GetStatStatus(statname)

Get lock status for a specific stats.

Parameters:
  • statname (String): Strength Dexterity Intelligence
Returns: Int32

GuildButton

Syntax: Player.GuildButton()

Press the Guild menu button in the paperdoll.

Returns: Void

HeadMessage

Syntax: Player.HeadMessage(color, msg)

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

Parameters:
  • color (Int32): Color of the Text.
  • msg (String): Text of the message.
Returns: Void

InRange

Syntax: 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:
  • entity (UOEntity)
  • range (Int32): Maximum distance in tiles.
Returns: Boolean

InRangeItem

Syntax: Player.InRangeItem(item, range)

Check if the Item is within a certain range (<=).

Parameters:
  • item (Int32): Serial or Item object.
  • range (Int32): Maximum distance in tiles.
Returns: Boolean

InRangeMobile

Syntax: Player.InRangeMobile(mobile, range)

Check if the Mobile is within a certain range (<=). Check if the mobile is within a certain range (<=).

Parameters:
  • mobile (Int32): Serial or Mobile object.
  • range (Int32): Maximum distance in tiles.
Returns: Boolean

InvokeVirtue

Syntax: Player.InvokeVirtue(virtue)

Invoke a virtue by name. Invoke a virtue by name.

Parameters:
  • virtue (String): Honor Sacrifice Valor Compassion Honesty Humility Justice Spirituality
Returns: Void

KickMember

Syntax: Player.KickMember(serial)

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

Parameters:
  • serial (Int32): Serial of the Mobile to remove.
Returns: Void

LeaveParty

Syntax: Player.LeaveParty(force)

Leaves a party.

Parameters:
  • force (Boolean): True: Leave the party invite even you notin any party.
Returns: Void

MapSay

Syntax: Player.MapSay(msg)

Send message in the Map chat.

Parameters:
  • msg (String): Message to send
Returns: Void

OpenPaperDoll

Syntax: Player.OpenPaperDoll()

Open Player's Paperdoll

Returns: Void

PartyAccept

Syntax: 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.
Returns: Boolean

PartyCanLoot

Syntax: Player.PartyCanLoot(CanLoot)

Set the Party loot permissions.

Parameters:
  • CanLoot (Boolean)
Returns: Void

PartyInvite

Syntax: Player.PartyInvite()

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

Returns: Void

PathFindTo

Syntax: Player.PathFindTo(x, y, z)

Go to the given coordinates using Client-provided pathfinding. Go to the position supplied using Client-provided pathfinding. Go to the position supplied using Client-provided pathfinding.

Parameters:
  • x (Int32): X map coordinates or Point3D
  • y (Int32): Y map coordinates
  • z (Int32): Z map coordinates
Returns: Void

QuestButton

Syntax: Player.QuestButton()

Press the Quest menu button in the paperdoll.

Returns: Void

Run

Syntax: 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:
  • direction (String): North South East West Up Down Left Right
Returns: Boolean

SetSkillStatus

Syntax: 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
Returns: Void

SetStatStatus

Syntax: 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
Returns: Void

SetStaticMount

Syntax: Player.SetStaticMount(serial)

Sets serial of mount set in Filter/Mount GUI.

Parameters:
  • serial (Int32)
Returns: Void

SetWarMode

Syntax: Player.SetWarMode(warflag)

Set war Mode on on/off.

Parameters:
  • warflag (Boolean): True: War - False: Peace
Returns: Void

SkillDelay

Syntax: Player.SkillDelay()

Returns the remaining milliseconds until the next skill use is allowed by the server. Returns 0 if no skill delay is active. Use with to moderate script timing: Misc.Pause(Player.SkillDelay())

Returns: Int32

SpellIsEnabled

Syntax: 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.
Returns: Boolean

SumAttribute

Syntax: 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.
Returns: Single

ToggleAlwaysRun

Syntax: Player.ToggleAlwaysRun()

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

Returns: Void

TrackingArrow

Syntax: Player.TrackingArrow(x, y, display, target)

Display a fake tracking arrow

Parameters:
  • x (UInt16): X coordinate.
  • y (UInt16): Y coordinate.
  • display (Boolean): True = On, False = off
  • target (UInt32): object serial targeted
Returns: Void

UnEquipItemByLayer

Syntax: 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.
Returns: Void

UnEquipUO3D

Syntax: Player.UnEquipUO3D(_layers)

UnEquip a python list of layer names by using UO3D packet.

Parameters:
  • _layers (IEnumerable[String])
Returns: Void

UpdateKarma

Syntax: Player.UpdateKarma()

Costly! Updates the Fame and Karma of the Mobile, but it can take as long as 1 second to complete.

Returns: Boolean

UseSkill

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

UseSkillOnly

Syntax: Player.UseSkillOnly(skillname, wait)
Parameters:
  • skillname (String)
  • wait (Boolean)
Returns: Void

Walk

Syntax: Player.Walk(direction)
Parameters:
  • direction (String)
Returns: Boolean

WeaponClearSA

Syntax: Player.WeaponClearSA()

Disable any active Special Ability of the weapon.

Returns: Void

WeaponDisarmSA

Syntax: Player.WeaponDisarmSA()

Toggle Disarm Ability.

Returns: Void

WeaponPrimarySA

Syntax: Player.WeaponPrimarySA()

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

Returns: Void

WeaponSecondarySA

Syntax: Player.WeaponSecondarySA()

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

Returns: Void

WeaponStunSA

Syntax: Player.WeaponStunSA()

Toggle Stun Ability.

Returns: Void

Zone

Syntax: Player.Zone()

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

Returns: String