document more

This commit is contained in:
maji
2025-12-30 01:46:23 +07:00
parent f37b029aa7
commit e9884abe4e
9 changed files with 46 additions and 43 deletions

View File

@@ -12,7 +12,8 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Returns true if any of the button in the collection is currently being pressed. Description: Returns true if any of the button in the collection is currently
being pressed.
- Name: Weight - Name: Weight
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true

View File

@@ -14,7 +14,7 @@ Methods:
IsAsync: false IsAsync: false
IsObsolete: false IsObsolete: false
IsStatic: true IsStatic: true
Description: Create new empty button Description: Create new button of this keycode
- Name: New - Name: New
ReturnType: InputButton ReturnType: InputButton
Parameters: Parameters:

View File

@@ -12,7 +12,8 @@ Properties:
IsAccessibleByScripts: false IsAccessibleByScripts: false
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Determine if children is editable, this is to be used if this instance is a Linked model. Only used in creator. Description: Determine if children is editable, this is to be used if this
instance is a Linked model. Only used in creator.
- Name: Tags - Name: Tags
Type: table Type: table
IsAccessibleByScripts: true IsAccessibleByScripts: true

View File

@@ -6,7 +6,9 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation 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
arrive reliably.
Methods: Methods:
- Name: InvokeServer - Name: InvokeServer
ReturnType: nil ReturnType: nil
@@ -67,4 +69,6 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
Description: Missing Documentation 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 when sending NetworkEvents.

View File

@@ -1,9 +0,0 @@
Name: NetworkService
BaseType: Instance
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: Missing Documentation

View File

@@ -24,7 +24,8 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
Description: Returns networked ID of this object. Networked ID are always unique per network session. Description: Returns networked ID of this object. Networked ID are always unique
per network session.
- Name: ObjectID - Name: ObjectID
Type: string Type: string
IsAccessibleByScripts: true IsAccessibleByScripts: true
@@ -36,7 +37,8 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
Description: Returns true if this object exists in network, false if this object is spawned by the local client. Description: Returns true if this object exists in network, false if this object
is spawned by the local client.
Methods: Methods:
- Name: IsA - Name: IsA
ReturnType: boolean ReturnType: boolean
@@ -48,7 +50,8 @@ Methods:
IsAsync: false IsAsync: false
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Returns whether or not the instance is the specified class, this also checks for inheritance. Description: Returns whether or not the instance is the specified class, this
also checks for inheritance.
- Name: Clone - Name: Clone
ReturnType: NetworkedObject ReturnType: NetworkedObject
Parameters: Parameters:
@@ -100,4 +103,5 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: true IsAbstract: true
IsInstantiatable: false IsInstantiatable: false
Description: NetworkedObject is a base class for all object that's synchronized by the network. Description: NetworkedObject is a base class for all object that's synchronized
by the network.

View File

@@ -6,13 +6,13 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: Target place path.
- Name: MaxPlayers - Name: MaxPlayers
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: How much player slot should the new server allocates for.
Methods: Methods:
- Name: New - Name: New
ReturnType: NewServerRequestData ReturnType: NewServerRequestData
@@ -20,7 +20,7 @@ Methods:
IsAsync: false IsAsync: false
IsObsolete: false IsObsolete: false
IsStatic: true IsStatic: true
Description: Missing Documentation Description: Creates a new `NewServerRequestData`
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false

View File

@@ -6,79 +6,81 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: The head color
- Name: TorsoColor - Name: TorsoColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: The torso color
- Name: LeftArmColor - Name: LeftArmColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: The left arm color
- Name: RightArmColor - Name: RightArmColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: The right arm color
- Name: LeftLegColor - Name: LeftLegColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: The left leg color
- Name: RightLegColor - Name: RightLegColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: The right leg color
- Name: FaceImage - Name: FaceImage
Type: ImageAsset Type: ImageAsset
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: The face image to use
- Name: ShirtImage - Name: ShirtImage
Type: ImageAsset Type: ImageAsset
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: The shirt image to use
- Name: PantsImage - Name: PantsImage
Type: ImageAsset Type: ImageAsset
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: The pants image to use
- Name: TorsoMesh - Name: TorsoMesh
Type: MeshAsset Type: MeshAsset
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: The torso mesh to use
- Name: Ragdolling - Name: Ragdolling
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: Returns true if this character is ragdolling
- Name: RagdollPosition - Name: RagdollPosition
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: Returns the current global ragdoll position, if ragdoll haven't
starts yet. Returns `Vector3.Zero`
- Name: RagdollRotation - Name: RagdollRotation
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: Returns the current global ragdoll rotation, if ragdoll haven't
starts yet. Returns `Vector3.Zero`
Methods: Methods:
- Name: StartRagdoll - Name: StartRagdoll
ReturnType: nil ReturnType: nil
@@ -90,14 +92,14 @@ Methods:
IsAsync: false IsAsync: false
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Missing Documentation Description: Start ragdoll
- Name: StopRagdoll - Name: StopRagdoll
ReturnType: nil ReturnType: nil
Parameters: [] Parameters: []
IsAsync: false IsAsync: false
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Missing Documentation Description: Stop ragdoll
- Name: GetAttachment - Name: GetAttachment
ReturnType: Dynamic ReturnType: Dynamic
Parameters: Parameters:
@@ -108,7 +110,7 @@ Methods:
IsAsync: false IsAsync: false
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Missing Documentation Description: Get an attachment from this character.
- Name: LoadAppearance - Name: LoadAppearance
ReturnType: nil ReturnType: nil
Parameters: Parameters:
@@ -119,14 +121,14 @@ Methods:
IsAsync: false IsAsync: false
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Missing Documentation Description: Load an appearance.
- Name: ClearAppearance - Name: ClearAppearance
ReturnType: nil ReturnType: nil
Parameters: [] Parameters: []
IsAsync: false IsAsync: false
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Missing Documentation Description: Clear current appearance.
Events: Events:
- Name: RagdollStarted - Name: RagdollStarted
Arguments: "" Arguments: ""
@@ -137,4 +139,4 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
Description: Missing Documentation Description: PolytorianModel is a CharacterModel that represent default Polytoria Character.

View File

@@ -6,13 +6,13 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: Current activity status.
- Name: CoverImage - Name: CoverImage
Type: PTImageAsset Type: PTImageAsset
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
Description: Missing Documentation Description: Activity cover image.
Methods: Methods:
- Name: ResetTimer - Name: ResetTimer
ReturnType: nil ReturnType: nil
@@ -20,7 +20,7 @@ Methods:
IsAsync: false IsAsync: false
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Missing Documentation Description: Reset the running timer for this activity.
Events: [] Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false