Skip to content

Commit

Permalink
html tables
Browse files Browse the repository at this point in the history
  • Loading branch information
@AutumnThyme
AutumnThyme committed Feb 7, 2025
1 parent eed7174 commit d09c725
Show file tree
Hide file tree
Showing 74 changed files with 2,791 additions and 788 deletions.
89 changes: 75 additions & 14 deletions Assets/Docs/objects/Character.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,78 @@ Inherits from object
|CurrentAnimation|[String](../static/String.md)|False|Character's current playing animation.|
|Grounded|bool|False|Character's grounded status.|
## Methods
|Function|Parameters|Returns|Description|
|---|---|---|---|
|GetKilled|killer : [String](../static/String.md)|none|Kills the character. Callable by non-owners.|
|GetDamaged|killer : [String](../static/String.md)<br/>damage : int|none|Damages the character and kills it if its health reaches 0. Callable by non-owners.|
|Emote|emote : [String](../static/String.md)|none|Causes the character to emote. The list of available emotes is the same as those shown in the in-game emote menu.|
|PlayAnimation|animation : [String](../static/String.md)<br/>fade : float = 0.1|none|Causes the character to play an animation. If the fade parameter is provided, will crossfade the animation by this timestep. Available animations can be found here: Human, Titan, Annie, Eren. Use the right-hand string value for the animation.|
|GetAnimationLength|animation : [String](../static/String.md)|float|Gets the length of animation.|
|PlaySound|sound : [String](../static/String.md)|none|Plays a sound if present in the character. Available sound names can be found here: Humans, Shifters, Titans. Note that shifters also have all titan sounds.|
|StopSound|sound : [String](../static/String.md)|none|Stops the sound.|
|LookAt|position : [Vector3](../objects/Vector3.md)|none|Rotates the character such that it is looking towards a world position.|
|AddForce|force : [Vector3](../objects/Vector3.md)<br/>mode : [String](../static/String.md) = Acceleration|none|Adds a force to the character with given force vector and optional mode. Valid modes are Force, Acceleration, Impulse, VelocityChange with default being Acceleration.|
|Reveal|delay : float|none|Reveaal the titan for a set number of seconds.|
|AddOutline|color : [Color](../objects/Color.md) = <br/>mode : [String](../static/String.md) = OutlineAll|none|Adds an outline effect with the given color and mode. Valid modes are: OutlineAll, OutlineVisible, OutlineHidden, OutlineAndSilhouette, SilhouetteOnly, OutlineAndLightenColor|
|RemoveOutline||none|Removes the outline effect from the character.|
<table>
<colgroup><col style="width: 30%"/>
<col style="width: 20%"/>
<col style="width: 50%"/>
</colgroup>
<thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>GetKilled(killer : [String](../static/String.md))</td>
<td>none</td>
<td>Kills the character. Callable by non-owners.</td>
</tr>
<tr>
<td>GetDamaged(killer : [String](../static/String.md),damage : int)</td>
<td>none</td>
<td>Damages the character and kills it if its health reaches 0. Callable by non-owners.</td>
</tr>
<tr>
<td>Emote(emote : [String](../static/String.md))</td>
<td>none</td>
<td>Causes the character to emote. The list of available emotes is the same as those shown in the in-game emote menu.</td>
</tr>
<tr>
<td>PlayAnimation(animation : [String](../static/String.md),fade : float = 0.1)</td>
<td>none</td>
<td>Causes the character to play an animation. If the fade parameter is provided, will crossfade the animation by this timestep. Available animations can be found here: Human, Titan, Annie, Eren. Use the right-hand string value for the animation.</td>
</tr>
<tr>
<td>GetAnimationLength(animation : [String](../static/String.md))</td>
<td>float</td>
<td>Gets the length of animation.</td>
</tr>
<tr>
<td>PlaySound(sound : [String](../static/String.md))</td>
<td>none</td>
<td>Plays a sound if present in the character. Available sound names can be found here: Humans, Shifters, Titans. Note that shifters also have all titan sounds.</td>
</tr>
<tr>
<td>StopSound(sound : [String](../static/String.md))</td>
<td>none</td>
<td>Stops the sound.</td>
</tr>
<tr>
<td>LookAt(position : [Vector3](../objects/Vector3.md))</td>
<td>none</td>
<td>Rotates the character such that it is looking towards a world position.</td>
</tr>
<tr>
<td>AddForce(force : [Vector3](../objects/Vector3.md),mode : [String](../static/String.md) = Acceleration)</td>
<td>none</td>
<td>Adds a force to the character with given force vector and optional mode. Valid modes are Force, Acceleration, Impulse, VelocityChange with default being Acceleration.</td>
</tr>
<tr>
<td>Reveal(delay : float)</td>
<td>none</td>
<td>Reveaal the titan for a set number of seconds.</td>
</tr>
<tr>
<td>AddOutline(color : [Color](../objects/Color.md) = ,mode : [String](../static/String.md) = OutlineAll)</td>
<td>none</td>
<td>Adds an outline effect with the given color and mode. Valid modes are: OutlineAll, OutlineVisible, OutlineHidden, OutlineAndSilhouette, SilhouetteOnly, OutlineAndLightenColor</td>
</tr>
<tr>
<td>RemoveOutline()</td>
<td>none</td>
<td>Removes the outline effect from the character.</td>
</tr>
</tbody>
</table>
7 changes: 0 additions & 7 deletions Assets/Docs/objects/Character.md.meta
View file

