User Tools

Site Tools


scripting-player

Scripting - Player data and function

Here can find some infomation about Enhanced Scripting function about player self data and related function!












Stats

Player Hits
Syntax Player.Hits
Description:
Retrieves an integer value from self character hits.
Returns: Integer
In Object: Player
Parameters: none

Player HitsMax
Syntax Player.HitsMax
Description:
Retrieves an integer value from self character max hits.
Returns: Integer
In Object: Player
Parameters: none

Player Strenght
Syntax Player.Str
Description:
Retrieves an integer value from self character strenght.
Returns: Integer
In Object: Player
Parameters: none

Player Mana
Syntax Player.Mana
Description:
Retrieves an integer value from self character mana.
Returns: Integer
In Object: Player
Parameters: none

Player MaxMana
Syntax Player.ManaMax
Description:
Retrieves an integer value from self character max mana.
Returns: Integer
In Object: Player
Parameters: none

Player Intelligence
Syntax Player.Int
Description:
Retrieves an integer value from self character intelligence.
Returns: Integer
In Object: Player
Parameters: none

Player Stamina
Syntax Player.Stam
Description:
Retrieves an integer value from self character stamina.
Returns: Integer
In Object: Player
Parameters: none

Player Max Stamina
Syntax Player.StamMax
Description:
Retrieves an integer value from self character max stamina.
Returns: Integer
In Object: Player
Parameters: none

Player Dexterity
Syntax Player.Dex
Description:
Retrieves an integer value from self character dexterity.
Returns: Integer
In Object: Player
Parameters: none

Player StatCap
Syntax Player.StatCap
Description:
Retrieves an integer value from self character StatCap.
Returns: Integer
In Object: Player
Parameters: none




Resistances

Player Armor
Syntax Player.AR
Description:
Retrieves an integer value from self character armor.
Returns: Integer
In Object: Player
Parameters: none

Player Fire Resistance
Syntax Player.FireResistance
Description:
Retrieves an integer value from self character fire resistance.
Returns: Integer
In Object: Player
Parameters: none

Player Cold Resistance
Syntax Player.ColdResistance
Description:
Retrieves an integer value from self character cold resistance.
Returns: Integer
In Object: Player
Parameters: none

Player Enery Resistance
Syntax Player.EnergyResistance
Description:
Retrieves an integer value from self character energy resistance.
Returns: Integer
In Object: Player
Parameters: none

Player Poison Resistance
Syntax Player.PoisonResistance
Description:
Retrieves an integer value from self character poison resistance.
Returns: Integer
In Object: Player
Parameters: none




Buff

Player Buffs
Syntax Player.Buffs
Description:
Get a string list whit name of current buffs active on player.
Returns: string[]
In Object: Player
Parameters: none
Result list:
  • 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

Player Buffs Exist
Syntax Player.BuffsExist(string)
Description:
Get a bool value if specific buff exist or not.
Returns: bool
In Object: Player
Parameters: string BuffName
Parameter list:
  • Meditation
  • Agility
  • Animal Form
  • Arcane Enpowerment
  • Arcane Enpowerment (new)
  • Arch Protection
  • Armor Pierce
  • Attunement
  • Aura of Nausea
  • Bleed
  • Bless
  • Block
  • Bloath 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





Flags

Player Ghost
Syntax Player.IsGhost
Description:
Retrieves an bool value from self character ghost status. True character is dead, False character is alive
Returns: Bool
In Object: Player
Parameters: none

Player Poisoned
Syntax Player.Poisoned
Description:
Retrieves an bool value from self character poison status. True character is poisoned, False character is not poisoned
Returns: Bool
In Object: Player
Parameters: none

Player YellowHits
Syntax Player.YellowHits
Description:
Retrieves an bool value from self character YellowHits status.
Returns: Bool
In Object: Player
Parameters: none

Player Hidded
Syntax Player.Visible
Description:
Retrieves an bool value from self character hidded status. True character is visible, False character is hidded
Returns: Bool
In Object: Player
Parameters: none

Player War Mode
Syntax Player.WarMode
Description:
Retrieves an bool value from self character war status. True character is in warmode, False character is in peace
Returns: Bool
In Object: Player
Parameters: none

