Skip to content

Commit 1c94ad1

Browse files
FoereaperFoereaper
authored
Merge pull request #14 from ElunaLuaEngine/master-2024-01-29_21-41
Update Eluna documentation
2 parents aa2802a + 36d4b4c commit 1c94ad1

7 files changed

Lines changed: 183 additions & 38 deletions

File tree

‎Creature/AddThreat.html‎

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,26 +67,53 @@ <h1 class='fqn'>
6767

6868

6969
<div class='docblock'>
70-
<p>Adds threat to a <a class="mod" href="../Unit/index.html">Unit</a> for this <a class="mod" href="../Creature/index.html">Creature</a>.</p>
70+
<p>Adds threat to the <a class="mod" href="../Creature/index.html">Creature</a> from the victim.</p>
71+
<pre>
72+
enum SpellSchoolMask
73+
{
74+
SPELL_SCHOOL_MASK_NONE = 0,
75+
SPELL_SCHOOL_MASK_NORMAL = 1,
76+
SPELL_SCHOOL_MASK_HOLY = 2,
77+
SPELL_SCHOOL_MASK_FIRE = 4,
78+
SPELL_SCHOOL_MASK_NATURE = 8,
79+
SPELL_SCHOOL_MASK_FROST = 16,
80+
SPELL_SCHOOL_MASK_SHADOW = 32,
81+
SPELL_SCHOOL_MASK_ARCANE = 64,
82+
}
83+
</pre>
7184

7285
<h2 id="synopsis" class='section-header'>
7386
<a href="#synopsis">Synopsis</a>
7487
</h2>
7588
<p>
76-
<code>Creature:AddThreat( target, amount )</code>
89+
<code>Creature:AddThreat( victim, threat )</code>
90+
</p>
91+
<p>
92+
<code>Creature:AddThreat( victim, threat, schoolMask )</code>
93+
</p>
94+
<p>
95+
<code>Creature:AddThreat( victim, threat, schoolMask, spell )</code>
7796
</p>
7897

7998
<h2 id="arguments" class='section-header'>
8099
<a href="#arguments">Arguments</a>
81100
</h2>
82101
<p>
83102
<dl>
84-
<dt><code><strong><a class="mod" href="../Unit/index.html">Unit</a></strong> target</code></dt>
85-
<dd class="docblock"><em>See method description.</em></dd>
103+
<dt><code><strong><a class="mod" href="../Unit/index.html">Unit</a></strong> victim</code></dt>
104+
<dd class="docblock"><p><a class="mod" href="../Unit/index.html">Unit</a> that caused the threat. </p></dd>
105+
</dl>
106+
<dl>
107+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> threat</code></dt>
108+
<dd class="docblock"><p>Threat amount. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
109+
</dl>
110+
<dl>
111+
<dt><code><strong><a href="https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/search?l=cpp&q=%22enum+SpellSchoolMask%22&type=Code&utf8=%E2%9C%93">SpellSchoolMask</a></strong> schoolMask (0)</code></dt>
112+
<dd class="docblock"><p>[SpellSchoolMask] of the threat causer. </p></dd>
86113
</dl>
87114
<dl>
88-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> amount</code></dt>
89-
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
115+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> spell (0)</code></dt>
116+
<dd class="docblock"><p>Spell entry used for threat. </p><p><em>Valid numbers</em>: integers from 0 to 4,294,967,295.</p></dd>
90117
</dl>
91118
</p>
92119

