From 8b2349fb8120afe8b47c8d0d88f9e52702a9d9ca Mon Sep 17 00:00:00 2001 From: thepotato Date: Thu, 7 May 2026 22:29:25 +0330 Subject: [PATCH 1/3] Improve /yaml/types docs --- yaml/types/NPC.yaml | 8 +++--- yaml/types/NetworkEvent.yaml | 4 +-- yaml/types/NetworkedObject.yaml | 2 +- yaml/types/NewServerRequestData.yaml | 2 +- yaml/types/PTSignal.yaml | 12 ++++---- yaml/types/Particles.yaml | 16 +++++------ yaml/types/Physical.yaml | 18 ++++++------ yaml/types/Player.yaml | 16 +++++------ yaml/types/PlayerDefaults.yaml | 13 ++++----- yaml/types/Players.yaml | 9 +++--- yaml/types/PointLight.yaml | 5 ++-- yaml/types/PolytorianModel.yaml | 42 +++++++++++++--------------- yaml/types/PreferencesService.yaml | 7 ++--- yaml/types/PresenceService.yaml | 12 ++++---- yaml/types/PurchasesService.yaml | 7 ++--- yaml/types/Quaternion.yaml | 14 ++++------ yaml/types/Script.yaml | 11 +++----- yaml/types/ScriptSharedTable.yaml | 13 ++++----- yaml/types/Seat.yaml | 4 +-- yaml/types/Sound.yaml | 14 ++++------ yaml/types/Stat.yaml | 19 ++++++------- yaml/types/Stats.yaml | 4 +-- 22 files changed, 115 insertions(+), 137 deletions(-) diff --git a/yaml/types/NPC.yaml b/yaml/types/NPC.yaml index b503234f..09482574 100644 --- a/yaml/types/NPC.yaml +++ b/yaml/types/NPC.yaml @@ -130,14 +130,14 @@ Properties: IsReadOnly: true IsObsolete: false IsStatic: false - Description: Indicates if NPC is standing on ground. + Description: Indicates if the NPC is standing on the ground. - Name: IsOnCeiling Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false IsStatic: false - Description: Indicates if NPC is on the ceiling. + Description: Indicates if the NPC is on the ceiling. - Name: NavDestinationDistance Type: number IsAccessibleByScripts: true @@ -170,7 +170,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Move this NPC while respecting collisions. + Description: Moves this NPC while respecting collisions. - Name: Kill ReturnType: nil Parameters: [] @@ -184,7 +184,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Try to detect stairs and step up. Returns true if the NPC has stepped up. + Description: Tries to detect stairs and step up. Returns true if the NPC has stepped up. - Name: Jump ReturnType: nil Parameters: [] diff --git a/yaml/types/NetworkEvent.yaml b/yaml/types/NetworkEvent.yaml index 4fc5846c..1060c3b7 100644 --- a/yaml/types/NetworkEvent.yaml +++ b/yaml/types/NetworkEvent.yaml @@ -1,6 +1,6 @@ Name: NetworkEvent Description: NetworkEvents are events that can be called to communicate between - server and client. NetMessages are the class used for sharing data between + server and client. NetMessages are the classes used for sharing data between server and client when sending NetworkEvents. Category: networking BaseType: Instance @@ -12,7 +12,7 @@ Properties: IsObsolete: false IsStatic: false Description: Determines if this network event should send messages reliably. - Recommended to be off if you're passing lot of data that doesn't need to + Recommended to be off if you're passing a lot of data that doesn't need to arrive reliably. Methods: - Name: InvokeServer diff --git a/yaml/types/NetworkedObject.yaml b/yaml/types/NetworkedObject.yaml index 7a66ae9f..7d858ff9 100644 --- a/yaml/types/NetworkedObject.yaml +++ b/yaml/types/NetworkedObject.yaml @@ -1,5 +1,5 @@ Name: NetworkedObject -Description: NetworkedObject is a base class for all object that's synchronized +Description: NetworkedObject is a base class for every object that are synchronized by the network. Category: networking BaseType: null diff --git a/yaml/types/NewServerRequestData.yaml b/yaml/types/NewServerRequestData.yaml index 50e5b32f..acc2c49b 100644 --- a/yaml/types/NewServerRequestData.yaml +++ b/yaml/types/NewServerRequestData.yaml @@ -17,7 +17,7 @@ Properties: IsReadOnly: false IsObsolete: false IsStatic: false - Description: How much player slot should the new server allocates for. + Description: How many player slots the new server should allocate for. Methods: - Name: New ReturnType: NewServerRequestData diff --git a/yaml/types/PTSignal.yaml b/yaml/types/PTSignal.yaml index 557d3aed..2126f8a2 100644 --- a/yaml/types/PTSignal.yaml +++ b/yaml/types/PTSignal.yaml @@ -1,5 +1,5 @@ Name: PTSignal -Description: A signal which scripts can subscribe to +Description: A signal which scripts can subscribe to. Category: scripting BaseType: null Properties: [] @@ -14,7 +14,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Connect a function to this signal + Description: Connects a function to this signal. - Name: Disconnect ReturnType: nil Parameters: @@ -25,14 +25,14 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Disconnect a function from this signal + Description: Disconnects a function from this signal. - Name: Wait ReturnType: any Parameters: [] IsAsync: true IsObsolete: false IsStatic: false - Description: Wait until this signal's emitted + Description: Waits until this signal is emitted. - Name: Once ReturnType: nil Parameters: @@ -43,9 +43,9 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Listen to this signal only once + Description: Listens to this signal only once. Events: [] IsStatic: false IsAbstract: false IsInstantiable: false -StaticAlias: null +StaticAlias: null \ No newline at end of file diff --git a/yaml/types/Particles.yaml b/yaml/types/Particles.yaml index 32e3d6d4..59cdc6be 100644 --- a/yaml/types/Particles.yaml +++ b/yaml/types/Particles.yaml @@ -59,14 +59,14 @@ Properties: IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determines the velocity direction + Description: Determines the velocity direction. - Name: InitialVelocity Type: NumberRange IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determines the initial velocity + Description: Determines the initial velocity. - Name: StartRotation Type: NumberRange IsAccessibleByScripts: true @@ -80,28 +80,28 @@ Properties: IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determines the spread angle of the velocity + Description: Determines the spread angle of the velocity. - Name: Flatness Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determines how flat the spread angle should be + Description: Determines how flat the spread angle should be. - Name: Scale Type: NumberRange IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determine the initial scale range + Description: Determines the initial scale range. - Name: HueVariation Type: NumberRange IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determine the hue variation + Description: Determines the hue variation. - Name: BlendMode Type: BlendModeEnum IsAccessibleByScripts: true @@ -122,14 +122,14 @@ Properties: IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determines the emission shape of this particle + Description: Determines the emission shape of this particle. - Name: EmissionShapeScale Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determines the emission shape's scale + Description: Determines the emission shape's scale. - Name: SimulationSpace Type: ParticleSimulationSpaceEnum IsAccessibleByScripts: true diff --git a/yaml/types/Physical.yaml b/yaml/types/Physical.yaml index d938f47e..18d56b31 100644 --- a/yaml/types/Physical.yaml +++ b/yaml/types/Physical.yaml @@ -49,7 +49,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Get all objects that's currently in contact with this object. + Description: Get all objects that are currently in contact with this object. - Name: MovePosition ReturnType: nil Parameters: @@ -86,7 +86,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Add force to this physical + Description: Adds force to this physical. - Name: AddTorque ReturnType: nil Parameters: @@ -101,7 +101,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Add torque to this physical + Description: Adds torque to this physical. - Name: AddForceAtPosition ReturnType: nil Parameters: @@ -120,7 +120,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Add force at position to this physical + Description: Adds force at position to this physical - Name: AddRelativeForce ReturnType: nil Parameters: @@ -135,7 +135,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Add relative force to this physical + Description: Adds relative force to this physical. - Name: AddRelativeTorque ReturnType: nil Parameters: @@ -150,7 +150,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Add relative torque to this physical + Description: Adds relative torque to this physical. Events: - Name: Touched Parameters: @@ -158,7 +158,7 @@ Events: Type: Physical IsOptional: false DefaultValue: null - Description: Fires when this object has collide with other object + Description: Fires when this object has collided with other objects. Arguments: Name: hit Type: Physical @@ -168,7 +168,7 @@ Events: Type: Physical IsOptional: false DefaultValue: null - Description: Fires when this object has stopped colliding with other object + Description: Fires when this object has stopped colliding with other objects. Arguments: Name: hit Type: Physical @@ -186,7 +186,7 @@ Events: Type: Player IsOptional: false DefaultValue: null - Description: Fires when this object has been clicked by a player + Description: Fires when this object has been clicked by a player. Arguments: Name: player Type: Player diff --git a/yaml/types/Player.yaml b/yaml/types/Player.yaml index 422c6216..0b06b490 100644 --- a/yaml/types/Player.yaml +++ b/yaml/types/Player.yaml @@ -93,21 +93,21 @@ Properties: IsReadOnly: false IsObsolete: false IsStatic: false - Description: If true, animation will not stop when player starts moving + Description: If true, animation will not stop when the player starts moving. - Name: Team Type: Team IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: Player's assigned team + Description: The player's assigned team. - Name: MovementMode Type: PlayerMovementModeEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determine the movement mode for the player. + Description: Determines the movement mode for the player. - Name: NetworkPing Type: number IsAccessibleByScripts: true @@ -218,7 +218,7 @@ Events: Type: string IsOptional: false DefaultValue: null - Description: Fires when this player chats + Description: Fires when this player chats. Arguments: Name: message Type: string @@ -232,7 +232,7 @@ Events: Type: any IsOptional: false DefaultValue: null - Description: Fires when stat value has changed + Description: Fires when a stat value has changed. Arguments: "" - Name: TeamChanged Parameters: @@ -240,13 +240,13 @@ Events: Type: Team IsOptional: false DefaultValue: null - Description: Fires when player has been assigned a team + Description: Fires when a player has been assigned a team. Arguments: "" - Name: Respawned Parameters: null - Description: Fires when this player has respawned + Description: Fires when this player has respawned. Arguments: "" IsStatic: false IsAbstract: false IsInstantiable: false -StaticAlias: null +StaticAlias: null \ No newline at end of file diff --git a/yaml/types/PlayerDefaults.yaml b/yaml/types/PlayerDefaults.yaml index 0b63c696..225b025f 100644 --- a/yaml/types/PlayerDefaults.yaml +++ b/yaml/types/PlayerDefaults.yaml @@ -1,6 +1,5 @@ Name: PlayerDefaults -Description: PlayerDefaults is a service used for storing the default values of - the Player when created. +Description: PlayerDefaults is a service used for storing the default values of the Player when created. Category: game BaseType: HiddenBase Properties: @@ -115,23 +114,21 @@ Properties: IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determines whether the player's appearance is automatically loaded - by default. + Description: Determines whether the player's appearance is automatically loaded by default. - Name: LoadAppearanceTools Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determines whether the player's equippable appearance tool should - be loaded. + Description: Determines whether the player's equippable appearance tool should be loaded. - Name: MovementMode Type: PlayerMovementModeEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determine the movement mode for the player. + Description: Determines the movement mode for the player. Methods: - Name: LoadDefaults ReturnType: nil @@ -144,4 +141,4 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiable: false -StaticAlias: PlayerDefaults +StaticAlias: PlayerDefaults \ No newline at end of file diff --git a/yaml/types/Players.yaml b/yaml/types/Players.yaml index 51e4a4a5..0e413deb 100644 --- a/yaml/types/Players.yaml +++ b/yaml/types/Players.yaml @@ -23,8 +23,7 @@ Properties: IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determines whether or not server should trust the client for - adjusting player's properties. Enabling this is recommended. + Description: Determines whether or not the server should trust the client for adjusting the player's properties. Enabling this is recommended. - Name: PlayersCount Type: number IsAccessibleByScripts: true @@ -69,7 +68,7 @@ Events: Type: Player IsOptional: false DefaultValue: null - Description: Fires when player has connected + Description: Fires when a player has been connected. Arguments: Name: player Type: Player @@ -79,11 +78,11 @@ Events: Type: Player IsOptional: false DefaultValue: null - Description: Fires when player has disconnected + Description: Fires when a player has been disconnected. Arguments: Name: player Type: Player IsStatic: true IsAbstract: false IsInstantiable: false -StaticAlias: Players +StaticAlias: Players \ No newline at end of file diff --git a/yaml/types/PointLight.yaml b/yaml/types/PointLight.yaml index 90e3e388..5703bb64 100644 --- a/yaml/types/PointLight.yaml +++ b/yaml/types/PointLight.yaml @@ -1,6 +1,5 @@ Name: PointLight -Description: PointLight is a type of light that emits light in all directions - from a single point. +Description: PointLight is a type of light that emits light in all directions from a single point. Category: lighting BaseType: Light Properties: @@ -16,4 +15,4 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiable: true -StaticAlias: null +StaticAlias: null \ No newline at end of file diff --git a/yaml/types/PolytorianModel.yaml b/yaml/types/PolytorianModel.yaml index 3c6448b6..a06a762f 100644 --- a/yaml/types/PolytorianModel.yaml +++ b/yaml/types/PolytorianModel.yaml @@ -1,5 +1,5 @@ Name: PolytorianModel -Description: PolytorianModel is a CharacterModel that represent default Polytoria Character. +Description: PolytorianModel is a CharacterModel that represents the default Polytoria Character. Category: world BaseType: CharacterModel Properties: @@ -9,79 +9,77 @@ Properties: IsReadOnly: false IsObsolete: false IsStatic: false - Description: The head color + Description: The head color. - Name: TorsoColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: The torso color + Description: The torso color. - Name: LeftArmColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: The left arm color + Description: The left arm color. - Name: RightArmColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: The right arm color + Description: The right arm color. - Name: LeftLegColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: The left leg color + Description: The left leg color. - Name: RightLegColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: The right leg color + Description: The right leg color. - Name: FaceImage Type: ImageAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: The face image to use + Description: The face image to use. - Name: BodyMesh Type: MeshAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: The body mesh to use, the mesh must be in Polytoria Body rig format. + Description: The body mesh to use. The mesh must be in Polytoria Body rig format. - Name: Ragdolling Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false IsStatic: false - Description: Returns true if this character is ragdolling + Description: Returns true if this character is ragdolling. - Name: RagdollPosition Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false IsStatic: false - Description: Returns the current global ragdoll position, if ragdoll haven't - starts yet. Returns `Vector3.Zero` + Description: Returns the current global ragdoll position. If ragdoll hasn't started yet, returns `Vector3.Zero`. - Name: RagdollRotation Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false IsStatic: false - Description: Returns the current global ragdoll rotation, if ragdoll haven't - starts yet. Returns `Vector3.Zero` + Description: Returns the current global ragdoll rotation. If ragdoll hasn't started yet, returns `Vector3.Zero`. Methods: - Name: StartRagdoll ReturnType: nil @@ -93,14 +91,14 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Start ragdoll + Description: Starts ragdoll. - Name: StopRagdoll ReturnType: nil Parameters: [] IsAsync: false IsObsolete: false IsStatic: false - Description: Stop ragdoll + Description: Stops ragdoll. - Name: GetAttachment ReturnType: Dynamic Parameters: @@ -111,7 +109,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Get an attachment from this character. + Description: Gets an attachment from this character. - Name: LoadAppearance ReturnType: nil Parameters: @@ -126,24 +124,24 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Load an appearance. + Description: Loads an appearance. - Name: ClearAppearance ReturnType: nil Parameters: [] IsAsync: false IsObsolete: false IsStatic: false - Description: Clear current appearance. + Description: Clears the current appearance. Events: - Name: RagdollStarted Parameters: null - Description: Fires when ragdoll has been started + Description: Fires when ragdoll has been started. Arguments: "" - Name: RagdollStopped Parameters: null - Description: Fires when ragdoll has been stopped + Description: Fires when ragdoll has been stopped. Arguments: "" IsStatic: false IsAbstract: false IsInstantiable: true -StaticAlias: null +StaticAlias: null \ No newline at end of file diff --git a/yaml/types/PreferencesService.yaml b/yaml/types/PreferencesService.yaml index 95f3f93d..0461c298 100644 --- a/yaml/types/PreferencesService.yaml +++ b/yaml/types/PreferencesService.yaml @@ -1,6 +1,5 @@ Name: PreferencesService -Description: PreferencesService is a service that allows scripts to access some - of the user preferences +Description: PreferencesService is a service that allows scripts to access some of the user preferences. Category: services BaseType: Instance Properties: @@ -30,7 +29,7 @@ Events: Type: any IsOptional: false DefaultValue: null - Description: Fired when a user preference setting is changed. + Description: Fires when a user preference setting is changed. Arguments: - Name: settingName Type: string @@ -39,4 +38,4 @@ Events: IsStatic: true IsAbstract: false IsInstantiable: false -StaticAlias: Preferences +StaticAlias: Preferences \ No newline at end of file diff --git a/yaml/types/PresenceService.yaml b/yaml/types/PresenceService.yaml index 74890ebd..53a9387c 100644 --- a/yaml/types/PresenceService.yaml +++ b/yaml/types/PresenceService.yaml @@ -1,7 +1,5 @@ Name: PresenceService -Description: PresenceService is a service that allows ClientScripts to set the - active status of the player. Which will be used to display in supported - integrations. +Description: PresenceService is a service that allows ClientScripts to set the active status of the player, which will be used to display in supported integrations. Category: services BaseType: Instance Properties: @@ -11,14 +9,14 @@ Properties: IsReadOnly: false IsObsolete: false IsStatic: false - Description: Current activity status. + Description: The current activity status. - Name: CoverImage Type: PTImageAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: Activity cover image. + Description: The activity cover image. Methods: - Name: ResetTimer ReturnType: nil @@ -26,9 +24,9 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Reset the running timer for this activity. + Description: Resets the running timer for this activity. Events: [] IsStatic: true IsAbstract: false IsInstantiable: false -StaticAlias: Presence +StaticAlias: Presence \ No newline at end of file diff --git a/yaml/types/PurchasesService.yaml b/yaml/types/PurchasesService.yaml index 06c9eba4..ea7c781e 100644 --- a/yaml/types/PurchasesService.yaml +++ b/yaml/types/PurchasesService.yaml @@ -18,7 +18,7 @@ Methods: IsAsync: true IsObsolete: false IsStatic: false - Description: Prompt the purchase prompt to player + Description: Prompts the purchase prompt to the player. - Name: OwnsItemAsync ReturnType: boolean Parameters: @@ -33,10 +33,9 @@ Methods: IsAsync: true IsObsolete: false IsStatic: false - Description: Checks asynchronously if the specified player owns the asset with - the given asset ID. + Description: Checks asynchronously if the specified player owns the asset with the given asset ID. Events: [] IsStatic: true IsAbstract: false IsInstantiable: false -StaticAlias: Purchases +StaticAlias: Purchases \ No newline at end of file diff --git a/yaml/types/Quaternion.yaml b/yaml/types/Quaternion.yaml index c3c2007b..39c620e6 100644 --- a/yaml/types/Quaternion.yaml +++ b/yaml/types/Quaternion.yaml @@ -98,7 +98,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: true - Description: Creates a rotation which rotates angle degrees around axis. + Description: Creates a rotation which rotates `angle` degrees around `axis`. - Name: Dot ReturnType: number Parameters: @@ -169,7 +169,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: true - Description: Creates a rotation which rotates angle degrees around axis. + Description: Creates a rotation which rotates `fromDirection` to `toDirection`. - Name: Inverse ReturnType: Quaternion Parameters: @@ -218,8 +218,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: true - Description: Linearly interpolates between two quaternions without clamping the - interpolant. + Description: Linearly interpolates between two quaternions without clamping the interpolant. - Name: LookRotation ReturnType: Quaternion Parameters: @@ -275,7 +274,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: true - Description: Rotates a rotation from towards to by maxDegreesDelta. + Description: Rotates a rotation `from` towards `to` by `maxDegreesDelta`. - Name: Slerp ReturnType: Quaternion Parameters: @@ -313,10 +312,9 @@ Methods: IsAsync: false IsObsolete: false IsStatic: true - Description: Spherically interpolates between two quaternions without clamping - the interpolant. + Description: Spherically interpolates between two quaternions without clamping the interpolant. Events: [] IsStatic: false IsAbstract: false IsInstantiable: false -StaticAlias: null +StaticAlias: null \ No newline at end of file diff --git a/yaml/types/Script.yaml b/yaml/types/Script.yaml index 2f29e1f0..1e8f66c1 100644 --- a/yaml/types/Script.yaml +++ b/yaml/types/Script.yaml @@ -1,6 +1,5 @@ Name: Script -Description: Scripts are abstract base classes representing Lua code that can be - executed in the game. +Description: Scripts are abstract base classes representing Lua code that can be executed in the game. Category: scripting BaseType: Instance Properties: @@ -17,9 +16,7 @@ Properties: IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determine if this script should be enabled. Note that setting it to - false during runtime won't stop the script immediately, rather it would - stop any running threads when it hits any yield function. + Description: Determines if this script should be enabled. Note that setting it to false during runtime won't stop the script immediately; rather, it will stop any running threads when it hits any yield function. - Name: LinkedScript Type: FileLinkAsset IsAccessibleByScripts: false @@ -75,9 +72,9 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Link script with the target file path + Description: Links the script with the target file path. Events: [] IsStatic: false IsAbstract: true IsInstantiable: false -StaticAlias: null +StaticAlias: null \ No newline at end of file diff --git a/yaml/types/ScriptSharedTable.yaml b/yaml/types/ScriptSharedTable.yaml index 74843dc0..922fafdb 100644 --- a/yaml/types/ScriptSharedTable.yaml +++ b/yaml/types/ScriptSharedTable.yaml @@ -1,6 +1,5 @@ Name: ScriptSharedTable -Description: Shared table of object. This class provides a table which any - scripts can modify. +Description: Shared table of an object. This class provides a table which any script can modify. Category: scripting BaseType: null Properties: [] @@ -11,7 +10,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Clear the shared table + Description: Clears the shared table. - Name: Remove ReturnType: nil Parameters: @@ -22,7 +21,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Remove the key from shared table + Description: Removes the key from the shared table. - Name: ClearPrefix ReturnType: nil Parameters: @@ -33,7 +32,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Clear all keys with the prefix + Description: Clears all keys with the prefix. - Name: ClearSuffix ReturnType: nil Parameters: @@ -44,9 +43,9 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Clear all keys with the suffix + Description: Clears all keys with the suffix. Events: [] IsStatic: false IsAbstract: false IsInstantiable: false -StaticAlias: null +StaticAlias: null \ No newline at end of file diff --git a/yaml/types/Seat.yaml b/yaml/types/Seat.yaml index a00733b0..cda66880 100644 --- a/yaml/types/Seat.yaml +++ b/yaml/types/Seat.yaml @@ -1,5 +1,5 @@ Name: Seat -Description: Seats are parts the player can sit on. +Description: Seats are parts that the player can sit on. Category: world BaseType: Part Properties: @@ -42,4 +42,4 @@ Events: IsStatic: false IsAbstract: false IsInstantiable: true -StaticAlias: null +StaticAlias: null \ No newline at end of file diff --git a/yaml/types/Sound.yaml b/yaml/types/Sound.yaml index 604d42e0..16dc3b87 100644 --- a/yaml/types/Sound.yaml +++ b/yaml/types/Sound.yaml @@ -30,8 +30,7 @@ Properties: IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determines whether the sound should start playing automatically - when loaded. + Description: Determines whether the sound should start playing automatically when loaded. - Name: Loop Type: boolean IsAccessibleByScripts: true @@ -52,7 +51,7 @@ Properties: IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determines whether the sound should be paused + Description: Determines whether the sound should be paused. - Name: MaxDistance Type: number IsAccessibleByScripts: true @@ -106,15 +105,14 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Plays the sound once at the specified volume without affecting the - current playback. + Description: Plays the sound once at the specified volume without affecting the current playback. - Name: Pause ReturnType: nil Parameters: [] IsAsync: false IsObsolete: false IsStatic: false - Description: Pause the sound if it is currently playing. + Description: Pauses the sound if it is currently playing. - Name: Stop ReturnType: nil Parameters: [] @@ -125,9 +123,9 @@ Methods: Events: - Name: Loaded Parameters: null - Description: Fires when this sound has loaded + Description: Fires when this sound has loaded. Arguments: "" IsStatic: false IsAbstract: false IsInstantiable: true -StaticAlias: null +StaticAlias: null \ No newline at end of file diff --git a/yaml/types/Stat.yaml b/yaml/types/Stat.yaml index 6bc4fe7b..e86f3c21 100644 --- a/yaml/types/Stat.yaml +++ b/yaml/types/Stat.yaml @@ -1,6 +1,5 @@ Name: Stat -Description: Stat is an object that represents a player stat to which players - can be assigned to have their own number or string values. +Description: Stat is an object that represents a player stat to which players can be assigned to have their own number or string values. Category: game BaseType: Instance Properties: @@ -18,8 +17,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Returns the display name of the stat. If DisplayName is specified, - it returns DisplayName; otherwise, it returns Name. + Description: Returns the display name of the stat. If DisplayName is specified, it returns DisplayName; otherwise, it returns Name. - Name: Set ReturnType: nil Parameters: @@ -34,7 +32,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Set the value stat of player to string + Description: Sets the value of the stat for the player to a number. - Name: Set ReturnType: nil Parameters: @@ -49,7 +47,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Set the value stat of player to string + Description: Sets the value of the stat for the player to a string. - Name: Get ReturnType: any Parameters: @@ -60,7 +58,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Get the value stat of player + Description: Gets the value of the stat for the player. - Name: GetTotalForTeam ReturnType: number Parameters: @@ -71,7 +69,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Get the total value for team + Description: Gets the total value for the team. - Name: GetDisplayValue ReturnType: string Parameters: @@ -82,10 +80,9 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Gets the display value for a player. If the value is a number, it - is automatically converted to K/M/S format (e.g., 1K+, 12.3K+). + Description: Gets the display value for a player. If the value is a number, it is automatically converted to K/M/S format (e.g., 1K+, 12.3K+). Events: [] IsStatic: false IsAbstract: false IsInstantiable: true -StaticAlias: null +StaticAlias: null \ No newline at end of file diff --git a/yaml/types/Stats.yaml b/yaml/types/Stats.yaml index ada5097f..f56f534f 100644 --- a/yaml/types/Stats.yaml +++ b/yaml/types/Stats.yaml @@ -10,9 +10,9 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Get all Stat objects + Description: Gets all Stat objects. Events: [] IsStatic: true IsAbstract: false IsInstantiable: false -StaticAlias: Stats +StaticAlias: Stats \ No newline at end of file From 24b717d5d5521da1f7f8284d7c1120fc06d27035 Mon Sep 17 00:00:00 2001 From: thepotato Date: Fri, 8 May 2026 12:08:26 +0330 Subject: [PATCH 2/3] Resolve issues --- yaml/types/NetworkedObject.yaml | 2 +- yaml/types/Physical.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/yaml/types/NetworkedObject.yaml b/yaml/types/NetworkedObject.yaml index 7d858ff9..78838608 100644 --- a/yaml/types/NetworkedObject.yaml +++ b/yaml/types/NetworkedObject.yaml @@ -1,5 +1,5 @@ Name: NetworkedObject -Description: NetworkedObject is a base class for every object that are synchronized +Description: NetworkedObject is a base class for every object that is synchronized by the network. Category: networking BaseType: null diff --git a/yaml/types/Physical.yaml b/yaml/types/Physical.yaml index 18d56b31..0eaef53a 100644 --- a/yaml/types/Physical.yaml +++ b/yaml/types/Physical.yaml @@ -120,7 +120,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Adds force at position to this physical + Description: Adds force at position to this physical. - Name: AddRelativeForce ReturnType: nil Parameters: From c364ec466a78d91e35b7302eaef0310aaa4a625b Mon Sep 17 00:00:00 2001 From: thepotato <112724769+thepotato0@users.noreply.github.com> Date: Fri, 8 May 2026 18:42:56 +0330 Subject: [PATCH 3/3] Update yaml/types/NetworkEvent.yaml Co-authored-by: nihilvm <282644017+nihilvm@users.noreply.github.com> --- yaml/types/NetworkEvent.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/yaml/types/NetworkEvent.yaml b/yaml/types/NetworkEvent.yaml index 1060c3b7..3158ce09 100644 --- a/yaml/types/NetworkEvent.yaml +++ b/yaml/types/NetworkEvent.yaml @@ -1,6 +1,6 @@ Name: NetworkEvent Description: NetworkEvents are events that can be called to communicate between - server and client. NetMessages are the classes used for sharing data between + server and client. NetMessage is the class used for sharing data between server and client when sending NetworkEvents. Category: networking BaseType: Instance