Skip to content

Commit 9a64918

Browse files
FoereaperFoereaper
committed
Update Eluna documentation
1 parent 8207812 commit 9a64918

File tree

201 files changed

+753
-597
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

201 files changed

+753
-597
lines changed

‎Aura/GetSpellInfo.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h1 class='fqn'>
8787

8888

8989
<div class='docblock'>
90-
<p>Returns the [ElunaSpellInfo] of the spell that created this <a class="mod" href="../Aura/index.html">Aura</a>.</p>
90+
<p>Returns the <a class="mod" href="../SpellInfo/index.html">SpellInfo</a> of the spell that created this <a class="mod" href="../Aura/index.html">Aura</a>.</p>
9191

9292

9393
<h2 id="synopsis" class='section-header'>
@@ -109,7 +109,7 @@ <h2 id="returns" class='section-header'>
109109
</h2>
110110
<p>
111111
<dl>
112-
<dt><code><strong><a href="https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/search?l=cpp&q=%22enum+ElunaSpellInfo%22&type=Code&utf8=%E2%9C%93">ElunaSpellInfo</a></strong> spellInfo</code></dt>
112+
<dt><code><strong><a class="mod" href="../SpellInfo/index.html">SpellInfo</a></strong> spellInfo</code></dt>
113113
<dd class="docblock"><em>See method description.</em></dd>
114114
</dl>
115115
</p>

‎Aura/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
151151
<a class='fn' href='GetSpellInfo.html'>GetSpellInfo</a>
152152
</td>
153153
<td class='docblock short'>
154-
<p>Returns the [ElunaSpellInfo] of the spell that created this <a class="mod" href="../Aura/index.html">Aura</a>.</p>
154+
<p>Returns the <a class="mod" href="../SpellInfo/index.html">SpellInfo</a> of the spell that created this <a class="mod" href="../Aura/index.html">Aura</a>.</p>
155155
</td>
156156
</tr>
157157
<tr>

‎Global/GetSpellInfo.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h1 class='fqn'>
8787

8888

8989
<div class='docblock'>
90-
<p>Returns the [ElunaSpellInfo] for the given spell ID, or nil if the spell does not exist.</p>
90+
<p>Returns the <a class="mod" href="../SpellInfo/index.html">SpellInfo</a> for the given spell ID, or nil if the spell does not exist.</p>
9191

9292

9393
<h2 id="synopsis" class='section-header'>
@@ -112,7 +112,7 @@ <h2 id="returns" class='section-header'>
112112
</h2>
113113
<p>
114114
<dl>
115-
<dt><code><strong><a href="https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/search?l=cpp&q=%22enum+ElunaSpellInfo%22&type=Code&utf8=%E2%9C%93">ElunaSpellInfo</a></strong> spellInfo</code></dt>
115+
<dt><code><strong><a class="mod" href="../SpellInfo/index.html">SpellInfo</a></strong> spellInfo</code></dt>
116116
<dd class="docblock"><em>See method description.</em></dd>
117117
</dl>
118118
</p>

