Client Methods
These are the Client object methods available through the EQEmu Quest API
We are actively working on a system to explore the EQEmu Quest API. Please cross-reference with the new system as needed.
Perl
Lua
1
$client->AccountID()
2
$client->AccountName()
3
$client->AddAAPoints(uint32 points)
4
$client->AddAlternateCurrencyValue(uint32 currency_id, int32 amount)
5
$client->AddCrystals(uint32 radiant_count, uint32 ebon_count)
6
$client->AddEXP(uint32 experience_points)
7
$client->AddLevelBasedExp(uint8 exp_percentage, uint8 max_level = 0, bool ignore_mods = false)
8
$client->AddMoneyToPP(uint32 copper, uint32 silver, uint32 gold, uint32 platinum, bool update_client)
9
$client->AddPVPPoints(uint32 points)
10
$client->AddSkill(int skill_id, uint16 value)
11
$client->Admin()
12
$client->AssignTask(int task_id, int npc_id, [bool enforce_level_requirement = false])
13
$client->AssignToInstance(uint16 instance_id)
14
$client->AutoSplitEnabled()
15
$client->BreakInvis()
16
$client->CalcPriceMod(mob*, [bool reverse = false])
17
$client->CanHaveSkill(int skill_id)
18
$client->ChangeLastName(string last_name)
19
$client->CharacterID()
20
$client->CheckIncreaseSkill(int skill_id, int chance_modifier = 0)
21
$client->CheckSpecializeIncrease(uint16 spell_id)
22
$client->ClearCompassMark()
23
$client->ClearZoneFlag(uint32 zone_id)
24
$client->Connected()
25
$client->CountItem(uint32 item_id)
26
$client->DecreaseByID(uint32 type, unit8 amount)
27
$client->DeleteItemInInventory(int16 slot_id, [int8 quantity = 0], [bool client_update = false])
28
$client->Disconnect()
29
$client->DropItem(int16 slot_id)
30
$client->Duck()
31
$client->DyeArmorBySlot(uint8 slot, uint8 red, uint8 green, uint8 blue, [uint8 use_tint = 0x00])
32
$client->Escape()
33
$client->ExpeditionMessage(int expedition_id, string message)
34
$client->FailTask(int task_id)
35
$client->FindMemmedSpellBySlot(int slot)
36
$client->ForageItem()
37
$client->GMKill()
38
$client->GetAAExp()
39
$client->GetAALevel(uint32 aa_skill_id)
40
$client->GetAAPercent()
41
$client->GetAAPoints()
42
$client->GetAccountFlag(string flag)
43
$client->GetAggroCount()
44
$client->GetAllMoney()
45
$client->GetAlternateCurrencyValue(uint32 currency_id)
46
$client->GetAnon()
47
$client->GetAugmentAt(uint32 slot, uint32 aug_slot)
48
$client->GetAugmentIDAt(int16 slot_id, int16 aug_slot)
49
$client->GetBaseAGI()
50
$client->GetBaseCHA()
51
$client->GetBaseDEX()
52
$client->GetBaseFace()
53
$client->GetBaseINT()
54
$client->GetBaseRace()
55
$client->GetBaseSTA()
56
$client->GetBaseSTR()
57
$client->GetBaseWIS()
58
$client->GetBecomeNPCLevel()
59
$client->GetBindHeading(int index = 0)
60
$client->GetBindX(int index = 0)
61
$client->GetBindY(int index = 0)
62
$client->GetBindZ(int index = 0)
63
$client->GetBindZoneID(int index = 0)
64
$client->GetCarriedMoney()
65
$client->GetCharacterFactionLevel(int32 faction_id)
66
$client->GetClientVersion()
67
$client->GetClientVersionBit()
68
$client->GetCorpseCount()
69
$client->GetCorpseID(uint8 corpse)
70
$client->GetCorpseItemAt(uint32 corpse_id, uint16 slot_id)
71
$client->GetCustomItemData(int16 slot_id, string identifier)
72
$client->GetDisciplineTimer(uint32 timer_id)
73
$client->GetDiscSlotBySpellID(int32 spell_id)
74
$client->GetDisplayAC()
75
$client->GetDuelTarget()
76
$client->GetEXP()
77
$client->GetEbonCrystals()
78
$client->GetEndurance()
79
$client->GetEnduranceRatio()
80
$client->GetFace()
81
$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*)
82
$client->GetFeigned()
83
$client->GetFreeSpellBookSlot(uint32 start_slot = 0)
84
$client->GetGM()
85
$client->GetGroup()
86
$client->GetGroupPoints()
87
$client->GetHorseId()
88
$client->GetHunger()
89
$client->GetIP()
90
$client->GetInstanceID()
91
$client->GetInstrumentMod(uint16 spell_id)
92
$client->GetItemAt(uint32 slot)
93
$client->GetItemIDAt(int16 slot_id)
94
$client->GetItemInInventory(int16 slot_id)
95
$client->GetLDoNLosses()
96
$client->GetLDoNLossesTheme(int32 theme)
97
$client->GetLDoNPointsTheme(int32 theme)
98
$client->GetLDoNWins()
99
$client->GetLDoNWinsTheme(int32 theme)
100
$client->GetLanguageSkill(uint16 lanuage_id)
101
$client->GetLastName()
102
$client->GetMaxEndurance()
103
$client->GetModCharacterFactionLevel(int32 faction_id)
104
$client->GetPVP()
105
$client->GetPVPPoints()
106
$client->GetRadiantCrystals()
107
$client->GetRaid()
108
$client->GetRaidPoints()
109
$client->GetRawItemAC()
110
$client->GetRawSkill(int skill_id)
111
$client->GetSkill(uint16 skill_id)
112
$client->GetSkillPoints()
113
$client->GetSpellBookSlotBySpellID(uint32 spell_id)
114
$client->GetSpentAA()
115
$client->GetStartZone()
116
$client->GetTargetRingX()
117
$client->GetTargetRingY()
118
$client->GetTargetRingZ()
119
$client->GetTaskActivityDoneCount(int task_id, int activity_id)
120
$client->GetThirst()
121
$client->GetTotalSecondsPlayed()
122
$client->GetWeight()
123
$client->GoFish()
124
$client->GrantAlternateAdvancementAbility(int aa_id, int points, [bool ignore_cost = false])
125
$client->GuildID()
126
$client->GuildRank()
127
$client->HasSkill(int skill_id)
128
$client->HasSpellScribed(int spell_id)
129
$client->HasZoneFlag(uint32 zone_id)
130
$client->Hungry()
131
$client->InZone()
132
$client->IncStats(uint8 type, uint16 increase_val)
133
$client->IncreaseLanguageSkill(int skill_id, int value = 1)
134
$client->IncreaseSkill(int skill_id, int value = 1)
135
$client->IncrementAA(uint32 aa_skill_id)
136
$client->IsBecomeNPC()
137
$client->IsCrouching()
138
$client->IsDueling()
139
$client->IsGrouped()
140
$client->IsLD()
141
$client->IsMedding()
142
$client->IsRaidGrouped()
143
$client->IsSitting()
144
$client->IsStanding()
145
$client->IsTaskActive(int task_id)
146
$client->IsTaskActivityActive(int task_id, int activity_id)
147
$client->IsTaskCompleted(int task_id)
148
$client->KeyRingAdd(uint32 item_id)
149
$client->KeyRingCheck(uint32 item_id)
150
$client->Kick()
151
$client->LearnRecipe(uint32 recipe_id)
152
$client->LeaveGroup()
153
$client->LoadZoneFlags()
154
$client->MarkCompassLoc(float X, float Y, float Z)
155
$client->MaxSkill(uint16 skill_id, uint16 class_id, uint16 level)
156
$client->MemSpell(uint16 spell_id, int slot, [bool update_client = true])
157
$client->MemmedCount()
158
$client->MovePC(uint32 zone_id, float X, float Y, float Z, float heading)
159
$client->MovePCInstance(uint32 zone_id, uint32 instance_id, float X, float Y, float Z, float heading)
160
$client->MoveZone(const char *zone_short_name)
161
$client->MoveZoneGroup(const char *zone_short_name)
162
$client->MoveZoneRaid(const char *zone_short_name)
163
$client->MoveZoneInstance(uint16 instance_id)
164
$client->MoveZoneInstanceGroup(uint16 instance_id)
165
$client->MoveZoneInstanceRaid(uint16 instance_id)
166
$client->NotifyNewTitlesAvailable()
167
$client->NPCSpawn(npc*, string option, uint32 respawn_time=1200)
168
$client->NukeItem(uint32 item_id, [uint8 slot_to_check])
169
$client->OpenLFGuildWindow()
170
$client->PlayMP3(string file_name)
171
$client->Popup2(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)
172
$client->QuestReward(int32 mob, int32 copper, int32 silver, int32 gold, int32 platinum, int32 item_id, int32 exp, [bool faction = false])
173
$client->ReadBook(char* book_test, uint8 type)
174
$client->RefundAA()
175
$client->RemoveFromInstance(uint16 instance_id)
176
$client->RemoveItem(uint32 item_id, uint32 quantity)
177
$client->RemoveNoRent()
178
$client->ResetAA()
179
$client->ResetDisciplineTimer(uint32 timer_id)
180
$client->ResetTrade()
181
$client->Save(uint8 commit_now)
182
$client->SaveBackup()
183
$client->ScribeSpell(uint16 spell_id, int slot, [bool update_client = true])
184
$client->SendColoredText(uint32 color, string message)
185
$client->SendMarqueeMessage(uint32 type, uint32 priority, uint32 fade_in, uint32 fade_out, uint32 duration, string msg)
186
$client->SendOPTranslocateConfirm(mob* caster, int32 spell_id)
187
$client->SendSound()
188
$client->SendTargetCommand(int32 entity_id)
189
$client->SendToGuildHall()
190
$client->SendToInstance(sting type, string short name, uint32 instance version, float x, float y, float z, float heading, string instance identifier, uint32 duration)
191
$client->SendWebLink(string website_url)
192
$client->SendZoneFlagInfo(client* to)
193
$client->SetAAPoints(uint32 points)
194
$client->SetAATitle(string text, [bool save = false])
195
$client->SetAccountFlag(string flag, string value)
196
$client->SetAlternateCurrencyValue(uint32 currency_id, int32 amount)
197
$client->SetBaseClass(uint32 class_id)
198
$client->SetBaseGender(uint32 gender_id)
199
$client->SetBaseRace(uint32 race_id)
200
$client->SetBecomeNPC(flag)
201
$client->SetBecomeNPCLevel(level)
202
$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)
203
$client->SetCustomItemData(int16 slot_id, string identifier, string value)
204
$client->SetDeity(uint32 deity_id)
205
$client->SetDuelTarget(set_id)
206
$client->SetDueling(duel)
207
$client->SetEXP(uint32 experience_points, uint32 aa_experience_points, [bool resexp=false])
208
$client->SetEndurance(endurance)
209
$client->SetFactionLevel(uint32 character_id, uint32 npc_id, uint8 character_class, uint8 character_race, uint8 character_deity)
210
$client->SetFactionLevel2(uint32 character_id, int32 faction_id, uint8 character_class, uint8 character_race, uint8 character_deity, int32 value, uint8 temp)
211
$client->SetFeigned(in_feigned)
212
$client->SetGM(bool toggle)
213
$client->SetHorseId(horseid_in)
214
$client->SetHunger(in_hunger)
215
$client->SetHunger(int32 hunger_amount, int32 thirst_amount)
216
$client->SetLanguageSkill(int language_id, int value)
217
$client->SetMaterial(int16 slot_id, uint32 item_id)
218
$client->SetPVP(bool toggle)
219
$client->SetPrimaryWeaponOrnamentation(model_id)
220
$client->SetSecondaryWeaponOrnamentation(model_id)
221
$client->SetSkill(int skill_id, uint16 value)
222
$client->SetSkillPoints(inp)
223
$client->SetStats(uint8 type, uint16 increase_val)
224
$client->SetThirst(int32 in_thirst)
225
$client->SetTint(int16 slot_id, uint32 color)
226
$client->SetTitleSuffix(string text, [bool save = false])
227
$client->SetZoneFlag(uint32 zone_id)
228
$client->SignalClient(uint32 data)
229
$client->SilentMessage(string message)
230
$client->SlotConvert2(uint8 slot)
231
$client->Stand()
232
$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 = cursor])
233
$client->TGB()
234
$client->TakeMoneyFromPP(uint32 copper, bool update_client = false)
235
$client->Thirsty()
236
$client->TrainDiscBySpellID(int32 spell_id)
237
$client->Undye()
238
$client->UnmemSpell(int slot, [bool update_client = true])
239
$client->UnmemSpellAll([bool update_client = true])
240
$client->UnmemSpellBySpellID(int32 spell_id)
241
$client->UnscribeSpell(int slot, [bool update_client = true])
242
$client->UnscribeSpellAll([bool update_client = true])
243
$client->UntrainDisc(int slot, [bool update_client = true])
244
$client->UntrainDiscAll([update_client = true])
245
$client->UpdateAdmin(bool from_db = true)
246
$client->UpdateGroupAAs(int32 points, uint32 type)
247
$client->UpdateLDoNPoints(int32 points, uint32 theme)
248
$client->UpdateTaskActivity(int task_id, int activity_id, int count, [bool ignore_quest_update = false])
249
$client->UpdateWho(uint8 remove = 0)
250
$client->UseDiscipline(int32 spell_id, int32 target)
251
$client->WorldKick()
Copied!
1
client:AccountID(); -- uint32
2
client:AddAAPoints(int points); -- void
3
client:AddAlternateCurrencyValue(uint32 currency, int amount); -- void
4
client:AddCrystals(uint32 radiant, uint32 ebon); -- void
5
client:AddEXP(uint32 add_exp); -- void
6
client:AddEXP(uint32 add_exp, int conlevel); -- void
7
client:AddEXP(uint32 add_exp, int conlevel, bool resexp); -- void
8
client:AddLevelBasedExp(int exp_pct); -- void
9
client:AddLevelBasedExp(int exp_pct, int max_level); -- void
10
client:AddLevelBasedExp(int exp_pct, int max_level, bool ignore_mods); -- void
11
client:AddMoneyToPP(uint32 copper, uint32 silver, uint32 gold, uint32 platinum, bool update_client); -- void
12
client:AddPVPPoints(uint32 points); -- void
13
client:AddSkill(int skill_id, int value); -- void
14
client:Admin(); -- int
15
client:AssignTask(int task, int npc_id); -- void
16
client:AssignTask(int task, int npc_id, bool enforce_level_requirement); -- void
17
client:AssignToInstance(int instance_id); -- void
18
client:AutoSplitEnabled(); -- bool
19
client:BreakInvis(); -- void
20
client:CalcATK(); -- int
21
client:CalcCurrentWeight(); -- int
22
client:CalcPriceMod(Lua_Mob other, bool reverse); -- float
23
client:CanHaveSkill(int skill_id); -- bool
24
client:ChangeLastName(const char *in); -- void
25
client:CharacterID(); -- uint32
26
client:CheckIncreaseSkill(int skill_id, Lua_Mob target); -- void
27
client:CheckIncreaseSkill(int skill_id, Lua_Mob target, int chance_mod); -- void
28
client:CheckSpecializeIncrease(int spell_id); -- void
29
client:ClearCompassMark(); -- void
30
client:ClearZoneFlag(int zone_id); -- void
31
client:Connected(); -- bool
32
client:CountItem(uint32 item_id); -- int
33
client:DecreaseByID(uint32 type, int amt); -- bool
34
client:DeleteItemInInventory(int slot_id, int quantity); -- void
35
client:DeleteItemInInventory(int slot_id, int quantity, bool update_client); -- void
36
client:DisableAreaEndRegen(); -- void
37
client:DisableAreaHPRegen(); -- void
38
client:DisableAreaManaRegen(); -- void
39
client:DisableAreaRegens(); -- void
40
client:Disconnect(); -- void
41
client:DropItem(int slot_id); -- void
42
client:Duck(); -- void
43
client:DyeArmorBySlot(uint8 slot, uint8 red, uint8 green, uint8 blue); -- void
44
client:DyeArmorBySlot(uint8 slot, uint8 red, uint8 green, uint8 blue, uint8 use_tint); -- void
45
client:EnableAreaEndRegen(int value); -- void
46
client:EnableAreaHPRegen(int value); -- void
47
client:EnableAreaManaRegen(int value); -- void
48
client:EnableAreaRegens(int value); -- void
49
client:Escape(); -- void
50
client:FailTask(int task); -- void
51
client:FilteredMessage(Mob *sender, uint32 type, int filter, const char *message); -- void
52
client:FindMemmedSpellBySlot(int slot); -- uint16
53
client:FindSpellBookSlotBySpellID(int spell_id); -- int
54
client:ForageItem(); -- void
55
client:ForageItem(bool guarantee); -- void
56
client:Freeze(); -- void
57
client:GetAAExp(); -- uint32
58
client:GetAAPercent(); -- uint32
59
client:GetAAPoints(); -- int
60
client:GetAccountAge(); -- int
61
client:GetAccountFlag(std::string flag); -- std::string
62
client:GetAggroCount(); -- int
63
client:GetAllMoney(); -- uint64
64
client:GetAlternateCurrencyValue(uint32 currency); -- int
65
client:GetAnon(); -- bool
66
client:GetAugmentIDAt(int slot_id, int aug_slot); -- int
67
client:GetBaseAGI(); -- int
68
client:GetBaseCHA(); -- int
69
client:GetBaseDEX(); -- int
70
client:GetBaseFace(); -- int
71
client:GetBaseINT(); -- int
72
client:GetBaseRace(); -- int
73
client:GetBaseSTA(); -- int
74
client:GetBaseSTR(); -- int
75
client:GetBaseWIS(); -- int
76
client:GetBindHeading(); -- float
77
client:GetBindHeading(int index); -- float
78
client:GetBindX(); -- float
79
client:GetBindX(int index); -- float
80
client:GetBindY(); -- float
81
client:GetBindY(int index); -- float
82
client:GetBindZ(); -- float
83
client:GetBindZ(int index); -- float
84
client:GetBindZoneID(); -- uint32
85
client:GetBindZoneID(int index); -- uint32
86
client:GetCarriedMoney(); -- uint64
87
client:GetCharacterFactionLevel(int faction_id); -- int
88
client:GetClientVersion(); -- int
89
client:GetClientVersionBit(); -- uint32
90
client:GetCorpseCount(); -- int
91
client:GetCorpseID(int corpse); -- int
92
client:GetCorpseItemAt(int corpse, int slot); -- int
93
client:GetDisciplineTimer(uint32 timer_id); -- uint32
94
client:GetDiscSlotBySpellID(int32 spell_id); -- int
95
client:GetDisplayAC()
96
client:GetDuelTarget(); -- int
97
client:GetEXP(); -- uint32
98
client:GetEbonCrystals(); -- uint32
99
client:GetEndurance(); -- int
100
client:GetEndurancePercent(); -- int
101
client:GetFace(); -- int
102
client:GetFactionLevel(uint32 char_id, uint32 npc_id, uint32 race, uint32 class_, uint32 deity, uint32 faction, Lua_NPC npc); -- int
103
client:GetFeigned(); -- bool
104
client:GetGM(); -- bool
105
client:GetGroup(); -- Lua_Group
106
client:GetGroupPoints(); -- uint32
107
client:GetHorseId(); -- int
108
client:GetHunger(); -- int
109
client:GetIP(); -- uint32
110
client:GetInstrumentMod(int spell_id); -- int
111
client:GetInventory(); -- Lua_Inventory
112
client:GetItemIDAt(int slot_id); -- int
113
client:GetLDoNLosses(); -- int
114
client:GetLDoNLossesTheme(int theme); -- int
115
client:GetLDoNPointsTheme(int theme); -- int
116
client:GetLDoNWins(); -- int
117
client:GetLDoNWinsTheme(int theme); -- int
118
client:GetLanguageSkill(int skill_id); -- int
119
client:GetMaxEndurance(); -- int
120
client:GetModCharacterFactionLevel(int faction); -- int
121
client:GetMoney(uint8 type, uint8 subtype); -- uint32
122
client:GetNextAvailableSpellBookSlot(); -- int
123
client:GetNextAvailableSpellBookSlot(int start); -- int
124
client:GetPVP(); -- bool
125
client:GetPVPPoints(); -- uint32
126
client:GetRadiantCrystals(); -- uint32
127
client:GetRaid(); -- Lua_Raid
128
client:GetRaidPoints(); -- uint32
129
client:GetRawItemAC(); -- int
130
client:GetRawSkill(int skill_id); -- int
131
client:GetSkillPoints(); -- int
132
client:GetSpentAA(); -- int
133
client:GetStartZone(); -- int
134
client:GetThirst(); -- int
135
client:GetTotalSecondsPlayed(); -- uint32
136
client:GetWeight(); -- int
137
client:GoFish(); -- void
138
client:GrantAlternateAdvancementAbility(int aa_id, int points); -- bool
139
client:GrantAlternateAdvancementAbility(int aa_id, int points, bool ignore_cost); -- bool
140
client:GuildID(); -- uint32
141
client:GuildRank(); -- int
142
client:HasSkill(int skill_id); -- bool
143
client:HasSpellScribed(int spell_id); -- bool
144
client:HasZoneFlag(int zone_id); -- bool
145
client:Hungry(); -- bool
146
client:InZone(); -- bool
147
client:IncStats(int type, int value); -- void
148
client:IncreaseLanguageSkill(int skill_id); -- void
149
client:IncreaseLanguageSkill(int skill_id, int value); -- void
150
client:IncreaseSkill(int skill_id); -- void
151
client:IncreaseSkill(int skill_id, int value); -- void
152
client:IncrementAA(int aa); -- void
153
client:IsCrouching(); -- bool
154
client:IsDead(); -- bool
155
client:IsDueling(); -- bool
156
client:IsGrouped(); -- bool
157
client:IsLD(); -- bool
158
client:IsMedding(); -- bool
159
client:IsRaidGrouped(); -- bool
160
client:IsSitting(); -- bool
161
client:IsStanding(); -- bool
162
client:IsTaskActive(int task); -- bool
163
client:IsTaskActivityActive(int task, int activity); -- bool
164
client:IsTaskCompleted(int task); -- bool
165
client:KeyRingAdd(uint32 item); -- void
166
client:KeyRingCheck(uint32 item); -- bool
167
client:Kick(); -- void
168
client:LearnRecipe(uint32 recipe); -- void
169
client:LeaveGroup(); -- void
170
client:MarkSingleCompassLoc(float in_x, float in_y, float in_z); -- void
171
client:MarkSingleCompassLoc(float in_x, float in_y, float in_z, int count); -- void
172
client:MaxSkill(int skill_id); -- int
173
client:MemSpell(int spell_id, int slot); -- void
174
client:MemSpell(int spell_id, int slot, bool update_client); -- void
175
client:MemmedCount(); -- int
176
client:MovePC(int zone, float x, float y, float z, float heading); -- void
177
client:MovePCInstance(int zone, int instance, float x, float y, float z, float heading); -- void
178
client:MoveZone(const char *zone_short_name); -- void
179
client:MoveZoneGroup(const char *zone_short_name); -- void
180
client:MoveZoneRaid(const char *zone_short_name); -- void
181
client:MoveZoneInstance(uint16 instance_id); -- void
182
client:MoveZoneInstanceGroup(uint16 instance_id); -- void
183
client:MoveZoneInstanceRaid(uint16 instance_id); -- void
184
client:NukeItem(uint32 item_num); -- void
185
client:NukeItem(uint32 item_num, int where_to_check); -- void
186
client:OpenLFGuildWindow(); -- void
187
client:PlayMP3(std::string file); -- void
188
client:PushItemOnCursor(Lua_ItemInst inst); -- bool
189
client:PutItemInInventory(int slot_id, Lua_ItemInst inst); -- bool
190
client:QuestReadBook(const char *text, int type); -- void
191
client:QuestReward(Lua_Mob target); -- void
192
client:QuestReward(Lua_Mob target, uint32 copper); -- void
193
client:QuestReward(Lua_Mob target, uint32 copper, uint32 silver); -- void
194
client:QuestReward(Lua_Mob target, uint32 copper, uint32 silver, uint32 gold); -- void
195
client:QuestReward(Lua_Mob target, uint32 copper, uint32 silver, uint32 gold, uint32 platinum); -- void
196
client:QuestReward(Lua_Mob target, uint32 copper, uint32 silver, uint32 gold, uint32 platinum, uint32 itemid); -- void
197
client:QuestReward(Lua_Mob target, uint32 copper, uint32 silver, uint32 gold, uint32 platinum, uint32 itemid, uint32 exp); -- void
198
client:QuestReward(Lua_Mob target, uint32 copper, uint32 silver, uint32 gold, uint32 platinum, uint32 itemid, uint32 exp, bool faction); -- void
199
client:QueuePacket(Lua_Packet app); -- void
200
client:QueuePacket(Lua_Packet app, bool ack_req); -- void
201
client:QueuePacket(Lua_Packet app, bool ack_req, int client_connection_status); -- void
202
client:QueuePacket(Lua_Packet app, bool ack_req, int client_connection_status, int filter); -- void
203
client:RefundAA(); -- void
204
client:RemoveItem(uint32 item_id, uint32 quantity); -- void
205
client:ResetAA(); -- void
206
client:ResetDisciplineTimer(uint32 timer_id); -- void
207
client:ResetTrade(); -- void
208
client:Save(); -- void
209
client:Save(int commit_now); -- void
210
client:SaveBackup(); -- void
211
client:ScribeSpell(int spell_id, int slot); -- void
212
client:ScribeSpell(int spell_id, int slot, bool update_client); -- void
213
client:SendColoredText(uint32 type, std::string msg); -- void
214
client:SendItemScale(Lua_ItemInst inst); -- void
215
client:SendMarqueeMessage(uint32 type, uint32 priority, uint32 fade_in, uint32 fade_out, uint32 duration, std::string msg); -- void
216
client:SendOPTranslocateConfirm(Lua_Mob caster, int spell_id); -- void
217
client:SendSound(); -- void
218
client:SendToInstance(string instance_type, string zone_short_name, uint32 instance_version, float x, float y, float z, float heading, string instance_identifier, uint32 duration); -- void
219
client:SendWebLink(const char *site); -- void
220
client:SendZoneFlagInfo(Lua_Client to); -- void
221
client:SetAAPoints(int points); -- void
222
client:SetAATitle(const char *title); -- void
223
client:SetAccountFlag(std::string flag, std::string val); -- void
224
client:SetAlternateCurrencyValue(uint32 currency, int amount); -- void
225
client:SetBaseClass(int v); -- void
226
client:SetBaseGender(int v); -- void
227
client:SetBaseRace(int v); -- void
228
client:SetBindPoint(); -- void
229
client:SetBindPoint(int to_zone); -- void
230
client:SetBindPoint(int to_zone, int to_instance); -- void
231
client:SetBindPoint(int to_zone, int to_instance, float new_x); -- void
232
client:SetBindPoint(int to_zone, int to_instance, float new_x, float new_y); -- void
233
client:SetBindPoint(int to_zone, int to_instance, float new_x, float new_y, float new_z); -- void
234
client:SetConsumption(int in_hunger, int in_thirst); -- void
235
client:SetDeity(int v); -- void
236
client:SetDuelTarget(int c); -- void
237
client:SetDueling(bool v); -- void
238
client:SetEXP(uint32 set_exp, uint32 set_aaxp); -- void
239
client:SetEXP(uint32 set_exp, uint32 set_aaxp, bool resexp); -- void
240
client:SetEndurance(int endur); -- void
241
client:SetFactionLevel(uint32 char_id, uint32 npc_id, int char_class, int char_race, int char_deity); -- void
242
client:SetFactionLevel2(uint32 char_id, int faction_id, int char_class, int char_race, int char_deity, int value, int temp); -- void
243
client:SetFeigned(bool v); -- void
244
client:SetGM(bool v); -- void
245
client:SetHorseId(int id); -- void
246
client:SetHunger(int in_hunger); -- void
247
client:SetLanguageSkill(int language, int value); -- void
248
client:SetMaterial(int slot_id, uint32 item_id); -- void
249
client:SetPVP(bool v); -- void
250
client:SetPrimaryWeaponOrnamentation(uint32 model_id); -- void
251
client:SetSecondaryWeaponOrnamentation(uint32 model_id); -- void
252
client:SetSkill(int skill_id, int value); -- void
253
client:SetSkillPoints(int skill); -- void
254
client:SetStartZone(int zone_id); -- void
255
client:SetStartZone(int zone_id, float x); -- void
256
client:SetStartZone(int zone_id, float x, float y); -- void
257
client:SetStartZone(int zone_id, float x, float y, float z); -- void
258
client:SetStats(int type, int value); -- void
259
client:SetThirst(int in_thirst); -- void
260
client:SetTint(int slot_id, uint32 color); -- void
261
client:SetTitleSuffix(const char *text); -- void
262
client:SetZoneFlag(int zone_id); -- void
263
client:Signal(uint32 id); -- void
264
client:Stand(); -- void
265
client:SummonItem(uint32 item_id); -- void
266
client:SummonItem(uint32 item_id, int charges); -- void
267
client:SummonItem(uint32 item_id, int charges, uint32 aug1); -- void
268
client:SummonItem(uint32 item_id, int charges, uint32 aug1, uint32 aug2); -- void
269
client:SummonItem(uint32 item_id, int charges, uint32 aug1, uint32 aug2, uint32 aug3); -- void
270
client:SummonItem(uint32 item_id, int charges, uint32 aug1, uint32 aug2, uint32 aug3, uint32 aug4); -- void
271
client:SummonItem(uint32 item_id, int charges, uint32 aug1, uint32 aug2, uint32 aug3, uint32 aug4, uint32 aug5); -- void
272
client:SummonItem(uint32 item_id, int charges, uint32 aug1, uint32 aug2, uint32 aug3, uint32 aug4, uint32 aug5, bool attuned); -- void
273
client:SummonItem(uint32 item_id, int charges, uint32 aug1, uint32 aug2, uint32 aug3, uint32 aug4, uint32 aug5, bool attuned, int to_slot); -- void
274
client:TGB(); -- bool
275
client:TakeMoneyFromPP(uint64 copper); -- bool
276
client:TakeMoneyFromPP(uint64 copper, bool update_client); -- bool
277
client:Thirsty(); -- bool
278
client:TrainDisc(int itemid); -- void
279
client:TrainDiscBySpellID(int32 spell_id); -- void
280
client:UnFreeze(); -- void
281
client:Undye(); -- void
282
client:UnmemSpell(int slot); -- void
283
client:UnmemSpell(int slot, bool update_client); -- void
284
client:UnmemSpellAll(); -- void
285
client:UnmemSpellAll(bool update_client); -- void
286
client:UnmemSpellBySpellID(int32 spell_id); -- void
287
client:UnscribeSpell(int slot); -- void
288
client:UnscribeSpell(int slot, bool update_client); -- void
289
client:UnscribeSpellAll(); -- void
290
client:UnscribeSpellAll(bool update_client); -- void
291
client:UntrainDisc(int slot); -- void
292
client:UntrainDisc(int slot, bool update_client); -- void
293
client:UntrainDiscAll(); -- void
294
client:UntrainDiscAll(bool update_client); -- void
295
client:UpdateGroupAAs(int points, uint32 type); -- void
296
client:UpdateLDoNPoints(int points, uint32 theme); -- void
297
client:UpdateTaskActivity(int task, int activity, int count); -- void
298
client:UseDiscipline(int spell_id, int target_id); -- bool
299
client:WorldKick(); -- void
Copied!
$obj->$a is an example to access variable $a from object $obj

