Skip to content

Commit dfff69e

Browse files
committed
Added api layouts
1 parent 2d5ed8c commit dfff69e

File tree

8 files changed

+1060
-5
lines changed

8 files changed

+1060
-5
lines changed

docs/_api/index.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
title: ClassNameHere
3+
permalink: /api/classnamehere/
4+
---
5+
6+
<div style="line-height: 1;">
7+
<h2 markdown="1">ClassNameHere ``class``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.SomeNamespace</p>
9+
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
10+
</div>
11+
<p>This class can do things, it has methods that can execute stuff</p>
12+
<div>
13+
<h3 markdown="1">Public Properties</h3>
14+
<div style="line-height: 1;">
15+
<h4 markdown="1"><b>public ``bool`` isLocalPlayer { get; }</b></h4>
16+
<p>Gets if the object is the the personal clients player object</p>
17+
</div>
18+
<div style="line-height: 1;">
19+
<h4 markdown="1"><b>public ``bool`` isOwner { get; }</b></h4>
20+
<p>Gets if the object is owned by the local player or if the object is the local player object</p>
21+
</div>
22+
</div>
23+
<br>
24+
<div>
25+
<h3 markdown="1">Inherited Properties</h3>
26+
<div style="line-height: 1;">
27+
<h4 markdown="1"><b>public ``bool`` isLocalPlayer { get; }</b></h4>
28+
<p>Gets if the object is the the personal clients player object</p>
29+
</div>
30+
<div style="line-height: 1;">
31+
<h4 markdown="1"><b>public ``bool`` isOwner { get; }</b></h4>
32+
<h5 markdown="1">Inherited from: ``MonoBehaviour``</h5>
33+
<p>Gets if the object is owned by the local player or if the object is the local player object</p>
34+
</div>
35+
</div>
36+
<div>
37+
<h3 markdown="1">Public Methods</h3>
38+
<div style="line-height: 1;">
39+
<h4 markdown="1"><b>public ``float`` ReadRangedSingle(``float`` minValue, ``float`` maxValue, ``int`` bytes);</b></h4>
40+
<p>Read a single-precision floating point value from the stream. The value is between (inclusive) the minValue and maxValue.</p>
41+
<h5><b>Parameters</b></h5>
42+
<div>
43+
<p style="font-size: 20px; color: #444;" markdown="1">``float`` minValue</p>
44+
<p>Minimum value that this value could be</p>
45+
</div>
46+
<div>
47+
<p style="font-size: 20px; color: #444;" markdown="1">``float`` maxValue</p>
48+
<p>Maximum possible value that this could be</p>
49+
</div>
50+
<h5 markdown="1"><b>Returns ``float``</b></h5>
51+
<div>
52+
<p>The read value</p>
53+
</div>
54+
</div>
55+
<br>
56+
<div style="line-height: 1;">
57+
<h4 markdown="1"><b>public ``float`` ReadRangedSingle(``float`` minValue, ``float`` maxValue, ``int`` bytes);</b></h4>
58+
<p>Read a single-precision floating point value from the stream. The value is between (inclusive) the minValue and maxValue.</p>
59+
<h5><b>Parameters</b></h5>
60+
<div>
61+
<p style="font-size: 20px; color: #444;" markdown="1">``float`` minValue</p>
62+
<p>Minimum value that this value could be</p>
63+
</div>
64+
<div>
65+
<p style="font-size: 20px; color: #444;" markdown="1">``float`` maxValue</p>
66+
<p>Maximum possible value that this could be</p>
67+
</div>
68+
<h5 markdown="1"><b>Returns ``float``</b></h5>
69+
<div>
70+
<p>The read value</p>
71+
</div>
72+
</div>
73+
</div>

0 commit comments

Comments
 (0)