Skip to content

Commit 2c9a612

Browse files
authored
Merge pull request #50 from ElunaLuaEngine/master-2024-11-30_20-29
Update Eluna documentation
2 parents 4b3ea4f + 3c66bac commit 2c9a612

17 files changed

+156
-156
lines changed

Global/RegisterBGEvent.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,28 +106,28 @@ <h1 class='fqn'>
106106
<td>1</td>
107107
<td>ON_START</td>
108108
<td>MAP</td>
109-
<td>event, bg, bgId, instanceId</td>
109+
<td><span title="number">event</span>, <span title="BattleGround">bg</span>, <span title="number">bgId</span>, <span title="number">instanceId</span></td>
110110
<td>Needs to be added to TC</td>
111111
</tr>
112112
<tr>
113113
<td>2</td>
114114
<td>ON_END</td>
115115
<td>MAP</td>
116-
<td>event, bg, bgId, instanceId, winner</td>
116+
<td><span title="number">event</span>, <span title="BattleGround">bg</span>, <span title="number">bgId</span>, <span title="number">instanceId</span>, <span title="number">winner</span></td>
117117
<td>Needs to be added to TC</td>
118118
</tr>
119119
<tr>
120120
<td>3</td>
121121
<td>ON_CREATE</td>
122122
<td>MAP</td>
123-
<td>event, bg, bgId, instanceId</td>
123+
<td><span title="number">event</span>, <span title="BattleGround">bg</span>, <span title="number">bgId</span>, <span title="number">instanceId</span></td>
124124
<td>Needs to be added to TC</td>
125125
</tr>
126126
<tr>
127127
<td>4</td>
128128
<td>ON_PRE_DESTROY</td>
129129
<td>MAP</td>
130-
<td>event, bg, bgId, instanceId</td>
130+
<td><span title="number">event</span>, <span title="BattleGround">bg</span>, <span title="number">bgId</span>, <span title="number">instanceId</span></td>
131131
<td>Needs to be added to TC</td>
132132
</tr>
133133
</tbody>

