From e1b6d69ed2325d8ce0ad5272287da644ab2aee5e Mon Sep 17 00:00:00 2001 From: Alex Date: Mon, 21 Jan 2019 19:30:32 -0500 Subject: [PATCH] Updated Perl API Quest API (markdown) --- Perl-API---Quest-API.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/Perl-API---Quest-API.md b/Perl-API---Quest-API.md index d406970..3e81378 100644 --- a/Perl-API---Quest-API.md +++ b/Perl-API---Quest-API.md @@ -104,6 +104,7 @@ [quest::follow(entity_id, distance)](#follow) | _int_ [quest::forcedoorclose(door_id, alt_mode)](#forcedoorclose) | _multiple_ [quest::forcedooropen(door_id, alt_mode)](#forcedooropen) | _int_ +[quest::get_rule(rule_name)](#getrule) | _string_ [quest::get_spawn_condition(zone_short, instance_id, condition_id)](#get_spawn_condition) | _multiple_ [quest::getguildnamebyid(guild_id)](#getguildnamebyid) | _uint32_ [quest::getlevel(type)](#getlevel) | _int_ @@ -2027,6 +2028,25 @@ quest::forcedoorclose(31); quest::forcedooropen(31); ``` +## get_rule +      **Parameter(s):** + +      rule_name _(string)_ + +      **Usage:** + +      Returns the value of the specified rule for the zone you're in. + +      **Example:** + +```perl +#:: Get the rule value for rule "Zone:UseZoneController" +sub EVENT_SAY { + if ($text=~/Hail/i) { + plugin::Whisper(quest::get_rule("Zone:UseZoneController")); #:: Whispers rule value to client. + } +}``` + ## get_spawn_condition       **Parameter(s):** @@ -3361,6 +3381,16 @@ sub EVENT_HP { } ``` +## set_rule +      **Parameter(s):** + +      rule_name _(string)_, rule_value _(string)_ + +      **Usage:** + +      Used to set the specified [Rule](https://github.com/EQEmu/Server/wiki/Server-Rules) to the specified value. + + ## setskill       **Parameter(s):**