Client Methods Explained

AccountID

Parameter:
None.
Usage:
Returns the account ID of the client.
Example
1
sub EVENT_SAY {
2
if ($text=~/hail/i) {
3
#:: Create a scalar variable to store the account ID of the client that triggered the event
4
my $AccountID = $client->AccountID();
5
#:: Send a message to the client in yellow (15) text
6
$client->Message(15, "Your account ID is $AccountID.");
7
}
8
}
Copied!

AccountName

Parameter:
None.
Usage:
Returns the account name of the client.
Example
1
sub EVENT_SAY {
2
if ($text=~/hail/i) {
3
#:: Create a scalar variable to store the account name of the client that triggered the event
4
my $AccountName = $client->AccountName();
5
#:: Send a message to the client in yellow (15) text
6
$client->Message(15, "Your account name is $AccountName.");
7
}
8
}
Copied!

AddAAPoints

Parameter:
points (uint32)
Usage:
Add the specified number of AA points to the client.
Example
1
sub EVENT_ITEM_CLICK {
2
#:: Match item 123456 - Some Item
3
if ($item == 123456) {
4
#:: Award 20 AA points to the client who triggered the event
5
$client->AddAAPoints(20);
6
}
7
}
Copied!

AddAlternateCurrencyValue

Parameter:
currency_id (uint32) amount (int32)
Usage:
Add the specified amount of the specified currency to the client.
Example
1
sub EVENT_ITEM_CLICK {
2
#:: Match item 57810 - Bag of Doubloons
3
if ($itemid == 57810) {
4
#:: Give 79910 - Doubloon x100 to the client who triggered the event
5
$client->AddAlternateCurrencyValue(79910, 100);
6
}
7
}
Copied!

