# DataType:spawn Represents an in-game spawn. ## Members | **Type** | **Member** | **Description** | | ---------------------------------------------------------------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **AARank** | AA rank number | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **AFK** | AFK? | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Aggressive** | returns TRUE or FALSE if a mob is aggressive or not | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **Animation** | Current animation ID. See [Animations](/macroquest/general-information/animations.md) for a list of animations. | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Anonymous** | Anonymous | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Assist** | Current Raid or Group assist target? | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Binding** | Binding wounds? | | [*body*](/macroquest/data-types-and-top-level-objects/data-types/datatype-body.md) | **Body** | Body type | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Buyer** | Is a buyer? (ie. Buyer in the bazaar) | | [*cachedbuff*](/macroquest/data-types-and-top-level-objects/data-types/datatype-cachedbuff.md) | **CachedBuff** | Caches buff information cast on others | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **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*](/macroquest/data-types-and-top-level-objects/data-types/datatype-spell.md) | **Casting** | Spell, if currently casting (only accurate on yourself, not NPCs or other group members) | | [*class*](/macroquest/data-types-and-top-level-objects/data-types/datatype-class.md) | **Class** | Class | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **CleanName** | The "cleaned up" name | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **ConColor** | GREY, GREEN, LIGHT BLUE, BLUE, WHITE, YELLOW, RED | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **CurrentEndurance** | Current Endurance points (only updates when target/group) | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **CurrentHPs** | Current hit points | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **CurrentMana** | Current Mana points (only updates when target/group) | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Dead** | Dead? | | [*deity*](/macroquest/data-types-and-top-level-objects/data-types/datatype-deity.md) | **Deity** | Deity | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **DisplayName** | Name displayed in game (same as EQ's %T) | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **Distance** | Distance from player in (x,y) | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **Distance3D** | Distance from player in (x,y,z) in 3D | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **DistanceN** | Distance from player in Y plane (North/South) | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **DistancePredict** | Estimated distance in (x,y), taking into account the spawn's movement speed but not the player's | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **DistanceU** | Distance from player in Z plane (Up/Down) | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **DistanceW** | Distance from player in X plane (East/West) | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **DistanceX** | Distance from player in X plane | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **DistanceY** | Distance from player in Y plane | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **DistanceZ** | Distance from player in Z plane | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Ducking** | Ducking? | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **Equipment** | returns a inttype, it takes numbers 0-8 or names: head chest arms wrists hands legs feet primary offhand | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **EQLoc** | Location using EQ format | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **FeetWet** | Feet wet/swimming? | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Feigning** | Feigning? | | [*spawn*](/macroquest/data-types-and-top-level-objects/data-types/datatype-spawn.md) | **Following** | The spawn a player is following using /follow on - also returns your pet's target via ${Me.Pet.Following} | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Fleeing** | Is your target moving away from you? | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Gender** | Gender | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **GM** | GM or Guide? | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **GroupLeader** | Group leader? | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Guild** | Guild name | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **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*](/macroquest/data-types-and-top-level-objects/data-types/datatype-heading.md) | **Heading** | Heading in this direction | | [*heading*](/macroquest/data-types-and-top-level-objects/data-types/datatype-heading.md) | **HeadingTo** | Heading player must travel in to reach this spawn | | [*heading*](/macroquest/data-types-and-top-level-objects/data-types/datatype-heading.md) | **HeadingToLoc\[**y**,**x**]** | Heading to the coordinates y,x from the spawn | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **Height** | Height | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **Holding** | Represents what the pc/npc is holding | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Hovering** | Hovering? | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **ID** | Spawn ID | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Invis\[ANY\|0]** |

Gives TRUE/FALSE returns. Options are:

| | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Invited** | Invited to group? | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **Level** | Level | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Levitating** | Levitating? | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **LFG** | LFG? | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Light** | Name of the light class this spawn has | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **LineOfSight** | Returns TRUE if spawn is in LoS | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Linkdead** | Linkdead? | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Loc** | Loc of the spawn | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **LocYX** | LocYX of the spawn | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **Look** | Looking this angle | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **Mark** | Current Raid or Group marked npc mark number (raid first) | | [*spawn*](/macroquest/data-types-and-top-level-objects/data-types/datatype-spawn.md) | **Master** | Master, if it is charmed or a pet | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **MaxEndurance** | Maximum Endurance points (only updates when target/group) | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **MaxHPs** | Maximum hit points | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **MaxMana** | Maximum Mana points (only updates when target/group) | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **MaxRange** | The max distance from this spawn for it to hit you | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **MaxRangeTo** | The Max distance from this spawn for you to hit it | | [*spawn*](/macroquest/data-types-and-top-level-objects/data-types/datatype-spawn.md) | **Mount** | Mount | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Moving** | Moving? | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **MQLoc** | Location using MQ format | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Name** | Name | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Named** | Is this a "named" spawn (ie. does it's name not start with an "a" or an "an") | | [*spawn*](/macroquest/data-types-and-top-level-objects/data-types/datatype-spawn.md) | **NearestSpawn\[**search**]** | Find the nearest spawn matching this [Spawn Search](/macroquest/general-information/spawn-search.md), to this spawn (most efficient on yourself) | | [*spawn*](/macroquest/data-types-and-top-level-objects/data-types/datatype-spawn.md) | **NearestSpawn\[**#**,**search**]** | Find the #th nearest spawn matching this [Spawn Search](/macroquest/general-information/spawn-search.md), to this spawn (most efficient on yourself) | | [*spawn*](/macroquest/data-types-and-top-level-objects/data-types/datatype-spawn.md) | **Next** | Next spawn in the list | | [*spawn*](/macroquest/data-types-and-top-level-objects/data-types/datatype-spawn.md) | **Owner** | Owner, if mercenary | | [*spawn*](/macroquest/data-types-and-top-level-objects/data-types/datatype-spawn.md) | **Prev** | Previous spawn in the list | | [*spawn*](/macroquest/data-types-and-top-level-objects/data-types/datatype-spawn.md) | **Pet** | Pet | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **PctHPs** | Percent hit points | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **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 | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **Primary** | Item ID of anything that may be in the Primary slot | | [*race*](/macroquest/data-types-and-top-level-objects/data-types/datatype-race.md) | **Race** | Race | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Roleplaying** | Roleplaying? | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **Secondary** | Item ID of anything that may be in the Secondary slot | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Sitting** | Sitting? | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Sneaking** | Sneaking? | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **Speed** | Speed moving | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Standing** | Standing? | | [*int*](/macroquest/data-types-and-top-level-objects/data-types/datatype-int.md) | **StandState** | StandState | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **State** | STAND, SIT, DUCK, BIND, FEIGN, DEAD, STUN, HOVER, MOUNT, UNKNOWN | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Stunned** | Stunned? | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Stuck** | Stuck? | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Suffix** | Suffix attached to name, eg. of | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Surname** | Last name | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Title** | Prefix/Title before name | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Trader** | Trader? | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **Type** | PC, NPC, Untargetable, Mount, Pet, Corpse, Chest, Trigger, Trap, Timer, Item, Mercenary, Aura, Object, Banner, Campfire, Flyer | | [*bool*](/macroquest/data-types-and-top-level-objects/data-types/datatype-bool.md) | **Underwater** | Underwater? | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **X** | X coordinate | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **Y** | Y coordinate | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **Z** | Z coordinate | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **N** | X, the Northward-positive coordinate | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **W** | Y, the Westward-positive coordinate | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **U** | Z, the Upward-positive coordinate | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **E** | Shortcut for -X (makes Eastward positive) | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **S** | Shortcut for -Y (makes Southward positive) | | [*float*](/macroquest/data-types-and-top-level-objects/data-types/datatype-float.md) | **D** | Shortcut for -Z (makes Downward positive) | | [*string*](/macroquest/data-types-and-top-level-objects/data-types/datatype-string.md) | **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 | ## All members as of 9/22/20 * AARank * AATitle * ActorDef * Address * AFK * Aggressive * Animation * Anonymous * Assist * AssistName * bAlwaysShowAura * bBetaBuffed * BearingToTarget * Binding * Blind * Body * bShowHelm * bStationary * bTempPet * Buyer * bWaitingForPort * CachedBuff * CachedBuffCount * CanSplashLand * Casting * CeilingHeightAtCurrLocation * Class * CleanName * CollisionCounter * CombatSkillTicks * ConColor * ContractorID * CorpseDragCount * CurrentEndurance * CurrentHPs * CurrentMana * D * Dead * Deity * DisplayName * Distance * Distance3D * DistanceN * DistancePredict * DistanceU * DistanceW * DistanceX * DistanceY * DistanceZ * DraggingPlayer * DragNames * Ducking * E * EQLoc * Equipment * FD * FeetWet * Feigning * Fleeing * FloorZ * Following * Gender * GM * GMRank * GroupLeader * Guild * GuildStatus * Heading * HeadingTo * HeadingToLoc * Height * Holding * HoldingAnimation * Hovering * ID * InPvPArea * Invis * Invited * Inviter * IsBerserk * IsPassenger * IsSummoned * LastCastNum * LastCastTime * Levitating * LFG * Light * LineOfSight * Linkdead * Loc * LocYX * LocYXZ * Look * Mark * Master * MaxEndurance * MaxHPs * MaxMana * MaxRange * MaxRangeTo * MercID * Mount * Moving * MQLoc * N * Named * NearestSpawn * Next * Owner * PctEndurance * PctHPs * PctMana * Pet * PlayerState * Prev * Primary * pTouchingSwitch * Race * Roleplaying * S * Secondary * SeeInvis * Sitting * Sneaking * SpawnStatus * Speed * Standing * StandState * State * Stuck * Stunned * Suffix * Surname * Targetable * TargetOfTarget * TimeBeenDead * Title * Trader * Type * U * Underwater * W * WarCry * X * Y * Z ## Usage | **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 | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://macroquest.gitbook.io/macroquest/data-types-and-top-level-objects/data-types/datatype-spawn.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.