Skip to content

Commit 784c086

Browse files
FoereaperFoereaper
authored
Merge pull request #29 from ElunaLuaEngine/master-2024-09-01_14-15
Update Eluna documentation
2 parents 3b156e1 + 34d43cd commit 784c086

7 files changed

Lines changed: 500 additions & 1 deletion

File tree

‎Unit/AddFlatStatModifier.html‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
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:AddFlatStatModifier 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:AddFlatStatModifier - 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:AddFlatStatModifier");
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/AddFlatStatModifier.html">AddFlatStatModifier</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>Modifies a flat amount of a specific stat of the <a class="mod" href="../Unit/index.html">Unit</a></p>
71+
<pre>
72+
enum UnitModifierFlatType
73+
{
74+
BASE_VALUE = 0,
75+
TOTAL_VALUE = 1
76+
};
77+
</pre>
78+
79+
<h2 id="synopsis" class='section-header'>
80+
<a href="#synopsis">Synopsis</a>
81+
</h2>
82+
<p>
83+
<code>Unit:AddFlatStatModifier( statType, modType, value )</code>
84+
</p>
85+
<p>
86+
<code>Unit:AddFlatStatModifier( statType, modType, value, apply )</code>
87+
</p>
88+
89+
<h2 id="arguments" class='section-header'>
90+
<a href="#arguments">Arguments</a>
91+
</h2>
92+
<p>
93+
<dl>
94+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> statType</code></dt>
95+
<dd class="docblock"><p>The stat to modify. </p><p><em>Valid numbers</em>: integers from 0 to 4,294,967,295.</p></dd>
96+
</dl>
97+
<dl>
98+
<dt><code><strong><a href="https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/search?l=cpp&q=%22enum+UnitModifierFlatType%22&type=Code&utf8=%E2%9C%93">UnitModifierFlatType</a></strong> modType</code></dt>
99+
<dd class="docblock"><p>The type of modifier to apply. </p></dd>
100+
</dl>
101+
<dl>
102+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> value</code></dt>
103+
<dd class="docblock"><p>The value to apply to the stat. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
104+
</dl>
105+
<dl>
106+
<dt><code><strong><a href="http://www.lua.org/pil/2.2.html">boolean</a></strong> apply (true)</code></dt>
107+
<dd class="docblock"><p>True applies a positive modifier, false applies a negative. </p></dd>
108+
</dl>
109+
</p>
110+
111+
<h2 id="returns" class='section-header'>
112+
<a href="#returns">Returns</a>
113+
</h2>
114+
<p>
115+
Nothing.
116+
</p>
117+
</div>
118+
119+
</section>
120+
121+
<section id='search' class="content hidden"></section>
122+
123+
<section class="footer"></section>
124+
125+
<div id="help" class="hidden">
126+
<div class="shortcuts">
127+
<h1>Keyboard shortcuts</h1>
128+
<dl>
129+
<dt>?</dt>
130+
<dd>Show this help dialog</dd>
131+
<dt>S</dt>
132+
<dd>Focus the search field</dd>
133+
<dt>&larrb;</dt>
134+
<dd>Move up in search results</dd>
135+
<dt>&rarrb;</dt>
136+
<dd>Move down in search results</dd>
137+
<dt>&#9166;</dt>
138+
<dd>Go to active search result</dd>
139+
</dl>
140+
</div>
141+
<div class="infos">
142+
<h1>Search tricks</h1>
143+
<p>
144+
Prefix searches with a type followed by a colon (e.g.
145+
<code>fn:</code>) to restrict the search to a given type.
146+
</p>
147+
<p>
148+
Accepted types are: <code>fn</code>, <code>mod</code>,
149+
<code>struct</code> (or <code>str</code>), <code>enum</code>,
150+
<code>trait</code>, <code>typedef</code> (or
151+
<code>tdef</code>).
152+
</p>
153+
</div>
154+
</div>
155+
156+
<script>
157+
window.rootPath = "../";
158+
</script>
159+
<script src="../static/jquery.js"></script>
160+
<script src="../static/main.js"></script>
161+
<script async src="../search-index.js"></script>
162+
<center>Generated on <script src="../date.js"></script></center>
163+
<center>&copy; 2010 - 2024 Eluna Lua Engine</center>
164+
</body>
165+
</html>

