Updated Perl General Functions (markdown)

Perl-General-Functions.md

@@ -1,219 +1,220 @@
+Perl general functions are wrapped within the quest type.
 
 ```
-void Client::new()
+void quest::Client::new()
-void NPC::new()
+void quest::NPC::new()
-void EntityList::new()
+void quest::EntityList::new()
-void QuestItem::new()
+void quest::QuestItem::new()
-void MobList::new()
+void quest::MobList::new()
-void echo(int color_id, string message)
+void quest::echo(int color_id, string message)
-void say(string message, int language_id)
+void quest::say(string message, int language_id)
-void summonitem(int item_id, int charges)
+void quest::summonitem(int item_id, int charges)
-void write(string file, string message)
+void quest::write(string file, string message)
-void spawn(int npc_type_id, int grid_id, int int_unused, float x, float y, float z)
+uint quest::spawn(int npc_type_id, int grid_id, int int_unused, float x, float y, float z)
-void spawn2(int npc_type_id, int grid_id, int int_unused, float x, float y, float z, float heading)
+uint quest::spawn2(int npc_type_id, int grid_id, int int_unused, float x, float y, float z, float heading)
-void unique_spawn(int npc_type_id, int grid_id, int int_unused, float x, float y, float z, float heading)
+uint quest::unique_spawn(int npc_type_id, int grid_id, int int_unused, float x, float y, float z, float heading)
-void spawn_from_spawn2()
+uint quest::spawn_from_spawn2()
-void enable_spawn2()
+void quest::enable_spawn2()
-void disable_spawn2()
+void quest::disable_spawn2()
-void setstat(int stat_id, int int_value)
+void quest::setstat(int stat_id, int int_value)
-void incstat(int stat_id, int int_value)
+void quest::incstat(int stat_id, int int_value)
-void castspell(int spell_id, int target_id)
+void quest::castspell(int spell_id, int target_id)
-void selfcast()
+void quest::selfcast()
-void addloot(int item_id, int charges)
+void quest::addloot(int item_id, int charges)
-void zone()
+void quest::zone()
-void settimer(string timer_name, int seconds)
+void quest::settimer(string timer_name, int seconds)
-void settimerMS(string timer_name, int milliseconds)
+void quest::settimerMS(string timer_name, int milliseconds)
-void stoptimer()
+void quest::stoptimer()
-void stopalltimers()
+void quest::stopalltimers()
-void emote()
+void quest::emote()
-void shout()
+void quest::shout()
-void shout2()
+void quest::shout2()
-void gmsay(string message, int color_id, bool send_to_world)
+void quest::gmsay(string message, int color_id, bool send_to_world)
-void depop()
+void quest::depop()
-void depop_withtimer()
+void quest::depop_withtimer()
-void depopall()
+void quest::depopall()
-void settarget(string target_enum, int target_id)
+void quest::settarget(string target_enum, int target_id)
-void follow(int entity_id, int distance)
+void quest::follow(int entity_id, int distance)
-void sfollow()
+void quest::sfollow()
-void changedeity()
+void quest::changedeity()
-void exp()
+void quest::exp()
-void level()
+void quest::level()
-void traindisc()
+void quest::traindisc()
-void isdisctome()
+bool quest::isdisctome()
-void safemove()
+void quest::safemove()
-void rain()
+void quest::rain()
-void snow()
+void quest::snow()
-void surname()
+void quest::surname()
-void permaclass()
+void quest::permaclass()
-void permarace()
+void quest::permarace()
-void permagender()
+void quest::permagender()
-void scribespells(int max_level, int min_level)
+uint quest::scribespells(int max_level, int min_level)
-void traindiscs(int max_level, int min_level)
+uint quest::traindiscs(int max_level, int min_level)
-void unscribespells()
+void quest::unscribespells()
-void untraindiscs()
+void quest::untraindiscs()
-void givecash(int copper, int silver, int gold, int platinum)
+void quest::givecash(int copper, int silver, int gold, int platinum)
-void pvp()
+void quest::pvp()
-void movepc(int zone_id, float x, float y, float z, float heading)
+void quest::movepc(int zone_id, float x, float y, float z, float heading)
-void gmmove(float x, float y, float z)
+void quest::gmmove(float x, float y, float z)
-void movegrp(int zone_id, float x, float y, float z)
+void quest::movegrp(int zone_id, float x, float y, float z)
-void doanim()
+void quest::doanim()
-void addskill(int skill_id, int int_value)
+void quest::addskill(int skill_id, int int_value)
-void setlanguage(int skill_id, int int_value)
+void quest::setlanguage(int skill_id, int int_value)
-void setskill(int skill_id, int int_value)
+void quest::setskill(int skill_id, int int_value)
-void setallskill()
+void quest::setallskill()
-void attack()
+void quest::attack()
-void attacknpc()
+void quest::attacknpc()
-void attacknpctype()
+void quest::attacknpctype()
-void save()
+void quest::save()
-void faction(int faction_id, int int_value, int temp)
+void quest::faction(int faction_id, int int_value, int temp)
-void setsky()
+void quest::setsky()
-void setguild(unsigned long new_guild_id, int guild_rank_id)
+void quest::setguild(unsigned long new_guild_id, int guild_rank_id)
-void createguild(string guild_name, string leader_name)
+void quest::createguild(string guild_name, string leader_name)
-void settime(int new_hour, int new_min, int update_world)
+void quest::settime(int new_hour, int new_min, int update_world)
-void itemlink()
+void quest::itemlink()
-void signalwith(int npc_id, int signal_id, int wait_ms)
+void quest::signalwith(int npc_id, int signal_id, int wait_ms)
-void signal(int npc_id, int wait_ms)
+void quest::signal(int npc_id, int wait_ms)
-void setglobal(string key, string str_value, int options, int duration)
+void quest::setglobal(string key, string str_value, int options, int duration)
-void targlobal(string key, string str_value, int duration, int npc_id, int char_id, int zone_id)
+void quest::targlobal(string key, string str_value, int duration, int npc_id, int char_id, int zone_id)
-void delglobal()
+void quest::delglobal()
-void ding()
+void quest::ding()
-void rebind(int zone_id, float x, float y, float z)
+void quest::rebind(int zone_id, float x, float y, float z)
-void start()
+void quest::start()
-void stop()
+void quest::stop()
-void pause()
+void quest::pause()
-void moveto(float x, float y, float z, float heading, bool saveguard)
+void quest::moveto(float x, float y, float z, float heading, bool saveguard)
-void resume()
+void quest::resume()
-void addldonpoints(long points, int theme_id)
+void quest::addldonpoints(long points, int theme_id)
-void addldonwin(long wins, int theme_id)
+void quest::addldonwin(long wins, int theme_id)
-void addldonloss(long losses, int theme_id)
+void quest::addldonloss(long losses, int theme_id)
-void setnexthpevent()
+void quest::setnexthpevent()
-void setnextinchpevent()
+void quest::setnextinchpevent()
-void sethp()
+void quest::sethp()
-void respawn(int npc_type_id, int grid_id)
+void quest::respawn(int npc_type_id, int grid_id)
-void ChooseRandom()
+void quest::ChooseRandom()
-void set_proximity(float min_x, float max_x, float min_y, float max_y, float min_z, float max_z)
+void quest::set_proximity(float min_x, float max_x, float min_y, float max_y, float min_z, float max_z)
-void clear_proximity()
+void quest::clear_proximity()
-void enable_proximity_say()
+void quest::enable_proximity_say()
-void disable_proximity_say()
+void quest::disable_proximity_say()
 void quest::setanim(int npc_type_id, int anim_num)
 void quest::showgrid()
-void spawn_condition(string zone_short, int instance_id, int condition_id, int int_value)
+void quest::spawn_condition(string zone_short, int instance_id, int condition_id, int int_value)
-void get_spawn_condition(string zone_short, int instance_id, int condition_id)
+uint quest::get_spawn_condition(string zone_short, int instance_id, int condition_id)
-void toggle_spawn_event(uint event_id, bool is_enabled, bool is_strict, bool reset_base)
+void quest::toggle_spawn_event(uint event_id, bool is_enabled, bool is_strict, bool reset_base)
-void has_zone_flag()
+uint quest::has_zone_flag()
-void set_zone_flag()
+void quest::set_zone_flag()
-void clear_zone_flag()
+void quest::clear_zone_flag()
-void summonburiedplayercorpse(int char_id, float dest_x, float dest_y, float dest_z, float dest_heading)
+bool quest::summonburiedplayercorpse(int char_id, float dest_x, float dest_y, float dest_z, float dest_heading)
-void summonallplayercorpses(int char_id, float dest_x, float dest_y, float dest_z, float dest_heading)
+bool quest::summonallplayercorpses(int char_id, float dest_x, float dest_y, float dest_z, float dest_heading)
-void getplayerburiedcorpsecount()
+uint quest::getplayerburiedcorpsecount()
-void buryplayercorpse()
+uint quest::buryplayercorpse()
-void forcedooropen(int door_id, bool alt_mode)
+void quest::forcedooropen(int door_id, bool alt_mode)
-void forcedoorclose(int door_id, bool alt_mode)
+void quest::forcedoorclose(int door_id, bool alt_mode)
-void toggledoorstate()
+void quest::toggledoorstate()
-void isdooropen()
+uint quest::isdooropen()
-void depopzone()
+void quest::depopzone()
-void repopzone()
+void quest::repopzone()
-void ConnectNodeToNode(int node1, int node2, int teleport, uint doorid)
+void quest::ConnectNodeToNode(int node1, int node2, int teleport, uint doorid)
-void AddNode(float x, float y, float z, float best_z, int requested_id)
+void quest::AddNode(float x, float y, float z, float best_z, int requested_id)
-void npcrace()
+void quest::npcrace()
-void npcgender()
+void quest::npcgender()
-void npcsize()
+void quest::npcsize()
-void npctexture()
+void quest::npctexture()
-void playerrace()
+void quest::playerrace()
-void playergender()
+void quest::playergender()
-void playersize()
+void quest::playersize()
-void playertexture()
+void quest::playertexture()
-void playerfeature(string str_value, int int_value)
+void quest::playerfeature(string str_value, int int_value)
-void npcfeature(string str_value, int int_value)
+uint quest::npcfeature(string str_value, int int_value)
-void createBot(string firstname, string lastname, int level, int race_id, int class_id, int gender_id)
+uint quest::createBot(string firstname, string lastname, int level, int race_id, int class_id, int gender_id)
-void taskselector(int task_id1, int task_id2, int task_id%i)
+void quest::taskselector(int task_id1, int task_id2, int task_id%i)
-void task_setselector()
+void quest::task_setselector()
-void enabletask(int task_id1, int task_id2, int task_id10)
+void quest::enabletask(int task_id1, int task_id2, int task_id10)
-void disabletask(int task_id1, int task_id2, int task_id10)
+void quest::disabletask(int task_id1, int task_id2, int task_id10)
-void istaskenabled()
+uint quest::istaskenabled()
-void istaskactive()
+uint quest::istaskactive()
-void istaskactivityactive(uint task_id, uint activity_id)
+uint quest::istaskactivityactive(uint task_id, uint activity_id)
-void gettaskactivitydonecount(uint task_id, uint activity_id)
+void quest::gettaskactivitydonecount(uint task_id, uint activity_id)
-void updatetaskactivity(uint task_id, uint activity_id, int count, bool ignore_quest_update)
+void quest::updatetaskactivity(uint task_id, uint activity_id, int count, bool ignore_quest_update)
-void resettaskactivity(uint task_id, uint activity_id)
+void quest::resettaskactivity(uint task_id, uint activity_id)
-void taskexplorearea()
+void quest::taskexplorearea()
-void assigntask(uint task_id, bool enforce_level_requirement)
+void quest::assigntask(uint task_id, bool enforce_level_requirement)
-void failtask()
+void quest::failtask()
-void tasktimeleft()
+int quest::tasktimeleft()
-void istaskcompleted()
+int quest::istaskcompleted()
-void enabledtaskcount()
+int quest::enabledtaskcount()
-void firsttaskinset()
+int quest::firsttaskinset()
-void lasttaskinset()
+int quest::lasttaskinset()
-void nexttaskinset(int task_set, uint task_id)
+int quest::nexttaskinset(int task_set, uint task_id)
-void activespeaktask()
+int quest::activespeaktask()
-void activespeakactivity()
+int quest::activespeakactivity()
-void activetasksinset()
+int quest::activetasksinset()
-void completedtasksinset()
+int quest::completedtasksinset()
-void istaskaappropriate()
+uint quest::istaskaappropriate()
-void popup(string window_title, string message, int popup_id, int buttons, int duration)
+void quest::popup(string window_title, string message, int popup_id, int buttons, int duration)
-void clearspawntimers()
+void quest::clearspawntimers()
-void ze(int channel_id, string message)
+void quest::ze(int channel_id, string message)
-void we(int channel_id, string message)
+void quest::we(int channel_id, string message)
-void getlevel()
+uint quest::getlevel()
-void creategroundobject(int item_id, float x, float y, float z, float heading, int decay_time)
+void quest::creategroundobject(int item_id, float x, float y, float z, float heading, int decay_time)
-void creategroundobjectfrommodel(string modelname, float x, float y, float z, float heading, int object_type, int decay_time)
+void quest::creategroundobjectfrommodel(string modelname, float x, float y, float z, float heading, int object_type, int decay_time)
-void createdoor(string modelname, float x, float y, float z, float heading, int object_type, int size)
+void quest::createdoor(string modelname, float x, float y, float z, float heading, int object_type, int size)
-void ModifyNPCStat(int stat_id, string str_value)
+void quest::ModifyNPCStat(int stat_id, string str_value)
-void collectitems(int item_id, bool remove_item)
+void quest::collectitems(int item_id, bool remove_item)
-void UpdateSpawnTimer(uint spawn2_id, uint updated_time_till_repop)
+void quest::UpdateSpawnTimer(uint spawn2_id, uint updated_time_till_repop)
-void MerchantSetItem(int npc_id, int item_id, int quantity)
+void quest::MerchantSetItem(int npc_id, int item_id, int quantity)
-void MerchantCountItem(int npc_id, int item_id)
+void quest::MerchantCountItem(int npc_id, int item_id)
-void varlink()
+string quest::varlink()
-void CreateInstance(string zone_name, int version, int duration)
+void quest::CreateInstance(string zone_name, int version, int duration)
-void DestroyInstance()
+void quest::DestroyInstance()
-void UpdateInstanceTimer(int instance_id, int duration)
+void quest::UpdateInstanceTimer(int instance_id, int duration)
-void GetInstanceTimer()
+void quest::GetInstanceTimer()
-void GetInstanceTimerByID()
+void quest::GetInstanceTimerByID()
-void GetInstanceID(string zone_name, int version)
+void quest::GetInstanceID(string zone_name, int version)
-void GetCharactersInInstance()
+string quest::GetCharactersInInstance()
-void AssignToInstance()
+void quest::AssignToInstance()
-void AssignGroupToInstance()
+void quest::AssignGroupToInstance()
-void AssignRaidToInstance()
+void quest::AssignRaidToInstance()
-void RemoveFromInstance()
+void quest::RemoveFromInstance()
-void RemoveAllFromInstance()
+void quest::RemoveAllFromInstance()
-void MovePCInstance(int zone_id, int instance_id, float x, float y, float z, float heading)
+void quest::MovePCInstance(int zone_id, int instance_id, float x, float y, float z, float heading)
-void FlagInstanceByGroupLeader(uint zone, int version)
+void quest::FlagInstanceByGroupLeader(uint zone, int version)
-void FlagInstanceByRaidLeader(uint zone, int version)
+void quest::FlagInstanceByRaidLeader(uint zone, int version)
-void saylink(string message, bool silent, string link_name)
+string quest::saylink(string message, bool silent, string link_name)
-void getguildnamebyid()
+string quest::getguildnamebyid()
-void SetRunning()
+void quest::SetRunning()
-void IsRunning()
+uint quest::IsRunning()
-void IsEffectInSpell(uint spell_id, int effect_id)
+uint quest::IsEffectInSpell(uint spell_id, int effect_id)
-void IsBeneficialSpell()
+uint quest::IsBeneficialSpell()
-void GetSpellResistType()
+void quest::GetSpellResistType()
-void GetSpellTargetType()
+void quest::GetSpellTargetType()
-void FlyMode()
+void quest::FlyMode()
-void factionvalue()
+void quest::factionvalue()
-void enabletitle()
+void quest::enabletitle()
-void checktitle()
+bool quest::checktitle()
-void removetitle()
+void quest::removetitle()
-void wearchange(uint slot, int texture_id, int hero_forge_model_id, int elite_material_id)
+void quest::wearchange(uint slot, int texture_id, int hero_forge_model_id, int elite_material_id)
-void voicetell(string client_name, int macro_id, int race_id, int gender_id)
+void quest::voicetell(string client_name, int macro_id, int race_id, int gender_id)
-void LearnRecipe()
+void quest::LearnRecipe()
-void SendMail(string to, string from, string subject, string message)
+void quest::SendMail(string to, string from, string subject, string message)
-void GetZoneID()
+void quest::GetZoneID()
-void GetZoneLongName()
+string quest::GetZoneLongName()
-void GetTimeSeconds()
+void quest::GetTimeSeconds()
-void crosszonesignalclientbychar_id(int char_id, int int_value)
+void quest::crosszonesignalclientbychar_id(int char_id, int int_value)
-void crosszonesignalclientbychar_id(int char_id, int int_value)
+void quest::crosszonesignalclientbychar_id(int char_id, int int_value)
-void crosszonesignalclientbychar_id(string name, int int_value)
+void quest::crosszonesignalclientbychar_id(string name, int int_value)
-void crosszonesignalclientbychar_id(string name, int int_value)
+void quest::crosszonesignalclientbychar_id(string name, int int_value)
-void crosszonemessageplayerbyname(int channel_id, string name, string message)
+void quest::crosszonemessageplayerbyname(int channel_id, string name, string message)
-void crosszonemessageplayerbyname(int channel_id, string name, string message)
+void quest::crosszonemessageplayerbyname(int channel_id, string name, string message)
-void enablerecipe()
+void quest::enablerecipe()
-void disablerecipe()
+void quest::disablerecipe()
-void clear_npctype_cache()
+void quest::clear_npctype_cache()
-void qs_send_query()
+void quest::qs_send_query()
-void qs_player_event(int char_id, string message)
+void quest::qs_player_event(int char_id, string message)
-void crosszonesetentityvariablebynpctypeid(int npc_type_id, string key, string str_value)
+void quest::crosszonesetentityvariablebynpctypeid(int npc_type_id, string key, string str_value)
-void crosszonesetentityvariablebyclient_name(string client_name, string key, string str_value)
+void quest::crosszonesetentityvariablebyclient_name(string client_name, string key, string str_value)
-void crosszonesignalnpcbynpctypeid(int npc_type_id, int int_value)
+void quest::crosszonesignalnpcbynpctypeid(int npc_type_id, int int_value)
-void worldwidemarquee(int color_id, int priority, int fade_in, int fade_out, int duration, string message)
+void quest::worldwidemarquee(int color_id, int priority, int fade_in, int fade_out, int duration, string message)
-void debug(string message, int debug_level)
+void quest::debug(string message, int debug_level)
-void UpdateZoneHeader(string key, string str_value)
+
 ```