Player Paralized
Syntax Player.Paralized
Description:
Retrieves an bool value from self character paral status. True character is in paralized, False character is not paralized
Returns: Bool
In Object: Player
Parameters: none




General

Player Sex
Syntax Player.Female
Description:
Retrieves an bool value from self character sex. True character is womand, False character is male
Returns: Bool
In Object: Player
Parameters: none

Player Name
Syntax Player.Name
Description:
Retrieves a string whit self character name.
Returns: String
In Object: Player
Parameters: none

Player Backpack
Syntax Player.Backpack
Description:
Retrieves a item whit self character backpack.
Returns: Item
In Object: Player
Parameters: none

Player Backpack Serial
Syntax Player.Backpack.Serial
Description:
Retrieves a int whit self character backpack serial.
Returns: Int
In Object: Player
Parameters: none

Player Backpack Color
Syntax Player.Backpack.Hue
Description:
Retrieves a int whit self character backpack color.
Returns: Int
In Object: Player
Parameters: none

Player Bank
Syntax Player.Bank
Description:
Retrieves a item whit self character bankbox.
Returns: Item
In Object: Player
Parameters: none

Player Quiver
Syntax Player.Quiver
Description:
Retrieves a item whit self character quiver.
Returns: Item
In Object: Player
Parameters: none

Player Quiver Serial
Syntax Player.Quiver.Serial
Description:
Retrieves a int whit self character quiver serial.
Returns: Int
In Object: Player
Parameters: none

Player Quiver Color
Syntax Player.Quiver.Hue
Description:
Retrieves a int whit self character quiver color.
Returns: Int
In Object: Player
Parameters: none

Player Mount
Syntax Player.Mount
Description:
Retrieves a item whit self character mount. You must be mounted for retrive this information
Returns: Item
In Object: Player
Parameters: none

Gui Static Mount
Syntax Player.StaticMount
Description:
Retrieves serial of mount set in Filter/Mount GUI.
Returns: Int
In Object: Player
Parameters: none

Player Mount Serial
Syntax Player.Mount.Serial
Description:
Retrieves a int whit self character mount serial.You must be mounted for retrive this information
Returns: Int
In Object: Player
Parameters: none

Player Mount Color
Syntax Player.Mount.Hue
Description:
Retrieves a int whit self character mount color. You must be mounted for retrive this information
Returns: Int
In Object: Player
Parameters: none

Player Mount Name
Syntax Player.Mount.Name
Description:
Retrieves a string whit self character mount name. You must be mounted for retrive this information
Returns: String
In Object: Player
Parameters: none

Player Gold in Backpack
Syntax Player.Gold
Description:
Retrieves a int whit self character gold amount in backpack.
Returns: Int
In Object: Player
Parameters: none

Player Luck
Syntax Player.Luck
Description:
Retrieves a int whit self character luck value.
Returns: Int
In Object: Player
Parameters: none

Player Body Graphycs
Syntax Player.Body
Description:
Retrieves a int whit self character body graphycs value.
Returns: Int
In Object: Player
Parameters: none

Player Serial
Syntax Player.Serial
Description:
Retrieves a int whit self character serial.
Returns: Int
In Object: Player
Parameters: none

Player Head Message
Syntax Player.HeadMessage(int, string)
Description:
Display a message over self character whit color.
Returns: void
In Object: Player
Parameters: Int MessageColor, String Message

Player Notoriety
Syntax Player.Notoriety
Description:
Read byte of Notoriety color.
Returns: byte
In Object: Player




Followers

Player Current Followers
Syntax Player.Followers( )
Description:
Retrieves an int value from self character current followers.
Returns: Int
In Object: Player
Parameters: none

Player Max Followers
Syntax Player.FollowersMax( )
Description:
Retrieves an int value from self character max followers allowed.
Returns: Int
In Object: Player
Parameters: none




Weight

Player Current Weight
Syntax Player.Weight
Description:
Retrieves an int value from self character current weight.
Returns: Int
In Object: Player
Parameters: none

