Updated Perl API (markdown)

Chris Miles
2018-07-01 18:17:10 -05:00
parent 89c492ff25
commit 868409feaa
+135 -116
@@ -510,47 +510,48 @@ sub EVENT_AGGRO_SAY {
```perl
$client->AccountID()
$client->AccountName()
$client->AddAAPoints(number)
$client->AddAlternateCurrencyValue(currency_id, value)
$client->AddCrystals(NumberOfRadiant, NumberOfEbon)
$client->AddEXP(add_exp, conlevel, resexp)
$client->AddLevelBasedExp(exp_percentage, max_level)
$client->AddMoneyToPP(copper, silver, gold, platinum, updateclient)
$client->AddPVPPoints(Points)
$client->AddSkill(skillid, value)
$client->AddAAPoints(uint32 points)
$client->AddAlternateCurrencyValue(uint32 currency_id, int32 amount)
$client->AddCrystals(uint32 radiant_count, uint32 ebon_count)
$client->AddEXP(uint32 experience_points)
$client->AddLevelBasedExp(uint8 exp_percentage, uint8 max_level = 0)
$client->AddMoneyToPP(uint32 copper, uint32 silver, uint32 gold, uint32 platinum, bool update_client)
$client->AddPVPPoints(uint32 points)
$client->AddSkill(int skill_id, uint16 value)
$client->Admin()
$client->AssignTask(taskid, npcid[, enforce_level_requirement]) # use 0 for npcid to assume current npc, 0/1 to enforce level requirement in DB
$client->AssignToInstance(instance_id)
$client->AssignTask(int task_id, int npc_id, [bool enforce_level_requirement = false])
$client->AssignToInstance(uint16 instance_id)
$client->AutoSplitEnabled()
$client->BreakInvis()
$client->CalcPriceMod(other, reverse)
$client->CanHaveSkill(skill_id)
$client->ChangeLastName(in_lastname)
$client->CalcPriceMod(mob*, [bool reverse = false])
$client->CanHaveSkill(int skill_id)
$client->ChangeLastName(string last_name)
$client->CharacterID()
$client->CheckIncreaseSkill(skillid, chancemodi)
$client->CheckSpecializeIncrease(spell_id)
$client->CheckIncreaseSkill(int skill_id, int chance_modifier = 0)
$client->CheckSpecializeIncrease(uint16 spell_id)
$client->ClearCompassMark()
$client->ClearZoneFlag(zone_id)
$client->ClearZoneFlag(uint32 zone_id)
$client->Connected()
$client->DecreaseByID(type, amt)
$client->DeleteItemInInventory(slot_id, quantity, client_update)
$client->DecreaseByID(uint32 type, unit8 amount)
$client->DeleteItemInInventory(int16 slot_id, [int8 quantity = 0], [bool client_update = false])
$client->Disconnect()
$client->DropItem(slot_id)
$client->DropItem(int16 slot_id)
$client->Duck()
$client->Escape()
$client->FailTask(taskid)
$client->ExpeditionMessage(int expedition_id, string message)
$client->FailTask(int task_id)
$client->ForageItem()
$client->Freeze()
$client->GMKill()
$client->GetAAExp()
$client->GetAALevel(skill_id)
$client->GetAALevel(uint32 aa_skill_id)
$client->GetAAPercent()
$client->GetAAPoints()
$client->GetAccountFlag(flag)
$client->GetAccountFlag(string flag)
$client->GetAggroCount()
$client->GetAllMoney()
$client->GetAnon()
$client->GetAugmentAt(slot, aug_slot)
$client->GetAugmentIDAt(slot, aug_slot)
$client->GetAugmentAt(uint32 slot, uint32 aug_slot)
$client->GetAugmentIDAt(int16 slot_id, int16 aug_slot)
$client->GetBaseAGI()
$client->GetBaseCHA()
$client->GetBaseDEX()
@@ -560,71 +561,81 @@ $client->GetBaseSTA()
$client->GetBaseSTR()
$client->GetBaseWIS()
$client->GetBecomeNPCLevel()
$client->GetBindHeading(int index = 0)
$client->GetBindX(int index = 0)
$client->GetBindY(int index = 0)
$client->GetBindZ(int index = 0)
$client->GetBindZoneID(int index = 0)
$client->GetCarriedMoney()
$client->GetCharacterFactionLevel(faction_id)
$client->GetCharacterFactionLevel(int32 faction_id)
$client->GetClientVersion()
$client->GetClientVersionBit()
$client->GetCorpseCount()
$client->GetCorpseID(corpse_number)
$client->GetCorpseItemAt(corpse_number, slotid)
$client->GetCustomItemData()
$client->GetCorpseID(uint8 corpse)
$client->GetCorpseItemAt(uint32 corpse_id, uint16 slot_id)
$client->GetCustomItemData(int16 slot_id, string identifier)
$client->GetDiscSlotBySpellID(int32 spell_id)
$client->GetDuelTarget()
$client->GetEXP()
$client->GetEbonCrystals()
$client->GetEndurance()
$client->GetEnduranceRatio()
$client->GetFace()
$client->GetFactionLevel(char_id, npc_id, p_race, p_class, p_deity, pFaction, tnpc)
$client->GetFactionLevel(uint32 character_id, uint32 npc_id, uint32 player_race_id, uint32 player_class_id, uint32 player_deity_id, uint32 player_faction_id, mob*)
$client->GetFeigned()
$client->GetFreeSpellBookSlot(start_slot)
$client->GetFreeSpellBookSlot(uint32 start_slot = 0)
$client->GetGM()
$client->GetGroup()
$client->GetGroupPoints()
$client->GetHorseId()
$client->GetInstrumentMod(spell_id)
$client->GetHunger()
$client->GetIP()
$client->GetInstrumentMod()
$client->GetItemAt(slot)
$client->GetItemIDAt(slot_id)
$client->GetItemInInventory(slot_id)
$client->GetInstanceID()
$client->GetInstrumentMod(uint16 spell_id)
$client->GetItemAt(uint32 slot)
$client->GetItemIDAt(int16 slot_id)
$client->GetItemInInventory(int16 slot_id)
$client->GetLDoNLosses()
$client->GetLDoNLossesTheme()
$client->GetLDoNPointsTheme(theme)
$client->GetLDoNLossesTheme(int32 theme)
$client->GetLDoNPointsTheme(int32 theme)
$client->GetLDoNWins()
$client->GetLDoNWinsTheme()
$client->GetLanguageSkill(n)
$client->GetLDoNWinsTheme(int32 theme)
$client->GetLanguageSkill(uint16 lanuage_id)
$client->GetLastName()
$client->GetMaxEndurance()
$client->GetModCharacterFactionLevel(faction_id) # Returns the character's faction level with race, class, and deity modifiers
$client->GetModCharacterFactionLevel(int32 faction_id)
$client->GetPVP()
$client->GetPVPPoints()
$client->GetRadiantCrystals()
$client->GetRaid()
$client->GetRaidPoints()
$client->GetRawItemAC()
$client->GetRawSkill(skill_id)
$client->GetSkill(skill_id)
$client->GetRawSkill(int skill_id)
$client->GetSkill(uint16 skill_id)
$client->GetSkillPoints()
$client->GetSpellBookSlotBySpellID(spell_id)
$client->GetSpellBookSlotBySpellID(uint32 spell_id)
$client->GetSpentAA()
$client->GetStartZone() # Returns the zone id number of the character's home city
$client->GetStartZone()
$client->GetTargetRingX()
$client->GetTargetRingY()
$client->GetTargetRingZ()
$client->GetTaskActivityDoneCount(taskid, activityid)
$client->GetTaskActivityDoneCount(int task_id, int activity_id)
$client->GetThirst()
$client->GetTotalSecondsPlayed()
$client->GetWeight()
$client->GoFish()
$client->GrantAlternateAdvancementAbility(int aa_id, int points, [bool ignore_cost = false])
$client->GuildID()
$client->GuildRank()
$client->HasSkill(skill_id)
$client->HasZoneFlag(zone_id)
$client->HasSkill(int skill_id)
$client->HasSpellScribed(int spell_id)
$client->HasZoneFlag(uint32 zone_id)
$client->Hungry()
$client->InZone()
$client->IncStats(type, increase_val)
$client->IncreaseLanguageSkill(skill_id, value)
$client->IncreaseSkill(skill_id, value)
$client->IncrementAA(skill_id)
$client->IncStats(uint8 type, uint16 increase_val)
$client->IncreaseLanguageSkill(int skill_id, int value = 1)
$client->IncreaseSkill(int skill_id, int value = 1)
$client->IncrementAA(uint32 aa_skill_id)
$client->IsBecomeNPC()
$client->IsDueling()
$client->IsGrouped()
@@ -632,91 +643,99 @@ $client->IsLD()
$client->IsMedding()
$client->IsRaidGrouped()
$client->IsSitting()
$client->IsTaskActive(taskid)
$client->IsTaskActivityActive(taskid, activityid)
$client->IsTaskCompleted(taskid)
$client->KeyRingAdd()
$client->KeyRingCheck()
$client->IsTaskActive(int task_id)
$client->IsTaskActivityActive(int task_id, int activity_id)
$client->IsTaskCompleted(int task_id)
$client->KeyRingAdd(uint32 item_id)
$client->KeyRingCheck(uint32 item_id)
$client->Kick()
$client->LearnRecipe()
$client->LearnRecipe(uint32 recipe_id)
$client->LeaveGroup()
$client->LoadZoneFlags()
$client->LootToStack(itemid)
$client->MarkCompassLoc(x, y, z)
$client->MaxSkill(skillid)
$client->MemSpell(spell_id, slot, update_client)
$client->MovePC(zoneID, x, y, z, heading)
$client->MovePCInstance(zoneID, instanceID, x, y, z, heading)
$client->NPCSpawn(target_npc, option, respawntime) # Options are: "create", "add", "update", "remove", "delete"
$client->NukeItem(itemnum)
$client->MarkCompassLoc(float x, float y, float z)
$client->MaxSkill(uint16 skill_id, uint16 class_id, uint16 level)
$client->MemSpell(uint16 spell_id, int slot, [bool update_client = true])
$client->MovePC(uint32 zone_id, float x, float y, float z, float heading)
$client->MovePCInstance(uint32 zone_id, uint32 instance_id, float x, float y, float z, float heading)
$client->NPCSpawn(npc*, string option, uint32 respawn_time=1200)
$client->NukeItem(uint32 item_id, [uint8 slot_to_check])
$client->OpenLFGuildWindow()
$client->ReadBook(Book Text, Type)
$client->PlayMP3(string file_name)
$client->QuestReward(int32 mob, int32 copper, int32 silver, int32 gold, int32 platinum, int32 item_id, int32 exp, [bool faction = false])
$client->ReadBook(char* book_test, uint8 type)
$client->RefundAA()
$client->RemoveFromInstance(uint16 instance_id)
$client->RemoveNoRent()
$client->ResetAA()
$client->ResetTaskActivity(taskid, activityid)
$client->ResetTrade()
$client->Save(iCommitNow)
$client->Save(uint8 commit_now)
$client->SaveBackup()
$client->ScribeSpell(spell_id, slot, update_client)
$client->SendColoredText(color, msg)
$client->SendMarqueeMessage(type, priority, fade_in, fade_out,  duration, message) # type = color, priority = text opacity, fade_in = 1, fade_out = fade out in MS, duration = duration in MS
$client->SendOPTranslocateConfirm()
$client->ScribeSpell(uint16 spell_id, int slot, [bool update_client = true])
$client->SendColoredText(uint32 color, string message)
$client->SendFullPopup(string title, string text, uint32 popup_id, uint32 negative_id, uint32 buttons, uint32 duration, string button_name_0, string button_name_1, uint32 sound_controls)
$client->SendMarqueeMessage(uint32 type, uint32 priority, uint32 fade_in, uint32 fade_out, uint32 duration, std::string msg)
$client->SendMarqueeMessage(uint32 type, uint32 priority, uint32 fade_in, uint32 fade_out, uint32 duration, string msg)
$client->SendOPTranslocateConfirm(mob* caster, int32 spell_id)
$client->SendSound()
$client->SendSpellAnim(targetid, spellid)
$client->SendZoneFlagInfo(to)
$client->SetAAPoints(points)
$client->SetAATitle(txt, save)
$client->SetAccountFlag(flag, value)
$client->SetBaseClass(i)
$client->SetBaseGender(i)
$client->SetBaseRace(i)
$client->SendTargetCommand(int32 entity_id)
$client->SendWebLink(string website_url)
$client->SendZoneFlagInfo(client* to)
$client->SetAAPoints(uint32 points)
$client->SetAATitle(string text, [bool save = false])
$client->SetAccountFlag(string flag, string value)
$client->SetBaseClass(uint32 class_id)
$client->SetBaseGender(uint32 gender_id)
$client->SetBaseRace(uint32 race_id)
$client->SetBecomeNPC(flag)
$client->SetBecomeNPCLevel(level)
$client->SetBindPoint(to_zone, new_x, new_y, new_z)
$client->SetCustomItemData()
$client->SetDeity(i)
$client->SetBindPoint(int to_zone = -1, int to_instance = 0, float new_x = 0.0f, float new_y = 0.0f, float new_z = 0.0f)
$client->SetCustomItemData(int16 slot_id, string identifier, string value)
$client->SetDeity(uint32 deity_id)
$client->SetDuelTarget(set_id)
$client->SetDueling(duel)
$client->SetEXP(set_exp, set_aaxp, resexp)
$client->SetEndurance(Endurance)
$client->SetFactionLevel(char_id, npc_id, char_class, char_race, char_deity)
$client->SetFactionLevel2(char_id, faction_id, char_class, char_race, char_deity, value)
$client->SetEXP(uint32 experience_points, uint32 aa_experience_points, [bool resexp=false])
$client->SetEndurance(endurance)
$client->SetFactionLevel(uint32 character_id, uint32 npc_id, uint8 character_class, uint8 character_race, uint8 character_deity)
$client->SetFactionLevel2(uint32 character_id, int32 faction_id, uint8 character_class, uint8 character_race, uint8 character_deity, int32 value, uint8 temp)
$client->SetFeigned(in_feigned)
$client->SetGM(toggle)
$client->SetGM(bool toggle)
$client->SetHorseId(horseid_in)
$client->SetLanguageSkill(langid, value)
$client->SetMaterial(slot_id, item_id)
$client->SetPVP(toggle)
$client->SetSkill(skill_num, value)
$client->SetHunger(in_hunger)
$client->SetHunger(int32 hunger_amount, int32 thirst_amount)
$client->SetLanguageSkill(int language_id, int value)
$client->SetMaterial(int16 slot_id, uint32 item_id)
$client->SetPVP(bool toggle)
$client->SetSkill(int skill_id, uint16 value)
$client->SetSkillPoints(inp)
$client->SetStartZone(zoneid, x, y, z) # Sets the home city bind point. The coordinates x, y, and z are optional.
$client->SetStats(type, increase_val)
$client->SetTint(slot_id, color)
$client->SetTitleSuffix(txt, save)
$client->SetZoneFlag(zone_id)
$client->SignalClient(data)
$client->SlotConvert2(slot)
$client->SetStartZone(uint32 zone_id, [float x = 0], [float y = 0], [float z = 0])
$client->SetStats(uint8 type, uint16 increase_val)
$client->SetThirst(int32 in_thirst)
$client->SetTint(int16 slot_id, uint32 color)
$client->SetTitleSuffix(string text, [bool save = false])
$client->SetZoneFlag(uint32 zone_id)
$client->SignalClient(uint32 data)
$client->SilentMessage(string message)
$client->SlotConvert2(uint8 slot)
$client->Stand()
$client->SummonItem(item_id, charges, attune, aug1, aug2, aug3, aug4, aug5)
$client->SummonItem(uint32 item_id, [int16 charges = -1], [bool attune = false], [uint32 aug1 = 0], [uint32 aug2 = 0], [uint32 aug3 = 0], [uint32 aug4 = 0], [uint32 aug5 = 0], [uint16 slot_id = 30])
$client->TGB()
$client->TakeMoneyFromPP(copper, update_client)
$client->TaskTimeLeft(taskid)
$client->TakeMoneyFromPP(uint32 copper, bool update_client = false)
$client->Thirsty()
$client->UnFreeze()
$client->TrainDiscBySpellID(int32 spell_id)
$client->Undye()
$client->UnmemSpell(slot, update_client)
$client->UnmemSpellAll(update_client)
$client->UnscribeSpell(slot, update_client)
$client->UnscribeSpellAll(update_client)
$client->UntrainDisc(slot, update_client)
$client->UntrainDiscAll(update_client)
$client->UpdateAdmin(iFromDB)
$client->UpdateGroupAAs()
$client->UpdateLDoNPoints(points, theme)
$client->UpdateTaskActivity(taskID, activityID, count[, hide update client?]) # i.e. $client->UpdateTaskActivity(507, 0, 3) will increment task 507's activity 0 by 3.
$client->UpdateWho(remove)
$client->UseDiscipline(spell_id, target)
$client->UnmemSpell(int slot, [bool update_client = true])
$client->UnmemSpellAll([bool update_client = true])
$client->UnmemSpellBySpellID(int32 spell_id)
$client->UnscribeSpell(int slot, [bool update_client = true])
$client->UnscribeSpellAll([bool update_client = true])
$client->UntrainDisc(int slot, [bool update_client = true])
$client->UntrainDiscAll([update_client = true])
$client->UpdateAdmin(bool from_db = true)
$client->UpdateGroupAAs(int32 points, uint32 type)
$client->UpdateLDoNPoints(int32 points, uint32 theme)
$client->UpdateTaskActivity(int task_id, int activity_id, int count, [bool ignore_quest_update = false])
$client->UpdateWho(uint8 remove = 0)
$client->UseDiscipline(int32 spell_id, int32 target)
$client->WorldKick()
```