-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathindex.html
More file actions
301 lines (284 loc) · 11.7 KB
/
index.html
File metadata and controls
301 lines (284 loc) · 11.7 KB
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
<!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 Map class in the Eluna engine.">
<meta name="keywords" content="eluna, lua, lua engine, trinitycore, trinity, mangos, cmangos, script, scripting, doc, docs, documentation">
<title>Map - 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">
</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'>
Class <a class="mod" href="">Map</a>
<span class='out-of-band'>
<span id='render-detail'>
<a id="collapse-all" href="#">[-]</a>
<a id="expand-all" href="#">[+]</a>
</span>
</span>
</h1>
<p>A game map, e.g. Azeroth, Eastern Kingdoms, the Molten Core, etc.</p>
<p>Inherits all methods from: none</p>
<h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
<table>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='Data.html'>Data</a>
</td>
<td class='docblock short'>
<p>Returns a runtime-persistent cache tied to the <a class="mod" href="../Map/index.html">Map</a>.
This data will remain for as long as the <a class="mod" href="../Map/index.html">Map</a> exists, or until a server restart.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='
10BC0
Documented'></a>
<a class='fn' href='GetAreaId.html'>GetAreaId</a>
</td>
<td class='docblock short'>
<p>Returns the area ID of the <a class="mod" href="../Map/index.html">Map</a> at the specified X, Y, and Z coordinates.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='GetDifficulty.html'>GetDifficulty</a>
</td>
<td class='docblock short'>
<p>Returns the difficulty of the <a class="mod" href="../Map/index.html">Map</a>.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='GetHeight.html'>GetHeight</a>
</td>
<td class='docblock short'>
<p>Returns the height of the <a class="mod" href="../Map/index.html">Map</a> at the given X and Y coordinates.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='GetInstanceData.html'>GetInstanceData</a>
</td>
<td class='docblock short'>
<p>Gets the instance data table for the <a class="mod" href="../Map/index.html">Map</a>, if it exists.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='GetInstanceId.html'>GetInstanceId</a>
</td>
<td class='docblock short'>
<p>Returns the instance ID of the <a class="mod" href="../Map/index.html">Map</a>.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='GetMapId.html'>GetMapId</a>
</td>
<td class='docblock short'>
<p>Returns the ID of the <a class="mod" href="../Map/index.html">Map</a>.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='GetName.html'>GetName</a>
</td>
<td class='docblock short'>
<p>Returns the name of the <a class="mod" href="../Map/index.html">Map</a>.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='GetPlayerCount.html'>GetPlayerCount</a>
</td>
<td class='docblock short'>
<p>Returns the player count currently on the <a class="mod" href="../Map/index.html">Map</a> (excluding GMs).</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='GetPlayers.html'>GetPlayers</a>
</td>
<td class='docblock short'>
<p>Returns a table with all the current <a class="mod" href="../Player/index.html">Player</a>s in the map</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='GetWorldObject.html'>GetWorldObject</a>
</td>
<td class='docblock short'>
<p>Returns a <a class="mod" href="../WorldObject/index.html">WorldObject</a> by its GUID from the map if it is spawned.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='IsArena.html'>IsArena</a>
</td>
<td class='docblock short'>
<p>Returns <code>true</code> if the <a class="mod" href="../Map/index.html">Map</a> is an arena <a class="mod" href="../BattleGround/index.html">BattleGround</a>, <code>false</code> otherwise.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='IsBattleground.html'>IsBattleground</a>
</td>
<td class='docblock short'>
<p>Returns <code>true</code> if the <a class="mod" href="../Map/index.html">Map</a> is a non-arena <a class="mod" href="../BattleGround/index.html">BattleGround</a>, <code>false</code> otherwise.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='IsDungeon.html'>IsDungeon</a>
</td>
<td class='docblock short'>
<p>Returns <code>true</code> if the <a class="mod" href="../Map/index.html">Map</a> is a dungeon, <code>false</code> otherwise.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='IsEmpty.html'>IsEmpty</a>
</td>
<td class='docblock short'>
<p>Returns <code>true</code> if the <a class="mod" href="../Map/index.html">Map</a> has no <a class="mod" href="../Player/index.html">Player</a>s, <code>false</code> otherwise.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='IsHeroic.html'>IsHeroic</a>
</td>
<td class='docblock short'>
<p>Returns <code>true</code> if the <a class="mod" href="../Map/index.html">Map</a> is a heroic, <code>false</code> otherwise.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='IsRaid.html'>IsRaid</a>
</td>
<td class='docblock short'>
<p>Returns <code>true</code> if the <a class="mod" href="../Map/index.html">Map</a> is a raid, <code>false</code> otherwise.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='SaveInstanceData.html'>SaveInstanceData</a>
</td>
<td class='docblock short'>
<p>Saves the <a class="mod" href="../Map/index.html">Map</a>'s instance data to the database.</p>
</td>
</tr>
<tr>
<td>
<a class='stability Stable' title='Documented'></a>
<a class='fn' href='SetWeather.html'>SetWeather</a>
</td>
<td class='docblock short'>
<p>Sets the [Weather] type based on [WeatherType] and grade supplied.</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>