ApiMobile
Class Description
Section titled “Class Description”Represents a Python-accessible mobile (NPC, creature, or player character).
Inherits entity and positional data from
Properties
Section titled “Properties”Type: ushort
Type: ushort
Type: sbyte
HitsDiff
Section titled “HitsDiff”Type: int
ManaDiff
Section titled “ManaDiff”Type: int
StamDiff
Section titled “StamDiff”Type: int
IsDead
Section titled “IsDead”Type: bool
IsPoisoned
Section titled “IsPoisoned”Type: bool
HitsMax
Section titled “HitsMax”Type: int
Type: int
StaminaMax
Section titled “StaminaMax”Type: int
Stamina
Section titled “Stamina”Type: int
ManaMax
Section titled “ManaMax”Type: int
Type: int
IsRenamable
Section titled “IsRenamable”Type: bool
IsHuman
Section titled “IsHuman”Type: bool
IsYellowHits
Section titled “IsYellowHits”Type: bool
IsHidden
Section titled “IsHidden”Type: bool
IsGargoyle
Section titled “IsGargoyle”Type: bool
IsMounted
Section titled “IsMounted”Type: bool
IsDrivingBoat
Section titled “IsDrivingBoat”Type: bool
IsRunning
Section titled “IsRunning”Type: bool
IsParalyzed
Section titled “IsParalyzed”Type: bool
Direction
Section titled “Direction”Type: string
Get this mobiles direction as a string, for example: “west”, “east”, etc
Notoriety
Section titled “Notoriety”Type: Notoriety
InWarMode
Section titled “InWarMode”Type: bool
Backpack
Section titled “Backpack”Type: ApiItem
Get the mobile’s Backpack item
Type: ApiItem
Get the mobile’s Mount item (if mounted)
__class__
Section titled “__class__”Type: string
The Python-visible class name of this object.
Accessible in Python as obj.__class__ .
No enums found.
Methods
Section titled “Methods”Highlight
Section titled “Highlight”(hue)
Highlight this mobile and all of its equipped items with the given hue.
The original hues are remembered so they can be restored.
Call with None to restore the mobile and its equipped items to their original hues.
Example:
mob.Highlight(0x0021)mob.Highlight(None)Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
hue | ushort? | ✅ Yes | The hue to apply, or null to restore the original hues. |
Return Type: void (Does not return anything)
NameAndProps
Section titled “NameAndProps”(wait, timeout)
Gets the mobile name and properties (tooltip text).
This returns the name and properties in a single string. You can split it by newline if you want to separate them.
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
wait | bool | ✅ Yes | True or false to wait for name and props |
timeout | int | ✅ Yes | Timeout in seconds |
Return Type: string