-
Notifications
You must be signed in to change notification settings - Fork 3
/
index.html
347 lines (327 loc) · 14.3 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="API documentation for the Eluna engine.">
<meta name="keywords" content="eluna, lua, lua engine, trinitycore, trinity, mangos, cmangos, script, scripting, doc, docs, documentation">
<title>Eluna API</title>
<link rel="stylesheet" type="text/css" href="static/main.css">
<link rel="stylesheet" href="static/highlight.css">
<link rel="shortcut icon" href="static/favicon.ico">
<script>
// Inline script to set theme before the rest of the document loads
(function() {
const currentTheme = localStorage.getItem('theme');
if (currentTheme) {
document.documentElement.classList.add(currentTheme);
}
})();
</script>
<script src="static/highlight.min.js"></script>
<script src="static/lua.min.js"></script>
</head>
<body class="rustdoc">
<section class="sidebar">
<a href='index.html'><img src='static/eluna-logo.png' alt='Eluna Logo' width='100'></a>
<div class="block">
<h2>All Classes</h2>
<a class="mod " href="Aura/index.html">Aura</a><a class="mod " href="BattleGround/index.html">BattleGround</a><a class="mod " href="Corpse/index.html">Corpse</a><a class="mod " href="Creature/index.html">Creature</a><a class="mod " href="ElunaQuery/index.html">ElunaQuery</a><a class="mod " href="GameObject/index.html">GameObject</a><a class="mod " href="Global/index.html">Global</a><a class="mod " href="Group/index.html">Group</a><a class="mod " href="Guild/index.html">Guild</a><a class="mod " href="Item/index.html">Item</a><a class="mod " href="Map/index.html">Map</a><a class="mod " href="Object/index.html">Object</a><a class="mod " href="Player/index.html">Player</a><a class="mod " href="Quest/index.html">Quest</a><a class="mod " href="Spell/index.html">Spell</a><a class="mod " href="Unit/index.html">Unit</a><a class="mod " href="Vehicle/index.html">Vehicle</a><a class="mod " href="WorldObject/index.html">WorldObject</a><a class="mod " href="WorldPacket/index.html">WorldPacket</a>
</div>
</section>
<nav class="sub">
<form class="search-form js-only">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press 'S' to search..."
type="search">
<div class="toggle-container" id="themeToggle">
<svg class="sun-icon" xmlns="http://www.w3.org/2000/svg">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
<svg class="moon-icon" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79z"></path>
</svg>
</div>
</form>
</nav>
<section id='main' class="content mod">
<h1 class='fqn'>
Eluna API Documentation
<span class='out-of-band'>
<span id='render-detail'>
<a id="collapse-all" href="#">[-]</a>
<a id="expand-all" href="#">[+]</a>
</span>
</span>
</h1>
<div class='docblock'>
<h1 id="the-eluna-engine-api" class='section-header'>
<a href="#the-eluna-engine-api">The Eluna Lua Engine© API</a>
</h1>
<p>
The Eluna Lua Engine© API allows you to add your own Lua code to be executed when certain events (called "hooks") occur.
</p>
<p>
Add a new in-game command, give life to creatures with new AI, or even light players who try to duel on fire!
If the hook exists, you can script it.
</p>
<h2 id="about-eluna" class='section-header'>
<a href="#about-eluna">About Eluna</a>
</h2>
<p>
Eluna is a <a href="http://www.lua.org/">Lua</a> engine for World of Warcraft emulators.
Eluna supports <a href="http://cmangos.net/">CMaNGOS</a>/<a href="https://www.getmangos.eu/home.php">MaNGOS</a>
and <a href="http://www.trinitycore.org/">TrinityCore</a>.
</p>
<p>
To get Eluna, simply clone your favorite version of MaNGOS or Trinity from
<a href="https://github.com/ElunaLuaEngine">our Github account</a>.
Each fork there has Eluna already integrated, so you just need to compile and go!
</p>
<p>
Join our community <a href="https://discord.gg/bjkCVWqqfX">Discord</a> server to keep up with Eluna development and user provided support.
</p>
<h2 id="tutorials-and-guides" class='section-header'>
<a href="#tutorials-and-guides">Tutorials & Guides</a>
</h2>
<p>
We haven't written tutorials yet, but when we do, we'll put the links here.
</p>
<h2 id="about-this-documentation" class='section-header'>
<a href="#about-this-documentation">About this documentation</a>
</h2>
<p>
The layout, CSS, and Javascript code for this documentation was borrowed from <a href="http://doc.rust-lang.org/">doc.rust-lang.org</a>.
</p>
<p>
The documentation generator was originally written by <a href="https://github.com/Patman64">Patman64</a> and is maintained by the Eluna team.
</p>
</div>
<h2 id='modules' class='section-header'><a href="#modules">Classes</a></h2>
<table>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='Aura/index.html'>Aura</a>
</td>
<td class='docblock short'>
<p>The persistent effect of a <a class="mod" href="Spell/index.html">Spell</a> that remains on a <a class="mod" href="Unit/index.html">Unit</a> after the <a class="mod" href="Spell/index.html">Spell</a>
has been cast.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='BattleGround/index.html'>BattleGround</a>
</td>
<td class='docblock short'>
<p>Contains the state of a battleground, e.g. Warsong Gulch, Arathi Basin, etc.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='Corpse/index.html'>Corpse</a>
</td>
<td class='docblock short'>
<p>The remains of a <a class="mod" href="Player/index.html">Player</a> that has died.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='Creature/index.html'>Creature</a>
</td>
<td class='docblock short'>
<p>Non-<a class="mod" href="Player/index.html">Player</a> controlled <a class="mod" href="Unit/index.html">Unit</a>s (i.e. NPCs).</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='ElunaQuery/index.html'>ElunaQuery</a>
</td>
<td class='docblock short'>
<p>The result of a database query.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='GameObject/index.html'>GameObject</a>
</td>
<td class='docblock short'>
<p>Inherits all methods from: <a class="mod" href="Object/index.html">Object</a>, <a class="mod" href="WorldObject/index.html">WorldObject</a></p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='Global/index.html'>Global</a>
</td>
<td class='docblock short'>
<p>These functions can be used anywhere at any time, including at start-up.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='Group/index.html'>Group</a>
</td>
<td class='docblock short'>
<p>Inherits all methods from: none</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='Guild/index.html'>Guild</a>
</td>
<td class='docblock short'>
<p>Inherits all methods from: none</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='Item/index.html'>Item</a>
</td>
<td class='docblock short'>
<p>Inherits all methods from: <a class="mod" href="Object/index.html">Object</a></p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='Map/index.html'>Map</a>
</td>
<td class='docblock short'>
<p>A game map, e.g. Azeroth, Eastern Kingdoms, the Molten Core, etc.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='Object/index.html'>Object</a>
</td>
<td class='docblock short'>
<p>A basic game object (either an <a class="mod" href="Item/index.html">Item</a> or a <a class="mod" href="WorldObject/index.html">WorldObject</a>).</p>
</td>
</tr>
<tr>
<td>
<a class='stability Unstable' title='Partially Documented'></a>
<a class='mod' href='Player/index.html'>Player</a>
</td>
<td class='docblock short'>
<p>Inherits all methods from: <a class="mod" href="Object/index.html">Object</a>, <a class="mod" href="WorldObject/index.html">WorldObject</a>, <a class="mod" href="Unit/index.html">Unit</a></p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='Quest/index.html'>Quest</a>
</td>
<td class='docblock short'>
<p>Inherits all methods from: none</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='Spell/index.html'>Spell</a>
</td>
<td class='docblock short'>
<p>An instance of a spell, created when the spell is cast by a <a class="mod" href="Unit/index.html">Unit</a>.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Unstable' title='Partially Documented'></a>
<a class='mod' href='Unit/index.html'>Unit</a>
</td>
<td class='docblock short'>
<p>Inherits all methods from: <a class="mod" href="Object/index.html">Object</a>, <a class="mod" href="WorldObject/index.html">WorldObject</a></p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='Vehicle/index.html'>Vehicle</a>
</td>
<td class='docblock short'>
<p>Inherits all methods from: none</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='WorldObject/index.html'>WorldObject</a>
</td>
<td class='docblock short'>
<p>Inherits all methods from: <a class="mod" href="Object/index.html">Object</a></p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Fully Documented'></a>
<a class='mod' href='WorldPacket/index.html'>WorldPacket</a>
</td>
<td class='docblock short'>
<p>A packet used to pass messages between the server and a client.</p>
</td>
</tr>
</table>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<div id="help" class="hidden">
<div class="shortcuts">
<h1>Keyboard shortcuts</h1>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
</dl>
</div>
<div class="infos">
<h1>Search tricks</h1>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code> (or <code>str</code>), <code>enum</code>,
<code>trait</code>, <code>typedef</code> (or
<code>tdef</code>).
</p>
</div>
</div>
<script>
window.rootPath = "";
</script>
<script src="static/jquery.js"></script>
<script src="static/main.js"></script>
<script src="static/theme.js"></script>
<script async src="search-index.js"></script>
<center>Generated on <script src="date.js"></script></center>
<center>© 2010 - 2024 Eluna Lua Engine</center>
</body>
</html>