Player
The Player class represent the currently logged in character.
TODO: Player Constructors
Properties
Player.ARInt32
Resistance to Phisical damage.
Player.BackpackItem
Player backpack, as Item object.
Player.BankItem
Player bank chest, as Item object.
Player.BodyInt32
Player Body or MobileID (see: Mobile.Body)
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.BuffsInfoList[BuffInfo]
Player.BuffsInfoList[BuffInfo]
Returns a list with every detailed active buff
Player.ColdResistanceInt32
Player.ColdResistanceInt32
Resistance to Cold damage.
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
Stats value for Dexterity.
Player.DexterityIncreaseInt32
Player.DexterityIncreaseInt32
Get total Dexterity Increase.
Player.DirectionString
Player current direction, as text.
Player.EnergyResistanceInt32
Player.EnergyResistanceInt32
Resistance to Energy damage.
Player.EnhancePotionsInt32
Player.EnhancePotionsInt32
Get total Enhance Potions.
Player.FameInt32
Fame has to be reverse engineered from the title so it is just ranges:
0: neutaral - 3 is highest fame
Player.FasterCastRecoveryInt32
Player.FasterCastRecoveryInt32
Get total Faster Cast Recovery.
Player.FasterCastingInt32
Player.FasterCastingInt32
Get total Faster Casting.
Player.FemaleBoolean
Player is a female.
Player.FireResistanceInt32
Player.FireResistanceInt32
Resistance to Fire damage.
Player.FollowersInt32
Player current amount of pet/followers.
Player.FollowersMaxInt32
Player maximum amount of pet/followers.
Player.GoldInt32
Player total gold, in the backpack.
Player.HasPrimarySpecialBoolean
Player.HasPrimarySpecialBoolean
Player.HasSecondarySpecialBoolean
Player.HasSecondarySpecialBoolean
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
Current hit points.
Player.HitsMaxInt32
Maximum hit points.
Player.InPartyBoolean
Player is in praty.
Player.IntInt32
Stats value for Intelligence.
Player.IntelligenceIncreaseInt32
Player.IntelligenceIncreaseInt32
Get total Intelligence Increase.
Player.IsGhostBoolean
Player is a Ghost
Player.KarmaInt32
Karma has to be reverse engineered from the title so it is just ranges:
-5: most evil, 0: neutaral, 5 most good
Player.KarmaTitleString
This is the title string returned from the server
Player.LowerManaCostInt32
Player.LowerManaCostInt32
Get total Lower Mana Cost.
Player.LowerReagentCostInt32
Player.LowerReagentCostInt32
Get total Lower Reagent Cost.
Player.LuckInt32
Player total luck.
Player.ManaInt32
Current mana.
Player.ManaIncreaseInt32
Get total Mana Increase.
Player.ManaMaxInt32
Maximum mana.
Player.ManaRegenerationInt32
Player.ManaRegenerationInt32
Get total Mana Regeneration.
Player.MapInt32
Player current map, or facet.
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 MobileID or Body (see: Mobile.MobileID)
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 name.
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 is Paralized. True also while frozen because of casting of spells.
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 is Poisoned
Player.PositionPoint3D
Current Player position as Point3D object.
Player.PrimarySpecialUInt32
Player.PrimarySpecialUInt32
Player.QuiverItem
Player quiver, as Item object.
Player.ReflectPhysicalDamageInt32
Player.ReflectPhysicalDamageInt32
Get total Reflect Physical Damage.
Player.SecondarySpecialUInt32
Player.SecondarySpecialUInt32
Player.SerialInt32
Player unique Serial.
Player.SpellDamageIncreaseInt32
Player.SpellDamageIncreaseInt32
Get total Spell Damage Increase.
Player.StamInt32
Current stamina.
Player.StamMaxInt32
Maximum stamina.
Player.StaminaIncreaseInt32
Player.StaminaIncreaseInt32
Get total Stamina Increase.
Player.StaminaRegenerationInt32
Player.StaminaRegenerationInt32
Get total Stamina Regeneration.
Player.StatCapInt32
Get the stats cap.
Player.StaticMountInt32
Retrieves serial of mount set in Filter/Mount GUI.
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 is visible, false if hidden.
Player.WarModeBoolean
Player has war mode active.
Player.WeightInt32
Player current weight.
Player.YellowHitsBoolean
Player HP bar is not blue, but yellow.
Methods
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
StringName of the area. Unknown if not recognized.
Player.Attack(serial)
Attack a Mobile.
Parameters
serialInt32
MobileSerial or Mobile to attack.
Player.AttackLast()
Attack last target.
Player.AttackType(graphic, rangemax, selector, color, notoriety)
Player.AttackType(graphic, rangemax, selector, color, notoriety)
Parameters
graphicInt32
List[Int32]
rangemaxInt32
selectorString
colorList[Int32]
notorietyList[Byte]
Player.BuffTime(buffname)
Player.BuffTime(buffname)
Player.BuffsExist(buffname, okayToGuess)
Player.BuffsExist(buffname, okayToGuess)
Check if a buff is active, by buff name.
Parameters
buffnameStringMeditation
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
okayToGuessBoolean
Return
BooleanTrue: if the buff is active - False: otherwise.
Player.ChatAlliance(msg)
Send message to the alliace chat.
Parameters
msgString
Int32Message to send.
Player.ChatChannel(msg)
Send an chat channel message.
Parameters
msgString
Int32Message to send.
Player.ChatEmote(color, msg)
Player.ChatEmote(color, msg)
Send an emote in game.
Parameters
colorInt32Color of the text
msgString
Int32Message to send.
Player.ChatGuild(msg)
Send message to the guild chat.
Parameters
msgString
Int32Message to send.
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
msgStringText to send.
recepient_serialInt32Optional: Target of private message.
Player.ChatSay(color, msg)
Player.ChatSay(color, msg)
Send message in game.
Send message in game using 1153 for color.
Parameters
colorString
Int32Color of the text
Message to send.
msgString
Int32Message to send.
Player.ChatWhisper(color, msg)
Player.ChatWhisper(color, msg)
Send an wishper message.
Parameters
colorInt32Color of the text
msgString
Int32Message to send.
Player.ChatYell(color, msg)
Player.ChatYell(color, msg)
Send an yell message.
Parameters
colorInt32Color of the text
msgString
Int32Message to send.
Player.CheckLayer(layer)
Check if a Layer is equipped by the Item.
Parameters
layerStringLayers:
RightHand
LeftHand
Shoes
Pants
Shirt
Head
Gloves
Ring
Neck
Hair
Waist
InnerTorso
Bracelet
FacialHair
MiddleTorso
Earrings
Arms
Cloak
OuterTorso
OuterLegs
InnerLegs
Talisman
Return
BooleanTrue: the Layer is occupied by an Item - False: otherwise.
Player.ClearCorpseList()
Clear the Player corpse item list
Player.DistanceTo(target)
Player.DistanceTo(target)
Returns the distance between the Player and a Mobile or an Item.
Parameters
targetInt32
UOEntityThe other Mobile or Item
Return
Int32Distance in number of tiles.
Player.EmoteAction(action)
Player.EmoteAction(action)
Player.EquipItem(serial)
Equip an Item
Parameters
serialInt32
ItemSerial or Item to equip.
Player.EquipLastWeapon()
Equip the last used weapon
Player.EquipUO3D(serials)
Player.EquipUO3D(serials)
Equip a python list of item by using UO3D packet.
Parameters
serialsPythonList
List[Int32]
Player.Fly(status)
Enable or disable Gargoyle Flying.
Parameters
statusBooleanTrue: Gargoyle Fly ON - False: Gargoyle fly OFF
Player.GetBuffInfo(buffName, okayToGuess)
Player.GetBuffInfo(buffName, okayToGuess)
Check if buff information is active by buff name and returns it.
Parameters
buffNameStringbuff name
okayToGuessBoolean
Player.GetItemOnLayer(layer)
Player.GetItemOnLayer(layer)
Returns the Item associated with a Mobile Layer.
Parameters
layerStringLayers:
RightHand
LeftHand
Shoes
Pants
Shirt
Head
Gloves
Ring
Neck
Hair
Waist
InnerTorso
Bracelet
FacialHair
MiddleTorso
Earrings
Arms
Cloak
OuterTorso
OuterLegs
InnerLegs
Talisman
Return
ItemItem 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
indexInt32Line number, start from 0.
Return
StringSingle 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
nameStringName of the property.
Return
Int32n: 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
skillnameStringAlchemy
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
DoubleValue of the skill.
Player.GetSkillCap(skillname)
Player.GetSkillCap(skillname)
Get the skill cap for the given the skill name.
Parameters
skillnameStringAlchemy
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
DoubleValue of the skill cap.
Player.GetSkillStatus(skillname)
Player.GetSkillStatus(skillname)
Get lock status for a specific skill.
Parameters
skillnameStringAlchemy
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
Int32Lock 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
skillnameStringAlchemy
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
DoubleValue of the skill.
Player.GetStatStatus(statname)
Player.GetStatStatus(statname)
Get lock status for a specific stats.
Parameters
statnameStringStrength
Dexterity
Intelligence
Return
Int32Lock status:
0: Up
1: Down
2: Locked
Player.GuildButton()
Press the Guild menu button in the paperdoll.
Player.HeadMessage(color, msg)
Player.HeadMessage(color, msg)
Display a message above the Player. Visible only by the Player.
Parameters
colorInt32Color of the Text.
msgString
Int32Text of the message.
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
rangeInt32Maximum distance in tiles.
Return
BooleanTrue: 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
itemInt32
ItemSerial or Item object.
rangeInt32Maximum distance in tiles.
Return
BooleanTrue: 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
MobileSerial or Mobile object.
rangeInt32Maximum distance in tiles.
Return
BooleanTrue: 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
virtueString
Int32Honor
Sacrifice
Valor
Compassion
Honesty
Humility
Justice
Spirituality
Player.KickMember(serial)
Player.KickMember(serial)
Kick a member from party by serial. Only for party leader
Parameters
serialInt32Serial of the Mobile to remove.
Player.LeaveParty(force)
Leaves a party.
Parameters
forceBooleanTrue: Leave the party invite even you notin any party.
Player.MapSay(msg)
Send message in the Map chat.
Parameters
msgString
Int32Message to send
Player.OpenPaperDoll()
Open Player's Paperdoll
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_serialInt32Optional: Serial to accept party from.( in case of multiple offers )
forceBooleanTrue: Accept the party invite even you are already in a party.
Return
BooleanTrue: if you are now in a party - False: otherwise.
Player.PartyCanLoot(CanLoot)
Player.PartyCanLoot(CanLoot)
Set the Party loot permissions.
Player.PartyInvite()
Invite a person to a party. Prompt for a in-game Target.
Player.PathFindTo(x, y, z)
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
xInt32
Point3DX map coordinates or Point3D
yInt32Y map coordinates
zInt32Z map coordinates
Player.QuestButton()
Press the Quest menu button in the paperdoll.
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
directionStringNorth
South
East
West
Up
Down
Left
Right
Return
BooleanTrue: Destination reached - False: Coudn't reach the destination.
Player.SetSkillStatus(skillname, status)
Player.SetSkillStatus(skillname, status)
Set lock status for a specific skill.
Parameters
skillnameStringAlchemy
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
statusInt32Lock status:
0: Up
1: Down
2: Locked
Player.SetStatStatus(statname, status)
Player.SetStatStatus(statname, status)
Set lock status for a specific skill.
Parameters
statnameStringStrength
Dexterity
Intelligence
statusInt32Lock status:
0: Up
1: Down
2: Locked
Player.SetStaticMount(serial)
Player.SetStaticMount(serial)
Sets serial of mount set in Filter/Mount GUI.
Player.SetWarMode(warflag)
Player.SetWarMode(warflag)
Set war Mode on on/off.
Parameters
warflagBooleanTrue: War - False: Peace
Player.SpellIsEnabled(spellname)
Player.SpellIsEnabled(spellname)
Check if spell is active using the spell name (for spells that have this function).
Parameters
spellnameStringName of the spell.
Return
BooleanTrue: 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
attributenameStringName of the property.
Return
SingleThe total value as number.
Player.ToggleAlwaysRun()
Toggle on/off the awlays run flag.
NOTE: Works only on OSI client.
Player.TrackingArrow(x, y, display, target)
Player.TrackingArrow(x, y, display, target)
Display a fake tracking arrow
Parameters
xUInt16X coordinate.
yUInt16Y coordinate.
displayBooleanTrue = On, False = off
targetUInt32object serial targeted
Player.UnEquipItemByLayer(layer, wait)
Player.UnEquipItemByLayer(layer, wait)
Unequip the Item associated with a specific Layer.
Parameters
layerStringLayers:
RightHand
LeftHand
Shoes
Pants
Shirt
Head
Gloves
Ring
Neck
Hair
Waist
InnerTorso
Bracelet
FacialHair
MiddleTorso
Earrings
Arms
Cloak
OuterTorso
OuterLegs
InnerLegs
Talisman
waitBooleanWait for confirmation from the server.
Player.UnEquipUO3D(_layers)
Player.UnEquipUO3D(_layers)
UnEquip a python list of layer names by using UO3D packet.
Parameters
_layersList[String]
PythonList
Player.UpdateKarma()
Costly!
Updates the Fame and Karma of the Mobile, but it can take as long as 1 second to complete.
Return
BooleanTrue if successful, False if not server packet received
Player.UseSkill(skillname, target, wait)
Player.UseSkill(skillname, target, wait)
Use a specific skill, and optionally apply that skill to the target specified.
Parameters
skillnameStringAlchemy
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
Int32
Item
MobileOptional: Serial, Mobile or Item to target. (default: null)
waitBooleanOptional: True: wait for confirmation from the server (default: False)
Player.UseSkillOnly(skillname, wait)
Player.UseSkillOnly(skillname, wait)
Parameters
skillnameString
waitBoolean
Player.Walk(direction)
Parameters
directionString
Player.WeaponClearSA()
Disable any active Special Ability of the weapon.
Player.WeaponDisarmSA()
Toggle Disarm Ability.
Player.WeaponPrimarySA()
Toggle on/off the primary Special Ability of the weapon.
Player.WeaponSecondarySA()
Player.WeaponSecondarySA()
Toggle on/off the secondary Special Ability of the weapon.
Player.WeaponStunSA()
Toggle Stun Ability.
Player.Zone()
Get the type of zone in which the Player is currently in.
Regions are defined inside by Config/regions.json.
Return
StringTowns
Dungeons
Guarded
Forest
Unknown