This file was deleted.

35 changes: 30 additions & 5 deletions Assets/Docs/objects/Collider.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,33 @@ Inherits from object
|Transform|[Transform](../objects/Transform.md)|False||
|GameObjectTransform|[Transform](../objects/Transform.md)|False||
## Methods
|Function|Parameters|Returns|Description|
|---|---|---|---|
|ClosestPoint|position : [Vector3](../objects/Vector3.md)|[Vector3](../objects/Vector3.md)||
|ClosestPointOnBounds|position : [Vector3](../objects/Vector3.md)|[Vector3](../objects/Vector3.md)||
|Raycast|start : [Vector3](../objects/Vector3.md)<br/>end : [Vector3](../objects/Vector3.md)<br/>maxDistance : float<br/>collideWith : [String](../static/String.md)|[LineCastHitResult](../objects/LineCastHitResult.md)||
<table>
<colgroup><col style="width: 30%"/>
<col style="width: 20%"/>
<col style="width: 50%"/>
</colgroup>
<thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>ClosestPoint(position : [Vector3](../objects/Vector3.md))</td>
<td>[Vector3](../objects/Vector3.md)</td>
<td></td>
</tr>
<tr>
<td>ClosestPointOnBounds(position : [Vector3](../objects/Vector3.md))</td>
<td>[Vector3](../objects/Vector3.md)</td>
<td></td>
</tr>
<tr>
<td>Raycast(start : [Vector3](../objects/Vector3.md),end : [Vector3](../objects/Vector3.md),maxDistance : float,collideWith : [String](../static/String.md))</td>
<td>[LineCastHitResult](../objects/LineCastHitResult.md)</td>
<td></td>
</tr>
</tbody>
</table>
7 changes: 0 additions & 7 deletions Assets/Docs/objects/Collider.md.meta
View file

This file was deleted.

29 changes: 25 additions & 4 deletions Assets/Docs/objects/Collision.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,28 @@ Inherits from object
|Impulse|[Vector3](../objects/Vector3.md)|False||
|RelativeVelocity|[Vector3](../objects/Vector3.md)|False||
## Methods
|Function|Parameters|Returns|Description|
|---|---|---|---|
|GetContact|index : int|none||
|GetContacts||none||
<table>
<colgroup><col style="width: 30%"/>
<col style="width: 20%"/>
<col style="width: 50%"/>
</colgroup>
<thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>GetContact(index : int)</td>
<td>none</td>
<td></td>
</tr>
<tr>
<td>GetContacts()</td>
<td>none</td>
<td></td>
</tr>
</tbody>
</table>
7 changes: 0 additions & 7 deletions Assets/Docs/objects/Collision.md.meta
View file