‎Creature/ClearThreatList.html‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
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 Creature:ClearThreatList 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>Creature:ClearThreatList - 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>Creature 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("Creature:ClearThreatList");
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="../Creature/index.html">Creature</a>:<a class="fn" href="../Creature/ClearThreatList.html">ClearThreatList</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>Clear the <a class="mod" href="../Creature/index.html">Creature</a>'s threat list. This will cause evading.</p>
71+
72+
<h2 id="synopsis" class='section-header'>
73+
<a href="#synopsis">Synopsis</a>
74+
</h2>
75+
<p>
76+
<code>Creature:ClearThreatList()</code>
77+
</p>
78+
79+
<h2 id="arguments" class='section-header'>
80+
<a href="#arguments">Arguments</a>
81+
</h2>
82+
<p>
83+
None.
84+
</p>
85+
86+
<h2 id="returns" class='section-header'>
87+
<a href="#returns">Returns</a>
88+
</h2>
89+
<p>
90+
Nothing.
91+
</p>
92+
</div>
93+
94+
</section>
95+
96+
<section id='search' class="content hidden"></section>
97+
98+
<section class="footer"></section>
99+
100+
<div id="help" class="hidden">
101+
<div class="shortcuts">
102+
<h1>Keyboard shortcuts</h1>
103+
<dl>
104+
<dt>?</dt>
105+
<dd>Show this help dialog</dd>
106+
<dt>S</dt>
107+
<dd>Focus the search field</dd>
108+
<dt>&larrb;</dt>
109+
<dd>Move up in search results</dd>
110+
<dt>&rarrb;</dt>
111+
<dd>Move down in search results</dd>
112+
<dt>&#9166;</dt>
113+
<dd>Go to active search result</dd>
114+
</dl>
115+
</div>
116+
<div class="infos">
117+
<h1>Search tricks</h1>
118+
<p>
119+
Prefix searches with a type followed by a colon (e.g.
120+
<code>fn:</code>) to restrict the search to a given type.
121+
</p>
122+
<p>
123+
Accepted types are: <code>fn</code>, <code>mod</code>,
124+
<code>struct</code> (or <code>str</code>), <code>enum</code>,
125+
<code>trait</code>, <code>typedef</code> (or
126+
<code>tdef</code>).
127+
</p>
128+
</div>
129+
</div>
130+
131+
<script>
132+
window.rootPath = "../";
133+
</script>
134+
<script src="../static/jquery.js"></script>
135+
<script src="../static/main.js"></script>
136+
<script async src="../search-index.js"></script>
137+
<center>Generated on <script src="../date.js"></script></center>
138+
<center>&copy; 2010 - 2024 Eluna Lua Engine</center>
139+
</body>
140+
</html>

‎Creature/index.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
7272
<a class='fn' href='AddThreat.html'>AddThreat</a>
7373
</td>
7474
<td class='docblock short'>
75-
<p>Adds threat to a <a class="mod" href="../Unit/index.html">Unit</a> for this <a class="mod" href="../Creature/index.html">Creature</a>.</p>
75+
<p>Adds threat to the <a class="mod" href="../Creature/index.html">Creature</a> from the victim.</p>
7676
</td>
7777
</tr>
7878
<tr>
@@ -174,28 +174,28 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
174174
<tr>
175175
<td>
176176
<a class='stability Stable' title='Documented'></a>
177-
<a class='fn' href='ClearAllThreat.html'>ClearAllThreat</a>
177+
<a class='fn' href='ClearFixate.html'>ClearFixate</a>
178178
</td>
179179
<td class='docblock short'>
180-
<p>Clear the <a class="mod" href="../Creature/index.html">Creature</a>'s threat list. This will cause evading.</p>
180+
<p>Clears the <a class="mod" href="../Creature/index.html">Creature</a>'s fixated target.</p>
181181
</td>
182182
</tr>
183183
<tr>
184184
<td>
185185
<a class='stability Stable' title='Documented'></a>
186-
<a class='fn' href='ClearFixate.html'>ClearFixate</a>
186+
<a class='fn' href='ClearThreat.html'>ClearThreat</a>
187187
</td>
188188
<td class='docblock short'>
189-
<p>Clears the <a class="mod" href="../Creature/index.html">Creature</a>'s fixated target.</p>
189+
<p>Clear the threat of a <a class="mod" href="../Unit/index.html">Unit</a> in this <a class="mod" href="../Creature/index.html">Creature</a>'s threat list.</p>
190190
</td>
191191
</tr>
192192
<tr>
193193
<td>
194194
<a class='stability Stable' title='Documented'></a>
195-
<a class='fn' href='ClearThreat.html'>ClearThreat</a>
195+
<a class='fn' href='ClearThreatList.html'>ClearThreatList</a>
196196
</td>
197197
<td class='docblock short'>
198-
<p>Clear the threat of a <a class="mod" href="../Unit/index.html">Unit</a> in this <a class="mod" href="../Creature/index.html">Creature</a>'s threat list.</p>
198+
<p>Clear the <a class="mod" href="../Creature/index.html">Creature</a>'s threat list. This will cause evading.</p>
199199
</td>
200200
</tr>
201201
<tr>

