Skip to content

Commit d496baa

Browse files
FoereaperFoereaper
committed
Update Eluna documentation
1 parent 1c94ad1 commit d496baa

5 files changed

Lines changed: 196 additions & 1 deletion

File tree

‎Unit/SetImmuneTo.html‎

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<meta name="description" content="API documentation for the Unit:SetImmuneTo method in the Eluna engine.">
7+
<meta name="keywords" content="eluna, lua, lua engine, trinitycore, trinity, mangos, cmangos, script, scripting, doc, docs, documentation">
8+
9+
<title>Unit:SetImmuneTo - Eluna</title>
10+
11+
<link rel="stylesheet" type="text/css" href="../static/main.css">
12+
13+
<link rel="shortcut icon" href="../static/favicon.ico">
14+
15+
</head>
16+
<body class="rustdoc">
17+
<!--[if lte IE 8]>
18+
<div class="warning">
19+
This old browser is unsupported and will most likely display funky
20+
things.
21+
</div>
22+
<![endif]-->
23+
24+
<section class="sidebar">
25+
<a href='../index.html'><img src='../static/eluna-logo.png' alt='Eluna Logo' width='100'></a>
26+
<div class="block">
27+
28+
<h2>Unit Methods</h2>
29+
<script src="sidebar.js"></script>
30+
<script>
31+
// Highlight current method by adding "current" class to it
32+
var element = document.getElementById("Unit:SetImmuneTo");
33+
if (element) {
34+
var classname = "current";
35+
arr = element.className.split(" ");
36+
if (arr.indexOf(classname) == -1) {
37+
element.className += " " + classname;
38+
}
39+
}
40+
</script>
41+
42+
</div>
43+
</section>
44+
45+
<nav class="sub">
46+
<form class="search-form js-only">
47+
<div class="search-container">
48+
<input class="search-input" name="search"
49+
autocomplete="off"
50+
placeholder="Click or press 'S' to search, '?' for more options..."
51+
type="search">
52+
</div>
53+
</form>
54+
</nav>
55+
56+
<section id='main' class="content mod">
57+
<h1 class='fqn'>
58+
Method
59+
<a class="mod" href="../Unit/index.html">Unit</a>:<a class="fn" href="../Unit/SetImmuneTo.html">SetImmuneTo</a>
60+
<span class='out-of-band'>
61+
<span id='render-detail'>
62+
<a id="collapse-all" href="#">[-]</a>
63+
<a id="expand-all" href="#">[+]</a>
64+
</span>
65+
</span>
66+
</h1>
67+
68+
69+
<div class='docblock'>
70+
<p>Sets a mechanic immunity for the <a class="mod" href="../Unit/index.html">Unit</a>.</p>
71+
<pre>
72+
MECHANIC_NONE = 0,
73+
MECHANIC_CHARM = 1,
74+
MECHANIC_DISORIENTED = 2,
75+
MECHANIC_DISARM = 3,
76+
MECHANIC_DISTRACT = 4,
77+
MECHANIC_FEAR = 5,
78+
MECHANIC_GRIP = 6,
79+
MECHANIC_ROOT = 7,
80+
MECHANIC_SLOW_ATTACK = 8,
81+
MECHANIC_SILENCE = 9,
82+
MECHANIC_SLEEP = 10,
83+
MECHANIC_SNARE = 11,
84+
MECHANIC_STUN = 12,
85+
MECHANIC_FREEZE = 13,
86+
MECHANIC_KNOCKOUT = 14,
87+
MECHANIC_BLEED = 15,
88+
MECHANIC_BANDAGE = 16,
89+
MECHANIC_POLYMORPH = 17,
90+
MECHANIC_BANISH = 18,
91+
MECHANIC_SHIELD = 19,
92+
MECHANIC_SHACKLE = 20,
93+
MECHANIC_MOUNT = 21,
94+
MECHANIC_INFECTED = 22,
95+
MECHANIC_TURN = 23,
96+
MECHANIC_HORROR = 24,
97+
MECHANIC_INVULNERABILITY = 25,
98+
MECHANIC_INTERRUPT = 26,
99+
MECHANIC_DAZE = 27,
100+
MECHANIC_DISCOVERY = 28,
101+
MECHANIC_IMMUNE_SHIELD = 29, // Divine (Blessing) Shield/Protection and Ice Block
102+
MECHANIC_SAPPED = 30,
103+
MECHANIC_ENRAGED = 31
104+
</pre>
105+
106+
<h2 id="synopsis" class='section-header'>
107+
<a href="#synopsis">Synopsis</a>
108+
</h2>
109+
<p>
110+
<code>Unit:SetImmuneTo( immunity )</code>
111+
</p>
112+
<p>
113+
<code>Unit:SetImmuneTo( immunity, apply )</code>
114+
</p>
115+
116+
<h2 id="arguments" class='section-header'>
117+
<a href="#arguments">Arguments</a>
118+
</h2>
119+
<p>
120+
<dl>
121+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> immunity</code></dt>
122+
<dd class="docblock"><p>New value for the immunity mask. </p><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
123+
</dl>
124+
<dl>
125+
<dt><code><strong><a href="http://www.lua.org/pil/2.2.html">boolean</a></strong> apply (true)</code></dt>
126+
<dd class="docblock"><p>If true, the immunity is applied, otherwise it is removed. </p></dd>
127+
</dl>
128+
</p>
129+
130+
<h2 id="returns" class='section-header'>
131+
<a href="#returns">Returns</a>
132+
</h2>
133+
<p>
134+
Nothing.
135+
</p>
136+
</div>
137+
138+
</section>
139+
140+
<section id='search' class="content hidden"></section>
141+
142+
<section class="footer"></section>
143+
144+
<div id="help" class="hidden">
145+
<div class="shortcuts">
146+
<h1>Keyboard shortcuts</h1>
147+
<dl>
148+
<dt>?</dt>
149+
<dd>Show this help dialog</dd>
150+
<dt>S</dt>
151+
<dd>Focus the search field</dd>
152+
<dt>&larrb;</dt>
153+
<dd>Move up in search results</dd>
154+
<dt>&rarrb;</dt>
155+
<dd>Move down in search results</dd>
156+
<dt>&#9166;</dt>
157+
<dd>Go to active search result</dd>
158+
</dl>
159+
</div>
160+
<div class="infos">
161+
<h1>Search tricks</h1>
162+
<p>
163+
Prefix searches with a type followed by a colon (e.g.
164+
<code>fn:</code>) to restrict the search to a given type.
165+
</p>
166+
<p>
167+
Accepted types are: <code>fn</code>, <code>mod</code>,
168+
<code>struct</code> (or <code>str</code>), <code>enum</code>,
169+
<code>trait</code>, <code>typedef</code> (or
170+
<code>tdef</code>).
171+
</p>
172+
</div>
173+
</div>
174+
175+
<script>
176+
window.rootPath = "../";
177+
</script>
178+
<script src="../static/jquery.js"></script>
179+
<script src="../static/main.js"></script>
180+
<script async src="../search-index.js"></script>
181+
<center>Generated on <script src="../date.js"></script></center>
182+
<center>&copy; 2010 - 2024 Eluna Lua Engine</center>
183+
</body>
184+
</html>