This file was deleted.

52 changes: 45 additions & 7 deletions Assets/Docs/objects/Color.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,49 @@ Inherits from object
|B|int|False|Blue component of the color|
|A|int|False|Alpha component of the color|
## Methods
|Function|Parameters|Returns|Description|
|---|---|---|---|
|ToHexString||[String](../static/String.md)|Converts the color to a hex string|
<table>
<colgroup><col style="width: 30%"/>
<col style="width: 20%"/>
<col style="width: 50%"/>
</colgroup>
<thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>ToHexString()</td>
<td>[String](../static/String.md)</td>
<td>Converts the color to a hex string</td>
</tr>
</tbody>
</table>
## Static Methods
|Function|Parameters|Returns|Description|
|---|---|---|---|
|Lerp|a : [Color](../objects/Color.md)<br/>b : [Color](../objects/Color.md)<br/>t : float|[Color](../objects/Color.md)|Linearly interpolates between colors a and b by t|
|Gradient|a : [Color](../objects/Color.md)<br/>b : [Color](../objects/Color.md)<br/>t : float|[Color](../objects/Color.md)|Creates a gradient color from two colors|
<table>
<colgroup><col style="width: 30%"/>
<col style="width: 20%"/>
<col style="width: 50%"/>
</colgroup>
<thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Lerp(a : [Color](../objects/Color.md),b : [Color](../objects/Color.md),t : float)</td>
<td>[Color](../objects/Color.md)</td>
<td>Linearly interpolates between colors a and b by t</td>
</tr>
<tr>
<td>Gradient(a : [Color](../objects/Color.md),b : [Color](../objects/Color.md),t : float)</td>
<td>[Color](../objects/Color.md)</td>
<td>Creates a gradient color from two colors</td>
</tr>
</tbody>
</table>
7 changes: 0 additions & 7 deletions Assets/Docs/objects/Color.md.meta
View file

This file was deleted.

47 changes: 40 additions & 7 deletions Assets/Docs/objects/Dict.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,43 @@ example = Dict()
|Keys|[List](../objects/List.md)|False|Keys in the dictionary|
|Values|[List](../objects/List.md)|False|Values in the dictionary|
## Methods
|Function|Parameters|Returns|Description|
|---|---|---|---|
|Clear||none|Clears the dictionary|
|Get|key : Object<br/>defaultValue : Object = |Object|Gets a value from the dictionary|
|Set|key : Object<br/>value : Object|none|Sets a value in the dictionary|
|Remove|key : Object|none|Removes a value from the dictionary|
|Contains|key : Object|bool|Checks if the dictionary contains a key|
<table>
<colgroup><col style="width: 30%"/>
<col style="width: 20%"/>
<col style="width: 50%"/>
</colgroup>
<thead>
<tr>
<th>Function</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Clear()</td>
<td>none</td>
<td>Clears the dictionary</td>
</tr>
<tr>
<td>Get(key : Object,defaultValue : Object = )</td>
<td>Object</td>
<td>Gets a value from the dictionary</td>
</tr>
<tr>
<td>Set(key : Object,value : Object)</td>
<td>none</td>
<td>Sets a value in the dictionary</td>
</tr>
<tr>
<td>Remove(key : Object)</td>
<td>none</td>
<td>Removes a value from the dictionary</td>
</tr>
<tr>
<td>Contains(key : Object)</td>
<td>bool</td>
<td>Checks if the dictionary contains a key</td>
</tr>
</tbody>
</table>
7 changes: 0 additions & 7 deletions Assets/Docs/objects/Dict.md.meta
View file

This file was deleted.

Loading

0 comments on commit d09c725

Please sign in to comment.