‎Creature/sidebar.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ document.write(`
1111
<a id="Creature:CanStartAttack" class="fn" href="../Creature/CanStartAttack.html">CanStartAttack</a>
1212
<a id="Creature:CanSwim" class="fn" href="../Creature/CanSwim.html">CanSwim</a>
1313
<a id="Creature:CanWalk" class="fn" href="../Creature/CanWalk.html">CanWalk</a>
14-
<a id="Creature:ClearAllThreat" class="fn" href="../Creature/ClearAllThreat.html">ClearAllThreat</a>
1514
<a id="Creature:ClearFixate" class="fn" href="../Creature/ClearFixate.html">ClearFixate</a>
1615
<a id="Creature:ClearThreat" class="fn" href="../Creature/ClearThreat.html">ClearThreat</a>
16+
<a id="Creature:ClearThreatList" class="fn" href="../Creature/ClearThreatList.html">ClearThreatList</a>
1717
<a id="Creature:DespawnOrUnsummon" class="fn" href="../Creature/DespawnOrUnsummon.html">DespawnOrUnsummon</a>
1818
<a id="Creature:FixateTarget" class="fn" href="../Creature/FixateTarget.html">FixateTarget</a>
1919
<a id="Creature:FleeToGetAssistance" class="fn" href="../Creature/FleeToGetAssistance.html">FleeToGetAssistance</a>

‎Unit/index.html‎

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,6 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
6565
<p>Adds the <a class="mod" href="../Aura/index.html">Aura</a> of the given spell entry on the given target from the <a class="mod" href="../Unit/index.html">Unit</a>.</p>
6666
</td>
6767
</tr>
68-
<tr>
69-
<td>
70-
<a class='stability Stable' title='Documented'></a>
71-
<a class='fn' href='AddThreat.html'>AddThreat</a>
72-
</td>
73-
<td class='docblock short'>
74-
<p>Adds threat to the <a class="mod" href="../Unit/index.html">Unit</a> from the victim.</p>
75-
</td>
76-
</tr>
7768
<tr>
7869
<td>
7970
<a class='stability Stable' title='Documented'></a>
@@ -138,15 +129,6 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
138129
<p>Clears the <a class="mod" href="../Unit/index.html">Unit</a>'s combat</p>
139130
</td>
140131
</tr>
141-
<tr>
142-
<td>
143-
<a class='stability Stable' title='Documented'></a>
144-
<a class='fn' href='ClearThreatList.html'>ClearThreatList</a>
145-
</td>
146-
<td class='docblock short'>
147-
<p>Clears the <a class="mod" href="../Unit/index.html">Unit</a>'s threat list.</p>
148-
</td>
149-
</tr>
150132
<tr>
151133
<td>
152134
<a class='stability Stable' title='Documented'></a>

‎Unit/sidebar.js‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
document.write(`
22
<a id="Unit:AddAura" class="fn" href="../Unit/AddAura.html">AddAura</a>
3-
<a id="Unit:AddThreat" class="fn" href="../Unit/AddThreat.html">AddThreat</a>
43
<a id="Unit:AddUnitState" class="fn" href="../Unit/AddUnitState.html">AddUnitState</a>
54
<a id="Unit:Attack" class="fn" href="../Unit/Attack.html">Attack</a>
65
<a id="Unit:AttackStop" class="fn" href="../Unit/AttackStop.html">AttackStop</a>
76
<a id="Unit:CastCustomSpell" class="fn" href="../Unit/CastCustomSpell.html">CastCustomSpell</a>
87
<a id="Unit:CastSpell" class="fn" href="../Unit/CastSpell.html">CastSpell</a>
98
<a id="Unit:CastSpellAoF" class="fn" href="../Unit/CastSpellAoF.html">CastSpellAoF</a>
109
<a id="Unit:ClearInCombat" class="fn" href="../Unit/ClearInCombat.html">ClearInCombat</a>
11-
<a id="Unit:ClearThreatList" class="fn" href="../Unit/ClearThreatList.html">ClearThreatList</a>
1210
<a id="Unit:ClearUnitState" class="fn" href="../Unit/ClearUnitState.html">ClearUnitState</a>
1311
<a id="Unit:CountPctFromCurHealth" class="fn" href="../Unit/CountPctFromCurHealth.html">CountPctFromCurHealth</a>
1412
<a id="Unit:CountPctFromMaxHealth" class="fn" href="../Unit/CountPctFromMaxHealth.html">CountPctFromMaxHealth</a>

‎search-index.js‎

Lines changed: 2 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)