Global/RegisterCreatureEvent.html

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -106,196 +106,196 @@ <h1 class='fqn'>
106106
<td>1</td>
107107
<td>ON_ENTER_COMBAT</td>
108108
<td>MAP</td>
109-
<td>event, creature, target</td>
109+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Unit">target</span></td>
110110
<td>Can return true to stop normal action</td>
111111
</tr>
112112
<tr>
113113
<td>2</td>
114114
<td>ON_LEAVE_COMBAT</td>
115115
<td>MAP</td>
116-
<td>event, creature</td>
116+
<td><span title="number">event</span>, <span title="Creature">creature</span></td>
117117
<td>Can return true to stop normal action</td>
118118
</tr>
119119
<tr>
120120
<td>3</td>
121121
<td>ON_TARGET_DIED</td>
122122
<td>MAP</td>
123-
<td>event, creature, victim</td>
123+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Unit">victim</span></td>
124124
<td>Can return true to stop normal action</td>
125125
</tr>
126126
<tr>
127127
<td>4</td>
128128
<td>ON_DIED</td>
129129
<td>MAP</td>
130-
<td>event, creature, killer</td>
130+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Unit">killer</span></td>
131131
<td>Can return true to stop normal action</td>
132132
</tr>
133133
<tr>
134134
<td>5</td>
135135
<td>ON_SPAWN</td>
136136
<td>MAP</td>
137-
<td>event, creature</td>
137+
<td><span title="number">event</span>, <span title="Creature">creature</span></td>
138138
<td>Can return true to stop normal action</td>
139139
</tr>
140140
<tr>
141141
<td>6</td>
142142
<td>ON_REACH_WP</td>
143143
<td>MAP</td>
144-
<td>event, creature, type, id</td>
144+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="number">type</span>, <span title="number">id</span></td>
145145
<td>Can return true to stop normal action</td>
146146
</tr>
147147
<tr>
148148
<td>7</td>
149149
<td>ON_AIUPDATE</td>
150150
<td>MAP</td>
151-
<td>event, creature, diff</td>
151+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="number">diff</span></td>
152152
<td>Can return true to stop normal action</td>
153153
</tr>
154154
<tr>
155155
<td>8</td>
156156
<td>ON_RECEIVE_EMOTE</td>
157157
<td>MAP</td>
158-
<td>event, creature, player, emoteid</td>
158+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Player">player</span>, <span title="number">emoteid</span></td>
159159
<td>Can return true to stop normal action</td>
160160
</tr>
161161
<tr>
162162
<td>9</td>
163163
<td>ON_DAMAGE_TAKEN</td>
164164
<td>MAP</td>
165-
<td>event, creature, attacker, damage</td>
165+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Unit">attacker</span>, <span title="number">damage</span></td>
166166
<td>Can return true to stop normal action, can return new damage as second return value.</td>
167167
</tr>
168168
<tr>
169169
<td>10</td>
170170
<td>ON_PRE_COMBAT</td>
171171
<td>MAP</td>
172-
<td>event, creature, target</td>
172+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Unit">target</span></td>
173173
<td>Can return true to stop normal action</td>
174174
</tr>
175175
<tr>
176176
<td>12</td>
177177
<td>ON_OWNER_ATTACKED</td>
178178
<td>MAP</td>
179-
<td>event, creature, target</td>
179+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Unit">target</span></td>
180180
<td>Can return true to stop normal action. Not on mangos</td>
181181
</tr>
182182
<tr>
183183
<td>13</td>
184184
<td>ON_OWNER_ATTACKED_AT</td>
185185
<td>MAP</td>
186-
<td>event, creature, attacker</td>
186+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Unit">attacker</span></td>
187187
<td>Can return true to stop normal action. Not on mangos</td>
188188
</tr>
189189
<tr>
190190
<td>14</td>
191191
<td>ON_HIT_BY_SPELL</td>
192192
<td>MAP</td>
193-
<td>event, creature, caster, spellid</td>
193+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Unit">caster</span>, <span title="number">spellid</span></td>
194194
<td>Can return true to stop normal action</td>
195195
</tr>
196196
<tr>
197197
<td>15</td>
198198
<td>ON_SPELL_HIT_TARGET</td>
199199
<td>MAP</td>
200-
<td>event, creature, target, spellid</td>
200+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Unit">target</span>, <span title="number">spellid</span></td>
201201
<td>Can return true to stop normal action</td>
202202
</tr>
203203
<tr>
204204
<td>19</td>
205205
<td>ON_JUST_SUMMONED_CREATURE</td>
206206
<td>MAP</td>
207-
<td>event, creature, summon</td>
207+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Creature">summon</span></td>
208208
<td>Can return true to stop normal action</td>
209209
</tr>
210210
<tr>
211211
<td>20</td>
212212
<td>ON_SUMMONED_CREATURE_DESPAWN</td>
213213
<td>MAP</td>
214-
<td>event, creature, summon</td>
214+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Creature">summon</span></td>
215215
<td>Can return true to stop normal action</td>
216216
</tr>
217217
<tr>
218218
<td>21</td>
219219
<td>ON_SUMMONED_CREATURE_DIED</td>
220220
<td>MAP</td>
221-
<td>event, creature, summon, killer</td>
221+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Creature">summon</span>, <span title="Unit">killer</span></td>
222222
<td>Can return true to stop normal action. Not on mangos</td>
223223
</tr>
224224
<tr>
225225
<td>22</td>
226226
<td>ON_SUMMONED</td>
227227
<td>MAP</td>
228-
<td>event, creature, summoner</td>
228+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Unit">summoner</span></td>
229229
<td>Can return true to stop normal action</td>
230230
</tr>
231231
<tr>
232232
<td>23</td>
233233
<td>ON_RESET</td>
234234
<td>MAP</td>
235-
<td>event, creature</td>
235+
<td><span title="number">event</span>, <span title="Creature">creature</span></td>
236236
<td></td>
237237
</tr>
238238
<tr>
239239
<td>24</td>
240240
<td>ON_REACH_HOME</td>
241241
<td>MAP</td>
242-
<td>event, creature</td>
242+
<td><span title="number">event</span>, <span title="Creature">creature</span></td>
243243
<td>Can return true to stop normal action</td>
244244
</tr>
245245
<tr>
246246
<td>26</td>
247247
<td>ON_CORPSE_REMOVED</td>
248248
<td>MAP</td>
249-
<td>event, creature, respawndelay</td>
249+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="number">respawndelay</span></td>
250250
<td>Can return true to stop normal action, can return new respawndelay as second return value</td>
251251
</tr>
252252
<tr>
253253
<td>27</td>
254254
<td>ON_MOVE_IN_LOS</td>
255255
<td>MAP</td>
256-
<td>event, creature, unit</td>
256+
<td><span title="number">event</span>, <span title="Creature">creature</span>, <span title="Unit">who</span></td>
257257
<td>Can return true to stop normal action. Does not actually check LOS, just uses the sight range</td>
258258
</tr>
259259
<tr>
260260
<td>30</td>
261261
<td>ON_DUMMY_EFFECT</td>
262262
<td>MAP</td>
263-
<td>event, caster, spellid, effindex, creature</td>
263+
<td><span title="number">event</span>, <span title="WorldObject">caster</span>, <span title="number">spellid</span>, <span title="number">effindex</span>, <span title="Creature">creature</span></td>
264264
<td></td>
265265
</tr>
266266
<tr>
267267
<td>31</td>
268268
<td>ON_QUEST_ACCEPT</td>
269269
<td>MAP</td>
270-
<td>event, player, creature, quest</td>
270+
<td><span title="number">event</span>, <span title="Player">player</span>, <span title="Creature">creature</span>, <span title="Quest">quest</span></td>
271271
<td>Can return true</td>
272272
</tr>
273273
<tr>
274274
<td>34</td>
275275
<td>ON_QUEST_REWARD</td>
276276
<td>MAP</td>
277-
<td>event, player, creature, quest, opt</td>
277+
<td><span title="number">event</span>, <span title="Player">player</span>, <span title="Creature">creature</span>, <span title="Quest">quest</span>, <span title="number">opt</span></td>
278278
<td>Can return true</td>
279279
</tr>
280280
<tr>
281281
<td>35</td>
282282
<td>ON_DIALOG_STATUS</td>
283283
<td>MAP</td>
284-
<td>event, player, creature</td>
284+
<td><span title="number">event</span>, <span title="Player">player</span>, <span title="Creature">creature</span></td>
285285
<td></td>
286286
</tr>
287287
<tr>
288288
<td>36</td>
289289
<td>ON_ADD</td>
290290
<td>MAP</td>
291-
<td>event, creature</td>
291+
<td><span title="number">event</span>, <span title="Creature">creature</span></td>
292292
<td></td>
293293
</tr>
294294
<tr>
295295
<td>37</td>
296296
<td>ON_REMOVE</td>
297297
<td>MAP</td>
298-
<td>event, creature</td>
298+
<td><span title="number">event</span>, <span title="Creature">creature</span></td>
299299
<td></td>
300300
</tr>
301301
</tbody>

