spawn
¶
Represents an in-game spawn.
Members¶
Type | Member | Description |
---|---|---|
int | AARank | AA rank number |
AATitle | ||
ActorDef | ||
bool | AFK | AFK? |
bool | Aggressive | returns TRUE or FALSE if a mob is aggressive or not |
int | Animation | Current animation ID. See Animations for a list of animations. |
bool | Anonymous | Anonymous |
bool | Assist | Current Raid or Group assist target? |
bool | Binding | Binding wounds? |
Blind | ||
body | Body | Body type |
BodyWet | ||
bShowHelm | ||
Buff | ||
BuffCount | ||
BuffDuration | ||
BuffsPopulated | ||
bool | Buyer | Is a buyer? (ie. Buyer in the bazaar) |
cachedbuff | CachedBuff | Caches buff information cast on others |
CachedBuffCount | ||
bool | CanSplashLand | TRUE/FALSE on if a splash spell can land... Note: This check is ONLY for line of sight to the targetindicator (red/green circle) |
spell | Casting | Spell, if currently casting (only accurate on yourself, not NPCs or other group members) |
CeilingHeightAtCurrLocation | ||
class | Class | Class |
string | CleanName | The "cleaned up" name |
CombatSkillTicks | ||
string | ConColor | GREY, GREEN, LIGHT BLUE, BLUE, WHITE, YELLOW, RED |
ContractorID | ||
int | CurrentEndurance | Current Endurance points (only updates when target/group) |
int64 | CurrentHPs | Current hit points |
int | CurrentMana | Current Mana points (only updates when target/group) |
bool | Dead | Dead? |
deity | Deity | Deity |
string | DisplayName | Name displayed in game (same as EQ's %T) |
float | Distance | Distance from player in (x,y) |
float | Distance3D | Distance from player in (x,y,z) in 3D |
float | DistanceN | Distance from player in Y plane (North/South) |
float | DistancePredict | Estimated distance in (x,y), taking into account the spawn's movement speed but not the player's |
float | DistanceU | Distance from player in Z plane (Up/Down) |
float | DistanceW | Distance from player in X plane (East/West) |
float | DistanceX | Distance from player in X plane |
float | DistanceY | Distance from player in Y plane |
float | DistanceZ | Distance from player in Z plane |
bool | Ducking | Ducking? |
float | EQLoc | Location using EQ format |
int | Equipment | returns a inttype, it takes numbers 0-8 or names: head chest arms wrists hands legs feet primary offhand |
bool | FeetWet | Feet wet/swimming? |
bool | Feigning | Feigning? |
FindBuff | ||
bool | Fleeing | Is your target moving away from you? |
FloorZ | ||
spawn | Following | The spawn a player is following using /follow on - also returns your pet's target via ${Me.Pet.Following} |
string | Gender | Gender |
bool | GM | GM or Guide? |
GMRank | ||
bool | GroupLeader | Group leader? |
string | Guild | Guild name |
string | GuildStatus | Guild status (Leader, Officer, Member) NOTE GuildStatus is no longer present in BETA/TEST/LIVE versions and only available in UF and ROF EMU builds. |
heading | Heading | Heading in this direction |
heading | HeadingTo | Heading player must travel in to reach this spawn |
heading | HeadingToLoc[ y, x ] | Heading to the coordinates y,x from the spawn |
HeadWet | ||
float | Height | Height |
bool | Holding | Is the spawn holding an item? |
HoldingAnimation | ||
bool | Hovering | Hovering? |
int | ID | Spawn ID |
InPvPArea | ||
bool | Invis[ANY | 0 ] | Gives TRUE/FALSE returns. Options are:
|
IsSummoned | ||
IsTouchingSwitch | ||
int | Level | Level |
bool | Levitating | Levitating? |
bool | LFG | LFG? |
string | Light | Name of the light class this spawn has |
bool | LineOfSight | Returns TRUE if spawn is in LoS |
bool | Linkdead | Linkdead? |
string | Loc | Loc of the spawn |
string | LocYX | LocYX of the spawn |
LocYXZ | ||
float | Look | Looking this angle |
int | Mark | Current Raid or Group marked npc mark number (raid first) |
spawn | Master | Master, if it is charmed or a pet |
int | MaxEndurance | Maximum Endurance points (only updates when target/group) |
int64 | MaxHPs | Maximum hit points |
int | MaxMana | Maximum Mana points (only updates when target/group) |
float | MaxRange | The max distance from this spawn for it to hit you |
float | MaxRangeTo | The Max distance from this spawn for you to hit it |
MercID | ||
spawn | Mount | Mount |
bool | Moving | Moving? |
float | MQLoc | Location using MQ format |
MyBuff | ||
MyBuffCount | ||
MyBuffDuration | ||
string | Name | Name |
bool | Named | Is this a "named" spawn (ie. does it's name not start with an "a" or an "an") |
spawn | NearestSpawn[ search ] | Find the nearest spawn matching this Spawn Search, to this spawn (most efficient on yourself) |
spawn | NearestSpawn[ #, search ] | Find the #th nearest spawn matching this Spawn Search, to this spawn (most efficient on yourself) |
spawn | Next | Next spawn in the list |
spawn | Owner | Owner, if mercenary |
int64 | PctHPs | Percent hit points |
PctMana | ||
spawn | Pet | Pet |
int | PlayerState | returns a mask as an inttype which has the following meaning: 0=Idle 1=Open 2=WeaponSheathed 4=Aggressive 8=ForcedAggressive 0x10=InstrumentEquipped 0x20=Stunned 0x40=PrimaryWeaponEquipped 0x80=SecondaryWeaponEquipped |
spawn | Prev | Previous spawn in the list |
int | Primary | Item ID of anything that may be in the Primary slot |
race | Race | Race |
bool | Roleplaying | Roleplaying? |
int | Secondary | Item ID of anything that may be in the Secondary slot |
SeeInvis | ||
bool | Sitting | Sitting? |
bool | Sneaking | Sneaking? |
SpawnStatus | ||
float | Speed | Speed moving |
bool | Standing | Standing? |
int | StandState | StandState |
string | State | STAND, SIT, DUCK, BIND, FEIGN, DEAD, STUN, HOVER, MOUNT, UNKNOWN |
bool | Stuck | Stuck? |
bool | Stunned | Stunned? |
string | Suffix | Suffix attached to name, eg. of |
string | Surname | Last name |
Targetable | ||
TargetOfTarget | ||
TemporaryPet | ||
TimeBeenDead | ||
string | Title | Prefix/Title before name |
bool | Trader | Trader? |
string | Type | PC, NPC, Untargetable, Mount, Pet, Corpse, Chest, Trigger, Trap, Timer, Item, Mercenary, Aura, Object, Banner, Campfire, Flyer |
bool | Underwater | Underwater? |
float | X | X coordinate |
float | Y | Y coordinate |
float | Z | Z coordinate |
float | N | X, the Northward-positive coordinate |
float | W | Y, the Westward-positive coordinate |
float | U | Z, the Upward-positive coordinate |
float | E | Shortcut for -X (makes Eastward positive) |
float | S | Shortcut for -Y (makes Southward positive) |
float | D | Shortcut for -Z (makes Downward positive) |
string | To String | Same as Name |
Methods¶
Name | Action |
---|---|
DoAssist | assists the spawn |
DoFace | Faces target |
DoTarget | Targets the spawn |
LeftClick | left clicks the spawn |
RightClick | Right clicks the spawn |
Examples¶
Example | Output |
---|---|
${Pet.Equipment[primary].ID} |
ID number of the pet's primary weapon |
${Group.Member[mymagesname].Pet.Equipment[primary].ID} |
ID number of the group member's pet's primary weapon |