Skip to content

Commit 12a9dae

Browse files
FoereaperFoereaper
authored
Merge pull request #45 from ElunaLuaEngine/master-2024-11-14_22-25
Update Eluna documentation
2 parents 595dac8 + fb8a361 commit 12a9dae

File tree

9 files changed

+364
-102
lines changed

9 files changed

+364
-102
lines changed

‎GameObject/GetGoState.html‎

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,34 @@ <h1 class='fqn'>
8989
<div class='docblock'>
9090
<p>Returns the state of a <a class="mod" href="../GameObject/index.html">GameObject</a>
9191
Below are client side [GOState]s off of 3.3.5a</p>
92-
<pre>
93-
enum GOState
94-
{
95-
GO_STATE_ACTIVE = 0, // show in world as used and not reset (closed door open)
96-
GO_STATE_READY = 1, // show in world as ready (closed door close)
97-
GO_STATE_ACTIVE_ALTERNATIVE = 2 // show in world as used in alt way and not reset (closed door open by cannon fire)
98-
};
99-
</pre>
92+
<div class="table-container">
93+
<table>
94+
<thead>
95+
<tr>
96+
<th>GOState</th>
97+
<th>ID</th>
98+
<th>Comment</th>
99+
</tr>
100+
</thead>
101+
<tbody>
102+
<tr>
103+
<td>GO_STATE_ACTIVE</td>
104+
<td>0</td>
105+
<td>show in world as used and not reset (closed door open)</td>
106+
</tr>
107+
<tr>
108+
<td>GO_STATE_READY</td>
109+
<td>1</td>
110+
<td>show in world as ready (closed door close)</td>
111+
</tr>
112+
<tr>
113+
<td>GO_STATE_ACTIVE_ALTERNATIVE</td>
114+
<td>2</td>
115+
<td>show in world as used in alt way and not reset (closed door open by cannon fire)</td>
116+
</tr>
117+
</tbody>
118+
</table>
119+
</div>
100120

101121

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

‎GameObject/GetLootState.html‎

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,39 @@ <h1 class='fqn'>
8989
<div class='docblock'>
9090
<p>Returns the [LootState] of a <a class="mod" href="../GameObject/index.html">GameObject</a>
9191
Below are [LootState]s off of 3.3.5a</p>
92-
<pre>
93-
enum LootState
94-
{
95-
GO_NOT_READY = 0,
96-
GO_READY, // can be ready but despawned, and then not possible activate until spawn
97-
GO_ACTIVATED,
98-
GO_JUST_DEACTIVATED
99-
};
100-
</pre>
92+
<div class="table-container">
93+
<table>
94+
<thead>
95+
<tr>
96+
<th>LootState</th>
97+
<th>ID</th>
98+
<th>Comment</th>
99+
</tr>
100+
</thead>
101+
<tbody>
102+
<tr>
103+
<td>GO_NOT_READY</td>
104+
<td>0</td>
105+
<td></td>
106+
</tr>
107+
<tr>
108+
<td>GO_READY</td>
109+
<td>1</td>
110+
<td>can be ready but despawned, and then not possible activate until spawn</td>
111+
</tr>
112+
<tr>
113+
<td>GO_ACTIVATED</td>
114+
<td>2</td>
115+
<td></td>
116+
</tr>
117+
<tr>
118+
<td>GO_JUST_DEACTIVATED</td>
119+
<td>3</td>
120+
<td></td>
121+
</tr>
122+
</tbody>
123+
</table>
124+
</div>
101125

102126

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

‎GameObject/SetGoState.html‎

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,34 @@ <h1 class='fqn'>
8888