Player Max Weight
Syntax Player.MaxWeight
Description:
Retrieves an int value from self character max weight can carry.
Returns: Int
In Object: Player
Parameters: none




Positioning

Player Position
Syntax Player.Position
Description:
Retrieves an Point3D value from self character current position.
Returns: Point3D
In Object: Player
Parameters: none

Player Position X Coord
Syntax Player.Position.X
Description:
Retrieves an int value from self character position X coord.
Returns: Int
In Object: Player
Parameters: none

Player Position Y Coord
Syntax Player.Position.Y
Description:
Retrieves an int value from self character position Y coord.
Returns: Int
In Object: Player
Parameters: none

Player Position Z Level
Syntax Player.Position.Z
Description:
Retrieves an int value from self character position Z level.
Returns: Int
In Object: Player
Parameters: none

Check Mobile Range
Syntax Player.InRangeMobile(Mobile or Int, int)
Description:
Retrieves a bool value if specific mobile is in specific range.
Returns: bool
In Object: Player
Parameters: mobile mobiletocheck or int serialmobiletocheck, int range

Check Item Range
Syntax Player.InRangeItem(Item or Int, int)
Description:
Retrieves a bool value if specific item is in specific range.
Returns: bool
In Object: Player
Parameters: item itemtocheck or int serialitemtocheck, int range

Get Player Direction
Syntax Player.Direction
Description:
Contain player direction in string: North, South, West, East, Right, Left, Up, Down.
Returns: string
In Object: Player
Parameters: none

Player Map
Syntax Player.Map
Description:
Retrieves current player map number.
Returns: Int
In Object: Player
Parameters: none





Layers

Player Get Item on Layer
Syntax Player.GetItemOnLayer(string)
Description:
Retrieves a item value of item equipped on specific layer.
Returns: Item
In Object: Player
Parameters: String Layername
Parameters list:
  • RightHand
  • LeftHand
  • Shoes
  • Pants
  • Shirt
  • Head
  • Gloves
  • Ring
  • Neck
  • Waist
  • InnerTorso
  • Bracelet
  • MiddleTorso
  • Earrings
  • Arms
  • Cloak
  • OuterTorso
  • OuterLegs
  • InnerLegs
  • Talisman
Exception: If wrong layer name or layer empty function return null!

Player UnEquip Item on Layer
Syntax Player.UnEquipItemByLayer(string)
Description:
Unequip item equipped on specific layer.
Returns: void
In Object: Player
Parameters: String Layername
Parameters list:
  • RightHand
  • LeftHand
  • Shoes
  • Pants
  • Shirt
  • Head
  • Gloves
  • Ring
  • Neck
  • Hair
  • Waist
  • InnerTorso
  • Bracelet
  • FacialHair
  • MiddleTorso
  • Earrings
  • Arms
  • Cloak
  • OuterTorso
  • OuterLegs
  • InnerLegs
  • Talisman

Player Equip Item on Layer
Syntax Player.EquipItem(Int or Item)
Description:
Equip item on specific layer. Can use item or serial for parameters.
Returns: void
In Object: Player
Parameters: Int item serial, Item referece

Player Check Layer
Syntax Player.CheckLayer(String)
Description:
Get a bool value if layer is busy whit item or not. True: Layer busy, False: Layer free
Returns: Bool
In Object: Player
Parameters: String Layername
Parameters list:
  • RightHand
  • LeftHand
  • Shoes
  • Pants
  • Shirt
  • Head
  • Gloves
  • Ring
  • Neck
  • Hair
  • Waist
  • InnerTorso
  • Bracelet
  • FacialHair
  • MiddleTorso
  • Earrings
  • Arms
  • Cloak
  • OuterTorso
  • OuterLegs
  • InnerLegs
  • Talisman

Player Get Assistant Layer
Syntax Player.GetAssistantLayer(string)
Description:
Get the Layer's name in Hex.
Returns: Layer
In Object: Player
Parameters: string Layer's name

Player Equip UO3D
Syntax Player.EquipUO3D(List(Int))
Description:
Equip a list of item by using UO3D packet.
Returns: Layer
In Object: Player
Parameters: List(Int) Serialtoequip




