Skip to content

Add missing value information for most enums #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HarryBlueJay wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add missing value information for most enums #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a248ef0
Add missing value information for most enums
HarryBlueJay Feb 19, 2026
820022e
Add documentation for CameraMode.FollowTarget
HarryBlueJay Feb 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/objects/enums/CameraMode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ icon: polytoria/Enum

# CameraMode

| Name | Description |
| ------------------------- | ----------------------------------------------- |
| `CameraMode.Scripted` | Camera is able to be controlled by scripts |
| `CameraMode.FollowPlayer` | Camera is controlled by the player `(default)` |
| `CameraMode.FreeCam` | Camera is able to be freely moved by the player |
| Name | Value | Description |
| ------------------------- | ----- | --------------------------------------------------- |
| `CameraMode.FollowPlayer` | 0 | Camera is controlled by the player `(default)` |
| `CameraMode.FollowTarget` | 1 | Camera's position follows the `Camera.FollowTarget` |
| `CameraMode.Free` | 2 | Camera is able to be freely moved by the player |
| `CameraMode.Scripted` | 3 | Camera is able to be controlled by scripts |
10 changes: 5 additions & 5 deletions docs/objects/enums/CollisionType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ description: CollisionType is an Enum.
icon: polytoria/Enum
---

| Name |
| -------- |
| `Bounds` |
| `Convex` |
| `Exact` |
| Name | Value |
| -------- | ----- |
| `Bounds` | 0 |
| `Convex` | 1 |
| `Exact` | 2 |
13 changes: 8 additions & 5 deletions docs/objects/enums/HorizontalAlignment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@ icon: polytoria/Enum

!!! note "This is undocumented on the original documentation - this is interpreted from references on the original documentation"

| Name | Description |
| ---------------------------- | --------------------------------- |
| `HorizontalAlignment.Left` | Aligned to the left |
| `HorizontalAlignment.Middle` | Aligned to the middle `(default)` |
| `HorizontalAlignment.Right` | Aligned to the right |
| Name | Value | Description |
| ------------------------------- | ----- | --------------------------------- |
| `HorizontalAlignment.Left` | 0 | Aligned to the left |
| `HorizontalAlignment.Middle` | 1 | Aligned to the middle `(default)` |
| `HorizontalAlignment.Right` | 2 | Aligned to the right |
| `HorizontalAlignment.Justified` | 3 | Text is justified |
| `HorizontalAlignment.Flush` | 4 | Text is flush aligned |
| `HorizontalAlignment.Geometry` | 5 | Aligned to the geometry |
15 changes: 8 additions & 7 deletions docs/objects/enums/ImageType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ description: ImageType is an Enum.
icon: polytoria/Enum
---

| Name |
| -------------------- |
| `Asset` |
| `AssetThumbnail` |
| `PlaceThumbnail` |
| `UserAvatarHeadshot` |
| `GuildIcon` |
| Name | Value |
| -------------------- | ----- |
| `Asset` | 0 |
| `AssetThumbnail` | 1 |
| `PlaceThumbnail` | 2 |
| `UserAvatar` | 3 |
| `UserAvatarHeadshot` | 4 |
| `GuildIcon` | 5 |
16 changes: 8 additions & 8 deletions docs/objects/enums/ParticleColorMode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ description: ParticleColorMode is an Enum.
icon: polytoria/Enum
---

| Name |
| ------------- |
| `Multiply` |
| `Additive` |
| `Subtractive` |
| `Overlay` |
| `Color` |
| `Difference` |
| Name | Value |
| ------------- | ----- |
| `Multiply` | 0 |
| `Additive` | 1 |
| `Subtractive` | 2 |
| `Overlay` | 3 |
| `Color` | 4 |
| `Difference` | 5 |
18 changes: 9 additions & 9 deletions docs/objects/enums/ParticleShape.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ description: ParticleShape is an Enum.
icon: polytoria/Enum
---

| Name |
| ------------ |
| `Sphere` |
| `Hemisphere` |
| `Cone` |
| `Box` |
| `Donut` |
| `Circle` |
| `Rectangle` |
| Name | Value |
| ------------ | ----- |
| `Sphere` | 0 |
| `Hemisphere` | 1 |
| `Cone` | 2 |
| `Box` | 3 |
| `Donut` | 4 |
| `Circle` | 5 |
| `Rectangle` | 6 |
8 changes: 4 additions & 4 deletions docs/objects/enums/ParticleSimulationSpace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: ParticleSimulationSpace is an Enum.
icon: polytoria/Enum
---

| Name |
| ------- |
| `Local` |
| `World` |
| Name | Value |
| ------- | ----- |
| `Local` | 0 |
| `World` | 1 |
28 changes: 14 additions & 14 deletions docs/objects/enums/TextFontPreset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ icon: polytoria/Enum

# TextFontPreset