8989
<div class='docblock'>
9090
<p>Sets the state of a <a class="mod" href="../GameObject/index.html">GameObject</a></p>
91-
<pre>
92-
enum GOState
93-
{
94-
GO_STATE_ACTIVE = 0, // show in world as used and not reset (closed door open)
95-
GO_STATE_READY = 1, // show in world as ready (closed door close)
96-
GO_STATE_ACTIVE_ALTERNATIVE = 2 // show in world as used in alt way and not reset (closed door open by cannon fire)
97-
};
98-
</pre>
91+
<div class="table-container">
92+
<table>
93+
<thead>
94+
<tr>
95+
<th>GOState</th>
96+
<th>ID</th>
97+
<th>Comment</th>
98+
</tr>
99+
</thead>
100+
<tbody>
101+
<tr>
102+
<td>GO_STATE_ACTIVE</td>
103+
<td>0</td>
104+
<td>show in world as used and not reset (closed door open)</td>
105+
</tr>
106+
<tr>
107+
<td>GO_STATE_READY</td>
108+
<td>1</td>
109+
<td>show in world as ready (closed door close)</td>
110+
</tr>
111+
<tr>
112+
<td>GO_STATE_ACTIVE_ALTERNATIVE</td>
113+
<td>2</td>
114+
<td>show in world as used in alt way and not reset (closed door open by cannon fire)</td>
115+
</tr>
116+
</tbody>
117+
</table>
118+
</div>
99119

100120

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

‎GameObject/SetLootState.html‎

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,39 @@ <h1 class='fqn'>
8989
<div class='docblock'>
9090
<p>Sets the [LootState] of a <a class="mod" href="../GameObject/index.html">GameObject</a>
9191
Below are [LootState]s off of 3.3.5a</p>
92-
<pre>
93-
enum LootState
94-
{
95-
GO_NOT_READY = 0,
96-
GO_READY, // can be ready but despawned, and then not possible activate until spawn
97-
GO_ACTIVATED,
98-
GO_JUST_DEACTIVATED
99-
};
100-
</pre>
92+
<div class="table-container">
93+
<table>
94+
<thead>
95+
<tr>
96+
<th>LootState</th>
97+
<th>ID</th>
98+
<th>Comment</th>
99+
</tr>
100+
</thead>
101+
<tbody>
102+
<tr>
103+
<td>GO_NOT_READY</td>
104+
<td>0</td>
105+
<td></td>
106+
</tr>
107+
<tr>
108+
<td>GO_READY</td>
109+
<td>1</td>
110+
<td>can be ready but despawned, and then not possible activate until spawn</td>
111+
</tr>
112+
<tr>
113+
<td>GO_ACTIVATED</td>
114+
<td>2</td>
115+
<td></td>
116+
</tr>
117+
<tr>
118+
<td>GO_JUST_DEACTIVATED</td>
119+
<td>3</td>
120+
<td></td>
121+
</tr>
122+
</tbody>
123+
</table>
124+
</div>
101125

102126

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

‎Group/GetMemberFlags.html‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,30 @@ <h1 class='fqn'>
8888

8989
<div class='docblock'>
9090
<p>Returns the <a class="mod" href="../Group/index.html">Group</a> members' flags</p>
91-
<pre>
92-
enum GroupMemberFlags
93-
{
94-
MEMBER_FLAG_ASSISTANT = 1,
95-
MEMBER_FLAG_MAINTANK = 2,
96-
MEMBER_FLAG_MAINASSIST = 4
97-
};
98-
</pre>
91+
<div class="table-container">
92+
<table>
93+
<thead>
94+
<tr>
95+
<th>GroupMemberFlags</th>
96+
<th>ID</th>
97+
</tr>
98+
</thead>
99+
<tbody>
100+
<tr>
101+
<td>MEMBER_FLAG_ASSISTANT</td>
102+
<td>1</td>
103+
</tr>
104+
<tr>
105+
<td>MEMBER_FLAG_MAINTANK</td>
106+
<td>2</td>
107+
</tr>
108+
<tr>
109+
<td>MEMBER_FLAG_MAINASSIST</td>
110+
<td>4</td>
111+
</tr>
112+
</tbody>
113+
</table>
114+
</div>
99115

100116

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