‎Global/RegisterSpellEvent.html‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,160 @@ <h1 class='fqn'>
109109
<td><span title="number">event</span>, <span title="Spell">spell</span>, <span title="boolean">skipCheck</span></td>
110110
<td></td>
111111
</tr>
112+
<tr>
113+
<td>2</td>
114+
<td>ON_AURA_APPLICATION</td>
115+
<td>MAP</td>
116+
<td><span title="number">event</span>, <span title="Aura">aura</span>, <span title="AuraEffect">auraEff</span>, <span title="Unit">target</span>, <span title="number">mode</span>, <span title="boolean">apply</span></td>
117+
<td>Can return true to prevent application</td>
118+
</tr>
119+
<tr>
120+
<td>3</td>
121+
<td>ON_DISPEL</td>
122+
<td>MAP</td>
123+
<td><span title="number">event</span>, <span title="Aura">aura</span>, <span title="WorldObject">dispeller</span>, <span title="number">dispellerSpellId</span>, <span title="number">removedCharges</span></td>
124+
<td></td>
125+
</tr>
126+
<tr>
127+
<td>4</td>
128+
<td>ON_PERIODIC_TICK</td>
129+
<td>MAP</td>
130+
<td><span title="number">event</span>, <span title="Aura">aura</span>, <span title="AuraEffect">auraEff</span>, <span title="Unit">target</span></td>
131+
<td>Can return true to prevent tick</td>
132+
</tr>
133+
<tr>
134+
<td>5</td>
135+
<td>ON_PERIODIC_UPDATE</td>
136+
<td>MAP</td>
137+
<td><span title="number">event</span>, <span title="Aura">aura</span>, <span title="AuraEffect">auraEff</span></td>
138+
<td></td>
139+
</tr>
140+
<tr>
141+
<td>6</td>
142+
<td>ON_AURA_CALC_AMOUNT</td>
143+
<td>MAP</td>
144+
<td><span title="number">event</span>, <span title="Aura">aura</span>, <span title="AuraEffect">auraEff</span>, <span title="number">amount</span>, <span title="boolean">canBeRecalculated</span></td>
145+
<td>Can return amount, canBeRecalculated to override</td>
146+
</tr>
147+
<tr>
148+
<td>7</td>
149+
<td>ON_CALC_PERIODIC</td>
150+
<td>MAP</td>
151+
<td><span title="number">event</span>, <span title="Aura">aura</span>, <span title="AuraEffect">auraEff</span>, <span title="boolean">isPeriodic</span>, <span title="number">amplitude</span></td>
152+
<td>Can return isPeriodic, amplitude to override</td>
153+
</tr>
154+
<tr>
155+
<td>8</td>
156+
<td>ON_CHECK_PROC</td>
157+
<td>MAP</td>
158+
<td><span title="number">event</span>, <span title="Aura">aura</span>, <span title="ElunaProcInfo">procInfo</span></td>
159+
<td>Can return false to prevent proc</td>
160+
</tr>
161+
<tr>
162+
<td>9</td>
163+
<td>ON_PROC</td>
164+
<td>MAP</td>
165+
<td><span title="number">event</span>, <span title="Aura">aura</span>, <span title="ElunaProcInfo">procInfo</span></td>
166+
<td>Can return true to prevent default proc handling</td>
167+
</tr>
168+
<tr>
169+
<td>10</td>
170+
<td>ON_CHECK_CAST</td>
171+
<td>MAP</td>
172+
<td><span title="number">event</span>, <span title="Spell">spell</span></td>
173+
<td>Can return SpellCastResult to override cast result</td>
174+
</tr>
175+
<tr>
176+
<td>11</td>
177+
<td>ON_BEFORE_CAST</td>
178+
<td>MAP</td>
179+
<td><span title="number">event</span>, <span title="Spell">spell</span></td>
180+
<td></td>
181+
</tr>
182+
<tr>
183+
<td>12</td>
184+
<td>ON_AFTER_CAST</td>
185+
<td>MAP</td>
186+
<td><span title="number">event</span>, <span title="Spell">spell</span></td>
187+
<td></td>
188+
</tr>
189+
<tr>
190+
<td>13</td>
191+
<td>ON_OBJECT_AREA_TARGET</td>
192+
<td>MAP</td>
193+
<td><span title="number">event</span>, <span title="Spell">spell</span>, <span title="number">effIndex</span>, <span title="table">targets</span></td>
194+
<td>Modify targets table in place to change targets</td>
195+
</tr>
196+
<tr>
197+
<td>14</td>
198+
<td>ON_OBJECT_TARGET</td>
199+
<td>MAP</td>
200+
<td><span title="number">event</span>, <span title="Spell">spell</span>, <span title="number">effIndex</span>, <span title="WorldObject">target</span></td>
201+
<td></td>
202+
</tr>
203+
<tr>
204+
<td>15</td>
205+
<td>ON_DEST_TARGET</td>
206+
<td>MAP</td>
207+
<td><span title="number">event</span>, <span title="Spell">spell</span>, <span title="number">effIndex</span>, <span title="number">mapId</span>, <span title="number">x</span>, <span title="number">y</span>, <span title="number">z</span>, <span title="number">orientation</span></td>
208+
<td>Can return mapId, x, y, z, orientation to override destination</td>
209+
</tr>
210+
<tr>
211+
<td>16</td>
212+
<td>ON_EFFECT_LAUNCH</td>
213+
<td>MAP</td>
214+
<td><span title="number">event</span>, <span title="Spell">spell</span>, <span title="number">effIndex</span>, <span title="number">mode</span></td>
215+
<td>Can return true to prevent default launch handling</td>
216+
</tr>
217+
<tr>
218+
<td>17</td>
219+
<td>ON_EFFECT_LAUNCH_TARGET</td>
220+
<td>MAP</td>
221+
<td><span title="number">event</span>, <span title="Spell">spell</span>, <span title="number">effIndex</span>, <span title="number">mode</span></td>
222+
<td>Can return true to prevent default launch target handling</td>
223+
</tr>
224+
<tr>
225+
<td>18</td>
226+
<td>ON_EFFECT_CALC_ABSORB</td>
227+
<td>MAP</td>
228+
<td><span title="number">event</span>, <span title="Spell">spell</span>, <span title="Unit">attacker</span>, <span title="Unit">victim</span>, <span title="number">damage</span>, <span title="number">absorb</span>, <span title="number">resist</span>, <span title="number">block</span>, <span title="number">schoolMask</span>, <span title="number">damageType</span>, <span title="number">attackType</span>, <span title="number">hitMask</span>, <span title="number">resistAmount</span>, <span title="number">absorbAmount</span></td>
229+
<td>Can return resistAmount, absorbAmount to override</td>
230+
</tr>
231+
<tr>
232+
<td>19</td>
233+
<td>ON_EFFECT_HIT</td>
234+
<td>MAP</td>
235+
<td><span title="number">event</span>, <span title="Spell">spell</span>, <span title="number">effIndex</span>, <span title="number">mode</span></td>
236+
<td>Can return true to prevent default hit handling</td>
237+
</tr>
238+
<tr>
239+
<td>20</td>
240+
<td>ON_BEFORE_HIT</td>
241+
<td>MAP</td>
242+
<td><span title="number">event</span>, <span title="Spell">spell</span>, <span title="number">missInfo</span></td>
243+
<td></td>
244+
</tr>
245+
<tr>
246+
<td>21</td>
247+
<td>ON_EFFECT_HIT_TARGET</td>
248+
<td>MAP</td>
249+
<td><span title="number">event</span>, <span title="Spell">spell</span>, <span title="number">effIndex</span>, <span title="number">mode</span></td>
250+
<td>Can return true to prevent default hit target handling</td>
251+
</tr>
252+
<tr>
253+
<td>22</td>
254+
<td>ON_HIT</td>
255+
<td>MAP</td>
256+
<td><span title="number">event</span>, <span title="Spell">spell</span></td>
257+
<td></td>
258+
</tr>
259+
<tr>
260+
<td>23</td>
261+
<td>ON_AFTER_HIT</td>
262+
<td>MAP</td>
263+
<td><span title="number">event</span>, <span title="Spell">spell</span></td>
264+
<td></td>
265+
</tr>
112266
</tbody>
113267
</table>
114268
</div>

