Skip to content

Update Eluna documentation #45

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 #45

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
36 changes: 28 additions & 8 deletions GameObject/GetGoState.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,34 @@ <h1 class='fqn'>
<div class='docblock'>
<p>Returns the state of a <a class="mod" href="../GameObject/index.html">GameObject</a>
Below are client side [GOState]s off of 3.3.5a</p>
<pre>
enum GOState
{
GO_STATE_ACTIVE = 0, // show in world as used and not reset (closed door open)
GO_STATE_READY = 1, // show in world as ready (closed door close)
GO_STATE_ACTIVE_ALTERNATIVE = 2 // show in world as used in alt way and not reset (closed door open by cannon fire)
};
</pre>
<div class="table-container">
<table>
<thead>
<tr>
<th>GOState</th>
<th>ID</th>
<th>Comment</th>
</tr>
</thead>
<tbody>
<tr>
<td>GO_STATE_ACTIVE</td>
<td>0</td>
<td>show in world as used and not reset (closed door open)</td>
</tr>
<tr>
<td>GO_STATE_READY</td>
<td>1</td>
<td>show in world as ready (closed door close)</td>
</tr>
<tr>
<td>GO_STATE_ACTIVE_ALTERNATIVE</td>
<td>2</td>
<td>show in world as used in alt way and not reset (closed door open by cannon fire)</td>
</tr>
</tbody>
</table>
</div>


<h2 id="synopsis" class='section-header'>
Expand Down
42 changes: 33 additions & 9 deletions GameObject/GetLootState.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,15 +89,39 @@ <h1 class='fqn'>
<div class='docblock'>
<p>Returns the [LootState] of a <a class="mod" href="../GameObject/index.html">GameObject</a>
Below are [LootState]s off of 3.3.5a</p>
<pre>
enum LootState
{
GO_NOT_READY = 0,
GO_READY, // can be ready but despawned, and then not possible activate until spawn
GO_ACTIVATED,
GO_JUST_DEACTIVATED
};
</pre>
<div class="table-container">
<table>
<thead>
<tr>
<th>LootState</th>
<th>ID</th>
<th>Comment</th>
</tr>
</thead>
<tbody>
<tr>
<td>GO_NOT_READY</td>
<td>0</td>
<td></td>
</tr>
<tr>
<td>GO_READY</td>
<td>1</td>
<td>can be ready but despawned, and then not possible activate until spawn</td>
</tr>
<tr>
<td>GO_ACTIVATED</td>
<td>2</td>
<td></td>
</tr>
<tr>
<td>GO_JUST_DEACTIVATED</td>
<td>3</td>
<td></td>
</tr>
</tbody>
</table>
</div>


<h2 id="synopsis" class='section-header'>
Expand Down
36 changes: 28 additions & 8 deletions GameObject/SetGoState.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,14 +88,34 @@ <h1 class='fqn'>

<div class='docblock'>
<p>Sets the state of a <a class="mod" href="../GameObject/index.html">GameObject</a></p>
<pre>
enum GOState
{
GO_STATE_ACTIVE = 0, // show in world as used and not reset (closed door open)
GO_STATE_READY = 1, // show in world as ready (closed door close)
GO_STATE_ACTIVE_ALTERNATIVE = 2 // show in world as used in alt way and not reset (closed door open by cannon fire)
};
</pre>
<div class="table-container">
<table>
<thead>
<tr>
<th>GOState</th>
<th>ID</th>
<th>Comment</th>
</tr>
</thead>
<tbody>
<tr>
<td>GO_STATE_ACTIVE</td>
<td>0</td>
<td>show in world as used and not reset (closed door open)</td>
</tr>
<tr>
<td>GO_STATE_READY</td>
<td>1</td>
<td>show in world as ready (closed door close)</td>
</tr>
<tr>
<td>GO_STATE_ACTIVE_ALTERNATIVE</td>
<td>2</td>
<td>show in world as used in alt way and not reset (closed door open by cannon fire)</td>
</tr>
</tbody>
</table>
</div>


<h2 id="synopsis" class='section-header'>
Expand Down
42 changes: 33 additions & 9 deletions GameObject/SetLootState.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,15 +89,39 @@ <h1 class='fqn'>
<div class='docblock'>
<p>Sets the [LootState] of a <a class="mod" href="../GameObject/index.html">GameObject</a>
Below are [LootState]s off of 3.3.5a</p>
<pre>
enum LootState
{
GO_NOT_READY = 0,
GO_READY, // can be ready but despawned, and then not possible activate until spawn
GO_ACTIVATED,
GO_JUST_DEACTIVATED
};
</pre>
<div class="table-container">
<table>
<thead>
<tr>
<th>LootState</th>
<th>ID</th>
<th>Comment</th>
</tr>
</thead>
<tbody>
<tr>
<td>GO_NOT_READY</td>
<td>0</td>
<td></td>
</tr>
<tr>
<td>GO_READY</td>
<td>1</td>
<td>can be ready but despawned, and then not possible activate until spawn</td>
</tr>
<tr>
<td>GO_ACTIVATED</td>
<td>2</td>
<td></td>
</tr>
<tr>
<td>GO_JUST_DEACTIVATED</td>
<td>3</td>
<td></td>
</tr>
</tbody>
</table>
</div>


