-
-
Notifications
You must be signed in to change notification settings - Fork 46
Entity
Generated on 9/2/2024 10:46:49 PM
Version: 4.425.19+0c26057dbb7e7e285dbbb7378d1639f9d9112e29
Method Signature:
Int32 AddFriend(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Adds a mobile to friends list, will display target cursor if no serial/alias supplied.
Example:
AddFriend() Method Signature:
Boolean Ally(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns true if the mobile's notoriety is Ally
Example:
if Criminal("mount"): Method Signature:
Void AutoColorPick(Int32)
- hue: Item Hue or -1 for any.
Description:
Setup an automated reply to the incoming dye color gump, allowing you to define dye tubs color. That command should be added prior to the action that opens the color pick gump.
Example:
AutoColorPick(666)
UseObject('dyes')
WaitForTarget(1000)
Target('tub') Method Signature:
Boolean BuffExists(System.String)
- name: Buff name.
Description:
Check for a specific buff
Example:
if BuffExists("Blood Oath"): Method Signature:
Double BuffTime(System.String)
- name: Buff name.
Description:
Returns milliseconds remaining for given buff name, or 0 if expired/not enabled.
Example:
if not BuffExists('Enemy Of One') or BuffTime('Enemy Of One') < 5000:
Cast('Enemy Of One')
Method Signature:
Void ClearIgnoreList()
Description:
Clears the ignore list.
Example:
ClearIgnoreList() Method Signature:
Void ClearObjectQueue()
Description:
Clears all actions in action packet queue
Example:
ClearObjectQueue() Method Signature:
Int32 CountType(Int32, System.Object, Int32)
- graphic: ItemID / Graphic such as 0x3db.
- source: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
- hue: Item Hue or -1 for any. (Optional)
Description:
Amount comparison of item type inside a container.
Example:
CountType(0xff, "backpack") Method Signature:
Int32 CountTypeGround(Int32, Int32, Int32)
- graphic: ItemID / Graphic such as 0x3db.
- hue: Item Hue or -1 for any. (Optional)
- range: Range, ie 10. (Optional)
Description:
Amount comparison of item or mobile type on the ground.
Example:
if CountGround(0xff, 0, 10) < 1: Method Signature:
Boolean Criminal(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns true if the mobile's notoriety is Criminal
Example:
if Criminal("mount"): Method Signature:
Boolean Dead(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns true if given mobile is dead, false if not, if parameter is null, then returns the value from the player (parameter can be serial or alias).
Example:
if Dead("self"): Method Signature:
Int32 Dex()
Description:
Returns the dexterity of the player
Example:
if Str() < 100: Method Signature:
Int32 DiffHits(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns the given mobiles difference between max and current hits, if parameter is null, then returns the value from the player (parameter can be serial or alias).
Example:
if DiffHits("self") > 50: Method Signature:
Double DiffHitsPercent(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns the given mobiles different between max and currents hits as a percentage, if parameter is null, then returns the value from the player (parameter can be serial or alias).
Example:
if DiffHitsPercent("self") > 30: # 70% health Method Signature:
Int32 DiffWeight()
Description:
Returns the difference between max weight and weight.
Example:
if DiffWeight() > 50: Method Signature:
System.String Direction(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns the Direction the given alias/serial is facing
Example:
if Direction('enemy') == 'West': Method Signature:
System.String DirectionTo(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns the Direction the entity is in relative to the player.
Example:
Run(DirectionTo("enemy")) Method Signature:
Int32 Distance(Int32, Int32)
- x: X Coordinate.
- y: Y Coordinate.
Description:
Returns the distance to the given coordinates.
Example:
location = (1000, 1000, 0)
while Distance(location[0], location[1]) > 2:
Pathfind(location[0], location[1], location[2])
Pause(1000) Method Signature:
Int32 Distance(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns the distance to the given entity.
Example:
if Distance("mount") < 4: Method Signature:
Boolean Enemy(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns true if the mobile's notoriety is Enemy
Example:
if Criminal("mount"): Method Signature:
Boolean EquipWand(System.String, Int32)
- wandname: Wand name. See Also: WandTypes
- minimumcharges: Integer value - See description for usage. (Optional)
Description:
Search for a wand inside your backpack and equip it
Example:
#Equip a fireball wand if one can be found in our backpack..
if FindWand("fireball", "backpack", 5):
#Remove current item in hand
if FindLayer("OneHanded"):
ClearHands("left")
#Equip the wand
EquipWand("fireball") Method Signature:
Double FasterCasting()
Description:
Return faster casting value.
Example:
fc = FasterCasting() Method Signature:
Double FasterCastRecovery()
Description:
Return faster cast recovery value.
Example:
fcr = FasterCastRecovery() Method Signature:
Boolean FindObject(System.Object, Int32, System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
- range: Range, ie 10. (Optional)
- findlocation: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Searches for entity by serial and sets found alias, defaults to ground if no source given.
Example:
# Find on ground
FindObject("mount")
# Find on ground with range
FindObject("mount", 10)
# Find in container, must specify search level or -1
FindObject("weapon", -1, "backpack") Method Signature:
Boolean FindType(Int32, Int32, System.Object, Int32, Int32)
- graphic: ItemID / Graphic such as 0x3db.
- range: Range, ie 10. (Optional)
- findlocation: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
- hue: Item Hue or -1 for any. (Optional)
- minimumstackamount: Integer representing an amount, ie 10. (Optional)
Description:
Searches for entity by graphic ID and sets found alias, defaults to ground if no source given.
Example:
# Look for a food item from a list and eat 1 if found.
if not ListExists("food"):
CreateList("food")
PushList("food", 0x9b7) #bird
PushList("food", 0x9d3) #ham
PushList("food", 0x97d) #cheese
PushList("food", 0x9d0) #apple
PushList("food", 0x9eb) #muffin
PushList("food", 0x97b) #fishsteak
PushList("food", 0x9c0) #sausage
PushList("food", 0x9f2) #ribs
PushList("food", 0x9d1) #grapes
PushList("food", 0x9d2) #peach
for i in GetList("food"):
if FindType(i, -1, "backpack"):
UseObject("found")
break Method Signature:
Boolean FindWand(System.String, System.Object, Int32)
- wandname: Wand name. See Also: WandTypes
- containersource: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
- minimumcharges: Integer value - See description for usage. (Optional)
Description:
Search for a wand and set alias "found".
Example:
FindWand("fireball", "backpack", 10) Method Signature:
Int32 Followers()
Description:
Returns the number of current followers as per status bar data.
Example:
if Followers() < 1: Method Signature:
Int32 Gold()
Description:
Returns the gold value as per status bar data.
Example:
if Gold() < 2000: Method Signature:
Int32 Graphic(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns Item ID of given object (parameter can be serial or alias).
Example:
Graphic("mount") Method Signature:
Boolean Gray(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns true if the mobile's notoriety is Attackable
Example:
if Criminal("mount"): Method Signature:
Boolean Hidden(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns true if given mobile is hidden, false if not, if parameter is null, then returns the value from the player (parameter can be serial or alias).
Example:
if Hidden("self"): Method Signature:
Int32 Hits(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns the given mobiles hitpoints, if parameter is null, then returns the value from the player (parameter can be serial or alias).
Example:
hits = Hits("self") Method Signature:
Int32 Hue(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns Hue of given object (parameter can be serial or alias).
Example:
if Hue("mount") == 0: Method Signature:
Void IgnoreObject(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Ignores the given object from find commands
Example:
IgnoreObject("self") Method Signature:
Boolean InFriendList(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns true if supplied mobile exists in the friends list.
Example:
if InFriendList("last"): Method Signature:
Boolean InIgnoreList(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Check whether the given serial / alias exists in the ignore list.
Example:
if InIgnoreList("mount"): Method Signature:
Boolean Innocent(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns true if the mobile's notoriety is Innocent
Example:
if Criminal("mount"): Method Signature:
Boolean InParty(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Return the true if the given serial/alias is in party with you.
Example:
if InParty("friend"): Method Signature:
Boolean InRange(System.Object, Int32)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
- distance: Distance.
Description:
Check for range between your character and another mobile or an item
Example:
if InRange("enemy", 10): Method Signature:
Int32 Int()
Description:
Returns the intelligence of the player
Example:
if Str() < 100: Method Signature:
Boolean Invulnerable(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns true if the mobile's notoriety is Invulnerable
Example:
if Criminal("mount"): Method Signature:
Int32 Luck()
Description:
Returns the luck value as per status bar data.
Example:
if Luck() < 800: Method Signature:
Int32 Mana(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns the given mobiles mana, if parameter is null, then returns the value from the player (parameter can be serial or alias).
Example:
if Mana("self") < 25: Method Signature:
Int32 Map()
Description:
Returns the current map of the Player
Example:
Map() Method Signature:
Int32 MaxFollowers()
Description:
Returns the number of max followers as per status bar data.
Example:
if Followers() == MaxFollowers(): Method Signature:
Int32 MaxHits(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns the given mobiles max hitpoints, if parameter is null, then returns the value from the player (parameter can be serial or alias).
Example:
hits = MaxHits("self") Method Signature:
Int32 MaxMana(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns the given mobiles max mana, if parameter is null, then returns the value from the player (parameter can be serial or alias).
Example:
mana = MaxMana("self") Method Signature:
Int32 MaxStam(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns the given mobiles max stamina, if parameter is null, then returns the value from the player (parameter can be serial or alias).
Example:
stam = MaxStam("self") Method Signature:
Int32 MaxWeight()
Description:
Returns the max weight as per status bar data.
Example:
if MaxWeight() < 300: Method Signature:
Boolean Mounted(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns true if the specified mobile is mounted.
Example:
if Mounted("self"): Method Signature:
Void MoveItem(System.Object, System.Object, Int32, Int32, Int32)
- item: An entity serial in integer or hex format, or an alias string such as "self".
- destination: An entity serial in integer or hex format, or an alias string such as "self".
- amount: Integer representing an amount, ie 10. (Optional)
- x: X Coordinate. (Optional)
- y: Y Coordinate. (Optional)
Description:
Move item to container (parameters can be serials or aliases).
Example:
MoveItem("source", "destination") Method Signature:
Void MoveItemOffset(System.Object, Int32, Int32, Int32, Int32)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
- xoffset: X Coordinate offset.
- yoffset: Y Coordinate offset.
- zoffset: Z Coordinate offset.
- amount: Integer representing an amount, ie 10. (Optional)
Description:
Move the given serial/alias to the specified x,y,z offset of the player, no amount specified or -1 will move the full stack.
Example:
MoveItemOffset("trashitem", 0, 1, 0, -1) Method Signature:
Void MoveType(Int32, System.Object, System.Object, Int32, Int32, Int32, Int32, Int32)
- id: ItemID / Graphic such as 0x3db.
- sourcecontainer: An entity serial in integer or hex format, or an alias string such as "self".
- destinationcontainer: An entity serial in integer or hex format, or an alias string such as "self".
- x: X Coordinate. (Optional)
- y: Y Coordinate. (Optional)
- z: Z Coordinate. (Optional)
- hue: Item Hue or -1 for any. (Optional)
- amount: Integer representing an amount, ie 10. (Optional)
Description:
Move a type from source to destintion.
Example:
#To move a type to another container...
MoveType(0x170f, "backpack", "bank")
#Destination can be the ground by specifying destination container to -1 and specifying the coordinates...
MoveType(0x170f, "backpack", -1, 1928, 2526, 0)
#Optional parameters exist for Hue and Amount, to move 10 maximum with the a Hue of 50...
MoveType(0x170f, "backpack", "bank", -1, -1, 0, 50, 10) Method Signature:
Boolean MoveTypeOffset(Int32, System.Object, Int32, Int32, Int32, Int32, Int32, Int32)
- id: ItemID / Graphic such as 0x3db.
- findlocation: An entity serial in integer or hex format, or an alias string such as "self".
- xoffset: X Coordinate offset.
- yoffset: Y Coordinate offset.
- zoffset: Z Coordinate offset.
- amount: Integer representing an amount, ie 10. (Optional)
- hue: Item Hue or -1 for any. (Optional)
- range: Distance. (Optional)
Description:
Move the given type from the specified source container to the specified x,y,z offset of the player, no amount specified or -1 will move the full stack.
Example:
MoveTypeOffset(0xf0e, "backpack", 0, 1, 0, -1) Method Signature:
Boolean Murderer(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns true if the mobile's notoriety is Murderer
Example:
if Criminal("mount"): Method Signature:
System.String Name(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Return the name of the given mobile.
Example:
if Name("self") == "Shmoo": Method Signature:
Boolean Paralyzed(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns true if the specified mobile is frozen.
Example:
if Paralyzed("self"): Method Signature:
Boolean Poisoned(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns true if the specified mobile is poisoned.
Example:
if Poisoned("self"): Method Signature:
Void Rehue(System.Object, Int32)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
- hue: Item Hue or -1 for any.
Description:
Rehue an item/mobile the specified hue value, set to 0 to remove. (Experimental)
Example:
Rehue("mount", 1176) Method Signature:
Void RemoveFriend(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Removes a mobile from the friends list, will display target cursor if no serial/alias supplied.
Example:
RemoveFriend() Method Signature:
Boolean SpecialMoveExists(System.String)
- name: Special move name.
Description:
Check for a specific special move
Example:
if SpecialMoveExists("Death Strike"): Method Signature:
Int32 Stam(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns the given mobiles stamina, if parameter is null, then returns the value from the player (parameter can be serial or alias).
Example:
if Stam("self") < 25: Method Signature:
Int32 Str()
Description:
Returns the strength of the player
Example:
if Str() < 100: Method Signature:
Int32 TithingPoints()
Description:
Returns the current players' tithing points.
Example:
if TithingPoints() < 1000: Method Signature:
Boolean UseLayer(System.Object, System.Object)
- layer: String representing a layer, such as "OneHanded" or "Talisman" etc.
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Uses object in the specified layer, optional parameter for mobile
Example:
UseLayer("Talisman") Method Signature:
Boolean War(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Checks whether a mobile is in war mode.
Example:
if War("self"): Method Signature:
Int32 Weight()
Description:
Returns the current weight as as per status bar data.
Example:
if Weight() > 300: Method Signature:
Int32 X(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns X coordinate of given object (parameter can be serial or alias).
Example:
x = X("self") Method Signature:
Int32 Y(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns Y coordinate of given object (parameter can be serial or alias).
Example:
y = Y("self") Method Signature:
Boolean YellowHits(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self".
Description:
Returns true if the specified mobile is yellowhits.
Example:
if YellowHits("self"): Method Signature:
Int32 Z(System.Object)
- obj: An entity serial in integer or hex format, or an alias string such as "self". (Optional)
Description:
Returns Z coordinate of given object (parameter can be serial or alias).
Example:
y = Y("self") - Clumsy
- Identification
- Heal
- Feeblemind
- Weaken
- Magic_Arrow
- Harm
- Fireball
- Greater_Heal
- Lightning
- Mana_Drain