Skills

Player Get Skill Value
Syntax Player.GetSkillValue(String)
Description:
Get value of specific skill.
Returns: Double
In Object: Player
Parameters: String Skillname
Parameters list:
  • 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
  • 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

Player Get Real Skill Value
Syntax Player.GetRealSkillValue(String)
Description:
Get real value of specific skill.
Returns: Double
In Object: Player
Parameters: String Skillname
Parameters list:
  • 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
  • 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

Player Get SkillCap Value
Syntax Player.GetSkillCap(String)
Description:
Get value of specific skillcap.
Returns: Double
In Object: Player
Parameters: String Skillname
Parameters list:
  • 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
  • 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

Player Get Skill Lock Status
Syntax Player.GetSkillStatus(String)
Description:
Get status lock for a specific skill. UP: 0, DOWN: 1, LOCKED: 2
Returns: Int
In Object: Player
Parameters: String Skillname
Parameters list:
  • 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
  • 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

Player Use Skill
Syntax Player.UseSkill(String)
Description:
Use a specific skill.
Returns: void
In Object: Player
Parameters: String Skillname
Parameters list:
  • Animal Lore
  • Item ID
  • Arms Lore
  • Begging
  • Peacemaking
  • Cartography
  • Detect Hidden
  • Discordance
  • Eval Int
  • Forensics
  • Hiding
  • Provocation
  • Poisoning
  • Spirit Speak
  • Stealing
  • Animal Taming
  • Taste ID
  • Tracking
  • Meditation
  • Stealth
  • Remove Trap
  • Inscribe
  • Anatomy
  • Imbuing




Chat

Player Chat Say
Syntax Player.ChatSay(int, string or int)
Description:
Send a message in say whit specific color and message.
Returns: void
In Object: Player
Parameters: Int Color, String Message or int number

Player Chat Emote
Syntax Player.ChatEmote(int, string or int)
Description:
Send a emote message whit specific color and message.
Returns: void
In Object: Player
Parameters: Int Color, String Message or int number

Player Chat Whisper
Syntax Player.ChatWhisper(int, string or int)
Description:
Send a message in whisper whit specific color and message.
Returns: void
In Object: Player
Parameters: Int Color, String Message or int number

Player Chat Yell
Syntax Player.ChatYell(int, string or int)
Description:
Send a message in yell whit specific color and message.
Returns: void
In Object: Player
Parameters: Int Color, String Message or int number

Player Chat Guild
Syntax Player.ChatGuild(string or int)
Description:
Send a message in guild chat.
Returns: void
In Object: Player
Parameters: String Message or int number

Player Chat Alliance
Syntax Player.ChatAlliance(string or int)
Description:
Send a message in alliance chat.
Returns: void
In Object: Player
Parameters: String Message or int number

Player Chat Channel
Syntax Player.ChatChannel(string or int)
Description:
Send a message in chat channel.
Returns: void
In Object: Player
Parameters: String Message or int number




Attack

Player Set Warmode
Syntax Player.SetWarMode(bool)
Description:
Set character warmode status. True: Set warmode ON, False: Set warmode OFF
Returns: void
In Object: Player
Parameters: bool warstatus

Player Attack
Syntax Player.Attack(int or mobile)
Description:
Force character to attack specific serial or mobile
Returns: void
In Object: Player
Parameters: int targetserial or mobile targetmobile

Player Attack Last
Syntax Player.AttackLast()
Description:
Force character to attack last attack
Returns: void
In Object: Player
Parameters: none




Party

Player Party Check
Syntax Player.InParty()
Description:
Check if character is in party. True: Is in party, False: Is not party
Returns: Bool
In Object: Player
Parameters: void

Player Party Send Message
Syntax Player.ChatParty(string, optional int)
Description:
Send a message to party chat, if specific a serial send private message.
Returns: void
In Object: Player
Parameters: string Message, optional int SerialtoPrivate

Player Party Set Loot
Syntax Player.PartyCanLoot(bool)
Description:
Set player party canloot flags. True: Member can loot me, False: Member can't me
Returns: void
In Object: Player
Parameters: bool

