Skip to content

Update Eluna documentation #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 14, 2024
Merged

Update Eluna documentation #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions Player/AddLifetimeKills.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,29 +87,31 @@ <h1 class='fqn'>


<div class='docblock'>
<p>This method is <em>undocumented</em>. <strong>Use at your own risk.</strong></p>
<p>For temporary documentation, please check the <a href="https://github.com/ElunaLuaEngine/Eluna/blob/master/LuaFunctions.cpp">LuaFunctions</a> source file.</p>
<p>Adds or detracts from the <a class="mod" href="../Player/index.html">Player</a>s current lifetime kill count</p>


<h2 id="synopsis" class='section-header'>
<a href="#synopsis">Synopsis</a>
</h2>
<p>
<code>Player:AddLifetimeKills()</code>
<code>Player:AddLifetimeKills( kills )</code>
</p>

<h2 id="arguments" class='section-header'>
<a href="#arguments">Arguments</a>
</h2>
<p>
Unknown.
<dl>
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> kills</code></dt>
<dd class="docblock"><p>Positive number to add, negative number to detract. </p><p><em>Valid numbers</em>: integers from -2,147,483,647 to 2,147,483,647.</p></dd>
</dl>
</p>

<h2 id="returns" class='section-header'>
<a href="#returns">Returns</a>
</h2>
<p>
Unknown.
Nothing.
</p>
</div>

Expand Down
26 changes: 21 additions & 5 deletions Player/AddTalent.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,29 +87,45 @@ <h1 class='fqn'>


<div class='docblock'>
<p>This method is <em>undocumented</em>. <strong>Use at your own risk.</strong></p>
<p>For temporary documentation, please check the <a href="https://github.com/ElunaLuaEngine/Eluna/blob/master/LuaFunctions.cpp">LuaFunctions</a> source file.</p>
<p>Adds a talent to the <a class="mod" href="../Player/index.html">Player</a> for the specified spec and learning status.</p>


<h2 id="synopsis" class='section-header'>
<a href="#synopsis">Synopsis</a>
</h2>
<p>
<code>Player:AddTalent()</code>
<code>success = Player:AddTalent( spellId, spec )</code>
</p>
<p>
<code>success = Player:AddTalent( spellId, spec, learning )</code>
</p>

<h2 id="arguments" class='section-header'>
<a href="#arguments">Arguments</a>
</h2>
<p>
Unknown.
<dl>
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> spellId</code></dt>
<dd class="docblock"><p>ID of the spell for the talent. </p><p><em>Valid numbers</em>: integers from 0 to 4,294,967,295.</p></dd>
</dl>
<dl>
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> spec</code></dt>
<dd class="docblock"><p>The spec to which the talent applies. </p><p><em>Valid numbers</em>: integers from 0 to 255.</p></dd>
</dl>
<dl>
<dt><code><strong><a href="http://www.lua.org/pil/2.2.html">boolean</a></strong> learning (true)</code></dt>
<dd class="docblock"><p>Whether the talent is being learned. </p></dd>
</dl>
</p>

<h2 id="returns" class='section-header'>
<a href="#returns">Returns</a>
</h2>
<p>
Unknown.
<dl>
<dt><code><strong><a href="http://www.lua.org/pil/2.2.html">boolean</a></strong> success</code></dt>
<dd class="docblock"><p>True if the talent was added, false otherwise. </p></dd>
</dl>
</p>
</div>

Expand Down
7 changes: 3 additions & 4 deletions Player/BindToInstance.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,7 @@ <h1 class='fqn'>


<div class='docblock'>
<p>This method is <em>undocumented</em>. <strong>Use at your own risk.</strong></p>
<p>For temporary documentation, please check the <a href="https://github.com/ElunaLuaEngine/Eluna/blob/master/LuaFunctions.cpp">LuaFunctions</a> source file.</p>
<p>Binds the <a class="mod" href="../Player/index.html">Player</a> to their current instance.</p>


<h2 id="synopsis" class='section-header'>
Expand All @@ -102,14 +101,14 @@ <h2 id="arguments" class='section-header'>
<a href="#arguments">Arguments</a>
</h2>
<p>
Unknown.
None.
</p>

