Skip to content

Commit 4b6cad5

Browse files
FoereaperFoereaper
authoredOct 2, 2024··
Merge pull request #36 from ElunaLuaEngine/master-2024-10-02_21-13
Update Eluna documentation
2 parents 9f26ac3 + 8787bc7 commit 4b6cad5

23 files changed

+55
-43
lines changed
 

Diff for: ‎Creature/GetAITarget.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,8 @@ <h2 id="arguments" class='section-header'>
138138
<dd class="docblock"><p>Used as an offset into the threat list. If <code>targetType</code> is random, used as the number of players from top of aggro to choose from. </p><p><em>Valid numbers</em>: integers from 0 to 4,294,967,295.</p></dd>
139139
</dl>
140140
<dl>
141-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> distance (0)</code></dt>
142-
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
141+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> distance (0.0)</code></dt>
142+
<dd class="docblock"><p>If positive, the maximum distance for the target. If negative, the minimum distance. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
143143
</dl>
144144
<dl>
145145
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> aura (0)</code></dt>

Diff for: ‎Global/Ban.html

+10-4
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,12 @@ <h1 class='fqn'>
116116
<h2 id="synopsis" class='section-header'>
117117
<a href="#synopsis">Synopsis</a>
118118
</h2>
119+
<p>
120+
<code>result = Ban( banMode, nameOrIP, duration )</code>
121+
</p>
122+
<p>
123+
<code>result = Ban( banMode, nameOrIP, duration, reason )</code>
124+
</p>
119125
<p>
120126
<code>result = Ban( banMode, nameOrIP, duration, reason, whoBanned )</code>
121127
</p>
@@ -137,12 +143,12 @@ <h2 id="arguments" class='section-header'>
137143
<dd class="docblock"><p>Duration (in seconds) of the ban. </p><p><em>Valid numbers</em>: integers from 0 to 4,294,967,295.</p></dd>
138144
</dl>
139145
<dl>
140-
<dt><code><strong><a href="http://www.lua.org/pil/2.4.html">string</a></strong> reason</code></dt>
141-
<dd class="docblock"><em>See method description.</em></dd>
146+
<dt><code><strong><a href="http://www.lua.org/pil/2.4.html">string</a></strong> reason ("")</code></dt>
147+
<dd class="docblock"><p>Ban reason, this is optional. </p></dd>
142148
</dl>
143149
<dl>
144-
<dt><code><strong><a href="http://www.lua.org/pil/2.4.html">string</a></strong> whoBanned</code></dt>
145-
<dd class="docblock"><em>See method description.</em></dd>
150+
<dt><code><strong><a href="http://www.lua.org/pil/2.4.html">string</a></strong> whoBanned ("")</code></dt>
151+
<dd class="docblock"><p>The <a class="mod" href="../Player/index.html">Player</a>'s name that banned the account, character or IP, this is optional. </p></dd>
146152
</dl>
147153
</p>
148154

Diff for: ‎Player/DurabilityRepair.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ <h2 id="arguments" class='section-header'>
113113
<dd class="docblock"><em>See method description.</em></dd>
114114
</dl>
115115
<dl>
116-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> discountMod (1)</code></dt>
116+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> discountMod (1.0)</code></dt>
117117
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
118118
</dl>
119119
</p>

Diff for: ‎Player/DurabilityRepairAll.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ <h2 id="arguments" class='section-header'>
109109
<dd class="docblock"><em>See method description.</em></dd>
110110
</dl>
111111
<dl>
112-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> discountMod (1)</code></dt>
112+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> discountMod (1.0)</code></dt>
113113
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
114114
</dl>
115115
<dl>

Diff for: ‎Player/ResurrectPlayer.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h2 id="arguments" class='section-header'>
102102
</h2>
103103
<p>
104104
<dl>
105-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> healthPercent (100)</code></dt>
105+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> healthPercent (100.0f)</code></dt>
106106
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
107107
</dl>
108108
<dl>

Diff for: ‎Unit/CastCustomSpell.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ <h2 id="arguments" class='section-header'>
128128
<dd class="docblock"><em>See method description.</em></dd>
129129
</dl>
130130
<dl>
131-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> originalCaster (ObjectGuid)</code></dt>
131+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> originalCaster (ObjectGuid())</code></dt>
132132
<dd class="docblock"><p><em>Valid numbers</em>: integers from 0 to 18,446,744,073,709,551,615.</p></dd>
133133
</dl>
134134
</p>