‎Group/RemoveMember.html‎

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,34 @@ <h1 class='fqn'>
8989
<div class='docblock'>
9090
<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>
9191
<p>In multistate, this method is only available in the WORLD state</p>
92-
<pre>
93-
enum RemoveMethod
94-
{
95-
GROUP_REMOVEMETHOD_DEFAULT = 0,
96-
GROUP_REMOVEMETHOD_KICK = 1,
97-
GROUP_REMOVEMETHOD_LEAVE = 2,
98-
GROUP_REMOVEMETHOD_KICK_LFG = 3
99-
};
100-
</pre>
92+
<div class="table-container">
93+
<table>
94+
<thead>
95+
<tr>
96+
<th>RemoveMethod</th>
97+
<th>ID</th>
98+
</tr>
99+
</thead>
100+
<tbody>
101+
<tr>
102+
<td>GROUP_REMOVEMETHOD_DEFAULT</td>
103+
<td>0</td>
104+
</tr>
105+
<tr>
106+
<td>GROUP_REMOVEMETHOD_KICK</td>
107+
<td>1</td>
108+
</tr>
109+
<tr>
110+
<td>GROUP_REMOVEMETHOD_LEAVE</td>
111+
<td>2</td>
112+
</tr>
113+
<tr>
114+
<td>GROUP_REMOVEMETHOD_KICK_LFG</td>
115+
<td>3</td>
116+
</tr>
117+
</tbody>
118+
</table>
119+
</div>
101120

102121

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

‎Group/SetMemberFlag.html‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,30 @@ <h1 class='fqn'>
8989
<div class='docblock'>
9090
<p>Sets or removes a flag for a <a class="mod" href="../Group/index.html">Group</a> member</p>
9191
<p>In multistate, this method is only available in the WORLD state</p>
92-
<pre>
93-
enum GroupMemberFlags
94-
{
95-
MEMBER_FLAG_ASSISTANT = 1,
96-
MEMBER_FLAG_MAINTANK = 2,
97-
MEMBER_FLAG_MAINASSIST = 4
98-
};
99-
</pre>
92+
<div class="table-container">
93+
<table>
94+
<thead>
95+
<tr>
96+
<th>GroupMemberFlags</th>
97+
<th>ID</th>
98+
</tr>
99+
</thead>
100+
<tbody>
101+
<tr>
102+
<td>MEMBER_FLAG_ASSISTANT</td>
103+
<td>1</td>
104+
</tr>
105+
<tr>
106+
<td>MEMBER_FLAG_MAINTANK</td>
107+
<td>2</td>
108+
</tr>
109+
<tr>
110+
<td>MEMBER_FLAG_MAINASSIST</td>
111+
<td>4</td>
112+
</tr>
113+
</tbody>
114+
</table>
115+
</div>
100116

101117

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

‎Item/GetItemLink.html‎

Lines changed: 48 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -88,20 +88,54 @@ <h1 class='fqn'>
8888

8989
<div class='docblock'>
9090
<p>Returns the chat link of the <a class="mod" href="../Item/index.html">Item</a></p>
91-
<pre>
92-
enum LocaleConstant
93-
{
94-
LOCALE_enUS = 0,
95-
LOCALE_koKR = 1,
96-
LOCALE_frFR = 2,
97-
LOCALE_deDE = 3,
98-
LOCALE_zhCN = 4,
99-
LOCALE_zhTW = 5,
100-
LOCALE_esES = 6,
101-
LOCALE_esMX = 7,
102-
LOCALE_ruRU = 8
103-
};
104-
</pre>
91+
<div class="table-container">
92+
<table>
93+
<thead>
94+
<tr>
95+
<th>Locale</th>
96+
<th>ID</th>
97+
</tr>
98+
</thead>
99+
<tbody>
100+
<tr>
101+
<td>LOCALE_enUS</td>
102+
<td>0</td>
103+
</tr>
104+
<tr>
105+
<td>LOCALE_koKR</td>
106+
<td>1</td>
107+
</tr>
108+
<tr>
109+
<td>LOCALE_frFR</td>
110+
<td>2</td>
111+
</tr>
112+
<tr>
113+
<td>LOCALE_deDE</td>
114+
<td>3</td>
115+
</tr>
116+
<tr>
117+
<td>LOCALE_zhCN</td>
118+
<td>4</td>
119+
</tr>
120+
<tr>
121+
<td>LOCALE_zhTW</td>
122+
<td>5</td>
123+
</tr>
124+
<tr>
125+
<td>LOCALE_esES</td>
126+
<td>6</td>
127+
</tr>
128+
<tr>
129+
<td>LOCALE_esMX</td>
130+
<td>7</td>
131+
</tr>
132+
<tr>
133+
<td>LOCALE_ruRU</td>
134+
<td>8</td>
135+
</tr>
136+
</tbody>
137+
</table>
138+
</div>
105139

106140

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

0 commit comments

Comments
 (0)