<h2 id="returns" class='section-header'>
<a href="#returns">Returns</a>
</h2>
<p>
Unknown.
Nothing.
</p>
</div>

Expand Down
117 changes: 91 additions & 26 deletions Player/EquipItem.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,37 +88,102 @@ <h1 class='fqn'>

<div class='docblock'>
<p>Equips the given item or item entry to the given slot. Returns the equipped item or nil.</p>
<pre><code>enum EquipmentSlots // 19 slots
{
EQUIPMENT_SLOT_START = 0,
EQUIPMENT_SLOT_HEAD = 0,
EQUIPMENT_SLOT_NECK = 1,
EQUIPMENT_SLOT_SHOULDERS = 2,
EQUIPMENT_SLOT_BODY = 3,
EQUIPMENT_SLOT_CHEST = 4,
EQUIPMENT_SLOT_WAIST = 5,
EQUIPMENT_SLOT_LEGS = 6,
EQUIPMENT_SLOT_FEET = 7,
EQUIPMENT_SLOT_WRISTS = 8,
EQUIPMENT_SLOT_HANDS = 9,
EQUIPMENT_SLOT_FINGER1 = 10,
EQUIPMENT_SLOT_FINGER2 = 11,
EQUIPMENT_SLOT_TRINKET1 = 12,
EQUIPMENT_SLOT_TRINKET2 = 13,
EQUIPMENT_SLOT_BACK = 14,
EQUIPMENT_SLOT_MAINHAND = 15,
EQUIPMENT_SLOT_OFFHAND = 16,
EQUIPMENT_SLOT_RANGED = 17,
EQUIPMENT_SLOT_TABARD = 18,
EQUIPMENT_SLOT_END = 19
};

enum InventorySlots // 4 slots
<pre><code>enum InventorySlots // 4 slots
{
INVENTORY_SLOT_BAG_START = 19,
INVENTORY_SLOT_BAG_END = 23
};
</code></pre>
<div class="table-container">
<p>
<table>
<thead>
<tr>
<th>Slot</th>
<th>ID</th>
</tr>
</thead>
<tbody>
<tr>
<td>EQUIPMENT_SLOT_HEAD</td>
<td>0</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_NECK</td>
<td>1</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_SHOULDERS</td>
<td>2</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_BODY</td>
<td>3</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_CHEST</td>
<td>4</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_WAIST</td>
<td>5</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_LEGS</td>
<td>6</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_FEET</td>
<td>7</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_WRISTS</td>
<td>8</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_HANDS</td>
<td>9</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_FINGER1</td>
<td>10</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_FINGER2</td>
<td>11</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_TRINKET1</td>
<td>12</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_TRINKET2</td>
<td>13</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_BACK</td>
<td>14</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_MAINHAND</td>
<td>15</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_OFFHAND</td>
<td>16</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_RANGED</td>
<td>17</td>
</tr>
<tr>
<td>EQUIPMENT_SLOT_TABARD</td>
<td>18</td>
</tr>
</tbody>
</table>
</p>
</div>


<h2 id="synopsis" class='section-header'>
Expand Down
12 changes: 7 additions & 5 deletions Player/GetNearbyGameObject.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,29 +87,31 @@ <h1 class='fqn'>


<div class='docblock'>
<p>This method is <em>undocumented</em>. <strong>Use at your own risk.</strong></p>
<p>For temporary documentation, please check the <a href="https://github.com/ElunaLuaEngine/Eluna/blob/master/LuaFunctions.cpp">LuaFunctions</a> source file.</p>
<p>Returns the closest <a class="mod" href="../GameObject/index.html">GameObject</a> to the <a class="mod" href="../Player/index.html">Player</a>.</p>


<h2 id="synopsis" class='section-header'>
<a href="#synopsis">Synopsis</a>
</h2>
<p>
<code>Player:GetNearbyGameObject()</code>
<code>gameobject = Player:GetNearbyGameObject()</code>
</p>

<h2 id="arguments" class='section-header'>
<a href="#arguments">Arguments</a>
</h2>
<p>
Unknown.
None.
</p>