Diff for: ‎Unit/GetFriendlyUnitsInRange.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ <h2 id="arguments" class='section-header'>
9999
</h2>
100100
<p>
101101
<dl>
102-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533)</code></dt>
103-
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
102+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533.333)</code></dt>
103+
<dd class="docblock"><p>Search radius. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
104104
</dl>
105105
</p>
106106

Diff for: ‎Unit/GetMaxPower.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ <h2 id="arguments" class='section-header'>
113113
</h2>
114114
<p>
115115
<dl>
116-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> type</code></dt>
117-
<dd class="docblock"><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
116+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> type (-1)</code></dt>
117+
<dd class="docblock"><p>A valid power type from [Powers] or -1 for the <a class="mod" href="../Unit/index.html">Unit</a>'s current power type. </p><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
118118
</dl>
119119
</p>
120120

Diff for: ‎Unit/GetPower.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ <h2 id="arguments" class='section-header'>
113113
</h2>
114114
<p>
115115
<dl>
116-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> type</code></dt>
117-
<dd class="docblock"><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
116+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> type (-1)</code></dt>
117+
<dd class="docblock"><p>A valid power type from [Powers] or -1 for the <a class="mod" href="../Unit/index.html">Unit</a>'s current power type. </p><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
118118
</dl>
119119
</p>
120120

Diff for: ‎Unit/GetPowerPct.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ <h2 id="arguments" class='section-header'>
113113
</h2>
114114
<p>
115115
<dl>
116-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> type</code></dt>
117-
<dd class="docblock"><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
116+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> type (-1)</code></dt>
117+
<dd class="docblock"><p>A valid power type from [Powers] or -1 for the <a class="mod" href="../Unit/index.html">Unit</a>'s current power type. </p><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
118118
</dl>
119119
</p>
120120

Diff for: ‎Unit/GetUnfriendlyUnitsInRange.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ <h2 id="arguments" class='section-header'>
9999
</h2>
100100
<p>
101101
<dl>
102-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533)</code></dt>
103-
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
102+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533.333)</code></dt>
103+
<dd class="docblock"><p>Search radius. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
104104
</dl>
105105
</p>
106106

Diff for: ‎Unit/ModifyPower.html

+5-2
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,9 @@ <h1 class='fqn'>
104104
<h2 id="synopsis" class='section-header'>
105105
<a href="#synopsis">Synopsis</a>
106106
</h2>
107+
<p>
108+
<code>Unit:ModifyPower( amount )</code>
109+
</p>
107110
<p>
108111
<code>Unit:ModifyPower( amount, type )</code>
109112
</p>
@@ -117,8 +120,8 @@ <h2 id="arguments" class='section-header'>
117120
<dd class="docblock"><p>Amount to modify. </p><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
118121
</dl>
119122
<dl>
120-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> type</code></dt>
121-
<dd class="docblock"><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
123+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> type (-1)</code></dt>
124+
<dd class="docblock"><p>A valid power type from [Powers] or -1 for the <a class="mod" href="../Unit/index.html">Unit</a>'s current power type. </p><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
122125
</dl>
123126
</p>
124127

Diff for: ‎Unit/SetMaxPower.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ <h2 id="arguments" class='section-header'>
113113
</h2>
114114
<p>
115115
<dl>
116-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> type</code></dt>
117-
<dd class="docblock"><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
116+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> type (-1)</code></dt>
117+
<dd class="docblock"><p>A valid power type from [Powers] or -1 for the <a class="mod" href="../Unit/index.html">Unit</a>'s current power type. </p><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
118118
</dl>
119119
<dl>
120120
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> maxPower</code></dt>

Diff for: ‎Unit/SetPower.html

+5-2
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,9 @@ <h1 class='fqn'>
104104
<h2 id="synopsis" class='section-header'>
105105
<a href="#synopsis">Synopsis</a>
106106
</h2>
107+
<p>
108+
<code>Unit:SetPower( amount )</code>
109+
</p>
107110
<p>
108111
<code>Unit:SetPower( amount, type )</code>
109112
</p>
@@ -117,8 +120,8 @@ <h2 id="arguments" class='section-header'>
117120
<dd class="docblock"><p>New power amount. </p><p><em>Valid numbers</em>: integers from 0 to 4,294,967,295.</p></dd>
118121
</dl>
119122
<dl>
120-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> type</code></dt>
121-
<dd class="docblock"><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
123+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> type (-1)</code></dt>
124+
<dd class="docblock"><p>A valid power type from [Powers] or -1 for the <a class="mod" href="../Unit/index.html">Unit</a>'s current power type. </p><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
122125
</dl>
123126
</p>
124127