AddCrystals

Parameter:
radiant_count (uint32), ebon_count (uint32)
Usage:
Add the specified amount of the Radiant or Ebon crystals to the client.
Example
1
sub EVENT_ITEM_CLICK {
2
#:: Match item 57816 - Bag of Ebon Crystals
3
if ($itemid == 57816) {
4
#:: Give 40902 - Ebon Crystal x100 to the client who triggered the event
5
$client->AddCrystals(0, 100);
6
}
7
}
Copied!

AddEXP

Parameter:
experience_points (uint32)
Usage:
Add the specified amount of experience to the client.
Example
1
sub EVENT_ITEM {
2
#:: Match item 123456 - Some Item
3
if (plugin::takeItem(123456 => 1) {
4
#:: Grant 100 experience to the client who triggered the event
5
$client->AddEXP(100);
6
}
7
}
Copied!

AddLevelBasedExp

Parameter:
exp_percentage (uint8), max_level (uint8) [default = 0], ignore_mods (bool) [default = false]
Usage:
Adds the specified percentage of experience at each level, up until the maximum level specified, to the client. If the player's level exceeds the maximum level specified, the player would only be rewarded the percentage of the experience at the specified level.
Example
1
sub EVENT_ITEM {
2
#:: Match item 123456 - Some Item
3
if (plugin::takeItem(123456 => 1) {
4
#:: Grant 4 percent experience to the client who triggered the event up until level 15
5
$client->AddLevelBasedExp(4, 15);
6
}
7
}
Copied!

AddMoneyToPP

Parameter:
copper (uint32), silver (uint32), gold (uint32), platinum (uint32), update_client (bool)
Usage:
Adds the amount of currency specified to the client.
Example
1
sub EVENT_ITEM {
2
#:: Match item 123456 - Some Item
3
if (plugin::takeItem(123456 => 1) {
4
#:: Give 1cp, 2sp, 3gp, 4pp to the client who triggered the event, but don't tell them about it
5
$client->AddMoneyToPP(1, 2, 3, 4, 0);
6
}
7
}
Copied!

AddPVPPoints

Parameter:
points (uint32)
Usage:
Adds the specified number of PVP points to the client.
Example
1
sub EVENT_ITEM {
2
#:: Match item 123456 - Some Item
3
if (plugin::takeItem(123456 => 1) {
4
#:: Grant one pvp point to the client who triggered the event
5
$client->AddPVPPoints(1);
6
}
7
}
Copied!

AddSkill

Parameter:
skill_id (int), value (uint16)
Usage:
Adds the specified skill level value to the specified skill for the client.
Note the difference between $client->AddSkill and $client->SetSkill
Example
1
sub EVENT_COMBINE_SUCCESS {
2
#:: Match Recipe 2686 - Hand Made Backpack by ID
3
if ($recipe_id == 2686) {
4
#:: Send the client a message in color 15 (yellow)
5
$client->Message(15,"Wow, you did it--you won tailoring!");
6
#:: Add 300 points to the Tailoring skill for the client that triggered the event
7
$client->AddSkill(61, 300);
8
}
9
}
Copied!

Admin

Parameter:
None.
Usage:
Returns the Admin account status of the client.
Note that $status is exported by many events, should it prove more useful.
Example
1
sub EVENT_SAY {
2
if ($text=~/hail/i) {
3
#:: Create a scalar variable to store admin status
4
$GMstatus = $client->Admin();
5
#:: Match if the account status is greater than one
6
if ($GMstatus > 1) {
7
quest::say("How ya doin', boss?");
8
}
9
else {
10
quest::say("Hello, $name");
11
}
12
}
13
}
Copied!

AssignTask

Parameter:
task_id (int), npc_id (int), enforce_level_requirement (bool) [Default = false]
Usage:
Assigns the specified task, credited to the specified NPC, to the client. Enforcing the level requirement of the task is optional, and defaults to false.
Example
1
#:: Assign Task 105, credit the npc by id, with level requirement enforced
2
$client->AssignTask(105, $npc->GetID(), 1);
3
#:: Assign Task 104, credit the npc by id, ignore level requirement
4
$client->AssignTask(104, $npc->GetID());
Copied!

AssignToInstance

Parameter:
instance_id (uint16)
Usage:
Assigns the specified instance to the client.
Example
1
#:: Create a scalar variable to store the instance id
2
$InstanceID = quest::CreateInstance("soldungb", 0, 86400); #:: Instance of Sol B, based on version 0, for 86400 seconds (1 day)
3
#:: Assign the client to the instance
4
$client->AssignToInstance($InstanceID);
Copied!

AutoSplitEnabled

Parameter:
None.
Usage:
Turns on auto-split (coin) for the client.
Example
1
sub EVENT_GROUP_CHANGE {
2
#:: Turn on auto-split
3
$client->AutoSplitEnabled()
4
}
Copied!

BreakInvis

Parameter:
None.
Usage:
Turns off invisibility effects for the client.
Example
1
sub EVENT_CLICKDOOR {
2
#:: Turn off invis for any client that clicks the door
3
$client->BreakInvis()
4
}
Copied!
Last modified 4mo ago