Skip to content

Commit

Permalink
newline stuff and trying styling on table
Browse files Browse the repository at this point in the history
  • Loading branch information
AutumnThyme committed Feb 6, 2025
1 parent fc0098e commit 3f090f8
Show file tree
Hide file tree
Showing 38 changed files with 560 additions and 259 deletions.
16 changes: 10 additions & 6 deletions Assets/Docs/objects/Character.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Character
Inherits from object
## Fields
|Field|Type|Readonly|Description|
|<div style="width:30%">Field</div>|<div style="width:10%">Type</div>|<div style="width:10%">Readonly</div>|<div style="width:50%">Description</div>|
|---|---|---|---|
|Name|[String](../static/String.md)|False|Character's name.|
|Guild|[String](../static/String.md)|False|Character's guild.|
Expand All @@ -28,17 +28,21 @@ Inherits from object
|CurrentAnimation|[String](../static/String.md)|False|Character's current playing animation.|
|Grounded|bool|False|Character's grounded status.|
## Methods
|Function|Returns|Description|
|<div style="width:33%">Function</div>|<div style="width:33%">Returns</div>|<div style="width:33%">Description</div>|
|---|---|---|
|GetKilled(killer : [String](../static/String.md))|none|Kills the character. Callable by non-owners.|
|GetDamaged(killer : [String](../static/String.md), damage : int)|none|Damages the character and kills it if its health reaches 0. Callable by non-owners.|
|GetDamaged(killer : [String](../static/String.md),
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), 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.|
|PlayAnimation(animation : [String](../static/String.md),
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), 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.|
|AddForce(force : [Vector3](../objects/Vector3.md),
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) = , 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|
|AddOutline(color : [Color](../objects/Color.md) = ,
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.|
9 changes: 6 additions & 3 deletions Assets/Docs/objects/Collider.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Collider
Inherits from object
## Fields
|Field|Type|Readonly|Description|
|<div style="width:30%">Field</div>|<div style="width:10%">Type</div>|<div style="width:10%">Readonly</div>|<div style="width:50%">Description</div>|
|---|---|---|---|
|AttachedArticulationBody|[Transform](../objects/Transform.md)|False||
|ContactOffset|float|False||
Expand All @@ -16,8 +16,11 @@ Inherits from object
|Transform|[Transform](../objects/Transform.md)|False||
|GameObjectTransform|[Transform](../objects/Transform.md)|False||
## Methods
|Function|Returns|Description|
|<div style="width:33%">Function</div>|<div style="width:33%">Returns</div>|<div style="width:33%">Description</div>|
|---|---|---|
|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), end : [Vector3](../objects/Vector3.md), maxDistance : float, collideWith : [String](../static/String.md))|[LineCastHitResult](../objects/LineCastHitResult.md)||
|Raycast(start : [Vector3](../objects/Vector3.md),
end : [Vector3](../objects/Vector3.md),
maxDistance : float,
collideWith : [String](../static/String.md))|[LineCastHitResult](../objects/LineCastHitResult.md)||
4 changes: 2 additions & 2 deletions Assets/Docs/objects/Collision.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Collision
Inherits from object
## Fields
|Field|Type|Readonly|Description|
|<div style="width:30%">Field</div>|<div style="width:10%">Type</div>|<div style="width:10%">Readonly</div>|<div style="width:50%">Description</div>|
|---|---|---|---|
|Collider|[Collider](../objects/Collider.md)|False||
|Impulse|[Vector3](../objects/Vector3.md)|False||
|RelativeVelocity|[Vector3](../objects/Vector3.md)|False||
## Methods
|Function|Returns|Description|
|<div style="width:33%">Function</div>|<div style="width:33%">Returns</div>|<div style="width:33%">Description</div>|
|---|---|---|
|GetContact(index : int)|none||
|GetContacts()|none||
14 changes: 9 additions & 5 deletions Assets/Docs/objects/Color.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# Color
Inherits from object
## Fields
|Field|Type|Readonly|Description|
|<div style="width:30%">Field</div>|<div style="width:10%">Type</div>|<div style="width:10%">Readonly</div>|<div style="width:50%">Description</div>|
|---|---|---|---|
|R|int|False|Red component of the color|
|G|int|False|Green component of the color|
|B|int|False|Blue component of the color|
|A|int|False|Alpha component of the color|
## Methods
|Function|Returns|Description|
|<div style="width:33%">Function</div>|<div style="width:33%">Returns</div>|<div style="width:33%">Description</div>|
|---|---|---|
|ToHexString()|[String](../static/String.md)|Converts the color to a hex string|
## Static Methods
|Function|Returns|Description|
|<div style="width:33%">Function</div>|<div style="width:33%">Returns</div>|<div style="width:33%">Description</div>|
|---|---|---|
|Lerp(a : [Color](../objects/Color.md), b : [Color](../objects/Color.md), t : float)|[Color](../objects/Color.md)|Linearly interpolates between colors a and b by t|
|Gradient(a : [Color](../objects/Color.md), b : [Color](../objects/Color.md), t : float)|[Color](../objects/Color.md)|Creates a gradient color from two colors|
|Lerp(a : [Color](../objects/Color.md),
b : [Color](../objects/Color.md),
t : float)|[Color](../objects/Color.md)|Linearly interpolates between colors a and b by t|
|Gradient(a : [Color](../objects/Color.md),
b : [Color](../objects/Color.md),
t : float)|[Color](../objects/Color.md)|Creates a gradient color from two colors|
10 changes: 6 additions & 4 deletions Assets/Docs/objects/Dict.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,18 @@ Inherits from object
example = Dict()
```
## Fields
|Field|Type|Readonly|Description|
|<div style="width:30%">Field</div>|<div style="width:10%">Type</div>|<div style="width:10%">Readonly</div>|<div style="width:50%">Description</div>|
|---|---|---|---|
|Count|int|False|Number of elements in the dictionary|
|Keys|[List](../objects/List.md)|False|Keys in the dictionary|
|Values|[List](../objects/List.md)|False|Values in the dictionary|
## Methods
|Function|Returns|Description|
|<div style="width:33%">Function</div>|<div style="width:33%">Returns</div>|<div style="width:33%">Description</div>|
|---|---|---|
|Clear()|none|Clears the dictionary|
|Get(key : Object, defaultValue : Object = )|Object|Gets a value from the dictionary|
|Set(key : Object, value : Object)|none|Sets a value in the dictionary|
|Get(key : Object,
defaultValue : Object = )|Object|Gets a value from the dictionary|
|Set(key : Object,
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|
24 changes: 16 additions & 8 deletions Assets/Docs/objects/Human.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Human
Inherits from [Character](../objects/Character.md)
## Fields
|Field|Type|Readonly|Description|
|<div style="width:30%">Field</div>|<div style="width:10%">Type</div>|<div style="width:10%">Readonly</div>|<div style="width:50%">Description</div>|
|---|---|---|---|
|Name|[String](../static/String.md)|False|The human's name|
|Guild|[String](../static/String.md)|False|The human's guild|
Expand Down Expand Up @@ -57,29 +57,37 @@ Inherits from [Character](../objects/Character.md)
|CurrentAnimation|[String](../static/String.md)|False|Character's current playing animation.|
|Grounded|bool|False|Character's grounded status.|
## Methods
|Function|Returns|Description|
|<div style="width:33%">Function</div>|<div style="width:33%">Returns</div>|<div style="width:33%">Description</div>|
|---|---|---|
|Refill()|bool|Refills the gas of the human|
|RefillImmediate()|none|Refills the gas of the human immediately|
|ClearHooks()|none|Clears all hooks|
|ClearLeftHook()|none|Clears the left hook|
|ClearRightHook()|none|Clears the right hook|
|MountMapObject(mapObject : [MapObject](../objects/MapObject.md), positionOffset : [Vector3](../objects/Vector3.md), rotationOffset : [Vector3](../objects/Vector3.md))|none|Mounts the human on a map object|
|MountTransform(transform : [Transform](../objects/Transform.md), positionOffset : [Vector3](../objects/Vector3.md), rotationOffset : [Vector3](../objects/Vector3.md))|none|Mounts the human on a transform|
|MountMapObject(mapObject : [MapObject](../objects/MapObject.md),
positionOffset : [Vector3](../objects/Vector3.md),
rotationOffset : [Vector3](../objects/Vector3.md))|none|Mounts the human on a map object|
|MountTransform(transform : [Transform](../objects/Transform.md),
positionOffset : [Vector3](../objects/Vector3.md),
rotationOffset : [Vector3](../objects/Vector3.md))|none|Mounts the human on a transform|
|Unmount()|none|Unmounts the human|
|SetSpecial(special : [String](../static/String.md))|none|Sets the special of the human|
|ActivateSpecial()|none|Activates the special of the human|
|SetWeapon(weapon : [String](../static/String.md))|none|Sets the weapon of the human|
|DisablePerks()|none|Disables all perks of the human|
|GetKilled(killer : [String](../static/String.md))|none|Kills the character. Callable by non-owners.|
|GetDamaged(killer : [String](../static/String.md), damage : int)|none|Damages the character and kills it if its health reaches 0. Callable by non-owners.|
|GetDamaged(killer : [String](../static/String.md),
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), 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.|
|PlayAnimation(animation : [String](../static/String.md),
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), 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.|
|AddForce(force : [Vector3](../objects/Vector3.md),
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) = , 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|
|AddOutline(color : [Color](../objects/Color.md) = ,
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.|
2 changes: 1 addition & 1 deletion Assets/Docs/objects/LineCastHitResult.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# LineCastHitResult
Inherits from object
## Fields
|Field|Type|Readonly|Description|
|<div style="width:30%">Field</div>|<div style="width:10%">Type</div>|<div style="width:10%">Readonly</div>|<div style="width:50%">Description</div>|
|---|---|---|---|
|IsCharacter|bool|True|true if the linecast hit a character|
|IsMapObject|bool|True|true if the linecast hit a map object|
Expand Down
9 changes: 5 additions & 4 deletions Assets/Docs/objects/LineRenderer.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# LineRenderer
Inherits from object
## Fields
|Field|Type|Readonly|Description|
|<div style="width:30%">Field</div>|<div style="width:10%">Type</div>|<div style="width:10%">Readonly</div>|<div style="width:50%">Description</div>|
|---|---|---|---|
|StartWidth|float|False|The width of the line at the start|
|EndWidth|float|False|The width of the line at the end|
Expand All @@ -22,11 +22,12 @@ Inherits from object
|WidthMultiplier|float|False|The width multiplier of the line renderer|
|ColorGradientMode|[String](../static/String.md)|False|The color gradient mode of the line renderer|
## Methods
|Function|Returns|Description|
|<div style="width:33%">Function</div>|<div style="width:33%">Returns</div>|<div style="width:33%">Description</div>|
|---|---|---|
|GetPosition(index : int)|[Vector3](../objects/Vector3.md)|Get the position of a point in the line renderer|
|SetPosition(index : int, position : [Vector3](../objects/Vector3.md))|none|Set the position of a point in the line renderer|
|SetPosition(index : int,
position : [Vector3](../objects/Vector3.md))|none|Set the position of a point in the line renderer|
## Static Methods
|Function|Returns|Description|
|<div style="width:33%">Function</div>|<div style="width:33%">Returns</div>|<div style="width:33%">Description</div>|
|---|---|---|
|CreateLineRenderer()|[LineRenderer](../objects/LineRenderer.md)|[Obselete] Create a new LineRenderer|
13 changes: 8 additions & 5 deletions Assets/Docs/objects/List.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,27 @@ example = List()
example = List((CustomLogicSetBuiltin))
```
## Fields
|Field|Type|Readonly|Description|
|<div style="width:30%">Field</div>|<div style="width:10%">Type</div>|<div style="width:10%">Readonly</div>|<div style="width:50%">Description</div>|
|---|---|---|---|
|Count|int|True|The number of elements in the list|
## Methods
|Function|Returns|Description|
|<div style="width:33%">Function</div>|<div style="width:33%">Returns</div>|<div style="width:33%">Description</div>|
|---|---|---|
|Clear()|none|Clear all list elements|
|Get(index : int)|Object|Get the element at the specified index|
|Set(index : int, value : Object)|none|Set the element at the specified index|
|Set(index : int,
value : Object)|none|Set the element at the specified index|
|Add(value : Object)|none|Add an element to the end of the list|
|InsertAt(index : int, value : Object)|none|Insert an element at the specified index|
|InsertAt(index : int,
value : Object)|none|Insert an element at the specified index|
|RemoveAt(index : int)|none|Remove the element at the specified index|
|Remove(value : Object)|none|Remove the first occurrence of the specified element|
|Contains(value : Object)|bool|Check if the list contains the specified element|
|Sort()|none|Sort the list|
|SortCustom(method : UserMethod)|none|Sort the list using a custom method, expects a method with the signature int method(a,b)|
|Filter(method : UserMethod)|[List](../objects/List.md)|Filter the list using a custom method, expects a method with the signature bool method(element)|
|Map(method : UserMethod)|[List](../objects/List.md)|Map the list using a custom method, expects a method with the signature object method(element)|
|Reduce(method : UserMethod, initialValue : Object)|Object|Reduce the list using a custom method, expects a method with the signature object method(acc, element)|
|Reduce(method : UserMethod,
initialValue : Object)|Object|Reduce the list using a custom method, expects a method with the signature object method(acc, element)|
|Randomize()|none|Randomize the list|
|ToSet()|[Set](../objects/Set.md)|Convert the list to a set|
Loading

0 comments on commit 3f090f8

Please sign in to comment.