<h2 id="returns" class='section-header'>
<a href="#returns">Returns</a>
</h2>
<p>
Unknown.
<dl>
<dt><code><strong><a class="mod" href="../GameObject/index.html">GameObject</a></strong> gameobject</code></dt>
<dd class="docblock"><em>See method description.</em></dd>
</dl>
</p>
</div>

Expand Down
12 changes: 7 additions & 5 deletions Player/GetRecruiterId.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,29 +87,31 @@ <h1 class='fqn'>


<div class='docblock'>
<p>This method is <em>undocumented</em>. <strong>Use at your own risk.</strong></p>
<p>For temporary documentation, please check the <a href="https://github.com/ElunaLuaEngine/Eluna/blob/master/LuaFunctions.cpp">LuaFunctions</a> source file.</p>
<p>Returns the <a class="mod" href="../Player/index.html">Player</a>s recruit-a-friend recruiter account ID</p>


<h2 id="synopsis" class='section-header'>
<a href="#synopsis">Synopsis</a>
</h2>
<p>
<code>Player:GetRecruiterId()</code>
<code>recruiterId = Player:GetRecruiterId()</code>
</p>

<h2 id="arguments" class='section-header'>
<a href="#arguments">Arguments</a>
</h2>
<p>
Unknown.
None.
</p>

<h2 id="returns" class='section-header'>
<a href="#returns">Returns</a>
</h2>
<p>
Unknown.
<dl>
<dt><code><strong><a href="http://www.lua.org/pil/2.3.html">number</a></strong> recruiterId</code></dt>
<dd class="docblock"><p><em>Valid numbers</em>: integers from 0 to 4,294,967,295.</p></dd>
</dl>
</p>
</div>

Expand Down
12 changes: 7 additions & 5 deletions Player/GetSelectedPlayer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,29 +87,31 @@ <h1 class='fqn'>


<div class='docblock'>
<p>This method is <em>undocumented</em>. <strong>Use at your own risk.</strong></p>
<p>For temporary documentation, please check the <a href="https://github.com/ElunaLuaEngine/Eluna/blob/master/LuaFunctions.cpp">LuaFunctions</a> source file.</p>
<p>Returns the <a class="mod" href="../Player/index.html">Player</a>s selected <a class="mod" href="../Player/index.html">Player</a> or nil.</p>


<h2 id="synopsis" class='section-header'>
<a href="#synopsis">Synopsis</a>
</h2>
<p>
<code>Player:GetSelectedPlayer()</code>
<code>selection = Player:GetSelectedPlayer()</code>
</p>

<h2 id="arguments" class='section-header'>
<a href="#arguments">Arguments</a>
</h2>
<p>
Unknown.
None.
</p>

<h2 id="returns" class='section-header'>
<a href="#returns">Returns</a>
</h2>
<p>
Unknown.
<dl>
<dt><code><strong><a class="mod" href="../Player/index.html">Player</a></strong> selection</code></dt>
<dd class="docblock"><em>See method description.</em></dd>
</dl>
</p>
</div>

Expand Down
12 changes: 7 additions & 5 deletions Player/GetSelectedUnit.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,29 +87,31 @@ <h1 class='fqn'>


<div class='docblock'>
<p>This method is <em>undocumented</em>. <strong>Use at your own risk.</strong></p>
<p>For temporary documentation, please check the <a href="https://github.com/ElunaLuaEngine/Eluna/blob/master/LuaFunctions.cpp">LuaFunctions</a> source file.</p>
<p>Returns the <a class="mod" href="../Player/index.html">Player</a>s selected <a class="mod" href="../Unit/index.html">Unit</a>.</p>


<h2 id="synopsis" class='section-header'>
<a href="#synopsis">Synopsis</a>
</h2>
<p>
<code>Player:GetSelectedUnit()</code>
<code>selection = Player:GetSelectedUnit()</code>
</p>

<h2 id="arguments" class='section-header'>
<a href="#arguments">Arguments</a>
</h2>
<p>
Unknown.
None.
</p>

<h2 id="returns" class='section-header'>
<a href="#returns">Returns</a>
</h2>
<p>
Unknown.
<dl>
<dt><code><strong><a class="mod" href="../Unit/index.html">Unit</a></strong> selection</code></dt>
<dd class="docblock"><em>See method description.</em></dd>
</dl>
</p>
</div>

Expand Down
Loading