EQEMU Quest API: Difference between revisions

From EQArchives
Jump to navigationJump to search
Line 6: Line 6:
! Constant !! Description
! Constant !! Description
|-
|-
| $class || The player's class (i.e. Rogue, Cleric, etc.).  
| $class || The player's class '''Name''' (i.e. Rogue, Cleric, etc.). See also https://docs.eqemu.io/server/player/class-list/
|-
|-
| $faction ||Provides the faction level the player has with the NPC's primary faction.  This will be an integer between 1 (Ally) and 9 (Scowls).  See https://docs.eqemu.io/server/factions/faction-values/
| $faction ||Provides the faction level the player has with the NPC's primary faction.  This will be an integer between 1 (Ally) and 9 (Scowls).  See also https://docs.eqemu.io/server/factions/faction-values/
|-
|-
| $h ||Current heading of mob (i.e. the direction they are facing out of 360 degrees).
| $h ||Current heading of mob (i.e. the direction they are facing out of 360 degrees).
Line 16: Line 16:
| $mname || Mob's (NPC) name
| $mname || Mob's (NPC) name
|-
|-
| $mobid || NPC ID
| $mobid || NPC ID - should line up with the ID in the npc_types table.  See also https://docs.eqemu.io/schema/npcs/npc_types/
|-
|-
| $name || the player's first name
| $name || the player's first name

Revision as of 23:00, 14 June 2023

This will document the Quest API for Perl since that is what is used on EQ Archives. Also see the official EQEMU Quest API docs and Spire Quest API Explorer for latest definitions and Quest examples.

Perl Consts

Mob

Constant Description
$class The player's class Name (i.e. Rogue, Cleric, etc.). See also https://docs.eqemu.io/server/player/class-list/
$faction Provides the faction level the player has with the NPC's primary faction. This will be an integer between 1 (Ally) and 9 (Scowls). See also https://docs.eqemu.io/server/factions/faction-values/
$h Current heading of mob (i.e. the direction they are facing out of 360 degrees).
$mlevel Mob's (NPC) level
$mname Mob's (NPC) name
$mobid NPC ID - should line up with the ID in the npc_types table. See also https://docs.eqemu.io/schema/npcs/npc_types/
$name the player's first name
$race The player's race (i.e. Human, Erudite, etc.).
$status -2 = Banned, -1 = Suspended, 0 = Normal players, and > 1 are privileged users (Guides, GM); see https://docs.eqemu.io/server/player/status-levels/
$ulevel player (user) level
$uguild_id player (user) unique guild identifier in the database (an integer)
$uguildrank
$userid player's unique identifier in the database (an integer)
$x Current x coordinates of mob.
$y Current y coordinates of mob.
$z Current z coordinates of mob.
$bot_id
$bot_owner_char_id
$hpratio
$targetid
$targetname

Zone

$instanceid
$instanceversion
$zonehour
$zoneid
$zoneln
$zonemin
$zonesn
$zonetime
$zoneweather