DataType:mercenary

From the wonderful RedGuides Wiki

This is the type used for mercenaries. If mercenary exists, this type inherits DataType:spawn


This Data Type is referenced in MacroQuest, and accessed by Top-Level Object(s): Mercenary
mercenary is used as a return type by these members:  [ Toggle ]

Page Member Description
character Mercenary Access the mercenary datatype

Members

Type Member Description
int AAPoints AA Points spent on mercenary abilities
Index
StateID Current state ID of the mercenary as a number.
string Name
Stance Current stance of the mercenary
State Current state of the mercenary (returns "DEAD","SUSPENDED","ACTIVE", "NONE", or "UNKNOWN"

Inherits spawn

You may also use members of spawn, shown here: [ Toggle ]

Type Member Description
action DoAssist assists the spawn
DoFace Faces spawn
DoTarget targets spawn
LeftClick left clicks the spawn
RightClick Right clicks the spawn
body Body Body type. See Body types
bool AFK True if AFK
Aggressive returns TRUE or FALSE if a mob is aggressive or not
Anonymous
Assist Current Raid or Group assist target?
Binding Binding wounds?
BodyWet
bShowHelm
BuffsPopulated returns 1 for a empty buff list and a number above 1 if there was some buffs received.
Buyer Are you in buyer mode?
CanSplashLand TRUE/FALSE on if a splash spell can land. This check is ONLY for line of sight to the targetindicator (red/green circle)
Dead
Ducking
FeetWet Feet wet/swimming?
Feigning
Fleeing Is your target moving away from you?
GM GM or Guide?
GroupLeader
HeadWet
Holding Represents what the pc/npc is holding
Hovering
Invis[#|name] No index, 0 and ANY return the same thing. Accepts: NORMAL or 1, UNDEAD or 2, ANIMAL or 3, SOS or 4.
IsSummoned if its a summoned being (pet for example)
IsTouchingSwitch
Levitating
LFG
LineOfSight Returns TRUE if spawn is in LoS
Linkdead
Moving
Named Is this a "named" spawn?
Roleplaying
Sitting
Sneaking
Standing
Stuck
Stunned
Targetable
TemporaryPet A flag indicating a non-permanent pet, like a swarm pet. (?)
Trader Are you in trader mode?
Underwater
cachedbuff Buff[#] Returns the target's spell by buff index number, or the first buff if no Index is provided.
Buff[name] Returns the target's spell name, or the first buff if no Index is provided.
CachedBuff[#|*|^x] Caches buff information cast on others. Index accepts spell ID by default. To accept buffslot (between 1 and 97) prefix with #. The * prefix is for an index, and ^ prefix is a keyword (Slowed Rooted Mezzed Crippled Maloed Tashed Snared and Beneficial).
FindBuff[<term> <option>...] Uses the Buff Find DSL to search for buffs.
MyBuff[#|name]
class Class Returns the class long name
Deity Deity
float CeilingHeightAtCurrLocation
D Negative Z Axis.
Distance Distance from player in (x,y)
Distance3D Distance from player in (x,y,z) in 3D
DistancePredict Estimated distance in (x,y), taking into account the spawn's movement speed but not the player's
DistanceX Alias: DistanceW. Distance from player in X plane (East/West)
DistanceY Alias: DistanceN. Distance from player in Y plane (North/South)
DistanceZ Alias: DistanceU. Distance from player in Z plane (Up/Down)
E Negative X axis
FloorZ
Height
Look Looking this angle
MaxRange The max distance from this spawn for it to hit you
MaxRangeTo The Max distance from this spawn for you to hit it
S Negative Y Axis.
Speed
X Alias: W. Returns X axis.
Y Alias: N. Y Axis.
Z Alias: U. Z Axis.
heading Heading Heading in this direction
HeadingTo Heading player must travel in to reach this spawn
HeadingToLoc[y,x] Heading to the coordinates y,x from the spawn
int AARank AA rank number
Animation Current animation ID. See Animations for a list.
Blind
BuffCount Returns the number of buffs on the target.
CachedBuffCount returns -1 if no buffs are cached for the spawn or number of buffs cached.
CombatSkillTicks[#]
ContractorID
CorpseDragCount
CurrentEndurance Current Endurance points (only updates when target/group)
CurrentMana Current Mana points (only updates when target/group)
Equipment[#|name] Takes numbers 0-8 or names: head chest arms wrists hands legs feet primary offhand
GMRank
HoldingAnimation
ID Returns the ID number of the spawn.
InPvPArea
Level
Mark Current Raid or Group marked npc mark number (raid first)
MaxEndurance Maximum Endurance points (only updates when target/group)
MaxMana Maximum Mana points (only updates when target/group)
MercID
MyBuffCount
PctEndurance
PctMana
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
Primary Item ID of anything that may be in the Primary slot
Secondary Item ID of anything that may be in the Secondary slot
SeeInvis[#]
SpawnStatus[#]
StandState
int64 CurrentHPs
MaxHPs
PctHPs Percent hit points
pet Pet
race Race
spawn Following The spawn a player is following using /follow on.
Master Master, if it is charmed or a pet
Mount
NearestSpawn[#, <name>] Find the #th nearest spawn matching this Spawn search to this spawn (most efficient on yourself)
NearestSpawn[<name>] Find the nearest spawn matching this Spawn search to this spawn (most efficient on yourself)
Next Next spawn in the list
Owner Owner, if mercenary
Prev Previous spawn in the list
TargetOfTarget
spell Casting Spell, if currently casting (only accurate on yourself, not NPCs or other group members)
string ActorDef
AssistName
CleanName
ConColor GREY, GREEN, LIGHT BLUE, BLUE, WHITE, YELLOW, RED
DisplayName Name displayed in game (same as EQ's %T)
EQLoc Location using EQ format
Gender
Guild Guild name
Light Name of the light class this spawn has
Loc location of the spawn
LocYX LocYX of the spawn
LocYXZ LocYXZ of the spawn
MQLoc Location using MQ format
Name
State STAND, SIT, DUCK, BIND, FEIGN, DEAD, STUN, HOVER, MOUNT, UNKNOWN
Suffix Suffix attached to name, eg. Billy Bob of Tunare
Surname Last name
Title Alias: AATitle. Prefix/Title before name.
Type Returns PC, NPC, Untargetable, Mount, Pet, Corpse, Chest, Trigger, Trap, Timer, Item, Mercenary, Aura, Object, Banner, Campfire, Flyer
timestamp BuffDuration[#|name] Returns the duration remaining on this target buff
MyBuffDuration[#|name] returns your buffs duration on the target.
TimeBeenDead

Examples

  • Check on if you have an active mercenary, mercenary is a cleric, and if it's stance is NOT reactive.... then change it TO reactive.
/if (${Mercenary.State.Equal[ACTIVE]} && ${Mercenary.Class.Name.Equal[Cleric]} && ${Mercenary.Stance.NotEqual[REACTIVE]}) {
     /stance reactive
 }
  • True if Merc is suspended

/echo ${Mercenary.State.Equal[SUSPENDED]}

See also