pa/eqemu-server
2
0
Fork 0
mirror of https://github.com/EQEmu/Server.git synced 2026-03-25 08:32:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated Perl API (markdown)

TurmoilToad 2018-07-19 08:36:47 -04:00
parent 48e311c500
commit 8c34bbbb6c
1 changed files with 87 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

176
Perl-API.md

@ -205,95 +205,93 @@ if ($text!~/Hail|Hi|Hello/i) # Will check if the text does not contain "Hail", "
* A full list can always be found in the EQEmu source [https://github.com/EQEmu/Server/blob/master/zone/embparser.cpp](https://github.com/EQEmu/Server/blob/master/zone/embparser.cpp) * A full list can always be found in the EQEmu source [https://github.com/EQEmu/Server/blob/master/zone/embparser.cpp](https://github.com/EQEmu/Server/blob/master/zone/embparser.cpp)
* Exported variables are sometimes available globally during sub-events, some exported variables are only available in certain sub-events * Exported variables are sometimes available globally during sub-events, some exported variables are only available in certain sub-events
```perl | Exported Variable | Usage |
$activity_id # Returns the ID of the task stage completed (in EVENT_TASK_STAGE_COMPLETE); Returns the ID of the task updated or complete (in EVENT_TASK_COMPLETE, EVENT_TASK_UPDATE) | --- | --- |
$charid # Returns the character ID of the client that triggered the Event or a negative value if no client was involved. | $activity_id | Returns the ID of the task stage completed (in EVENT_TASK_STAGE_COMPLETE); Returns the ID of the task updated or complete (in EVENT_TASK_COMPLETE, EVENT_TASK_UPDATE)
$class # Returns the class of the user that triggered the event. | $charid | Returns the character ID of the client that triggered the Event or a negative value if no client was involved.
$caster_id # Returns the ID of the caster (in EVENT_SPELL_EFFECT_CLIENT, EVENT_SPELL_EFFECT_NPC, EVENT_SPELL_BUFF_TIC_CLIENT, EVENT_SPELL_BUFF_TIC_NPC) | $class | Returns the class of the user that triggered the event.
$combat_state # Returns 1 for starting combat, returns 0 for leaving combat (in EVENT_COMBAT) | $caster_id | Returns the ID of the caster (in EVENT_SPELL_EFFECT_CLIENT, EVENT_SPELL_EFFECT_NPC, EVENT_SPELL_BUFF_TIC_CLIENT, EVENT_SPELL_BUFF_TIC_NPC)
$corpse # Returns the ID of the corpse in which an item was looted (in EVENT_LOOT) | $combat_state | Returns 1 for starting combat, returns 0 for leaving combat (in EVENT_COMBAT)
$donecount # Return the number of hand-ins completed [i.e. 5 of 10 Crushbone Belts, the 5 would be returned] (in EVENT_TASK_COMPLETE, EVENT_TASK_UPDATE) | $corpse | Returns the ID of the corpse in which an item was looted (in EVENT_LOOT)
$doorid # Returns ID of the door clicked (in EVENT_CLICK_DOOR) | $donecount | Return the number of hand-ins completed [i.e. 5 of 10 Crushbone Belts, the 5 would be returned] (in EVENT_TASK_COMPLETE, EVENT_TASK_UPDATE)
$faction # Returns the faction level number of the user with the NPC | $doorid | Returns ID of the door clicked (in EVENT_CLICK_DOOR)
$fished_items # Returns the item ID of fished item (in EVENT_FISH_SUCCESS) | $faction | Returns the faction level number of the user with the NPC
$foraged_item # Returns the item ID of foraged item (in EVENT_FORAGE_SUCCESS) | $fished_items | Returns the item ID of fished item (in EVENT_FISH_SUCCESS)
$grouped # Returns 0 or 1 depending on group status (in EVENT_GROUP_CHANGED) | $foraged_item | Returns the item ID of foraged item (in EVENT_FORAGE_SUCCESS)
$hate_state # Return the state of hate (in EVENT_HATE_LIST) | $grouped | Returns 0 or 1 depending on group status (in EVENT_GROUP_CHANGED)
$hpevent # Returns the value set by quest::setnexthpevent(); | $hate_state | Return the state of hate (in EVENT_HATE_LIST)
$item1 # The item ID in the first slot. | $hpevent | Returns the value set by quest::setnexthpevent();
$item2 # The item ID in the second slot. | $item1 | The item ID in the first slot.
$item3 # The item ID in the third slot. | $item2 | The item ID in the second slot.
$item4 # The item ID in the fourth slot. | $item3 | The item ID in the third slot.
$item1_charges # The number of charges in the first slot. | $item4 | The item ID in the fourth slot.
$item2_charges # The number of charges in the second slot. | $item1_charges | The number of charges in the first slot.
$item3_charges # The number of charges in the third slot. | $item2_charges | The number of charges in the second slot.
$item4_charges # The number of charges in the fourth slot. | $item3_charges | The number of charges in the third slot.
$item1_attuned # The attuned setting in the first slot (1 if attuned, 0 if not attuned). | $item4_charges | The number of charges in the fourth slot.
$item2_attuned # The attuned setting in the second slot (1 if attuned, 0 if not attuned). | $item1_attuned | The attuned setting in the first slot (1 if attuned, 0 if not attuned).
$item3_attuned # The attuned setting in the third slot (1 if attuned, 0 if not attuned). | $item2_attuned | The attuned setting in the second slot (1 if attuned, 0 if not attuned).
$item4_attuned # The attuned setting in the fourth slot (1 if attuned, 0 if not attuned). | $item3_attuned | The attuned setting in the third slot (1 if attuned, 0 if not attuned).
$itemcount{itemid} # $itemcount{1001} would return 2 if the user turned in 2 1001 items. | $item4_attuned | The attuned setting in the fourth slot (1 if attuned, 0 if not attuned).
$itemid # Return the item ID of items used (in EVENT_ITEM_CLICK_CAST, EVENT_ITEM_CLICK) | $itemcount{itemid} | | $itemcount{1001} would return 2 if the user turned in 2 1001 items.
$itemname # Returns the item name of items used (in EVENT_ITEM_CLICK_CAST, EVENT_ITEM_CLICK) | $itemid | Return the item ID of items used (in EVENT_ITEM_CLICK_CAST, EVENT_ITEM_CLICK)
$killed # Returns the NPC id of the npc slain (in EVENT_NPC_SLAY) | $itemname | Returns the item name of items used (in EVENT_ITEM_CLICK_CAST, EVENT_ITEM_CLICK)
$killer_damage # Returns the damage of the mob's killer's killing blow (in EVENT_DEATH, EVENT_DEATH_COMPLETE) | $killed | Returns the NPC id of the npc slain (in EVENT_NPC_SLAY)
$killer_id # Returns the entity ID of a mob's killer (in EVENT_DEATH, EVENT_DEATH_COMPLETE) | $killer_damage | Returns the damage of the mob's killer's killing blow (in EVENT_DEATH, EVENT_DEATH_COMPLETE)
$killer_skill # Returns the skill ID of the mob's killer's killing blow (in EVENT_DEATH, EVENT_DEATH_COMPLETE) | $killer_id | Returns the entity ID of a mob's killer (in EVENT_DEATH, EVENT_DEATH_COMPLETE)
$killer_spell # Returns the spell ID of the mob's killer's spell (in EVENT_DEATH, EVENT_DEATH_COMPLETE) | $killer_skill | Returns the skill ID of the mob's killer's killing blow (in EVENT_DEATH, EVENT_DEATH_COMPLETE)
$hasitem{itemid} # Checks the character's inventory master slots for an item | $killer_spell | Returns the spell ID of the mob's killer's spell (in EVENT_DEATH, EVENT_DEATH_COMPLETE)
$hpevent # Used to identify the HP Event set via quest::setnexthpevent() (in EVENT_HP) | $hasitem{itemid} | Checks the character's inventory master slots for an item
$hpratio # Returns HP Ratio | $hpevent | Used to identify the HP Event set via quest::setnexthpevent() (in EVENT_HP)
$inchpevent # Used potentially for the incoming hp event or next hp event (in EVENT_HP) | $hpratio | Returns HP Ratio
$instanceid # Returns the instance ID of the current zone | $inchpevent | Used potentially for the incoming hp event or next hp event (in EVENT_HP)
$instanceversion # Returns the instance version | $instanceid | Returns the instance ID of the current zone
$langid # Returns the language id the player/npc is currently using. (in EVENT_SAY, EVENT_AGGRO_SAY, EVENT_PROXIMITY_SAY) | $instanceversion | Returns the instance version
$looted_charges # Returns the charges of the looted item (in EVENT_LOOT) | $langid | Returns the language id the player/npc is currently using. (in EVENT_SAY, EVENT_AGGRO_SAY, EVENT_PROXIMITY_SAY)
$looted_id # Returns the ID of the looted item (in EVENT_LOOT) | $looted_charges | Returns the charges of the looted item (in EVENT_LOOT)
$oncursor{itemid} # Checks the character's front item on the cursor for an item | $looted_id | Returns the ID of the looted item (in EVENT_LOOT)
$objectid # Returns the object id of the clicked item (in EVENT_CLICK_OBJECT) | $oncursor{itemid} | Checks the character's front item on the cursor for an item
$mlevel # Returns the level of the mob that the user triggered the Event on. | $objectid | Returns the object id of the clicked item (in EVENT_CLICK_OBJECT)
$mname # Returns the mob's name (returns non-clean, for a clean name use $npc->GetCleanName();). | $mlevel | Returns the level of the mob that the user triggered the Event on.
$mobid # Returns the npc_types ID of the mob that the user triggered the Event on. | $mname | Returns the mob's name (returns non-clean, for a clean name use | $npc->GetCleanName();).
$name # Returns the name of the user that triggered the Event. | $mobid | Returns the npc_types ID of the mob that the user triggered the Event on.
$picked_up_id # Returns the item id picked up (in EVENT_PLAYER_PICKUP) | $name | Returns the name of the user that triggered the Event.
$popupid # Returns the ID of the popup window (in EVENT_POPUPRESPONSE) | $picked_up_id | Returns the item id picked up (in EVENT_PLAYER_PICKUP)
$race # Returns the race of the user that triggered the Event. | $popupid | Returns the ID of the popup window (in EVENT_POPUPRESPONSE)
$raided # Returns 0 or 1 depending on group status (in EVENT_GROUP_CHANGED) | $race | Returns the race of the user that triggered the Event.
$recipe # Returns the ID of the recipe (in EVENT_COMBINE_SUCCESS, EVENT_COMBINE_FAILURE) | $raided | Returns 0 or 1 depending on group status (in EVENT_GROUP_CHANGED)
$signal # Returns the value of a signal sent using quest::signalwith() (in EVENT_SIGNAL) | $recipe | Returns the ID of the recipe (in EVENT_COMBINE_SUCCESS, EVENT_COMBINE_FAILURE)
$slotid # Returns the slot ID of the item used (in EVENT_ITEM_CLICK_CAST, EVENT_ITEM_CLICK) | $signal | Returns the value of a signal sent using quest::signalwith() (in EVENT_SIGNAL)
$spell_id # Returns the ID of the spell cast (in EVENT_CAST, EVENT_CAST_ON, EVENT_CAST_BEGIN) | $slotid | Returns the slot ID of the item used (in EVENT_ITEM_CLICK_CAST, EVENT_ITEM_CLICK)
$status # Returns the account status of the user that triggered the Event. | $spell_id | Returns the ID of the spell cast (in EVENT_CAST, EVENT_CAST_ON, EVENT_CAST_BEGIN)
$target_zone_id # Returns the ID of the zone to enter, such as in casting ports (in EVENT_ZONE) | $status | Returns the account status of the user that triggered the Event.
$targetid # Returns the entity id of the NPC's current (or last) target. | $target_zone_id | Returns the ID of the zone to enter, such as in casting ports (in EVENT_ZONE)
$targetname # Returns the name of the NPC's current (or last) target. | $targetid | Returns the entity id of the NPC's current (or last) target.
$task_id # Returns the task ID of the task accepted (in EVENT_TASKACCEPTED), stage completed (in EVENT_TASK_STAGE_COMPLETE), task failed (in EVENT_TASK_FAIL), task updated or completed (in EVENT_TASK_COMPLETE, EVENT_TASK_UPDATE) | $targetname | Returns the name of the NPC's current (or last) target.
$text # The text sent by players to an NPC (in EVENT_SAY), from an NPC (in EVENT_AGGRO_SAY), spoken by player when nearby the NPC (in EVENT_PROXIMITY_SAY) | $task_id | Returns the task ID of the task accepted (in EVENT_TASKACCEPTED), stage completed (in EVENT_TASK_STAGE_COMPLETE), task failed (in EVENT_TASK_FAIL), task updated or completed (in EVENT_TASK_COMPLETE, EVENT_TASK_UPDATE)
$timer # Returns the value used when creating a timer with quest::settimer() (in EVENT_TIMER) | $text | The text sent by players to an NPC (in EVENT_SAY), from an NPC (in EVENT_AGGRO_SAY), spoken by player when nearby the NPC (in EVENT_PROXIMITY_SAY)
$uguild_id # Returns the ID of the guild of the user that triggered the Event. | $timer | Returns the value used when creating a timer with quest::settimer() (in EVENT_TIMER)
$uguildrank # Returns the guild rank of the user that triggered the Event. | $uguild_id | Returns the ID of the guild of the user that triggered the Event.
$ulevel # Returns the level of the user that triggered the Event. | $uguildrank | Returns the guild rank of the user that triggered the Event.
$userid # Returns the ID of the user that triggered the Event. | $ulevel | Returns the level of the user that triggered the Event.
$version # Returns the version of the door clicked (in EVENT_CLICKDOOR) | $userid | Returns the ID of the user that triggered the Event.
$wp # Returns current waypoint (in EVENT_WAYPOINT_ARRIVE and EVENT_WAYPOINT_DEPART) | $version | Returns the version of the door clicked (in EVENT_CLICKDOOR)
$zonehour # Returns the current in-game hour. | $wp | Returns current waypoint (in EVENT_WAYPOINT_ARRIVE and EVENT_WAYPOINT_DEPART)
$zoneid # Returns the zone id that the Event occured in. | $zonehour | Returns the current in-game hour.
$zoneln # Returns the zone long name that the Event occured in. | $zoneid | Returns the zone id that the Event occured in.
$zonemin # Returns the current in-game minute. | $zoneln | Returns the zone long name that the Event occured in.
$zonesn # Returns the zone short name that the Event occured in. | $zonemin | Returns the current in-game minute.
$zonetime # Returns the current in-game time in HHMM format. | $zonesn | Returns the zone short name that the Event occured in.
$zoneweather # Returns current weather of zone. 0 for none, 1 for rain, 2 for snow. | $zonetime | Returns the current in-game time in HHMM format.
  | $zoneweather | Returns current weather of zone. 0 for none, 1 for rain, 2 for snow.
$copper # Returns the number of copper coins given to the mob. | $copper | Returns the number of copper coins given to the mob.
$silver # Returns the number of silver coins given to the mob. | $silver | Returns the number of silver coins given to the mob.
$gold # Returns the number of gold coins given to the mob. | $gold | Returns the number of gold coins given to the mob.
$platinum # Returns the number of platinum coins given to the mob. | $platinum | Returns the number of platinum coins given to the mob.
  | $x | The X coordinate of the NPC.
$x # The X coordinate of the NPC. | $y | The Y coordinate of the NPC.
$y # The Y coordinate of the NPC. | $z | The Z coordinate of the NPC.
$z # The Z coordinate of the NPC. | $h | The heading of the NPC.
$h # The heading of the NPC.
```
# General Quest API # General Quest API