<h2 id="synopsis" class='section-header'>
Expand Down
32 changes: 24 additions & 8 deletions Group/GetMemberFlags.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,14 +88,30 @@ <h1 class='fqn'>

<div class='docblock'>
<p>Returns the <a class="mod" href="../Group/index.html">Group</a> members' flags</p>
<pre>
enum GroupMemberFlags
{
MEMBER_FLAG_ASSISTANT = 1,
MEMBER_FLAG_MAINTANK = 2,
MEMBER_FLAG_MAINASSIST = 4
};
</pre>
<div class="table-container">
<table>
<thead>
<tr>
<th>GroupMemberFlags</th>
<th>ID</th>
</tr>
</thead>
<tbody>
<tr>
<td>MEMBER_FLAG_ASSISTANT</td>
<td>1</td>
</tr>
<tr>
<td>MEMBER_FLAG_MAINTANK</td>
<td>2</td>
</tr>
<tr>
<td>MEMBER_FLAG_MAINASSIST</td>
<td>4</td>
</tr>
</tbody>
</table>
</div>


<h2 id="synopsis" class='section-header'>
Expand Down
37 changes: 28 additions & 9 deletions Group/RemoveMember.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,15 +89,34 @@ <h1 class='fqn'>
<div class='docblock'>
<p>Removes a <a class="mod" href="../Player/index.html">Player</a> from this <a class="mod" href="../Group/index.html">Group</a> and returns 'true' if successful</p>
<p>In multistate, this method is only available in the WORLD state</p>
<pre>
enum RemoveMethod
{
GROUP_REMOVEMETHOD_DEFAULT = 0,
GROUP_REMOVEMETHOD_KICK = 1,
GROUP_REMOVEMETHOD_LEAVE = 2,
GROUP_REMOVEMETHOD_KICK_LFG = 3
};
</pre>
<div class="table-container">
<table>
<thead>
<tr>
<th>RemoveMethod</th>
<th>ID</th>
</tr>
</thead>
<tbody>
<tr>
<td>GROUP_REMOVEMETHOD_DEFAULT</td>
<td>0</td>
</tr>
<tr>
<td>GROUP_REMOVEMETHOD_KICK</td>
<td>1</td>
</tr>
<tr>
<td>GROUP_REMOVEMETHOD_LEAVE</td>
<td>2</td>
</tr>
<tr>
<td>GROUP_REMOVEMETHOD_KICK_LFG</td>
<td>3</td>
</tr>
</tbody>
</table>
</div>


<h2 id="synopsis" class='section-header'>
Expand Down
32 changes: 24 additions & 8 deletions Group/SetMemberFlag.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,30 @@ <h1 class='fqn'>
<div class='docblock'>
<p>Sets or removes a flag for a <a class="mod" href="../Group/index.html">Group</a> member</p>
<p>In multistate, this method is only available in the WORLD state</p>
<pre>
enum GroupMemberFlags
{
MEMBER_FLAG_ASSISTANT = 1,
MEMBER_FLAG_MAINTANK = 2,
MEMBER_FLAG_MAINASSIST = 4
};
</pre>
<div class="table-container">
<table>
<thead>
<tr>
<th>GroupMemberFlags</th>
<th>ID</th>
</tr>
</thead>
<tbody>
<tr>
<td>MEMBER_FLAG_ASSISTANT</td>
<td>1</td>
</tr>
<tr>
<td>MEMBER_FLAG_MAINTANK</td>
<td>2</td>
</tr>
<tr>
<td>MEMBER_FLAG_MAINASSIST</td>
<td>4</td>
</tr>
</tbody>
</table>
</div>


<h2 id="synopsis" class='section-header'>
Expand Down
62 changes: 48 additions & 14 deletions Item/GetItemLink.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,20 +88,54 @@ <h1 class='fqn'>

<div class='docblock'>
<p>Returns the chat link of the <a class="mod" href="../Item/index.html">Item</a></p>
<pre>
enum LocaleConstant
{
LOCALE_enUS = 0,
LOCALE_koKR = 1,
LOCALE_frFR = 2,
LOCALE_deDE = 3,
LOCALE_zhCN = 4,
LOCALE_zhTW = 5,
LOCALE_esES = 6,
LOCALE_esMX = 7,
LOCALE_ruRU = 8
};
</pre>
<div class="table-container">
<table>
<thead>
<tr>
<th>Locale</th>
<th>ID</th>
</tr>
</thead>
<tbody>
<tr>
<td>LOCALE_enUS</td>
<td>0</td>
</tr>
<tr>
<td>LOCALE_koKR</td>
<td>1</td>
</tr>
<tr>
<td>LOCALE_frFR</td>
<td>2</td>
</tr>
<tr>
<td>LOCALE_deDE</td>
<td>3</td>
</tr>
<tr>
<td>LOCALE_zhCN</td>
<td>4</td>
</tr>
<tr>
<td>LOCALE_zhTW</td>
<td>5</td>
</tr>
<tr>
<td>LOCALE_esES</td>
<td>6</td>
</tr>
<tr>
<td>LOCALE_esMX</td>
<td>7</td>
</tr>
<tr>
<td>LOCALE_ruRU</td>
<td>8</td>
</tr>
</tbody>
</table>
</div>


<h2 id="synopsis" class='section-header'>
Expand Down
Loading