From 21581714eeec50f3478569f5799d001d01bd2a16 Mon Sep 17 00:00:00 2001 From: TurmoilToad Date: Fri, 11 Jan 2019 10:32:35 -0500 Subject: [PATCH] Created Perl API - Functions (markdown) --- Perl-API---Functions.md | 903 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 903 insertions(+) create mode 100644 Perl-API---Functions.md diff --git a/Perl-API---Functions.md b/Perl-API---Functions.md new file mode 100644 index 0000000..9f4c367 --- /dev/null +++ b/Perl-API---Functions.md @@ -0,0 +1,903 @@ +#ProTip: hit ctrl + f (Windows) or ⌘ + f (Mac) to FIND something on this page + +# **Function Lists** + +* Nearly every function for Perl can be found in the EQEmu source[https://github.com/EQEmu/Server/blob/master/zone/perl_mob.cpp](https://github.com/EQEmu/Server/blob/master/zone/perl_mob.cpp)  + +# Client + +```perl +$client->AccountID() +$client->AccountName() +$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(int task_id, int npc_id, [bool enforce_level_requirement = false]) +$client->AssignToInstance(uint16 instance_id) +$client->AutoSplitEnabled() +$client->BreakInvis() +$client->CalcPriceMod(mob*, [bool reverse = false]) +$client->CanHaveSkill(int skill_id) +$client->ChangeLastName(string last_name) +$client->CharacterID() +$client->CheckIncreaseSkill(int skill_id, int chance_modifier = 0) +$client->CheckSpecializeIncrease(uint16 spell_id) +$client->ClearCompassMark() +$client->ClearZoneFlag(uint32 zone_id) +$client->Connected() +$client->DecreaseByID(uint32 type, unit8 amount) +$client->DeleteItemInInventory(int16 slot_id, [int8 quantity = 0], [bool client_update = false]) +$client->Disconnect() +$client->DropItem(int16 slot_id) +$client->Duck() +$client->Escape() +$client->ExpeditionMessage(int expedition_id, string message) +$client->FailTask(int task_id) +$client->ForageItem() +$client->GMKill() +$client->GetAAExp() +$client->GetAALevel(uint32 aa_skill_id) +$client->GetAAPercent() +$client->GetAAPoints() +$client->GetAccountFlag(string flag) +$client->GetAggroCount() +$client->GetAllMoney() +$client->GetAnon() +$client->GetAugmentAt(uint32 slot, uint32 aug_slot) +$client->GetAugmentIDAt(int16 slot_id, int16 aug_slot) +$client->GetBaseAGI() +$client->GetBaseCHA() +$client->GetBaseDEX() +$client->GetBaseFace() +$client->GetBaseINT() +$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(int32 faction_id) +$client->GetClientVersion() +$client->GetClientVersionBit() +$client->GetCorpseCount() +$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(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(uint32 start_slot = 0) +$client->GetGM() +$client->GetGroup() +$client->GetGroupPoints() +$client->GetHorseId() +$client->GetHunger() +$client->GetIP() +$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(int32 theme) +$client->GetLDoNPointsTheme(int32 theme) +$client->GetLDoNWins() +$client->GetLDoNWinsTheme(int32 theme) +$client->GetLanguageSkill(uint16 lanuage_id) +$client->GetLastName() +$client->GetMaxEndurance() +$client->GetModCharacterFactionLevel(int32 faction_id) +$client->GetPVP() +$client->GetPVPPoints() +$client->GetRadiantCrystals() +$client->GetRaid() +$client->GetRaidPoints() +$client->GetRawItemAC() +$client->GetRawSkill(int skill_id) +$client->GetSkill(uint16 skill_id) +$client->GetSkillPoints() +$client->GetSpellBookSlotBySpellID(uint32 spell_id) +$client->GetSpentAA() +$client->GetStartZone() +$client->GetTargetRingX() +$client->GetTargetRingY() +$client->GetTargetRingZ() +$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(int skill_id) +$client->HasSpellScribed(int spell_id) +$client->HasZoneFlag(uint32 zone_id) +$client->Hungry() +$client->InZone() +$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() +$client->IsLD() +$client->IsMedding() +$client->IsRaidGrouped() +$client->IsSitting() +$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(uint32 recipe_id) +$client->LeaveGroup() +$client->LoadZoneFlags() +$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->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->ResetTrade() +$client->Save(uint8 commit_now) +$client->SaveBackup() +$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->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(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(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(bool toggle) +$client->SetHorseId(horseid_in) +$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(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(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(uint32 copper, bool update_client = false) +$client->Thirsty() +$client->TrainDiscBySpellID(int32 spell_id) +$client->Undye() +$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() +``` + +# Corpse + +```perl +$corpse->AddItem(uint32 item_id, uint16 charges, [unt16 slot = 0]) +$corpse->AddLooter(mob* who) +$corpse->AllowMobLoot(mob* them, uint8 slot) +$corpse->CanMobLoot(int character_id) +$corpse->CastRezz(uint16 spell_id, [mob* caster = nullptr]) +$corpse->CompleteRezz() +$corpse->CountItems() +$corpse->Delete() +$corpse->GetCharID() +$corpse->GetCopper() +$corpse->GetDBID() +$corpse->GetDecayTime() +$corpse->GetGold() +$corpse->GetOwnerName() +$corpse->GetPlatinum() +$corpse->GetSilver() +$corpse->GetWornItem(equipslot) +$corpse->IsEmpty() +$corpse->IsLocked() +$corpse->IsRezzed() +$corpse->Lock() +$corpse->RemoveCash() +$corpse->RemoveItem(uint16 loot_slot) +$corpse->ResetLooter() +$corpse->SetCash(uint16 copper, uint16 silver, uint16 gold, uint16 platinum) +$corpse->SetDecayTimer(uint32 decay_time) +$corpse->Summon(client* client, bool is_spell) +$corpse->UnLock() +``` + +# EntityList + +```perl +$entity_list->CanAddHateForMob(mob* target) +$entity_list->Clear() +$entity_list->ClearClientPetitionQueue() +$entity_list->ClearFeignAggro(mob* target) +$entity_list->DeleteNPCCorpses() +$entity_list->DeletePlayerCorpses() +$entity_list->DoubleAggro(*mob target) +$entity_list->Fighting(mob* target) +$entity_list->FindDoor(uint32 door_id) +$entity_list->GetClientByAccID(uint32 account_id) +$entity_list->GetClientByCharID(uint32 character_id) +$entity_list->GetClientByID(uint16 client_id) +$entity_list->GetClientByName(name) +$entity_list->GetClientByWID(uint32 wid) +$entity_list->GetClientList() +$entity_list->GetCorpseByID(id) +$entity_list->GetCorpseByName(name) +$entity_list->GetCorpseByOwner(client) +$entity_list->GetCorpseList() +$entity_list->GetDoorsByDBID(uint32 database_id) +$entity_list->GetDoorsByDoorID(uint32 door_id) +$entity_list->GetDoorsByID(uint32 entity_id) +$entity_list->GetDoorsList() +$entity_list->GetGroupByClient(client* client) +$entity_list->GetGroupByID(id) +$entity_list->GetGroupByLeaderName(leader) +$entity_list->GetGroupByMob(mob* mob) +$entity_list->GetMob(name) +$entity_list->GetMobByID(id) +$entity_list->GetMobByNpcTypeID(get_id) +$entity_list->GetMobID(id) +$entity_list->GetMobList() +$entity_list->GetNPCByID(id) +$entity_list->GetNPCByNPCTypeID(npc_id) +$entity_list->GetNPCList() +$entity_list->GetObjectByDBID(uint32 database_id) +$entity_list->GetObjectByID(uint32 entity_id) +$entity_list->GetObjectList() +$entity_list->GetRaidByClient(client) +$entity_list->GetRaidByID(id) +$entity_list->GetRandomClient(float x, float y, float z, float distance, [client* exclude_client = nullptr]) +$entity_list->HalveAggro(mob* target) +$entity_list->MakeNameUnique(string name) +$entity_list->Message(uint32 guild_id, uint32 emote_color_type, string message) +$entity_list->MessageClose(mob* sender, bool skip_sender, float distance, uint32 emote_color_type, string message) +$entity_list->MessageGroup(mob* sender, bool skip_close, uint32 emote_color_type, string message) +$entity_list->MessageStatus(uint32 guild_id, uint32 emote_color_type, string message) +$entity_list->OpenDoorsNear(npc* opener) +$entity_list->RemoveAllClients() +$entity_list->RemoveAllCorpses() +$entity_list->RemoveAllDoors() +$entity_list->RemoveAllGroups() +$entity_list->RemoveAllMobs() +$entity_list->RemoveAllNPCs() +$entity_list->RemoveAllObjects() +$entity_list->RemoveAllTraps() +$entity_list->RemoveClient(delete_id) +$entity_list->RemoveCorpse(delete_id) +$entity_list->RemoveDoor(delete_id) +$entity_list->RemoveEntity(uint16 id) +$entity_list->RemoveFromHateLists(mob* mob, [bool set_to_one = false]) +$entity_list->RemoveFromTargets(mob* target) +$entity_list->RemoveGroup(delete_id) +$entity_list->RemoveMob(delete_id) +$entity_list->RemoveNPC(delete_id) +$entity_list->RemoveObject(delete_id) +$entity_list->RemoveTrap(delete_id) +$entity_list->ReplaceWithTarget(mob* old_mob, mob* new_target) +$entity_list->SignalAllClients(uint32 data) +$entity_list->SignalMobsByNPCID(uint32 npc_type_id, int signal_id) +$entity_list->ValidMobByNpcTypeID(get_id) +``` + +# Group + + * $group needs to be fetched from an entity object, for example: $group = $client->GetGroup()) + +```perl +$group->CastGroupSpell(mob* caster, uint16 spell_id) +$group->DisbandGroup() +$group->GetHighestLevel() +$group->GetID() +$group->GetLeader() +$group->GetLeaderName() +$group->GetMember(int group_index) +$group->GetTotalGroupDamage(mob* other) +$group->GroupCount() +$group->GroupMessage(mob* sender, uint8 language, string message) +$group->IsGroupMember(client) +$group->IsLeader(mob* target) +$group->SendHPPacketsFrom(mob* new_member) +$group->SendHPPacketsTo(mob* new_member) +$group->SetLeader(mob* new_leader) +$group->SplitExp(uint32 exp, mob* other) +$group->SplitMoney(uint32 copper, uint32 silver, uint32 gold, uint32 platinum) +``` + +# Raid + +```perl +$raid->Object(); +``` + +* $raid needs to be fetched from an entity object, for example: $raid = $client->GetRaid()) + +```perl +$raid->BalanceHP(int32 penalty, uint32 group_id) +$raid->CastGroupSpell(mob* caster, uint16 spell_id, uint32 group_id) +$raid->GetClientByIndex(uint16 raid_indez) +$raid->GetGroup(string name) +$raid->GetHighestLevel() +$raid->GetID() +$raid->GetLowestLevel() +$raid->GetMember(int raid_index) +$raid->GetTotalRaidDamage([mob* other = nullptr]) +$raid->GroupCount(uint32 group_id) +$raid->IsGroupLeader(string name) +$raid->IsLeader(string name) +$raid->IsRaidMember(string name) +$raid->RaidCount() +$raid->SplitExp(uint32 experience, [mob* other = nullptr]) +$raid->SplitMoney(uint32 copper, uint32 silver, uint32 gold, uint32 platinum) +$raid->TeleportGroup(mob* sender, uint32 zone_id, float x, float y, float z, float heading, uint32 group_id) +$raid->TeleportRaid(mob* sender, uint32 zone_id, float x, float y, float z, float heading) +``` + +# Mob + +* Important Note! Most of the $mob objects also work when used with $client + +```perl +$mob->AddFeignMemory(client* attacker) +$mob->BehindMob(mob* other = 0, [float x = 0.0f], [float y= 0.0f]) +$mob->BuffFadeAll() +$mob->BuffFadeByEffect(int effect_id, int skip_slot = -1) +$mob->BuffFadeBySlot(int slot, bool recalc_bonuses = true) +$mob->BuffFadeBySpellID(uint16 spell_id) +$mob->CalculateDistance(float x, float y, float z) +$mob->CalculateHeadingToTarget(float x, float y) +$mob->CanClassEquipItem(uint32 item_id) +$mob->CanThisClassDodge() +$mob->CanThisClassDoubleAttack() +$mob->CanThisClassDualWield() +$mob->CanThisClassParry() +$mob->CanThisClassRiposte() +$mob->CastToClient() +$mob->CastToCorpse() +$mob->CastToMob() +$mob->CastToNPC() +$mob->CastingSpellID() +$mob->ChangeSize(float in_size, [bool no_restriction = false]) +$mob->Charmed() +$mob->CheckAggro(mob* other) +$mob->CheckAggroAmount(uint16 spell_id) +$mob->CheckHealAggroAmount(uint16 spell_id, uint32 possible_heal_amt) +$mob->CheckLoS(mob*) +$mob->CheckLoSToLoc(float x, float y, float z, float mob_size) +$mob->ClearFeignMemory() +$mob->ClearSpecialAbilities() +$mob->CombatRange(mob* target) +$mob->Depop(startspawntimer = true) +$mob->DivineAura() +$mob->DoAnim(int animation_number, [int type = 0]) +$mob->DoKnockback(mob* caster, uint32 push_back_amount, uint32 push_up_amount) +$mob->DontBuffMeBefore() +$mob->DontDotMeBefore() +$mob->DontHealMeBefore() +$mob->DontRootMeBefore() +$mob->DontSnareMeBefore() +$mob->DoubleAggro(mob* other) +$mob->Emote(string message) +$mob->EntityVariableExists(string id) +$mob->FaceTarget([mob* target = 0]) +$mob->FindBuff(uint16 spell_id) +$mob->FindGroundZ(float x, float y, float z_offset) +$mob->FindType(uint8 type, [bool offensive = false], [uint16 threshold = 100]) +$mob->GMMove(float x, float y, float z, [float heading = 0.01]) +$mob->Gate() +$mob->GetAA(uint32 rank_id) +$mob->GetAAByAAID(uint32 aa_id) +$mob->GetAC() +$mob->GetAGI() +$mob->GetATK() +$mob->GetActSpellCasttime(uint16 spell_id, uint32 cast_time) +$mob->GetActSpellCost(uint16 spell_id, int32 cost) +$mob->GetActSpellDamage(uint16 spell_id, int32 value) +$mob->GetActSpellDuration(uint16 spell_id, int32 duration) +$mob->GetActSpellHealing(uint16 spell_id, int32 value) +$mob->GetActSpellRange(uint16 spell_id, float range) +$mob->GetAggroRange() +$mob->GetAllowBeneficial() +$mob->GetAppearance() +$mob->GetArmorTint(uint8 material_slot) +$mob->GetAssistRange() +$mob->GetBaseGender() +$mob->GetBaseRace() +$mob->GetBaseSize() +$mob->GetBeard() +$mob->GetBeardColor() +$mob->GetBodyType() +$mob->GetBuffSlotFromType(uint16 type) +$mob->GetCHA() +$mob->GetCR() +$mob->GetCasterLevel(spell_id) +$mob->GetClass() +$mob->GetClassLevelFactor() +$mob->GetCleanName() +$mob->GetCorruption() +$mob->GetDEX() +$mob->GetDR() +$mob->GetDamageAmount(mob* target_mob) +$mob->GetDeity() +$mob->GetDrakkinDetails() +$mob->GetDrakkinHeritage() +$mob->GetDrakkinTattoo() +$mob->GetEntityVariable(string id) +$mob->GetEquipment(uint8 material_slot) +$mob->GetEquipmentColor(uint8 material_slot) +$mob->GetEquipmentMaterial(uint8 material_slot) +$mob->GetEyeColor1() +$mob->GetEyeColor2() +$mob->GetFR() +$mob->GetFlurryChance() +$mob->GetFollowID() +$mob->GetGender() +$mob->GetHP() +$mob->GetHPRatio() +$mob->GetHairColor() +$mob->GetHairStyle() +$mob->GetHandToHandDamage() +$mob->GetHandToHandDelay() +$mob->GetHaste() +$mob->GetHateAmount(mob* mob, [bool is_damage = false]) +$mob->GetHateDamageTop(mob* other) +$mob->GetHateList() +$mob->GetHateRandom() +$mob->GetHateTop() +$mob->GetHeading() +$mob->GetHelmTexture() +$mob->GetHerosForgeModel(uint8 material_slot) +$mob->GetID() +$mob->GetINT() +$mob->GetInvul() +$mob->GetItemHPBonuses() +$mob->GetItemStat(uint32 item_id, string stat) +$mob->GetLevel() +$mob->GetLevelCon(uint8 other_level) +$mob->GetLevelHP(uint8 level) +$mob->GetLuclinFace() +$mob->GetMR() +$mob->GetMana() +$mob->GetManaRatio() +$mob->GetMaxAGI() +$mob->GetMaxCHA() +$mob->GetMaxDEX() +$mob->GetMaxHP() +$mob->GetMaxINT() +$mob->GetMaxMana() +$mob->GetMaxSTA() +$mob->GetMaxSTR() +$mob->GetMaxWIS() +$mob->GetMeleeMitigation() +$mob->GetModSkillDmgTaken(int skill_id) +$mob->GetModVulnerability(uint8 resist) +$mob->GetNPCTypeID() +$mob->GetName() +$mob->GetNimbusEffect1() +$mob->GetNimbusEffect2() +$mob->GetNimbusEffect3() +$mob->GetOwnerID() +$mob->GetPR() +$mob->GetPetID() +$mob->GetPetOrder() +$mob->GetPetType() +$mob->GetPhR() +$mob->GetRace() +$mob->GetResist(type) +$mob->GetReverseFactionCon(iother) +$mob->GetRunAnimSpeed() +$mob->GetRunspeed() +$mob->GetSTA() +$mob->GetSTR() +$mob->GetShieldTarget() +$mob->GetSize() +$mob->GetSkill(int skill_id) +$mob->GetSkillDmgTaken(int skill_id) +$mob->GetSpecialAbility(int special_ability) +$mob->GetSpecialAbilityParam(int special_ability, int param) +$mob->GetSpecializeSkillValue(uint16 spell_id) +$mob->GetSpellHPBonuses() +$mob->GetSpellIDFromSlot(slot) +$mob->GetSpellStat(uint32 spell_id, string stat, uint8 slot) +$mob->GetTarget() +$mob->GetTexture() +$mob->GetWIS() +$mob->GetWalkspeed() +$mob->GetWaypointH() +$mob->GetWaypointID() +$mob->GetWaypointPause() +$mob->GetWaypointX() +$mob->GetWaypointY() +$mob->GetWaypointZ() +$mob->GetX() +$mob->GetY() +$mob->GetZ() +$mob->GetZoneID() +$mob->GoToBind() +$mob->HalveAggro(mob* other) +$mob->HasNPCSpecialAtk(string ability_string) +$mob->HasOwner() +$mob->HasPet() +$mob->HasProcs() +$mob->HasShieldEquiped() +$mob->HasTwoHandBluntEquiped() +$mob->HasTwoHanderEquipped() +$mob->HateSummon() +$mob->Heal() +$mob->HealDamage(int32 amount, [mob* caster = 0]) +$mob->InterruptSpell([uint16 spell_id = 0xffff]) +$mob->IsAIControlled() +$mob->IsAmnesiad() +$mob->IsBeacon() +$mob->IsBeneficialAllowed(mob* target) +$mob->IsBlind() +$mob->IsCasting() +$mob->IsClient() +$mob->IsCorpse() +$mob->IsDoor() +$mob->IsEliteMaterialItem(uint8 material_slot) +$mob->IsEngaged() +$mob->IsEnraged() +$mob->IsFeared() +$mob->IsImmuneToSpell(uint16 spell_id, [mob* caster = nullptr]) +$mob->IsInvisible([mob* other = 0]) +$mob->IsMeleeDisabled() +$mob->IsMezzed() +$mob->IsMob() +$mob->IsMoving() +$mob->IsNPC() +$mob->IsNPCCorpse() +$mob->IsObject() +$mob->IsPet() +$mob->IsPlayerCorpse() +$mob->IsRoamer() +$mob->IsRooted() +$mob->IsRunning() +$mob->IsSilenced() +$mob->IsStunned() +$mob->IsTargetable() +$mob->IsTargeted() +$mob->IsTrap() +$mob->IsWarriorClass() +$mob->Kill() +$mob->MakePet(uint16 spell_id, string pet_type, [string name = nullptr]) +$mob->Mesmerize() +$mob->Message(uint32 emote_color_type, string message) +$mob->ModSkillDmgTaken(int skill, int16 value) +$mob->ModVulnerability(uint8 resist, int16 value) +$mob->ProcessSpecialAbilities(string str) +$mob->RangedAttack(mob* other) +$mob->RemoveFromFeignMemory(client* attacker) +$mob->RemoveNimbusEffect(int32 effect_id) +$mob->ResistSpell(uint8 resist_type, uint16 spell_id, [mob* caster = nullptr]) +$mob->RogueAssassinate(other) +$mob->Say(string message) +$mob->SeeHide() +$mob->SeeImprovedHide() +$mob->SeeInvisible() +$mob->SeeInvisibleUndead() +$mob->SendPosUpdate([uint8 send_to_self = 0]) +$mob->SendPosition() +$mob->SendTo(float new_x, float new_y, float new_z) +$mob->SendToFixZ(float new_x, float new_y, float new_z) +$mob->SendWearChange(uint8 material_slot) +$mob->SetAA(int aa_id, int points, [int charges = 0]) +$mob->SetAllowBeneficial(bool value) +$mob->SetAppearance(int appearance [0|1|2|3|4], [ignore_self = true]) +$mob->SetBodyType(int32 type, [bool overwrite_orig = false]) +$mob->SetCurrentWP(waypoint) +$mob->SetDeltas(float delta_x, float delta_y, float delta_z, float delta_h) +$mob->SetDisableMelee(bool value) +$mob->SetEntityVariable(string id, string var) +$mob->SetExtraHaste(int haste) +$mob->SetFlurryChance(uint8 value) +$mob->SetFlyMode(uint8 flymode[0|1|2|3]) +$mob->SetFollowID(id) +$mob->SetGender(int32 gender) +$mob->SetHP(int32 hp) +$mob->SetHate(mob* other, [int32 hate = 0], [int32 damage = 0]) +$mob->SetHeading(float heading) +$mob->SetInvisible(uint8 state) +$mob->SetInvul(bool set_invulnerable) +$mob->SetLD(bool value) +$mob->SetLevel(uint8 in_level, [bool command = false]) +$mob->SetMana(amount) +$mob->SetMaxHP() +$mob->SetOOCRegen(int32 new_ooc_regen) +$mob->SetOwnerID(uint16 new_owner_id) +$mob->SetPetID(uint16 new_pet_id) +$mob->SetPetOrder(i) +$mob->SetRace(int32 race) +$mob->SetRunAnimSpeed(int8 speed) +$mob->SetRunning(bool value) +$mob->SetShieldTarget(mob) +$mob->SetSpecialAbility(int ability, int value) +$mob->SetSpecialAbilityParam(int ability, int param, int value) +$mob->SetTarget(mob) +$mob->SetTargetDestSteps(uint8 target_steps) +$mob->SetTargetable(bool targetable) +$mob->SetTexture(int32 texture) +$mob->Shout(string message) +$mob->SignalClient(client* client, uint32 data) +$mob->Spin() +$mob->StartEnrage() +$mob->Stun(int duration) +$mob->TempName(string name) +$mob->ThrowingAttack(mob* other) +$mob->TryMoveAlong(float distance, float angle, bool send) +$mob->WipeHateList() +``` + +# NPC + +```perl +$npc->AddCash(uint16 copper, uint16 silver, uint16 gold, uint16 platinum) +$npc->AddDefensiveProc(int spell_id, int chance) +$npc->AddLootTable([uint32 loottable_id]) +$npc->AddMeleeProc(int spell_id, int chance) +$npc->AddRangedProc(int spell_id, int chance) +$npc->AssignWaypoints(uint32 grid_id) +$npc->CalculateNewWaypoint() +$npc->ChangeLastName(string name) +$npc->CheckNPCFactionAlly(int32 faction_id) +$npc->ClearItemList() +$npc->ClearLastName() +$npc->CountLoot() +$npc->DisplayWaypointInfo(client* target) +$npc->DoClassAttacks(mob* target) +$npc->GetAccuracyRating() +$npc->GetAttackDelay() +$npc->GetAttackSpeed() +$npc->GetAvoidanceyRating() +$npc->GetCombatState() +$npc->GetCopper() +$npc->GetGold() +$npc->GetGrid() +$npc->GetGuardPointX() +$npc->GetGuardPointY() +$npc->GetGuardPointZ() +$npc->GetLoottableID() +$npc->GetMaxDMG() +$npc->GetMaxDamage(uint8 target_level) +$npc->GetMaxWp() +$npc->GetMinDMG() +$npc->GetNPCFactionID() +$npc->GetNPCHate(mob* entity) +$npc->GetNPCSpellsID() +$npc->GetPetSpellID() +$npc->GetPlatinum() +$npc->GetPrimSkill() +$npc->GetPrimaryFaction() +$npc->GetScore() +$npc->GetSecSkill() +$npc->GetSilver() +$npc->GetSlowMitigation() +$npc->GetSp2() +$npc->GetSpawnKillCount() +$npc->GetSpawnPointH() +$npc->GetSpawnPointID() +$npc->GetSpawnPointX() +$npc->GetSpawnPointY() +$npc->GetSpawnPointZ() +$npc->GetSpellFocusDMG() +$npc->GetSpellFocusHeal() +$npc->GetSwarmOwner() +$npc->GetSwarmTarget() +$npc->GetWaypointMax() +$npc->IsAnimal() +$npc->IsGuarding() +$npc->IsOnHatelist(mob* target) +$npc->ModifyNPCStat(string key, string value) +$npc->NextGuardPosition() +$npc->PauseWandering(int pause_time) +$npc->PickPocket(client* thief) +$npc->RemoveAISpell(int spell_id) +$npc->RemoveCash() +$npc->RemoveDefensiveProc(int spell_id) +$npc->RemoveFromHateList(mob* target) +$npc->RemoveItem(uint32 item_id, [uint16 quantity = 0], [uint16 slot_id = 0]) +$npc->RemoveMeleeProc(int spell_id) +$npc->RemoveRangedProc(int spell_id) +$npc->ResumeWandering() +$npc->SaveGuardSpot([bool clear_guard_spot = false]) +$npc->SetCopper(uint32 copper_amount) +$npc->SetGold(uint32 gold_amount) +$npc->SetGrid(int32 grid_id) +$npc->SetNPCFactionID(int32 faction_id) +$npc->SetPetSpellID(uint16 amount) +$npc->SetPlatinum(uint32 platinum_amount) +$npc->SetPrimSkill(int skill_id) +$npc->SetSaveWaypoint(uint16 waypoint) +$npc->SetSecSkill(int skill_id) +$npc->SetSilver(uint32 silver_amount) +$npc->SetSp2(uint32 set_spawn_group_id) +$npc->SetSpellFocusDMG(int new_spell_focus_dmg) +$npc->SetSpellFocusHeal(int32 new_spell_focus_heal) +$npc->SetSwarmTarget(int target_id) +$npc->SetTaunting(bool toggle) +$npc->SetWaypointPause() +$npc->SignalNPC(int signal_id) +$npc->StartSwarmTimer(uint32 duration) +$npc->StopWandering() +$npc->UpdateWaypoint(int wp_index) +``` + +# Quest Items + +* Below objects require you to fetch an item instance via an item getter, for example: + +```perl +$item = $client->GetItemAt(slot); +$item->GetCharges(); +``` + +```perl +$quest_item->GetAugment(int16 slot_id) +$quest_item->GetCharges() +$quest_item->GetID() +$quest_item->GetName() +$quest_item->IsAttuned() +$quest_item->IsType(type) +$quest_item->ItemSay(string text [int language_id]) +$quest_item->SetScale(float scale_multiplier) +``` + +# Object + +* Below objects require you to fetch the object instance via an entity getter, for example: + +```perl +$object = $entity_list->GetObjectByID(ID); +$object->SetLocation(x, y, z); +``` + +```perl +$object->ClearUser() +$object->Close() +$object->Delete([bool reset_state = false]) +$object->DeleteItem(uint8 index) +$object->Depop() +$object->EntityVariableExists(string key) +$object->GetDBID() +$object->GetEntityVariable(string key) +$object->GetHeading() +$object->GetID() +$object->GetIcon() +$object->GetItemID() +$object->GetModelName() +$object->GetSize() +$object->GetSize() +$object->GetSize() +$object->GetSolidType() +$object->GetType() +$object->GetX() +$object->GetY() +$object->GetZ() +$object->IsGroundSpawn() +$object->IsObject() +$object->Repop() +$object->Save() +$object->SetEntityVariable(string key, string var) +$object->SetHeading(float heading) +$object->SetID(uint16 id) +$object->SetIcon(uint32 icon) +$object->SetItemID(uint32 item_id) +$object->SetLocation(float x, float y, float z) +$object->SetModelName(string name) +$object->SetSize(float size) +$object->SetSolidType(uint16 type) +$object->SetTiltX(float tilt_x) +$object->SetTiltY(float tilt_y) +$object->SetType(uint32 type) +$object->SetX(float x) +$object->SetY(float y) +$object->SetZ(float z) +$object->StartDecay() +$object->VarSave() +``` + +# Door + +* Below objects require you to fetch the door instance via an entity getter, for example: + +```perl +$door = $entity_list->GetDoorsByID(ID); +$door->GetModelName(); +``` + +```perl +$door->GetDoorDBID() +$door->GetDoorID() +$door->GetHeading() +$door->GetID() +$door->GetIncline() +$door->GetIncline() +$door->GetKeyItem() +$door->GetLockpick() +$door->GetModelName() +$door->GetNoKeyring(uint8 type) +$door->GetOpenType() +$door->GetX() +$door->GetY() +$door->GetZ() +$door->InsertDoor() +$door->SetHeading(float heading) +$door->SetIncline(uint32 incline) +$door->SetKeyItem(uint32 key_item_id) +$door->SetLocation(float x, float y, float z) +$door->SetLockpick(uint32 lockpick_type) +$door->SetModelName(string name) +$door->SetNoKeyring(uint8 no_key_ring) +$door->SetOpenType(uint32 open_type) +$door->SetSize(uint32 size) +$door->SetX(float x) +$door->SetY(float y) +$door->SetZ(float z) +```