‎Global/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -568,7 +568,7 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
568568
<a class='fn' href='GetSpellInfo.html'>GetSpellInfo</a>
569569
</td>
570570
<td class='docblock short'>
571-
<p>Returns the [ElunaSpellInfo] for the given spell ID, or nil if the spell does not exist.</p>
571+
<p>Returns the <a class="mod" href="../SpellInfo/index.html">SpellInfo</a> for the given spell ID, or nil if the spell does not exist.</p>
572572
</td>
573573
</tr>
574574
<tr>

‎Spell/GetSpellInfo.html‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,29 +87,31 @@ <h1 class='fqn'>
8787

8888

8989
<div class='docblock'>
90-
<p>This method is <em>undocumented</em>. <strong>Use at your own risk.</strong></p>
91-
<p>For temporary documentation, please check the <a href="https://github.com/ElunaLuaEngine/Eluna/blob/master/LuaFunctions.cpp">LuaFunctions</a> source file.</p>
90+
<p>Returns the <a class="mod" href="../SpellInfo/index.html">SpellInfo</a> of the spell that created this <a class="mod" href="../Spell/index.html">Spell</a>.</p>
9291

9392

9493
<h2 id="synopsis" class='section-header'>
9594
<a href="#synopsis">Synopsis</a>
9695
</h2>
9796
<p>
98-
<code>Spell:GetSpellInfo()</code>
97+
<code>spellInfo = Spell:GetSpellInfo()</code>
9998
</p>
10099

