Skip to content

Commit 645b63b

Browse files
FoereaperFoereaper
authored
Merge pull request #33 from ElunaLuaEngine/master-2024-09-26_16-27
Update Eluna documentation
2 parents 03b5b61 + 260e7a0 commit 645b63b

18 files changed

+262
-2
lines changed

‎Global/RegisterBGEvent.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,16 @@ <h1 class='fqn'>
8585

8686
<div class='docblock'>
8787
<p>Registers a <a class="mod" href="../BattleGround/index.html">BattleGround</a> event handler.</p>
88+
<p>In Multistate mode (default), events are either registered to the WORLD state (-1) or the MAP states (map ID). These events will only ever trigger on their respective state.</p>
89+
<p>In Compatibility mode, all events are registered to the WORLD state (-1).</p>
8890
<div class="table-container">
8991
<p>
9092
<table>
9193
<thead>
9294
<tr>
9395
<th>ID</th>
9496
<th>Event</th>
97+
<th>State</th>
9598
<th>Parameters</th>
9699
<th>Comment</th>
97100
</tr>
@@ -100,24 +103,28 @@ <h1 class='fqn'>
100103
<tr>
101104
<td>1</td>
102105
<td>ON_START</td>
106+
<td>MAP</td>
103107
<td>event, bg, bgId, instanceId</td>
104108
<td>Needs to be added to TC</td>
105109
</tr>
106110
<tr>
107111
<td>2</td>
108112
<td>ON_END</td>
113+
<td>MAP</td>
109114
<td>event, bg, bgId, instanceId, winner</td>
110115
<td>Needs to be added to TC</td>
111116
</tr>
112117
<tr>
113118
<td>3</td>
114119
<td>ON_CREATE</td>
120+
<td>MAP</td>
115121
<td>event, bg, bgId, instanceId</td>
116122
<td>Needs to be added to TC</td>
117123
</tr>
118124
<tr>
119125
<td>4</td>
120126
<td>ON_PRE_DESTROY</td>
127+
<td>MAP</td>
121128
<td>event, bg, bgId, instanceId</td>
122129
<td>Needs to be added to TC</td>
123130
</tr>

‎Global/RegisterCreatureEvent.html‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,16 @@ <h1 class='fqn'>
8585