Player Party Invite
Syntax Player.PartyInvite( )
Description:
Open a target prompt for invite new member
Returns: void
In Object: Player
Parameters: none

Player Party Leave
Syntax Player.PartyLeave( )
Description:
Leave from party.
Returns: void
In Object: Player
Parameters: none

Player Party Kick Member
Syntax Player.KickMember(int)
Description:
Kick a member from party by serial. Only for party leader
Returns: void
In Object: Player
Parameters: int SerialPersontokick




Virtue

Player Invoke Virtue
Syntax Player.InvokeVirtue(string)
Description:
Invoke a character virtue by specific name.
Returns: none
In Object: Player
Parameters: String Virtuename
Parameters list:
  • Honor
  • Sacrifice
  • Valor
  • Compassion
  • Honesty
  • Humility
  • Justice

Move

Player Walk
Syntax Player.Walk(string)
Description:
Move char in specific direction. Return true for success move, false if fail.
Returns: bool
In Object: Player
Parameters: String Direction
Parameters list:
  • North
  • South
  • East
  • West
  • Up
  • Down
  • Left
  • Right

Player Run
Syntax Player.Run(string)
Description:
Move (run speed) char in specific direction. Return true for success move, false if fail.
Returns: bool
In Object: Player
Parameters: String Direction
Parameters list:
  • North
  • South
  • East
  • West
  • Up
  • Down
  • Left
  • Right

Player Pathfind
Syntax Player.PathFindTo(Point3D or int x, int y, int z)
Description:
Force a client pathfind to specific location XYZ coords.
Returns: none
In Object: Player
Parameters: int X Y Z




Properties

Get Proprerties
Syntax Player.GetPropValue(string)
Description: Get value self (player) propriety!
Returns: Int
In Object: Player
Parameters: String PropName

Get Proprerties String
Syntax Player.GetPropStringByIndex(int)
Description: Get string name of prop by index, if no prop in selected index return empty.
Returns: String
In Object: Player
Parameters: Int PropIndex

Get Proprerties String List
Syntax Items.GetPropStringList()
Description: Get string list of all props name, if no props list is empty.
Returns: List (String)
In Object: Player
Parameters: none





Paperdoll Button

Open quest Menu
Syntax Player.QuestButton( )
Description:
Open a quest menu linked to paperdool quest button.
Returns: Void
In Object: Player
Parameters: none

Open guild Menu
Syntax Player.GuildButton( )
Description:
Open a guild menu linked to paperdool quest button.
Returns: Void
In Object: Player
Parameters: none




Weapon Special Ability

Weapon Primary Ability
Syntax Player.WeaponPrimarySA( )
Description:
Set on Weapon Primary Ability.
Returns: Void
In Object: Player
Parameters: none

Weapon Secondary Ability
Syntax Player.WeaponSecondarySA( )
Description:
Set on Weapon Secondary Ability.
Returns: Void
In Object: Player
Parameters: none

Weapon Clear Ability
Syntax Player.WeaponClearSA( )
Description:
Clear ability if active.
Returns: Void
In Object: Player
Parameters: none

On Weapon Stun Ability
Syntax Player.WeaponStunSA( )
Description:
Set on No Weapon Stun.
Returns: Void
In Object: Player
Parameters: none

On Weapon Disarm Ability
Syntax Player.WeaponDisarmSA( )
Description:
Set on No Weapon Disarm.
Returns: Void
In Object: Player
Parameters: none

Check if have Ability ON
Syntax Player.HasSpecial
Description:
Check if player have a special abiliti ON.
Returns: bool
In Object: Player
Parameters: none





Gargoyle Flying

Gargoyle Flying
Syntax Player.Fly( bool )
Description:
Enable or disable Gargoyle Flying.
Returns: Void
In Object: Player
Parameters: bool EnableFly





Active Spells

Check Active spells
Syntax Player.SpellIsEnabled( string )
Description:
Check Active spell whit spell name (for spell have this function).
Returns: bool
In Object: Player
Parameters: string SpellName

scripting-player.txt · Last modified: 2018/10/04 00:00 by wikiadmin