Diff for: ‎WorldObject/GetCreaturesInRange.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ <h2 id="arguments" class='section-header'>
108108
</h2>
109109
<p>
110110
<dl>
111-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533)</code></dt>
112-
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
111+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533.33333)</code></dt>
112+
<dd class="docblock"><p>Optionally set range. Default range is grid size. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
113113
</dl>
114114
<dl>
115115
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> entryId (0)</code></dt>

Diff for: ‎WorldObject/GetGameObjectsInRange.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,8 @@ <h2 id="arguments" class='section-header'>
105105
</h2>
106106
<p>
107107
<dl>
108-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533)</code></dt>
109-
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
108+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533.33333)</code></dt>
109+
<dd class="docblock"><p>Optionally set range. Default range is grid size. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
110110
</dl>
111111
<dl>
112112
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> entryId (0)</code></dt>

Diff for: ‎WorldObject/GetNearObject.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ <h2 id="arguments" class='section-header'>
112112
</h2>
113113
<p>
114114
<dl>
115-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533)</code></dt>
116-
<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> range (533.33333)</code></dt>
116+
<dd class="docblock"><p>Optionally set range. Default range is grid size. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
117117
</dl>
118118
<dl>
119119
<dt><code><strong><a href="https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/search?l=cpp&q=%22enum+TypeMask%22&type=Code&utf8=%E2%9C%93">TypeMask</a></strong> type (0)</code></dt>

Diff for: ‎WorldObject/GetNearObjects.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ <h2 id="arguments" class='section-header'>
112112
</h2>
113113
<p>
114114
<dl>
115-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533)</code></dt>
116-
<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> range (533.33333)</code></dt>
116+
<dd class="docblock"><p>Optionally set range. Default range is grid size. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
117117
</dl>
118118
<dl>
119119
<dt><code><strong><a href="https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/search?l=cpp&q=%22enum+TypeMask%22&type=Code&utf8=%E2%9C%93">TypeMask</a></strong> type (0)</code></dt>

Diff for: ‎WorldObject/GetNearestCreature.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ <h2 id="arguments" class='section-header'>
108108
</h2>
109109
<p>
110110
<dl>
111-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533)</code></dt>
112-
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
111+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533.33333)</code></dt>
112+
<dd class="docblock"><p>Optionally set range. Default range is grid size. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
113113
</dl>
114114
<dl>
115115
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> entryId (0)</code></dt>

Diff for: ‎WorldObject/GetNearestGameObject.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,8 @@ <h2 id="arguments" class='section-header'>
105105
</h2>
106106
<p>
107107
<dl>
108-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533)</code></dt>
109-
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
108+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533.33333)</code></dt>
109+
<dd class="docblock"><p>Optionally set range. Default range is grid size. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
110110
</dl>
111111
<dl>
112112
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> entryId (0)</code></dt>

Diff for: ‎WorldObject/GetNearestPlayer.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,8 @@ <h2 id="arguments" class='section-header'>
105105
</h2>
106106
<p>
107107
<dl>
108-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533)</code></dt>
109-
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
108+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533.33333)</code></dt>
109+
<dd class="docblock"><p>Optionally set range. Default range is grid size. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
110110
</dl>
111111
<dl>
112112
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> hostile (0)</code></dt>

Diff for: ‎WorldObject/GetPlayersInRange.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,8 @@ <h2 id="arguments" class='section-header'>
105105
</h2>
106106
<p>
107107
<dl>
108-
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533)</code></dt>
109-
<dd class="docblock"><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
108+
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> range (533.33333)</code></dt>
109+
<dd class="docblock"><p>Optionally set range. Default range is grid size. </p><p><em>Valid numbers</em>: all decimal numbers.</p></dd>
110110
</dl>
111111
<dl>
112112
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> hostile (0)</code></dt>

Diff for: ‎date.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
document.write("26/09/2024");
1+
document.write("02/10/2024");

0 commit comments

Comments
 (0)
Please sign in to comment.