From 9cac2c9266d510c7c7f31b6f53cab1cc0cda5858 Mon Sep 17 00:00:00 2001 From: TurmoilToad Date: Sat, 22 Dec 2018 11:08:41 -0500 Subject: [PATCH] clearspawntimers, collectitems, completedtasksinset, createBot, createdoor --- Perl-API.md | 102 +++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 97 insertions(+), 5 deletions(-) diff --git a/Perl-API.md b/Perl-API.md index 622a991..6e23838 100644 --- a/Perl-API.md +++ b/Perl-API.md @@ -1272,14 +1272,106 @@ sub EVENT_ENTER { quest::clear_zone_flag(128); ``` +### clearspawntimers + +      **Parameter(s):** + +      None. + +      **Usage:** + +      Used to reset the spawn timers and repop a zone--similar to #repop force. + +      **Example:** + +```perl +quest::repopzone(); +``` + +## collectitems + +      **Parameter(s):** + +      item_id _(int)_, remove_item = true _(bool)_ + +      **Usage:** + +      Returns the number of items by ID that exist in inventory. If remove is true, items are removed as they are counted. + +      **Example:** + +```perl +sub EVENT_SAY { + #:: Match text for "hail", case insensitive, and the client that triggered the event has a 1001 - Cloth Cap + if ($text=~/hail/i && plugin::check_hasitem($client, 1001)) { + quest::emote("steals your cloth cap.") + quest::collectitems(1001, 1); + } +} +``` + +## completedtasksinset + +      **Parameter(s):** + +      task_set _(int)_ + +      **Usage:** + +      Returns the number of tasks in the given Task Set that the player has completed. + +      **Example:** + +```perl +sub EVENT_SAY { + #:: Match text for "tasks", case insensitive + if ($text=~/tasks/i) { + #:: Create a scalar variable to store the count of completed tasks in task set "200" + my $TasksComplete = quest::completedtasksinset(200); #:: Returns int + quest::say("You have completed $TasksComplete tasks."); + } +} +``` + +## createBot + +      **Parameter(s):** + +      first_name _(string)_, last_name _(string)_, level _(int)_, race_id _(int)_, class_id _(int)_, gender_id _(int)_ + +      **Usage:** + +      Used to create a bot with the given parameters. + +      **Example:** + +```perl +sub EVENT_ENTERZONE { + #:: Create a bot named Leroy Jenkins, who is level 50, Human, Paladin, Male + quest::createBot("Leroy", "Jenkins", 50, 1, 3, 0); +} +``` + +## createdoor + +      **Parameter(s):** + +      model_name _(string)_, x _(float)_, y _(float)_, z _(float)_, heading _(float)_, object_type = 58 _(int)_, size = 100 _(int)_ + +      **Usage:** + +      Creates a new door, with type 58 and size 100 as the defaults. + +      **Example:** + +```perl +quest::createdoor("POKTELE500", -582.532, 2324.96, -47.8143, 120, 58, 100); +``` + + (Work in Progress) ```perl -quest::clearspawntimers() -quest::collectitems(int item_id, [bool remove_item = true]) -quest::completedtasksinset(int task_set) -quest::createBot(string first_name, string last_name, int level, int race_id, int class_id, int gender_id) -quest::createdoor(string model_name, float x, float y, float z, float heading, [int object_type = 58], [int size = 100]) quest::creategroundobject(int item_id, float x, float y, float z, float heading, [uint32 decay_time-ms = 300000]) quest::creategroundobjectfrommodel(string model_name, float x, float y, float z, float heading, [int object_type], [uint32 decay_time-ms = 300000]) quest::createguild(string guild_name, string leader_name)