8686
<div class='docblock'>
8787
<p>Registers a <a class="mod" href="../Creature/index.html">Creature</a> event handler.</p>
88+
<p>In Multistate mode (default), events are either registered to the WORLD state (-1) or the MAP states (map ID). These events will only ever trigger on their respective state.</p>
89+
<p>In Compatibility mode, all events are registered to the WORLD state (-1).</p>
8890
<div class="table-container">
8991
<p>
9092
<table>
9193
<thead>
9294
<tr>
9395
<th>ID</th>
9496
<th>Event</th>
97+
<th>State</th>
9598
<th>Parameters</th>
9699
<th>Comment</th>
97100
</tr>
@@ -100,168 +103,196 @@ <h1 class='fqn'>
100103
<tr>
101104
<td>1</td>
102105
<td>ON_ENTER_COMBAT</td>
106+
<td>MAP</td>
103107
<td>event, creature, target</td>
104108
<td>Can return true to stop normal action</td>
105109
</tr>
106110
<tr>
107111
<td>2</td>
108112
<td>ON_LEAVE_COMBAT</td>
113+
<td>MAP</td>
109114
<td>event, creature</td>
110115
<td>Can return true to stop normal action</td>
111116
</tr>
112117
<tr>
113118
<td>3</td>
114119
<td>ON_TARGET_DIED</td>
120+
<td>MAP</td>
115121
<td>event, creature, victim</td>
116122
<td>Can return true to stop normal action</td>
117123
</tr>
118124
<tr>
119125
<td>4</td>
120126
<td>ON_DIED</td>
127+
<td>MAP</td>
121128
<td>event, creature, killer</td>
122129
<td>Can return true to stop normal action</td>
123130
</tr>
124131
<tr>
125132
<td>5</td>
126133
<td>ON_SPAWN</td>
134+
<td>MAP</td>
127135
<td>event, creature</td>
128136
<td>Can return true to stop normal action</td>
129137
</tr>
130138
<tr>
131139
<td>6</td>
132140
<td>ON_REACH_WP</td>
141+
<td>MAP</td>
133142
<td>event, creature, type, id</td>
134143
<td>Can return true to stop normal action</td>
135144
</tr>
136145
<tr>
137146
<td>7</td>
138147
<td>ON_AIUPDATE</td>
148+
<td>MAP</td>
139149
<td>event, creature, diff</td>
140150
<td>Can return true to stop normal action</td>
141151
</tr>
142152
<tr>
143153
<td>8</td>
144154
<td>ON_RECEIVE_EMOTE</td>
155+
<td>MAP</td>
145156
<td>event, creature, player, emoteid</td>
146157
<td>Can return true to stop normal action</td>
147158
</tr>
148159
<tr>
149160
<td>9</td>
150161
<td>ON_DAMAGE_TAKEN</td>
162+
<td>MAP</td>
151163
<td>event, creature, attacker, damage</td>
152164
<td>Can return true to stop normal action, can return new damage as second return value.</td>
153165
</tr>
154166
<tr>
155167
<td>10</td>
156168
<td>ON_PRE_COMBAT</td>
169+
<td>MAP</td>
157170
<td>event, creature, target</td>
158171
<td>Can return true to stop normal action</td>
159172
</tr>
160173
<tr>
161174
<td>12</td>
162175
<td>ON_OWNER_ATTACKED</td>
176+
<td>MAP</td>
163177
<td>event, creature, target</td>
164178
<td>Can return true to stop normal action. Not on mangos</td>
165179
</tr>
166180
<tr>
167181
<td>13</td>
168182
<td>ON_OWNER_ATTACKED_AT</td>
183+
<td>MAP</td>
169184
<td>event, creature, attacker</td>
170185
<td>Can return true to stop normal action. Not on mangos</td>
171186
</tr>
172187
<tr>
173188
<td>14</td>
174189
<td>ON_HIT_BY_SPELL</td>
190+
<td>MAP</td>
175191
<td>event, creature, caster, spellid</td>
176192
<td>Can return true to stop normal action</td>
177193
</tr>
178194
<tr>
179195
<td>15</td>
180196
<td>ON_SPELL_HIT_TARGET</td>
197+
<td>MAP</td>
181198
<td>event, creature, target, spellid</td>
182199
<td>Can return true to stop normal action</td>
183200
</tr>
184201
<tr>
185202
<td>19</td>
186203
<td>ON_JUST_SUMMONED_CREATURE</td>
204+
<td>MAP</td>
187205
<td>event, creature, summon</td>
188206
<td>Can return true to stop normal action</td>
189207
</tr>
190208
<tr>
191209
<td>20</td>
192210
<td>ON_SUMMONED_CREATURE_DESPAWN</td>
211+
<td>MAP</td>
193212
<td>event, creature, summon</td>
194213
<td>Can return true to stop normal action</td>
195214
</tr>
196215
<tr>
197216
<td>21</td>
198217
<td>ON_SUMMONED_CREATURE_DIED</td>
218+
<td>MAP</td>
199219
<td>event, creature, summon, killer</td>
200220
<td>Can return true to stop normal action. Not on mangos</td>
201221
</tr>
202222
<tr>
203223
<td>22</td>
204224
<td>ON_SUMMONED</td>
225+
<td>MAP</td>
205226
<td>event, creature, summoner</td>
206227
<td>Can return true to stop normal action</td>
207228
</tr>
208229
<tr>
209230
<td>23</td>
210231
<td>ON_RESET</td>
232+
<td>MAP</td>
211233
<td>event, creature</td>
212234
<td></td>
213235
</tr>
214236
<tr>
215237
<td>24</td>
216238
<td>ON_REACH_HOME</td>
239+
<td>MAP</td>
217240
<td>event, creature</td>
218241
<td>Can return true to stop normal action</td>
219242
</tr>
220243
<tr>
221244
<td>26</td>
222245
<td>ON_CORPSE_REMOVED</td>
246+
<td>MAP</td>
223247
<td>event, creature, respawndelay</td>
224248
<td>Can return true to stop normal action, can return new respawndelay as second return value</td>
225249
</tr>
226250
<tr>
227251
<td>27</td>
228252
<td>ON_MOVE_IN_LOS</td>
253+
<td>MAP</td>
229254
<td>event, creature, unit</td>
230255
<td>Can return true to stop normal action. Does not actually check LOS, just uses the sight range</td>
231256
</tr>
232257
<tr>
233258
<td>30</td>
234259
<td>ON_DUMMY_EFFECT</td>
260+
<td>MAP</td>
235261
<td>event, caster, spellid, effindex, creature</td>
236262
<td></td>
237263
</tr>
238264
<tr>
239265
<td>31</td>
240266
<td>ON_QUEST_ACCEPT</td>
267+
<td>MAP</td>
241268
<td>event, player, creature, quest</td>
242269
<td>Can return true</td>
243270
</tr>
244271
<tr>
245272
<td>34</td>
246273
<td>ON_QUEST_REWARD</td>
274+
<td>MAP</td>
247275
<td>event, player, creature, quest, opt</td>
248276
<td>Can return true</td>
249277
</tr>
250278
<tr>
251279
<td>35</td>
252280
<td>ON_DIALOG_STATUS</td>
281+
<td>MAP</td>
253282
<td>event, player, creature</td>
254283
<td></td>
255284
</tr>
256285
<tr>
257286
<td>36</td>
258287
<td>ON_ADD</td>
288+
<td>MAP</td>
259289
<td>event, creature</td>
260290
<td></td>
261291
</tr>
262292
<tr>
263293
<td>37</td>
264294
<td>ON_REMOVE</td>
295+
<td>MAP</td>
265296
<td>event, creature</td>
266297
<td></td>
267298
</tr>

‎Global/RegisterCreatureGossipEvent.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,16 @@ <h1 class='fqn'>
8585

8686
<div class='docblock'>
8787
<p>Registers a <a class="mod" href="../Creature/index.html">Creature</a> gossip event handler.</p>
88+
<p>In Multistate mode (default), events are either registered to the WORLD state (-1) or the MAP states (map ID). These events will only ever trigger on their respective state.</p>
89+
<p>In Compatibility mode, all events are registered to the WORLD state (-1).</p>
8890
<div class="table-container">
8991
<p>
9092
<table>
9193
<thead>
9294
<tr>
9395
<th>ID</th>
9496
<th>Event</th>
97+
<th>State</th>
9598
<th>Parameters</th>
9699
<th>Comment</th>
97100
</tr>
@@ -100,12 +103,14 @@ <h1 class='fqn'>
100103
<tr>
101104
<td>1</td>
102105
<td>ON_HELLO</td>
106+
<td>MAP</td>
103107
<td>event, player, object</td>
104108
<td>Object is the Creature/GameObject/Item. Can return false to do default action.</td>
105109
</tr>
106110
<tr>
107111
<td>2</td>
108112
<td>ON_SELECT</td>
113+
<td>MAP</td>
109114
<td>event, player, object, sender, intid, code, menu_id</td>
110115
<td>Object is the Creature/GameObject/Item/Player, menu_id is only for player gossip. Can return false to do default action.</td>
111116
</tr>

0 commit comments

Comments
 (0)