diff --git a/Lua-Client.md b/Lua-Client.md index d8e9639..f9cd711 100644 --- a/Lua-Client.md +++ b/Lua-Client.md @@ -1,258 +1,259 @@ -Client is a class exported to Lua that represent the Client object from EQEmu. All Client are also [Mob](Lua-Mob). - -[Return to the Lua API](Lua-API) - -### Properties -``` -client.null -- Returns true if this object is null -client.valid -- Returns true if this object is not null -``` - -### Member Functions -``` -Client() -- Creates a null client -Void SendSound(); -Void Save(); -Void Save(Integer commit_now); -Void SaveBackup(); -Boolean Connected(); -Boolean InZone(); -Void Kick(); -Void Disconnect(); -Boolean IsLD(); -Void WorldKick(); -Boolean GetAnon(); -Void Duck(); -Void Stand(); -Void SetGM(Boolean v); -Void SetPVP(Boolean v); -Boolean GetPVP(); -Boolean GetGM(); -Void SetBaseClass(Integer v); -Void SetBaseRace(Integer v); -Void SetBaseGender(Integer v); -Integer GetBaseFace(); -Integer GetLanguageSkill(Integer skill_id); -String GetLastName(); -Integer GetLDoNPointsTheme(Integer theme); -Integer GetBaseSTR(); -Integer GetBaseSTA(); -Integer GetBaseCHA(); -Integer GetBaseDEX(); -Integer GetBaseINT(); -Integer GetBaseAGI(); -Integer GetBaseWIS(); -Integer GetWeight(); -Integer GetEXP(); -Integer GetAAExp(); -Integer GetTotalSecondsPlayed(); -Void UpdateLDoNPoints(Integer points, Integer theme); -Void SetDeity(Integer v); -Void AddEXP(Integer add_exp); -Void AddEXP(Integer add_exp, Integer conlevel); -Void AddEXP(Integer add_exp, Integer conlevel, Boolean resexp); -Void SetEXP(Integer set_exp, Integer set_aaxp); -Void SetEXP(Integer set_exp, Integer set_aaxp, Boolean resexp); -Void SetBindPoint(); -Void SetBindPoint(Integer to_zone); -Void SetBindPoint(Integer to_zone, Real new_x); -Void SetBindPoint(Integer to_zone, Real new_x, Real new_y); -Void SetBindPoint(Integer to_zone, Real new_x, Real new_y, Real new_z); -Real GetBindX(); -Real GetBindX(Integer index); -Real GetBindY(); -Real GetBindY(Integer index); -Real GetBindZ(); -Real GetBindZ(Integer index); -Real GetBindHeading(); -Real GetBindHeading(Integer index); -Integer GetBindZoneID(); -Integer GetBindZoneID(Integer index); -Void MovePC(Integer zone, Real x, Real y, Real z, Real heading); -Void MovePCInstance(Integer zone, Integer instance, Real x, Real y, Real z, Real heading); -Void ChangeLastName(String in); -Integer GetFactionLevel(Integer char_id, Integer npc_id, Integer race, Integer class_, Integer deity, Integer faction, NPC npc); -Void SetFactionLevel(Integer char_id, Integer npc_id, Integer char_class, Integer char_race, Integer char_deity); -Void SetFactionLevel2(Integer char_id, Integer faction_id, Integer char_class, Integer char_race, Integer char_deity, Integer value, Integer temp); -Integer GetRawItemAC(); -Integer AccountID(); -String AccountName(); -Integer Admin(); -Integer CharacterID(); -Integer GuildRank(); -Integer GuildID(); -Integer GetFace(); -Boolean TakeMoneyFromPP(Integer copper); -Boolean TakeMoneyFromPP(Integer copper, Boolean update_client); -Void AddMoneyToPP(Integer copper, Integer silver, Integer gold, Integer platinum, Boolean update_client); -Boolean TGB(); -Integer GetSkillPoints(); -Void SetSkillPoints(Integer skill); -Void IncreaseSkill(Integer skill_id); -Void IncreaseSkill(Integer skill_id, Integer value); -Void IncreaseLanguageSkill(Integer skill_id); -Void IncreaseLanguageSkill(Integer skill_id, Integer value); -Integer GetRawSkill(Integer skill_id); -Boolean HasSkill(Integer skill_id); -Boolean CanHaveSkill(Integer skill_id); -Void SetSkill(Integer skill_id, Integer value); -Void AddSkill(Integer skill_id, Integer value); -Void CheckSpecializeIncrease(Integer spell_id); -Void CheckIncreaseSkill(Integer skill_id, Mob target); -Void CheckIncreaseSkill(Integer skill_id, Mob target, Integer chance_mod); -Void SetLanguageSkill(Integer language, Integer value); -Integer MaxSkill(Integer skill_id); -Boolean IsMedding(); -Integer GetDuelTarget(); -Boolean IsDueling(); -Void SetDuelTarget(Integer c); -Void SetDueling(Boolean v); -Void ResetAA(); -Void MemSpell(Integer spell_id, Integer slot); -Void MemSpell(Integer spell_id, Integer slot, Boolean update_client); -Void UnmemSpell(Integer slot); -Void UnmemSpell(Integer slot, Boolean update_client); -Void UnmemSpellAll(); -Void UnmemSpellAll(Boolean update_client); -Void ScribeSpell(Integer spell_id, Integer slot); -Void ScribeSpell(Integer spell_id, Integer slot, Boolean update_client); -Void UnscribeSpell(Integer slot); -Void UnscribeSpell(Integer slot, Boolean update_client); -Void UnscribeSpellAll(); -Void UnscribeSpellAll(Boolean update_client); -Void UntrainDisc(Integer slot); -Void UntrainDisc(Integer slot, Boolean update_client); -Void UntrainDiscAll(); -Void UntrainDiscAll(Boolean update_client); -Boolean IsSitting(); -Void SetFeigned(Boolean v); -Boolean GetFeigned(); -Boolean AutoSplitEnabled(); -Void SetHorseId(Integer id); -Integer GetHorseId(); -Void NukeItem(Integer item_num); -Void NukeItem(Integer item_num, Integer where_to_check); -Void SetTint(Integer slot_id, Integer color); -Void SetMaterial(Integer slot_id, Integer item_id); -Void Undye(); -Integer GetItemIDAt(Integer slot_id); -Integer GetAugmentIDAt(Integer slot_id, Integer aug_slot); -Void DeleteItemInInventory(Integer slot_id, Integer quantity); -Void DeleteItemInInventory(Integer slot_id, Integer quantity, Boolean update_client); -Void SummonItem(Integer item_id); -Void SummonItem(Integer item_id, Integer charges); -Void SummonItem(Integer item_id, Integer charges, Integer aug1); -Void SummonItem(Integer item_id, Integer charges, Integer aug1, Integer aug2); -Void SummonItem(Integer item_id, Integer charges, Integer aug1, Integer aug2, Integer aug3); -Void SummonItem(Integer item_id, Integer charges, Integer aug1, Integer aug2, Integer aug3, Integer aug4); -Void SummonItem(Integer item_id, Integer charges, Integer aug1, Integer aug2, Integer aug3, Integer aug4, Integer aug5); -Void SummonItem(Integer item_id, Integer charges, Integer aug1, Integer aug2, Integer aug3, Integer aug4, Integer aug5, Boolean attuned); -Void SummonItem(Integer item_id, Integer charges, Integer aug1, Integer aug2, Integer aug3, Integer aug4, Integer aug5, Boolean attuned, Integer to_slot); -Void SetStats(Integer type, Integer value); -Void IncStats(Integer type, Integer value); -Void DropItem(Integer slot_id); -Void BreakInvis(); -Void LeaveGroup(); -Boolean IsGrouped(); -Boolean IsRaidGrouped(); -Boolean Hungry(); -Boolean Thirsty(); -Integer GetInstrumentMod(Integer spell_id); -Boolean DecreaseByID(Integer type, Integer amt); -Void Escape(); -Void GoFish(); -Void ForageItem(); -Void ForageItem(Boolean guarantee); -Real CalcPriceMod(Mob other, Boolean reverse); -Void ResetTrade(); -Boolean UseDiscipline(Integer spell_id, Integer target_id); -Integer GetCharacterFactionLevel(Integer faction_id); -Void SetZoneFlag(Integer zone_id); -Void ClearZoneFlag(Integer zone_id); -Boolean HasZoneFlag(Integer zone_id); -Void SendZoneFlagInfo(Client to); -Void SetAATitle(String title); -Integer GetClientVersion(); -Integer GetClientVersionBit(); -Void SetTitleSuffix(String text); -Void SetAAPoints(Integer points); -Integer GetAAPoints(); -Integer GetSpentAA(); -Void AddAAPoints(Integer points); -Void RefundAA(); -Integer GetModCharacterFactionLevel(Integer faction); -Integer GetLDoNWins(); -Integer GetLDoNLosses(); -Integer GetLDoNWinsTheme(Integer theme); -Integer GetLDoNLossesTheme(Integer theme); -Integer GetStartZone(); -Void SetStartZone(Integer zone_id); -Void SetStartZone(Integer zone_id, Real x); -Void SetStartZone(Integer zone_id, Real x, Real y); -Void SetStartZone(Integer zone_id, Real x, Real y, Real z); -Void KeyRingAdd(Integer item); -Boolean KeyRingCheck(Integer item); -Void AddPVPPoints(Integer points); -Void AddCrystals(Integer radiant, Integer ebon); -Integer GetPVPPoints(); -Integer GetRadiantCrystals(); -Integer GetEbonCrystals(); -Void QuestReadBook(String text, Integer type); -Void UpdateGroupAAs(Integer points, Integer type); -Integer GetGroupPoints(); -Integer GetRaidPoints(); -Void LearnRecipe(Integer recipe); -Integer GetEndurance(); -Integer GetMaxEndurance(); -Integer GetEndurancePercent(); -Void SetEndurance(Integer endur); -Void SendOPTranslocateConfirm(Mob caster, Integer spell_id); -Integer GetIP(); -Void AddLevelBasedExp(Integer exp_pct); -Void AddLevelBasedExp(Integer exp_pct, Integer max_level); -Void IncrementAA(Integer aa); -Void MarkSingleCompassLoc(Real in_x, Real in_y, Real in_z); -Void MarkSingleCompassLoc(Real in_x, Real in_y, Real in_z, Integer count); -Integer GetNextAvailableSpellBookSlot(); -Integer GetNextAvailableSpellBookSlot(Integer start); -Integer FindSpellBookSlotBySpellID(Integer spell_id); -Void UpdateTaskActivity(Integer task, Integer activity, Integer count); -Void AssignTask(Integer task, Integer npc_id); -Void FailTask(Integer task); -Boolean IsTaskCompleted(Integer task); -Boolean IsTaskActive(Integer task); -Boolean IsTaskActivityActive(Integer task, Integer activity); -Integer GetCorpseCount(); -Integer GetCorpseID(Integer corpse); -Integer GetCorpseItemAt(Integer corpse, Integer slot); -Void AssignToInstance(Integer instance_id); -Void Freeze(); -Void UnFreeze(); -Integer GetAggroCount(); -Integer GetCarriedMoney(); -Integer GetAllMoney(); -Void OpenLFGuildWindow(); -Void Signal(Integer id); -Void AddAlternateCurrencyValue(Integer currency, Integer amount); -Void SendWebLink(String site); -Boolean HasSpellScribed(Integer spell_id); -Void SetAccountFlag(String flag, String val); -String GetAccountFlag(String flag); -Group GetGroup(); -Raid GetRaid(); -Boolean PutItemInInventory(Integer slot_id, ItemInst inst); -Boolean PushItemOnCursor(ItemInst inst); -Inventory GetInventory(); -Void SendItemScale(ItemInst inst); -Void QueuePacket(Packet app); -Void QueuePacket(Packet app, Boolean ack_req); -Void QueuePacket(Packet app, Boolean ack_req, Integer client_connection_status); -Void QueuePacket(Packet app, Boolean ack_req, Integer client_connection_status, Integer filter); -Integer GetHunger(); -Integer GetThirst(); -Void SetHunger(Integer in_hunger); -Void SetThirst(Integer in_thirst); -Void SetConsumption(Integer in_hunger, Integer in_thirst); -Void SendMarqueeMessage(Integer type, Integer priority, Integer fade_in, Integer fade_out, Integer duration, String msg); -Void PlayMP3(String filename); +Client is a class exported to Lua that represent the Client object from EQEmu. All Client are also [Mob](Lua-Mob). + +[Return to the Lua API](Lua-API) + +### Properties +``` +client.null -- Returns true if this object is null +client.valid -- Returns true if this object is not null +``` + +### Member Functions +``` +Client() -- Creates a null client +Void SendSound(); +Void Save(); +Void Save(Integer commit_now); +Void SaveBackup(); +Boolean Connected(); +Boolean InZone(); +Void Kick(); +Void Disconnect(); +Boolean IsLD(); +Void WorldKick(); +Boolean GetAnon(); +Void Duck(); +Void Stand(); +Void SetGM(Boolean v); +Void SetPVP(Boolean v); +Boolean GetPVP(); +Boolean GetGM(); +Void SetBaseClass(Integer v); +Void SetBaseRace(Integer v); +Void SetBaseGender(Integer v); +Integer GetBaseFace(); +Integer GetLanguageSkill(Integer skill_id); +String GetLastName(); +Integer GetLDoNPointsTheme(Integer theme); +Integer GetBaseSTR(); +Integer GetBaseSTA(); +Integer GetBaseCHA(); +Integer GetBaseDEX(); +Integer GetBaseINT(); +Integer GetBaseAGI(); +Integer GetBaseWIS(); +Integer GetWeight(); +Integer GetEXP(); +Integer GetAAExp(); +Integer GetTotalSecondsPlayed(); +Void UpdateLDoNPoints(Integer points, Integer theme); +Void SetDeity(Integer v); +Void AddEXP(Integer add_exp); +Void AddEXP(Integer add_exp, Integer conlevel); +Void AddEXP(Integer add_exp, Integer conlevel, Boolean resexp); +Void SetEXP(Integer set_exp, Integer set_aaxp); +Void SetEXP(Integer set_exp, Integer set_aaxp, Boolean resexp); +Void SetBindPoint(); +Void SetBindPoint(Integer to_zone); +Void SetBindPoint(Integer to_zone, Real new_x); +Void SetBindPoint(Integer to_zone, Real new_x, Real new_y); +Void SetBindPoint(Integer to_zone, Real new_x, Real new_y, Real new_z); +Real GetBindX(); +Real GetBindX(Integer index); +Real GetBindY(); +Real GetBindY(Integer index); +Real GetBindZ(); +Real GetBindZ(Integer index); +Real GetBindHeading(); +Real GetBindHeading(Integer index); +Integer GetBindZoneID(); +Integer GetBindZoneID(Integer index); +Void MovePC(Integer zone, Real x, Real y, Real z, Real heading); +Void MovePCInstance(Integer zone, Integer instance, Real x, Real y, Real z, Real heading); +Void ChangeLastName(String in); +Integer GetFactionLevel(Integer char_id, Integer npc_id, Integer race, Integer class_, Integer deity, Integer faction, NPC npc); +Void SetFactionLevel(Integer char_id, Integer npc_id, Integer char_class, Integer char_race, Integer char_deity); +Void SetFactionLevel2(Integer char_id, Integer faction_id, Integer char_class, Integer char_race, Integer char_deity, Integer value, Integer temp); +Integer GetRawItemAC(); +Integer AccountID(); +String AccountName(); +Integer Admin(); +Integer CharacterID(); +Integer GuildRank(); +Integer GuildID(); +Integer GetFace(); +Boolean TakeMoneyFromPP(Integer copper); +Boolean TakeMoneyFromPP(Integer copper, Boolean update_client); +Void AddMoneyToPP(Integer copper, Integer silver, Integer gold, Integer platinum, Boolean update_client); +Boolean TGB(); +Integer GetSkillPoints(); +Void SetSkillPoints(Integer skill); +Void IncreaseSkill(Integer skill_id); +Void IncreaseSkill(Integer skill_id, Integer value); +Void IncreaseLanguageSkill(Integer skill_id); +Void IncreaseLanguageSkill(Integer skill_id, Integer value); +Integer GetRawSkill(Integer skill_id); +Boolean HasSkill(Integer skill_id); +Boolean CanHaveSkill(Integer skill_id); +Void SetSkill(Integer skill_id, Integer value); +Void AddSkill(Integer skill_id, Integer value); +Void CheckSpecializeIncrease(Integer spell_id); +Void CheckIncreaseSkill(Integer skill_id, Mob target); +Void CheckIncreaseSkill(Integer skill_id, Mob target, Integer chance_mod); +Void SetLanguageSkill(Integer language, Integer value); +Integer MaxSkill(Integer skill_id); +Boolean IsMedding(); +Integer GetDuelTarget(); +Boolean IsDueling(); +Void SetDuelTarget(Integer c); +Void SetDueling(Boolean v); +Void ResetAA(); +Void MemSpell(Integer spell_id, Integer slot); +Void MemSpell(Integer spell_id, Integer slot, Boolean update_client); +Void UnmemSpell(Integer slot); +Void UnmemSpell(Integer slot, Boolean update_client); +Void UnmemSpellAll(); +Void UnmemSpellAll(Boolean update_client); +Void ScribeSpell(Integer spell_id, Integer slot); +Void ScribeSpell(Integer spell_id, Integer slot, Boolean update_client); +Void UnscribeSpell(Integer slot); +Void UnscribeSpell(Integer slot, Boolean update_client); +Void UnscribeSpellAll(); +Void UnscribeSpellAll(Boolean update_client); +Void UntrainDisc(Integer slot); +Void UntrainDisc(Integer slot, Boolean update_client); +Void UntrainDiscAll(); +Void UntrainDiscAll(Boolean update_client); +Boolean IsSitting(); +Void SetFeigned(Boolean v); +Boolean GetFeigned(); +Boolean AutoSplitEnabled(); +Void SetHorseId(Integer id); +Integer GetHorseId(); +Void NukeItem(Integer item_num); +Void NukeItem(Integer item_num, Integer where_to_check); +Void SetTint(Integer slot_id, Integer color); +Void SetMaterial(Integer slot_id, Integer item_id); +Void Undye(); +Integer GetItemIDAt(Integer slot_id); +Integer GetAugmentIDAt(Integer slot_id, Integer aug_slot); +Void DeleteItemInInventory(Integer slot_id, Integer quantity); +Void DeleteItemInInventory(Integer slot_id, Integer quantity, Boolean update_client); +Void SummonItem(Integer item_id); +Void SummonItem(Integer item_id, Integer charges); +Void SummonItem(Integer item_id, Integer charges, Integer aug1); +Void SummonItem(Integer item_id, Integer charges, Integer aug1, Integer aug2); +Void SummonItem(Integer item_id, Integer charges, Integer aug1, Integer aug2, Integer aug3); +Void SummonItem(Integer item_id, Integer charges, Integer aug1, Integer aug2, Integer aug3, Integer aug4); +Void SummonItem(Integer item_id, Integer charges, Integer aug1, Integer aug2, Integer aug3, Integer aug4, Integer aug5); +Void SummonItem(Integer item_id, Integer charges, Integer aug1, Integer aug2, Integer aug3, Integer aug4, Integer aug5, Boolean attuned); +Void SummonItem(Integer item_id, Integer charges, Integer aug1, Integer aug2, Integer aug3, Integer aug4, Integer aug5, Boolean attuned, Integer to_slot); +Void SetStats(Integer type, Integer value); +Void IncStats(Integer type, Integer value); +Void DropItem(Integer slot_id); +Void BreakInvis(); +Void LeaveGroup(); +Boolean IsGrouped(); +Boolean IsRaidGrouped(); +Boolean Hungry(); +Boolean Thirsty(); +Integer GetInstrumentMod(Integer spell_id); +Boolean DecreaseByID(Integer type, Integer amt); +Void Escape(); +Void GoFish(); +Void ForageItem(); +Void ForageItem(Boolean guarantee); +Real CalcPriceMod(Mob other, Boolean reverse); +Void ResetTrade(); +Boolean UseDiscipline(Integer spell_id, Integer target_id); +Integer GetCharacterFactionLevel(Integer faction_id); +Void SetZoneFlag(Integer zone_id); +Void ClearZoneFlag(Integer zone_id); +Boolean HasZoneFlag(Integer zone_id); +Void SendZoneFlagInfo(Client to); +Void SetAATitle(String title); +Integer GetClientVersion(); +Integer GetClientVersionBit(); +Void SetTitleSuffix(String text); +Void SetAAPoints(Integer points); +Integer GetAAPoints(); +Integer GetSpentAA(); +Void AddAAPoints(Integer points); +Void RefundAA(); +Integer GetModCharacterFactionLevel(Integer faction); +Integer GetLDoNWins(); +Integer GetLDoNLosses(); +Integer GetLDoNWinsTheme(Integer theme); +Integer GetLDoNLossesTheme(Integer theme); +Integer GetStartZone(); +Void SetStartZone(Integer zone_id); +Void SetStartZone(Integer zone_id, Real x); +Void SetStartZone(Integer zone_id, Real x, Real y); +Void SetStartZone(Integer zone_id, Real x, Real y, Real z); +Void KeyRingAdd(Integer item); +Boolean KeyRingCheck(Integer item); +Void AddPVPPoints(Integer points); +Void AddCrystals(Integer radiant, Integer ebon); +Integer GetPVPPoints(); +Integer GetRadiantCrystals(); +Integer GetEbonCrystals(); +Void QuestReadBook(String text, Integer type); +Void UpdateGroupAAs(Integer points, Integer type); +Integer GetGroupPoints(); +Integer GetRaidPoints(); +Void LearnRecipe(Integer recipe); +Integer GetEndurance(); +Integer GetMaxEndurance(); +Integer GetEndurancePercent(); +Void SetEndurance(Integer endur); +Void SendOPTranslocateConfirm(Mob caster, Integer spell_id); +Integer GetIP(); +Void AddLevelBasedExp(Integer exp_pct); +Void AddLevelBasedExp(Integer exp_pct, Integer max_level); +Void IncrementAA(Integer aa); +Void MarkSingleCompassLoc(Real in_x, Real in_y, Real in_z); +Void MarkSingleCompassLoc(Real in_x, Real in_y, Real in_z, Integer count); +Integer GetNextAvailableSpellBookSlot(); +Integer GetNextAvailableSpellBookSlot(Integer start); +Integer FindSpellBookSlotBySpellID(Integer spell_id); +Void UpdateTaskActivity(Integer task, Integer activity, Integer count); +Void AssignTask(Integer task, Integer npc_id); +Void FailTask(Integer task); +Boolean IsTaskCompleted(Integer task); +Boolean IsTaskActive(Integer task); +Boolean IsTaskActivityActive(Integer task, Integer activity); +Integer GetCorpseCount(); +Integer GetCorpseID(Integer corpse); +Integer GetCorpseItemAt(Integer corpse, Integer slot); +Void AssignToInstance(Integer instance_id); +Void Freeze(); +Void UnFreeze(); +Integer GetAggroCount(); +Integer GetCarriedMoney(); +Integer GetAllMoney(); +Void OpenLFGuildWindow(); +Void Signal(Integer id); +Void AddAlternateCurrencyValue(Integer currency, Integer amount); +Void SendWebLink(String site); +Boolean HasSpellScribed(Integer spell_id); +Void SetAccountFlag(String flag, String val); +String GetAccountFlag(String flag); +Group GetGroup(); +Raid GetRaid(); +Boolean PutItemInInventory(Integer slot_id, ItemInst inst); +Boolean PushItemOnCursor(ItemInst inst); +Inventory GetInventory(); +Void SendItemScale(ItemInst inst); +Void QueuePacket(Packet app); +Void QueuePacket(Packet app, Boolean ack_req); +Void QueuePacket(Packet app, Boolean ack_req, Integer client_connection_status); +Void QueuePacket(Packet app, Boolean ack_req, Integer client_connection_status, Integer filter); +Integer GetHunger(); +Integer GetThirst(); +Void SetHunger(Integer in_hunger); +Void SetThirst(Integer in_thirst); +Void SetConsumption(Integer in_hunger, Integer in_thirst); +Void SendMarqueeMessage(Integer type, Integer priority, Integer fade_in, Integer fade_out, Integer duration, String msg); +Void SendColoredText(Integer type, String msg); +Void PlayMP3(String filename); ``` \ No newline at end of file