‎Unit/AddPctStatModifier.html‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
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:AddPctStatModifier 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:AddPctStatModifier - 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:AddPctStatModifier");
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/AddPctStatModifier.html">AddPctStatModifier</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>Modifies a percentage amount of a specific stat of the <a class="mod" href="../Unit/index.html">Unit</a></p>
71+
<pre>
72+
enum UnitModifierPctType
73+
{
74+
BASE_PCT = 0,
75+
TOTAL_PCT = 1
76+
};
77+
</pre>
78+
79+
<h2 id="synopsis" class='section-header'>
80+
<a href="#synopsis">Synopsis</a>
81+
</h2>
82+
<p>
83+
<code>Unit:AddPctStatModifier( statType, modType, value )</code>
84+
</p>
85+
86+
<h2 id="arguments" class='section-header'>
87+
<a href="#arguments">Arguments</a>
88+
</h2>
89+
<p>
90+
<dl>
91+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> statType</code></dt>
92+
<dd class="docblock"><p>The stat to modify. </p><p><em>Valid numbers</em>: integers from 0 to 4,294,967,295.</p></dd>
93+
</dl>
94+
<dl>
95+
<dt><code><strong><a href="https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/search?l=cpp&q=%22enum+UnitModifierPctType%22&type=Code&utf8=%E2%9C%93">UnitModifierPctType</a></strong> modType</code></dt>
96+
<dd class="docblock"><p>The type of modifier to apply. </p></dd>
97+
</dl>
98+
<dl>
99+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> value</code></dt>
100+
<dd class="docblock"><p>The value to apply to the stat. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
101+
</dl>
102+
</p>
103+
104+
<h2 id="returns" class='section-header'>
105+
<a href="#returns">Returns</a>
106+
</h2>
107+
<p>
108+
Nothing.
109+
</p>
110+
</div>
111+
112+
</section>
113+
114+
<section id='search' class="content hidden"></section>
115+
116+
<section class="footer"></section>
117+
118+
<div id="help" class="hidden">
119+
<div class="shortcuts">
120+
<h1>Keyboard shortcuts</h1>
121+
<dl>
122+
<dt>?</dt>
123+
<dd>Show this help dialog</dd>
124+
<dt>S</dt>
125+
<dd>Focus the search field</dd>
126+
<dt>&larrb;</dt>
127+
<dd>Move up in search results</dd>
128+
<dt>&rarrb;</dt>
129+
<dd>Move down in search results</dd>
130+
<dt>&#9166;</dt>
131+
<dd>Go to active search result</dd>
132+
</dl>
133+
</div>
134+
<div class="infos">
135+
<h1>Search tricks</h1>
136+
<p>
137+
Prefix searches with a type followed by a colon (e.g.
138+
<code>fn:</code>) to restrict the search to a given type.
139+
</p>
140+
<p>
141+
Accepted types are: <code>fn</code>, <code>mod</code>,
142+
<code>struct</code> (or <code>str</code>), <code>enum</code>,
143+
<code>trait</code>, <code>typedef</code> (or
144+
<code>tdef</code>).
145+
</p>
146+
</div>
147+
</div>
148+
149+
<script>
150+
window.rootPath = "../";
151+
</script>
152+
<script src="../static/jquery.js"></script>
153+
<script src="../static/main.js"></script>
154+
<script async src="../search-index.js"></script>
155+
<center>Generated on <script src="../date.js"></script></center>
156+
<center>&copy; 2010 - 2024 Eluna Lua Engine</center>
157+
</body>
158+
</html>

0 commit comments

Comments
 (0)