Global/RegisterCreatureGossipEvent.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,14 +106,14 @@ <h1 class='fqn'>
106106
<td>1</td>
107107
<td>ON_HELLO</td>
108108
<td>MAP</td>
109-
<td>event, player, object</td>
109+
<td><span title="number">event</span>, <span title="Player">player</span>, <span title="Creature">object</span></td>
110110
<td>Object is the Creature/GameObject/Item. Can return false to do default action.</td>
111111
</tr>
112112
<tr>
113113
<td>2</td>
114114
<td>ON_SELECT</td>
115115
<td>MAP</td>
116-
<td>event, player, object, sender, intid, code, menu_id</td>
116+
<td><span title="number">event</span>, <span title="Player">player</span>, <span title="Creature">object</span>, <span title="number">sender</span>, <span title="number">intid</span>, <span title="string">code</span>, <span title="number">menu_id</span></td>
117117
<td>Object is the Creature/GameObject/Item/Player, menu_id is only for player gossip. Can return false to do default action.</td>
118118
</tr>
119119
</tbody>

Global/RegisterGameObjectEvent.html

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -106,91 +106,91 @@ <h1 class='fqn'>
106106
<td>1</td>
107107
<td>ON_AIUPDATE</td>
108108
<td>MAP</td>
109-
<td>event, go, diff</td>
109+
<td><span title="number">event</span>, <span title="GameObject">go</span>, <span title="number">diff</span></td>
110110
<td></td>
111111
</tr>
112112
<tr>
113113
<td>2</td>
114114
<td>ON_SPAWN</td>
115115
<td>MAP</td>
116-
<td>event, go</td>
116+
<td><span title="number">event</span>, <span title="GameObject">go</span></td>
117117
<td></td>
118118
</tr>
119119
<tr>
120120
<td>3</td>
121121
<td>ON_DUMMY_EFFECT</td>
122122
<td>MAP</td>
123-
<td>event, caster, spellid, effindex, go</td>
123+
<td><span title="number">event</span>, <span title="WorldObject">caster</span>, <span title="number">spellid</span>, <span title="number">effindex</span>, <span title="GameObject">go</span></td>
124124
<td>Can return true to stop normal action</td>
125125
</tr>
126126
<tr>
127127
<td>4</td>
128128
<td>ON_QUEST_ACCEPT</td>
129129
<td>MAP</td>
130-
<td>event, player, go, quest</td>
130+
<td><span title="number">event</span>, <span title="Player">player</span>, <span title="GameObject">go</span>, <span title="Quest">quest</span></td>
131131
<td>Can return true to stop normal action</td>
132132
</tr>
133133
<tr>
134134
<td>5</td>
135135
<td>ON_QUEST_REWARD</td>
136136
<td>MAP</td>
137-
<td>event, player, go, quest, opt</td>
137+
<td><span title="number">event</span>, <span title="Player">player</span>, <span title="GameObject">go</span>, <span title="Quest">quest</span>, <span title="number">opt</span></td>
138138
<td>Can return true to stop normal action</td>
139139
</tr>
140140
<tr>
141141
<td>6</td>
142142
<td>ON_DIALOG_STATUS</td>
143143
<td>MAP</td>
144-
<td>event, player, go</td>
144+
<td><span title="number">event</span>, <span title="Player">player</span>, <span title="GameObject">go</span></td>
145145
<td></td>
146146
</tr>
147147
<tr>
148148
<td>7</td>
149149
<td>ON_DESTROYED</td>
150150
<td>MAP</td>
151-
<td>event, go, attacker</td>
151+
<td><span title="number">event</span>, <span title="GameObject">go</span></td>
152152
<td></td>
153153
</tr>
154154
<tr>
155155
<td>8</td>
156156
<td>ON_DAMAGED</td>
157157
<td>MAP</td>
158-
<td>event, go, attacker</td>
158+
<td><span title="number">event</span>, <span title="GameObject">go</span>, <span title="Unit">attacker</span></td>
159159
<td></td>
160160
</tr>
161161
<tr>
162162
<td>9</td>
163163
<td>ON_LOOT_STATE_CHANGE</td>
164164
<td>MAP</td>
165-
<td>event, go, state</td>
165+
<td><span title="number">event</span>, <span title="GameObject">go</span>, <span title="number">state</span></td>
166166
<td></td>
167167
</tr>
168168
<tr>
169169
<td>10</td>
170170
<td>ON_GO_STATE_CHANGED</td>
171171
<td>MAP</td>
172-
<td>event, go, state</td>
172+
<td><span title="number">event</span>, <span title="GameObject">go</span>, <span title="number">state</span></td>
173173
<td></td>
174174
</tr>
175175
<tr>
176176
<td>12</td>
177177
<td>ON_ADD</td>
178178
<td>MAP</td>
179-
<td>event, gameobject</td>
179+
<td><span title="number">event</span>, <span title="GameObject">go</span></td>
180180
<td></td>
181181
</tr>
182182
<tr>
183183
<td>13</td>
184184
<td>ON_REMOVE</td>
185185
<td>MAP</td>
186-
<td>event, gameobject</td>
186+
<td><span title="number">event</span>, <span title="GameObject">go</span></td>
187187
<td></td>
188188
</tr>
189189
<tr>
190190
<td>14</td>
191191
<td>ON_USE</td>
192192
<td>MAP</td>
193-
<td>event, go, player</td>
193+
<td><span title="number">event</span>, <span title="GameObject">go</span>, <span title="Player">player</span></td>
194194
<td>Can return true to stop normal action</td>
195195
</tr>
196196
</tbody>

Global/RegisterGameObjectGossipEvent.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,14 +106,14 @@ <h1 class='fqn'>
106106
<td>1</td>
107107
<td>ON_HELLO</td>
108108
<td>MAP</td>
109-
<td>event, player, object</td>
109+
<td><span title="number">event</span>, <span title="Player">player</span>, <span title="Creature">object</span></td>
110110
<td>Object is the Creature/GameObject/Item. Can return false to do default action.</td>
111111
</tr>
112112
<tr>
113113
<td>2</td>
114114
<td>ON_SELECT</td>
115115
<td>MAP</td>
116-
<td>event, player, object, sender, intid, code, menu_id</td>
116+
<td><span title="number">event</span>, <span title="Player">player</span>, <span title="Creature">object</span>, <span title="number">sender</span>, <span title="number">intid</span>, <span title="string">code</span>, <span title="number">menu_id</span></td>
117117
<td>Object is the Creature/GameObject/Item/Player, menu_id is only for player gossip. Can return false to do default action.</td>
118118
</tr>
119119
</tbody>

0 commit comments

Comments
 (0)