‎Unit/index.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1308,6 +1308,15 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
13081308
<p>Sets the <a class="mod" href="../Unit/index.html">Unit</a>'s health.</p>
13091309
</td>
13101310
</tr>
1311+
<tr>
1312+
<td>
1313+
<a class='stability Stable' title='Documented'></a>
1314+
<a class='fn' href='SetImmuneTo.html'>SetImmuneTo</a>
1315+
</td>
1316+
<td class='docblock short'>
1317+
<p>Sets a mechanic immunity for the <a class="mod" href="../Unit/index.html">Unit</a>.</p>
1318+
</td>
1319+
</tr>
13111320
<tr>
13121321
<td>
13131322
<a class='stability Stable' title='Documented'></a>

‎Unit/sidebar.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ document.write(`
138138
<a id="Unit:SetFaction" class="fn" href="../Unit/SetFaction.html">SetFaction</a>
139139
<a id="Unit:SetFeared" class="fn" href="../Unit/SetFeared.html">SetFeared</a>
140140
<a id="Unit:SetHealth" class="fn" href="../Unit/SetHealth.html">SetHealth</a>
141+
<a id="Unit:SetImmuneTo" class="fn" href="../Unit/SetImmuneTo.html">SetImmuneTo</a>
141142
<a id="Unit:SetInCombatWith" class="fn" href="../Unit/SetInCombatWith.html">SetInCombatWith</a>
142143
<a id="Unit:SetLevel" class="fn" href="../Unit/SetLevel.html">SetLevel</a>
143144
<a id="Unit:SetMaxHealth" class="fn" href="../Unit/SetMaxHealth.html">SetMaxHealth</a>

‎date.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
document.write("29/01/2024");
1+
document.write("09/02/2024");

‎search-index.js‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)