| Name |
| --------------------------------------------------------------------- |
| <p style="font-family: 'Source Sans Pro', sans-serif">SourceSans</p> |
| <p style="font-family: 'Press Start 2P', sans-serif">PressStart2P</p> |
| <p style="font-family: 'Montserrat', sans-serif">Montserrat</p> |
| <p style="font-family: 'Roboto Mono', sans-serif">RobotoMono</p> |
| <p style="font-family: 'Rubik', sans-serif">Rubik</p> |
| <p style="font-family: 'Poppins', sans-serif">Poppins</p> |
| <p style="font-family: 'Domine', sans-serif">Domine</p> |
| <p style="font-family: 'Fredoka', sans-serif">Fredoka</p> |
| <p style="font-family: 'Comic Neue', sans-serif">ComicNeue</p> |
| <p style="font-family: 'Orbitron', sans-serif">Orbitron</p> |
| <p style="font-family: 'Papyrus', sans-serif">Papyrus</p> |
| <p style="font-family: 'Comic Sans MS', sans-serif">ComicSansMS</p> |
| Name | Value |
| --------------------------------------------------------------------- | ----- |
| <p style="font-family: 'Source Sans Pro', sans-serif">SourceSans</p> | 0 |
| <p style="font-family: 'Press Start 2P', sans-serif">PressStart2P</p> | 1 |
| <p style="font-family: 'Montserrat', sans-serif">Montserrat</p> | 2 |
| <p style="font-family: 'Roboto Mono', sans-serif">RobotoMono</p> | 3 |
| <p style="font-family: 'Rubik', sans-serif">Rubik</p> | 4 |
| <p style="font-family: 'Poppins', sans-serif">Poppins</p> | 5 |
| <p style="font-family: 'Domine', sans-serif">Domine</p> | 6 |
| <p style="font-family: 'Fredoka', sans-serif">Fredoka</p> | 7 |
| <p style="font-family: 'Comic Neue', sans-serif">ComicNeue</p> | 8 |
| <p style="font-family: 'Orbitron', sans-serif">Orbitron</p> | 9 |
| <p style="font-family: 'Papyrus', sans-serif">Papyrus</p> | 10 |
| <p style="font-family: 'Comic Sans MS', sans-serif">ComicSansMS</p> | 11 |
14 changes: 7 additions & 7 deletions docs/objects/enums/TextJustify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ icon: polytoria/Enum

# TextJustify

| Name |
| --------------------- |
| `TextJustify.Left` |
| `TextJustify.Center` |
| `TextJustify.Right` |
| `TextJustify.Justify` |
| `TextJustify.Flush` |
| Name | Value |
| --------------------- | ----- |
| `TextJustify.Left` | 0 |
| `TextJustify.Center` | 1 |
| `TextJustify.Right` | 2 |
| `TextJustify.Justify` | 3 |
| `TextJustify.Flush` | 4 |
10 changes: 5 additions & 5 deletions docs/objects/enums/TextVerticalAlign.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ icon: polytoria/Enum

# TextVerticalAlign

| Name |
| -------------------------- |
| `TextVerticalAlign.Top` |
| `TextVerticalAlign.Middle` |
| `TextVerticalAlign.Bottom` |
| Name | Value |
| -------------------------- | ----- |
| `TextVerticalAlign.Top` | 0 |
| `TextVerticalAlign.Middle` | 1 |
| `TextVerticalAlign.Bottom` | 2 |
14 changes: 9 additions & 5 deletions docs/objects/enums/VerticalAlignment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,12 @@ icon: polytoria/Enum

!!! note "This is undocumented on the original documentation - this is interpreted from references on the original documentation"

| Name | Description |
| -------------------------- | --------------------- |
| `VerticalAlignment.Top` | Aligned to the top |
| `VerticalAlignment.Middle` | Aligned to the middle |
| `VerticalAlignment.Bottom` | Aligned to the bottom |

| Name | Value | Description |
| ---------------------------- | ----- | ----------------------- |
| `VerticalAlignment.Top` | 0 | Aligned to the top |
| `VerticalAlignment.Middle` | 1 | Aligned to the middle |
| `VerticalAlignment.Bottom` | 2 | Aligned to the bottom |
| `VerticalAlignment.Baseline` | 3 | Aligned to the baseline |
| `VerticalAlignment.Geometry` | 4 | Aligned to the geometry |
| `VerticalAlignment.Capline` | 5 | Aligned to the capline |
18 changes: 14 additions & 4 deletions docs/objects/game/Camera.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,16 @@ weight: 4

## Properties

### FollowTarget:DynamicInstance { property }

Determines the position of the camera when the camera is in `FollowTarget` mode.

**Example**

```lua
Camera.FollowTarget = game["Environment"]["Brick"]
```

### Distance:float { property }

Determines the distance between the camera and the player when the camera is in `FollowPlayer` mode.
Expand All @@ -41,7 +51,7 @@ Camera.FOV = 90

### FastFlySpeed:float { property }

Determines the camera speed when the camera is in `FreeCam` mode while holding shift.
Determines the camera speed when the camera is in `Free` mode while holding shift.

**Example**

Expand All @@ -51,7 +61,7 @@ Camera.FastFlySpeed = 100

### FlySpeed:float { property }

Determines the camera speed when the camera is in `FreeCam` mode.
Determines the camera speed when the camera is in `Free` mode.

**Example**

Expand All @@ -71,7 +81,7 @@ Camera.FollowLerp = true

### FreeLookSensitivity:float { property }

Determines the mouse sensitivity while in `FreeCam` mode.
Determines the mouse sensitivity while in `Free` mode.

**Example**

Expand Down Expand Up @@ -133,7 +143,7 @@ Camera.MinDistance = 5

### Mode:CameraMode { property }

Determines or returns the camera's current mode `(Scripted, FollowPlayer, Freecam)`.
Determines or returns the camera's current mode `(Scripted, FollowPlayer, FollowTarget, Free)`.

**Example**

Expand Down