101100
<h2 id="arguments" class='section-header'>
102101
<a href="#arguments">Arguments</a>
103102
</h2>
104103
<p>
105-
Unknown.
104+
None.
106105
</p>
107106

108107
<h2 id="returns" class='section-header'>
109108
<a href="#returns">Returns</a>
110109
</h2>
111110
<p>
112-
Unknown.
111+
<dl>
112+
<dt><code><strong><a class="mod" href="../SpellInfo/index.html">SpellInfo</a></strong> spellInfo</code></dt>
113+
<dd class="docblock"><em>See method description.</em></dd>
114+
</dl>
113115
</p>
114116
</div>
115117

‎Spell/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,11 +223,11 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
223223
</tr>
224224
<tr>
225225
<td>
226-
<a class='stability Experimental' title='Undocumented'></a>
226+
<a class='stability Stable' title='Documented'></a>
227227
<a class='fn' href='GetSpellInfo.html'>GetSpellInfo</a>
228228
</td>
229229
<td class='docblock short'>
230-
<p></p>
230+
<p>Returns the <a class="mod" href="../SpellInfo/index.html">SpellInfo</a> of the spell that created this <a class="mod" href="../Spell/index.html">Spell</a>.</p>
231231
</td>
232232
</tr>
233233
<tr>

‎SpellInfo/CalcCastTime.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h1 class='fqn'>
8787

8888

8989
<div class='docblock'>
90-
<p>Returns the calculated cast time in milliseconds of the [ElunaSpellInfo].</p>
90+
<p>Returns the calculated cast time in milliseconds of the <a class="mod" href="../SpellInfo/index.html">SpellInfo</a>.</p>
9191

9292

9393
<h2 id="synopsis" class='section-header'>

‎SpellInfo/CanBeUsedInCombat.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h1 class='fqn'>
8787

8888

8989
<div class='docblock'>
90-
<p>Returns <code>true</code> if the [ElunaSpellInfo] can be used in combat, <code>false</code> otherwise.</p>
90+
<p>Returns <code>true</code> if the <a class="mod" href="../SpellInfo/index.html">SpellInfo</a> can be used in combat, <code>false</code> otherwise.</p>
9191

9292

9393
<h2 id="synopsis" class='section-header'>

‎SpellInfo/CanDispelAura.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h1 class='fqn'>
8787

8888

8989
<div class='docblock'>
90-
<p>Returns <code>true</code> if the [ElunaSpellInfo] can dispel the given [ElunaSpellInfo], <code>false</code> otherwise.</p>
90+
<p>Returns <code>true</code> if the <a class="mod" href="../SpellInfo/index.html">SpellInfo</a> can dispel the given <a class="mod" href="../SpellInfo/index.html">SpellInfo</a>, <code>false</code> otherwise.</p>
9191

9292

9393
<h2 id="synopsis" class='section-header'>
@@ -102,7 +102,7 @@ <h2 id="arguments" class='section-header'>
102102
</h2>
103103
<p>
104104
<dl>
105-
<dt><code><strong><a href="https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/search?l=cpp&q=%22enum+ElunaSpellInfo%22&type=Code&utf8=%E2%9C%93">ElunaSpellInfo</a></strong> auraSpellInfo</code></dt>
105+
<dt><code><strong><a class="mod" href="../SpellInfo/index.html">SpellInfo</a></strong> auraSpellInfo</code></dt>
106106
<dd class="docblock"><p>The aura spell info to check against. </p></dd>
107107
</dl>
108108
</p>

0 commit comments

Comments
 (0)