From e9884abe4e71c8c961896d771ab2c6b63006a54a Mon Sep 17 00:00:00 2001 From: maji Date: Tue, 30 Dec 2025 01:46:23 +0700 Subject: [PATCH] document more --- yaml/types/InputActionButton.yaml | 3 ++- yaml/types/InputButton.yaml | 2 +- yaml/types/Instance.yaml | 3 ++- yaml/types/NetworkEvent.yaml | 8 ++++-- yaml/types/NetworkService.yaml | 9 ------- yaml/types/NetworkedObject.yaml | 12 ++++++--- yaml/types/NewServerRequestData.yaml | 6 ++--- yaml/types/PolytorianModel.yaml | 40 +++++++++++++++------------- yaml/types/PresenceService.yaml | 6 ++--- 9 files changed, 46 insertions(+), 43 deletions(-) delete mode 100644 yaml/types/NetworkService.yaml diff --git a/yaml/types/InputActionButton.yaml b/yaml/types/InputActionButton.yaml index 01db55a..99906b7 100644 --- a/yaml/types/InputActionButton.yaml +++ b/yaml/types/InputActionButton.yaml @@ -12,7 +12,8 @@ Properties: IsAccessibleByScripts: true IsReadOnly: 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 Type: number IsAccessibleByScripts: true diff --git a/yaml/types/InputButton.yaml b/yaml/types/InputButton.yaml index 80b4b96..7abf1da 100644 --- a/yaml/types/InputButton.yaml +++ b/yaml/types/InputButton.yaml @@ -14,7 +14,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: true - Description: Create new empty button + Description: Create new button of this keycode - Name: New ReturnType: InputButton Parameters: diff --git a/yaml/types/Instance.yaml b/yaml/types/Instance.yaml index 95430c3..1195419 100644 --- a/yaml/types/Instance.yaml +++ b/yaml/types/Instance.yaml @@ -12,7 +12,8 @@ Properties: IsAccessibleByScripts: false IsReadOnly: 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 Type: table IsAccessibleByScripts: true diff --git a/yaml/types/NetworkEvent.yaml b/yaml/types/NetworkEvent.yaml index a2b9a12..07095d1 100644 --- a/yaml/types/NetworkEvent.yaml +++ b/yaml/types/NetworkEvent.yaml @@ -6,7 +6,9 @@ Properties: IsAccessibleByScripts: true IsReadOnly: 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: - Name: InvokeServer ReturnType: nil @@ -67,4 +69,6 @@ Events: IsStatic: false IsAbstract: false 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. diff --git a/yaml/types/NetworkService.yaml b/yaml/types/NetworkService.yaml deleted file mode 100644 index 7579f59..0000000 --- a/yaml/types/NetworkService.yaml +++ /dev/null @@ -1,9 +0,0 @@ -Name: NetworkService -BaseType: Instance -Properties: [] -Methods: [] -Events: [] -IsStatic: false -IsAbstract: false -IsInstantiatable: false -Description: Missing Documentation diff --git a/yaml/types/NetworkedObject.yaml b/yaml/types/NetworkedObject.yaml index aa7ee56..0e6ee28 100644 --- a/yaml/types/NetworkedObject.yaml +++ b/yaml/types/NetworkedObject.yaml @@ -24,7 +24,8 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true 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 Type: string IsAccessibleByScripts: true @@ -36,7 +37,8 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true 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: - Name: IsA ReturnType: boolean @@ -48,7 +50,8 @@ Methods: IsAsync: false IsObsolete: 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 ReturnType: NetworkedObject Parameters: @@ -100,4 +103,5 @@ Events: IsStatic: false IsAbstract: true 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. diff --git a/yaml/types/NewServerRequestData.yaml b/yaml/types/NewServerRequestData.yaml index b96623e..d64148a 100644 --- a/yaml/types/NewServerRequestData.yaml +++ b/yaml/types/NewServerRequestData.yaml @@ -6,13 +6,13 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: Target place path. - Name: MaxPlayers Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: How much player slot should the new server allocates for. Methods: - Name: New ReturnType: NewServerRequestData @@ -20,7 +20,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: true - Description: Missing Documentation + Description: Creates a new `NewServerRequestData` Events: [] IsStatic: false IsAbstract: false diff --git a/yaml/types/PolytorianModel.yaml b/yaml/types/PolytorianModel.yaml index 509e934..688d97f 100644 --- a/yaml/types/PolytorianModel.yaml +++ b/yaml/types/PolytorianModel.yaml @@ -6,79 +6,81 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: The head color - Name: TorsoColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: The torso color - Name: LeftArmColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: The left arm color - Name: RightArmColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: The right arm color - Name: LeftLegColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: The left leg color - Name: RightLegColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: The right leg color - Name: FaceImage Type: ImageAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: The face image to use - Name: ShirtImage Type: ImageAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: The shirt image to use - Name: PantsImage Type: ImageAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: The pants image to use - Name: TorsoMesh Type: MeshAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: The torso mesh to use - Name: Ragdolling Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false - Description: Missing Documentation + Description: Returns true if this character is ragdolling - Name: RagdollPosition Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false - Description: Missing Documentation + Description: Returns the current global ragdoll position, if ragdoll haven't + starts yet. Returns `Vector3.Zero` - Name: RagdollRotation Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false - Description: Missing Documentation + Description: Returns the current global ragdoll rotation, if ragdoll haven't + starts yet. Returns `Vector3.Zero` Methods: - Name: StartRagdoll ReturnType: nil @@ -90,14 +92,14 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Missing Documentation + Description: Start ragdoll - Name: StopRagdoll ReturnType: nil Parameters: [] IsAsync: false IsObsolete: false IsStatic: false - Description: Missing Documentation + Description: Stop ragdoll - Name: GetAttachment ReturnType: Dynamic Parameters: @@ -108,7 +110,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Missing Documentation + Description: Get an attachment from this character. - Name: LoadAppearance ReturnType: nil Parameters: @@ -119,14 +121,14 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Missing Documentation + Description: Load an appearance. - Name: ClearAppearance ReturnType: nil Parameters: [] IsAsync: false IsObsolete: false IsStatic: false - Description: Missing Documentation + Description: Clear current appearance. Events: - Name: RagdollStarted Arguments: "" @@ -137,4 +139,4 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true -Description: Missing Documentation +Description: PolytorianModel is a CharacterModel that represent default Polytoria Character. diff --git a/yaml/types/PresenceService.yaml b/yaml/types/PresenceService.yaml index 9392e09..56fa46a 100644 --- a/yaml/types/PresenceService.yaml +++ b/yaml/types/PresenceService.yaml @@ -6,13 +6,13 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: Current activity status. - Name: CoverImage Type: PTImageAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false - Description: Missing Documentation + Description: Activity cover image. Methods: - Name: ResetTimer ReturnType: nil @@ -20,7 +20,7 @@ Methods: IsAsync: false IsObsolete: false IsStatic: false - Description: Missing Documentation + Description: Reset the running timer for this activity. Events: [] IsStatic: true IsAbstract: false