Skip to content

Commit b5a93ea

Browse files
committed
Update Eluna documentation
1 parent 5b4331e commit b5a93ea

File tree

4 files changed

+14
-9
lines changed

4 files changed

+14
-9
lines changed

Player/IsGroupVisibleFor.html

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,29 +87,34 @@ <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 whether or not the <a class="mod" href="../Player/index.html">Player</a>s <a class="mod" href="../Group/index.html">Group</a> is visible for the other specific <a class="mod" href="../Player/index.html">Player</a>.</p>
9291

9392

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

101100
<h2 id="arguments" class='section-header'>
102101
<a href="#arguments">Arguments</a>
103102
</h2>
104103
<p>
105-
Unknown.
104+
<dl>
105+
<dt><code><strong><a class="mod" href="../Player/index.html">Player</a></strong> player</code></dt>
106+
<dd class="docblock"><em>See method description.</em></dd>
107+
</dl>
106108
</p>
107109

108110
<h2 id="returns" class='section-header'>
109111
<a href="#returns">Returns</a>
110112
</h2>
111113
<p>
112-
Unknown.
114+
<dl>
115+
<dt><code><strong><a href="http://www.lua.org/pil/2.2.html">boolean</a></strong> isGroupVisible</code></dt>
116+
<dd class="docblock"><em>See method description.</em></dd>
117+
</dl>
113118
</p>
114119
</div>
115120

Player/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1374,11 +1374,11 @@ <h2 id='methods' class='section-header'><a href="#methods">Methods</a></h2>
13741374
</tr>
13751375
<tr>
13761376
<td>
1377-
<a class='stability Experimental' title='Undocumented'></a>
1377+
<a class='stability Stable' title='Documented'></a>
13781378
<a class='fn' href='IsGroupVisibleFor.html'>IsGroupVisibleFor</a>
13791379
</td>
13801380
<td class='docblock short'>
1381-
<p></p>
1381+
<p>Returns whether or not the <a class="mod" href="../Player/index.html">Player</a>s <a class="mod" href="../Group/index.html">Group</a> is visible for the other specific <a class="mod" href="../Player/index.html">Player</a>.</p>
13821382
</td>
13831383
</tr>
13841384
<tr>

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ <h2 id='modules' class='section-header'><a href="#modules">Classes</a></h2>
234234
</tr>
235235
<tr>
236236
<td>
237-
<a class='stability Unstable' title='Partially Documented'></a>
237+
<a class='stability Stable' title='Fully Documented'></a>
238238
<a class='mod' href='Player/index.html'>Player</a>
239239
</td>
240240
<td class='docblock short'>

search-index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)