diff --git a/yaml/types/Accessory.yaml b/yaml/types/Accessory.yaml index 1bcb1a2..15a3556 100644 --- a/yaml/types/Accessory.yaml +++ b/yaml/types/Accessory.yaml @@ -6,11 +6,13 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Specifies the character attachment point Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Accessory represents a attachable object that can be equipped by a CharacterModel. diff --git a/yaml/types/AchievementsService.yaml b/yaml/types/AchievementsService.yaml index 3f16077..598a612 100644 --- a/yaml/types/AchievementsService.yaml +++ b/yaml/types/AchievementsService.yaml @@ -6,6 +6,7 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determine if achievement sound effect should play when user receives an achievement - Name: NotifyAchievements @@ -13,28 +14,10 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determine if achievement toast should show when user receives an achievement Methods: - - Name: Award - ReturnType: nil - Parameters: - - Name: userID - Type: number - IsOptional: false - DefaultValue: "" - - Name: achievementID - Type: number - IsOptional: false - DefaultValue: "" - - Name: callback - Type: function - IsOptional: false - DefaultValue: "" - IsAsync: false - IsObsolete: false - IsStatic: false - Description: Award achievement to the user - Name: AwardAsync ReturnType: nil Parameters: @@ -50,25 +33,6 @@ Methods: IsObsolete: false IsStatic: false Description: Award achievement to the user asynchronously. - - Name: HasAchievement - ReturnType: nil - Parameters: - - Name: userID - Type: number - IsOptional: false - DefaultValue: "" - - Name: achievementID - Type: number - IsOptional: false - DefaultValue: "" - - Name: callback - Type: function - IsOptional: false - DefaultValue: "" - IsAsync: false - IsObsolete: false - IsStatic: false - Description: Check if user of ID has the achievement. - Name: HasAchievementAsync ReturnType: boolean Parameters: @@ -93,4 +57,5 @@ Events: IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Achievements Description: Service for managing achievements diff --git a/yaml/types/Animation.yaml b/yaml/types/Animation.yaml index da1892c..ec8edc5 100644 --- a/yaml/types/Animation.yaml +++ b/yaml/types/Animation.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: WIP class diff --git a/yaml/types/Animator.yaml b/yaml/types/Animator.yaml index 0e8cc45..5d86b4e 100644 --- a/yaml/types/Animator.yaml +++ b/yaml/types/Animator.yaml @@ -42,4 +42,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: WIP class diff --git a/yaml/types/AssetsService.yaml b/yaml/types/AssetsService.yaml new file mode 100644 index 0000000..f994e88 --- /dev/null +++ b/yaml/types/AssetsService.yaml @@ -0,0 +1,54 @@ +Name: AssetsService +BaseType: Instance +Properties: [] +Methods: + - Name: NewAsset + ReturnType: BaseAsset + Parameters: + - Name: assetClassName + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: NewPTImage + ReturnType: PTImageAsset + Parameters: + - Name: imgID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: NewPTAudio + ReturnType: PTAudioAsset + Parameters: + - Name: audioID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: NewPTMesh + ReturnType: PTMeshAsset + Parameters: + - Name: assetID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +StaticAlias: Assets +Description: Missing Documentation diff --git a/yaml/types/AudioAsset.yaml b/yaml/types/AudioAsset.yaml index 411a1e2..2f172ca 100644 --- a/yaml/types/AudioAsset.yaml +++ b/yaml/types/AudioAsset.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Abstract class for audio diff --git a/yaml/types/BaseAsset.yaml b/yaml/types/BaseAsset.yaml index f8475e9..f07b81a 100644 --- a/yaml/types/BaseAsset.yaml +++ b/yaml/types/BaseAsset.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Base class for all assets diff --git a/yaml/types/BindableEvent.yaml b/yaml/types/BindableEvent.yaml index 8ab5cfb..f7a1f9d 100644 --- a/yaml/types/BindableEvent.yaml +++ b/yaml/types/BindableEvent.yaml @@ -22,5 +22,6 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: BindableEvent are events that can be called to communicate between scripts in the same boundary. diff --git a/yaml/types/BodyPosition.yaml b/yaml/types/BodyPosition.yaml index c57fe8d..2e5cdb9 100644 --- a/yaml/types/BodyPosition.yaml +++ b/yaml/types/BodyPosition.yaml @@ -6,18 +6,21 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the target position that the body applies forces to get to. - Name: Force Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines how much force the body applies. - Name: AcceptanceDistance Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines how close the body has to be to the target position to stop applying forces to it. Methods: [] @@ -25,5 +28,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: BodyPosition are objects that apply a force to their parent until it moves toward the target position. diff --git a/yaml/types/BoolValue.yaml b/yaml/types/BoolValue.yaml index b56c38d..53c5a00 100644 --- a/yaml/types/BoolValue.yaml +++ b/yaml/types/BoolValue.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The value of this object. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: BoolValue is a ValueBase that stores a boolean. diff --git a/yaml/types/Bounds.yaml b/yaml/types/Bounds.yaml index ce8cfcd..f6431b2 100644 --- a/yaml/types/Bounds.yaml +++ b/yaml/types/Bounds.yaml @@ -6,36 +6,42 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates the center point of the bounds. - Name: Size Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the size of the bounds. - Name: Extents Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates the extents of the bounds. - Name: Start Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The origin point - Name: End Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The ending point - Name: Volume Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates the volume of the bounds. Methods: - Name: New @@ -60,6 +66,32 @@ Methods: IsObsolete: false IsStatic: true Description: Creates a new Bounds object with the specified position and size. + - Name: __eq + ReturnType: boolean + Parameters: + - Name: a + Type: Bounds + IsOptional: false + DefaultValue: "" + - Name: b + Type: Bounds + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __tostring + ReturnType: string + Parameters: + - Name: v + Type: Bounds + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation - Name: ClosestPoint ReturnType: Vector3 Parameters: @@ -188,4 +220,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: Represents a bounding box in 3D space. diff --git a/yaml/types/BuiltInAudioAsset.yaml b/yaml/types/BuiltInAudioAsset.yaml index 89e9da1..73bc435 100644 --- a/yaml/types/BuiltInAudioAsset.yaml +++ b/yaml/types/BuiltInAudioAsset.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: false IsReadOnly: false IsObsolete: false + IsStatic: false Description: The target audio to use Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Audio asset that's built-in with the client diff --git a/yaml/types/BuiltInFontAsset.yaml b/yaml/types/BuiltInFontAsset.yaml index c0f768b..939a4e5 100644 --- a/yaml/types/BuiltInFontAsset.yaml +++ b/yaml/types/BuiltInFontAsset.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: false IsReadOnly: false IsObsolete: false + IsStatic: false Description: Target font to use Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Font asset that's built-in with the client diff --git a/yaml/types/Camera.yaml b/yaml/types/Camera.yaml index e971e11..68e528b 100644 --- a/yaml/types/Camera.yaml +++ b/yaml/types/Camera.yaml @@ -6,36 +6,42 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines or returns the camera's current mode. - Name: FOV Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines or returns the camera's field of view. - Name: ClipThroughWalls Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the camera should clip through walls. - Name: MinDistance Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The camera's minimum distance from the player in Follow mode. - Name: MaxDistance Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines camera's maximum distance from the player in Follow mode. - Name: Distance Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the distance between the camera and the player when the camera is in Follow mode. - Name: ScrollSensitivity @@ -43,12 +49,14 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the scroll move speed of the camera. - Name: Orthographic Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the camera should render in orthographic (2D) mode or not (3D). - Name: FollowLerp @@ -56,90 +64,105 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not to use lerping in Follow mode. - Name: LerpSpeed Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the lerp speed of the camera when lerping is enabled. - Name: OrthographicSize Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the half-size of the camera when in orthographic mode. - Name: PositionOffset Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the camera's offset from its position. - Name: RotationOffset Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the camera's offset from its rotation. - Name: IsFirstPerson Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns whether or not the camera is in first person. - Name: CanLock Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determine if camera can be ctrl locked. - Name: SensitivityMultiplier Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Multipler for camera sensitivity - Name: Sensitivity Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Current sensitivity of the camera - Name: HorizontalSpeed Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the horizontal movement speed of the camera in Follow mode. - Name: VerticalSpeed Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the vertical move speed of the camera. - Name: ScrollLerpSpeed Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the lerp amount when scrolling - Name: CtrlLocked Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determine if camera is in Ctrl lock mode - Name: AlwaysLocked Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determine if camera should always be in locked mode - Name: Target Type: Dynamic IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The target of Follow mode Methods: - Name: ViewportPointToRay @@ -258,4 +281,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Camera is a class that represents the local player's camera. diff --git a/yaml/types/CaptureService.yaml b/yaml/types/CaptureService.yaml index c96db2e..82ee2a4 100644 --- a/yaml/types/CaptureService.yaml +++ b/yaml/types/CaptureService.yaml @@ -6,24 +6,28 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns whenever the capture is on cooldown. - Name: CanCapture Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines if user/scripts can take a picture. - Name: DefaultCaptureOverlay Type: UIField IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Default capture overlay for all captures - Name: SpectatorAttach Type: Dynamic IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Attaches a spectator camera at dynamic for use with spectator mode. Methods: - Name: TakePhotoAtDynamic @@ -74,4 +78,5 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Capture Description: Service for capturing photos diff --git a/yaml/types/CharacterModel.yaml b/yaml/types/CharacterModel.yaml index 9813a84..37c176b 100644 --- a/yaml/types/CharacterModel.yaml +++ b/yaml/types/CharacterModel.yaml @@ -6,6 +6,7 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The animator for this character Methods: - Name: GetAttachment @@ -23,4 +24,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Base class for Character Models diff --git a/yaml/types/ChatService.yaml b/yaml/types/ChatService.yaml index b590bf7..3de60d9 100644 --- a/yaml/types/ChatService.yaml +++ b/yaml/types/ChatService.yaml @@ -45,4 +45,5 @@ Events: IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Chat Description: Chat is a static class used for various actions regarding the chat. diff --git a/yaml/types/ClientScript.yaml b/yaml/types/ClientScript.yaml index a0af770..274c24b 100644 --- a/yaml/types/ClientScript.yaml +++ b/yaml/types/ClientScript.yaml @@ -6,5 +6,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: ClientScript is a script that runs locally for each player. It can only see what the player can see. diff --git a/yaml/types/Color.yaml b/yaml/types/Color.yaml index 4698118..4b82e0b 100644 --- a/yaml/types/Color.yaml +++ b/yaml/types/Color.yaml @@ -6,24 +6,28 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Red color component - Name: G Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Green color component - Name: B Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Blue color component - Name: A Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Alpha (opacity) color component Methods: - Name: New @@ -86,6 +90,77 @@ Methods: IsObsolete: false IsStatic: true Description: Creates a new Color with the set R, G, B and A values + - Name: __add + ReturnType: Color + Parameters: + - Name: a + Type: Color + IsOptional: false + DefaultValue: "" + - Name: b + Type: Color + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __sub + ReturnType: Color + Parameters: + - Name: a + Type: Color + IsOptional: false + DefaultValue: "" + - Name: b + Type: Color + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __mul + ReturnType: any + Parameters: + - Name: a + Type: Color + IsOptional: false + DefaultValue: "" + - Name: b + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __eq + ReturnType: boolean + Parameters: + - Name: a + Type: Color + IsOptional: false + DefaultValue: "" + - Name: b + Type: Color + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __tostring + ReturnType: string + Parameters: + - Name: v + Type: Color + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation - Name: Random ReturnType: Color Parameters: [] @@ -127,6 +202,7 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: >- Color is a data type that represents a color. diff --git a/yaml/types/ColorAdjustModifier.yaml b/yaml/types/ColorAdjustModifier.yaml index 111e4b8..722fa2c 100644 --- a/yaml/types/ColorAdjustModifier.yaml +++ b/yaml/types/ColorAdjustModifier.yaml @@ -6,29 +6,34 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determine the brightness adjustment - Name: Contrast Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determine the contrast adjustment - Name: Saturation Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determine the saturation adjustment - Name: TintColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determine the tint color Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: ColorAdjustModifier is a LightingModifier that allows the adjustment of lighting diff --git a/yaml/types/ColorSeries.yaml b/yaml/types/ColorSeries.yaml index fa6ab64..29d5216 100644 --- a/yaml/types/ColorSeries.yaml +++ b/yaml/types/ColorSeries.yaml @@ -1,11 +1,12 @@ Name: ColorSeries -BaseType: ValueType +BaseType: null Properties: - Name: PointCount Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns the point count of this color series Methods: - Name: New @@ -30,6 +31,13 @@ Methods: IsObsolete: false IsStatic: true Description: Create color series by this color range + - Name: Clear + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: SetColor ReturnType: nil Parameters: @@ -108,5 +116,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: Color series is a data type that represents a collection of color and points, also known as gradient. diff --git a/yaml/types/ColorValue.yaml b/yaml/types/ColorValue.yaml index dab02e0..2aba431 100644 --- a/yaml/types/ColorValue.yaml +++ b/yaml/types/ColorValue.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The value of this object. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: ColorValue is an object that holds a Color value. diff --git a/yaml/types/CoreUIService.yaml b/yaml/types/CoreUIService.yaml index 9e982ad..c3713b0 100644 --- a/yaml/types/CoreUIService.yaml +++ b/yaml/types/CoreUIService.yaml @@ -6,6 +6,7 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the user card (in the upper right hand corner above the leaderboard) is visible. - Name: UseChat @@ -13,46 +14,61 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the chat box is visible. - Name: UseHealthBar Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the player's health bar is visible. - Name: UseLeaderboard Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the player list/leaderboard is visible. - Name: UseHotbar Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the hot bar is visible. + - Name: UseBackpack + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: UseMenuButton Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the menu button is visible. - Name: UseEmoteWheel Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the emote wheel is visible. - Name: CanRespawn Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the player can respawn. Methods: [] Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: CoreUI Description: CoreUI is a static class that allows for the toggling of certain core GUI. diff --git a/yaml/types/CreatorContextService.yaml b/yaml/types/CreatorContextService.yaml index f558df0..22827b3 100644 --- a/yaml/types/CreatorContextService.yaml +++ b/yaml/types/CreatorContextService.yaml @@ -6,6 +6,7 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: CreatorContext Description: CreatorContextService is a service that manage per game specific tools, such as Selections and History. This class is only available in the creator. diff --git a/yaml/types/CreatorGUI.yaml b/yaml/types/CreatorGUI.yaml index 027f969..2abfc10 100644 --- a/yaml/types/CreatorGUI.yaml +++ b/yaml/types/CreatorGUI.yaml @@ -3,8 +3,9 @@ BaseType: PlayerGUI Properties: [] Methods: [] Events: [] -IsStatic: false +IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: PlayerGUI Description: CreatorGUI is an object that allows GUI to overlay on top of the viewport in the creator. This class is only available in the creator. diff --git a/yaml/types/CreatorHistory.yaml b/yaml/types/CreatorHistory.yaml index 5e7af3d..0c272f5 100644 --- a/yaml/types/CreatorHistory.yaml +++ b/yaml/types/CreatorHistory.yaml @@ -46,5 +46,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: CreatorHistory is a class that manages history (undo-redo) of this game instance. This class is only available in the creator. diff --git a/yaml/types/CreatorInterface.yaml b/yaml/types/CreatorInterface.yaml index 911135a..3187d7a 100644 --- a/yaml/types/CreatorInterface.yaml +++ b/yaml/types/CreatorInterface.yaml @@ -6,59 +6,69 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns the target tool mode - Name: TargetPartColor Type: Color IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns the target part color - Name: TargetPartMaterial Type: PartMaterialEnum IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns the target part material - Name: MoveSnapEnabled Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns the move snapping value - Name: MoveSnapping Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns whenever the move snapping is enabled by the user - Name: UserMoveSnapping Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns the move snapping value defined by the user - Name: RotateSnapEnabled Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns whenever the rotate snapping is enabled by the user - Name: RotateSnapping Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns the rotate snapping value - Name: UserRotateSnapping Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns the rotate snapping value defined by the user Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: CreatorInterface represent the user interface of the creator. This class is only available in the creator. diff --git a/yaml/types/CreatorSelections.yaml b/yaml/types/CreatorSelections.yaml index 1d3a44f..2b1c3ff 100644 --- a/yaml/types/CreatorSelections.yaml +++ b/yaml/types/CreatorSelections.yaml @@ -68,5 +68,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: CreatorSelections is an object that manages selections in the game instance. This class is only available in the creator. diff --git a/yaml/types/CreatorService.yaml b/yaml/types/CreatorService.yaml index 37d4aea..e777cae 100644 --- a/yaml/types/CreatorService.yaml +++ b/yaml/types/CreatorService.yaml @@ -6,24 +6,21 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: The interface - - Name: Clipboard - Type: CreatorClipboard - IsAccessibleByScripts: true - IsReadOnly: true - IsObsolete: false - Description: The clipboard - Name: CurrentGame Type: Game IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Current active game - Name: LocalTestActive Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns true if local test is active Methods: [] Events: @@ -36,5 +33,6 @@ Events: IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Creator Description: CreatorService is the class that manages the creator. This class is only available in the creator. diff --git a/yaml/types/Datastore.yaml b/yaml/types/Datastore.yaml index 7e1e720..63d898c 100644 --- a/yaml/types/Datastore.yaml +++ b/yaml/types/Datastore.yaml @@ -6,6 +6,7 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The key identifying this Datastore connection. Methods: - Name: GetAsync @@ -53,4 +54,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: Datastore is an object that represent datastore connection. diff --git a/yaml/types/DatastoreService.yaml b/yaml/types/DatastoreService.yaml index c0b89b4..0c80a7b 100644 --- a/yaml/types/DatastoreService.yaml +++ b/yaml/types/DatastoreService.yaml @@ -17,5 +17,6 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Datastore Description: Datastore (not to be confused with the Datastore data type) is a service used for storing data between place sessions. diff --git a/yaml/types/Decal.yaml b/yaml/types/Decal.yaml index 82fff15..b6bb9d9 100644 --- a/yaml/types/Decal.yaml +++ b/yaml/types/Decal.yaml @@ -6,23 +6,27 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The image texture applied to the decal. - Name: Energy Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Energy multiplier for the decal. - Name: Color Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color tint applied to the decal. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Decals are objects that can have an image texture and are wrapped around other objects. diff --git a/yaml/types/Dynamic.yaml b/yaml/types/Dynamic.yaml index 6e1c518..a13e1c3 100644 --- a/yaml/types/Dynamic.yaml +++ b/yaml/types/Dynamic.yaml @@ -6,66 +6,84 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The position of the object. - Name: Rotation Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The rotation of the object. - Name: Size Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The size of the object. - Name: LocalPosition Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The position of the object relative to its parent. - Name: LocalRotation Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The rotation of the object relative to its parent. - Name: LocalSize Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The size of the object relative to its parent. - Name: Quaternion Type: Quaternion IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The rotation of the object represented as a quaternion. + - Name: LocalQuaternion + Type: Quaternion + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: Locked Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the object can be selected in the Creator. - Name: Forward Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The forward direction vector of the object. - Name: Right Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The right direction vector of the object. - Name: Up Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The up direction vector of the object. Methods: - Name: LookAt @@ -212,5 +230,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Dynamic is the base class where all objects with a position, rotation and scale derive from. diff --git a/yaml/types/Entity.yaml b/yaml/types/Entity.yaml index f11c41c..fcb5171 100644 --- a/yaml/types/Entity.yaml +++ b/yaml/types/Entity.yaml @@ -6,54 +6,63 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color of the entity. - Name: CastShadows Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the entity casts shadows. - Name: IsSpawn Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the part can be used as a spawn location or not. - Name: UseGravity Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the entity is affected by gravity. - Name: Mass Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the mass of the entity. - Name: Friction Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the friction of the entity. - Name: Drag Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the drag (air resistance) of the entity. - Name: AngularDrag Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the angular drag of the entity. - Name: Bounciness Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the bounciness of the entity. Methods: - Name: AddForce @@ -139,5 +148,6 @@ Events: [] IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Entity represents a physics object that's related to building blocks (inherited by Part and Mesh) diff --git a/yaml/types/Environment.yaml b/yaml/types/Environment.yaml index e59bb8c..8a08b6d 100644 --- a/yaml/types/Environment.yaml +++ b/yaml/types/Environment.yaml @@ -6,24 +6,28 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the current camera which player is using to view - Name: Gravity Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The direction and strength of gravity in the world. - Name: PartDestroyHeight Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The height at which unanchored parts are destroyed when they fall below it. - Name: AutoGenerateNavMesh Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not to automatically build a navigation mesh for NPC pathfinding. This property is disabled by default so there are no performance issues with larger maps. @@ -143,5 +147,6 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Environment Description: Environment is the primary object intended for storing active objects in the place. diff --git a/yaml/types/Explosion.yaml b/yaml/types/Explosion.yaml index 35a15c6..6bde34e 100644 --- a/yaml/types/Explosion.yaml +++ b/yaml/types/Explosion.yaml @@ -6,12 +6,14 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the radius of this explosion - Name: Force Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the force of this explosion that will be applied to affected hits - Name: AffectAnchored @@ -19,18 +21,21 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines if this explosion should affect anchored parts or not - Name: Damage Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Damage that is affected to player - Name: AffectPredicate Type: function IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: |- A predicate function deciding whenever this part should be accepted or not @@ -51,5 +56,6 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Explosion is a deadly explosion killing players and applying force to parts at the given position. diff --git a/yaml/types/FileLinkAsset.yaml b/yaml/types/FileLinkAsset.yaml index ca7d2dd..78956b2 100644 --- a/yaml/types/FileLinkAsset.yaml +++ b/yaml/types/FileLinkAsset.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: false IsReadOnly: false IsObsolete: false + IsStatic: false Description: The ID of the file Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Represents a link to a file path in the file system diff --git a/yaml/types/FilterService.yaml b/yaml/types/FilterService.yaml index 1402efa..cd55561 100644 --- a/yaml/types/FilterService.yaml +++ b/yaml/types/FilterService.yaml @@ -17,4 +17,5 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Filter Description: FilterService is a service which processes and filter user inputs diff --git a/yaml/types/Folder.yaml b/yaml/types/Folder.yaml index e361493..717afc0 100644 --- a/yaml/types/Folder.yaml +++ b/yaml/types/Folder.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Folder is similar to a model, used for storing objects in the place. diff --git a/yaml/types/FontAsset.yaml b/yaml/types/FontAsset.yaml index 410fd48..42525f0 100644 --- a/yaml/types/FontAsset.yaml +++ b/yaml/types/FontAsset.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Base class for font assets diff --git a/yaml/types/GUI.yaml b/yaml/types/GUI.yaml index 918d736..863574f 100644 --- a/yaml/types/GUI.yaml +++ b/yaml/types/GUI.yaml @@ -1,9 +1,31 @@ Name: GUI -BaseType: UIField -Properties: [] +BaseType: Instance +Properties: + - Name: Visible + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: ZIndex + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: AbsoluteSize + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + IsStatic: false + Description: Missing Documentation Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: GUI is a class that is used to create a GUI. diff --git a/yaml/types/GUI3D.yaml b/yaml/types/GUI3D.yaml index 33ddf38..180e951 100644 --- a/yaml/types/GUI3D.yaml +++ b/yaml/types/GUI3D.yaml @@ -6,24 +6,28 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the canvas size for this GUI - Name: Shaded Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines if this GUI3D should be affected by lighting - Name: FaceCamera Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines if this GUI3D always face the camera? - Name: Transparent Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines if the background should be transparent. Recommended to be set to false if transparent background is not needed. Methods: [] @@ -31,4 +35,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: GUI3D is a class that allows GUI to be displayed in a 3D space. diff --git a/yaml/types/Game.yaml b/yaml/types/Game.yaml index ac27728..ca166e4 100644 --- a/yaml/types/Game.yaml +++ b/yaml/types/Game.yaml @@ -6,30 +6,35 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns true if this current session is being tested locally - Name: GameID Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The ID of the current Polytoria place. - Name: ServerID Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The server ID of the current instance. - Name: UpTime Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The uptime of this game in seconds. - Name: InstanceCount Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The total number of instances currently loaded. Methods: [] Events: @@ -45,5 +50,6 @@ Events: IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: game Description: Game is the root object in the Polytoria instance tree. It is the object from which everything is descended. diff --git a/yaml/types/Grabbable.yaml b/yaml/types/Grabbable.yaml index c4f36ee..8dd99a8 100644 --- a/yaml/types/Grabbable.yaml +++ b/yaml/types/Grabbable.yaml @@ -6,30 +6,35 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the force used to drag this object. - Name: MaxRange Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the max range that this object can be dragged. - Name: PermissionMode Type: GrabbablePermissionModeEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the permission mode for this grabber - Name: Dragger Type: Player IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns the current dragger - Name: PermissionPredicate Type: function IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: >- A predicate function deciding whenever this player can grab this object. `PermissionMode` must be set to `GrabbablePermissionMode.Scripted` @@ -59,5 +64,6 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Grabbable represents a object that can be dragged by user. It can be parented to Physical to give user ability to drag that object. diff --git a/yaml/types/GradientSky.yaml b/yaml/types/GradientSky.yaml index fa1a3a7..c07ab03 100644 --- a/yaml/types/GradientSky.yaml +++ b/yaml/types/GradientSky.yaml @@ -6,76 +6,89 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the color emitting off the sun. - Name: SunDiscMultiplier Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the multiplier of the sun. - Name: SunDiscExponent Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the exponent of the sun. - Name: SunHaloColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the color of the sun halo. - Name: SunHaloExponent Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the exponent of the sun halo. - Name: SunHaloContribution Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the contribution of the sun halo. - Name: HorizonLineColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the horizon line's color. - Name: HorizonLineExponent Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the horizon line's exponent. - Name: HorizonLineContribution Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines how much the horizon line contributes. - Name: SkyGradientTop Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the top color of the gradient. - Name: SkyGradientBottom Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the bottom color of the gradient. - Name: SkyGradientExponent Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the gradient's exponent. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: GradientSky is a class that is used to set a gradient skybox in the world. diff --git a/yaml/types/Hidden.yaml b/yaml/types/Hidden.yaml index 9958c06..134673e 100644 --- a/yaml/types/Hidden.yaml +++ b/yaml/types/Hidden.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: Hidden is a object used for hiding instances. diff --git a/yaml/types/HttpRequestData.yaml b/yaml/types/HttpRequestData.yaml index 57c5a72..1608740 100644 --- a/yaml/types/HttpRequestData.yaml +++ b/yaml/types/HttpRequestData.yaml @@ -6,24 +6,28 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The target endpoint of the HTTP request. - Name: Method Type: HttpRequestMethodEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The HTTP method used for the request. - Name: Body Type: string IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The payload sent with the request. - Name: Headers Type: table IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: A table of HTTP headers to include with the request, represented as key-value pairs. Methods: @@ -38,4 +42,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: HttpRequestData represents the data required to construct an HTTP request diff --git a/yaml/types/HttpResponseData.yaml b/yaml/types/HttpResponseData.yaml index af4fe95..8260a19 100644 --- a/yaml/types/HttpResponseData.yaml +++ b/yaml/types/HttpResponseData.yaml @@ -6,18 +6,21 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the HTTP request completed successfully. - Name: StatusCode Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The HTTP status code returned by the server. - Name: Headers Type: table IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: A table containing the HTTP response headers returned by the server, represented as key-value pairs. - Name: Body @@ -25,10 +28,12 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The response payload returned by the server as a string buffer. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: HttpResponseData represents the result of an HTTP request. diff --git a/yaml/types/HttpService.yaml b/yaml/types/HttpService.yaml index d789b6f..1a804a8 100644 --- a/yaml/types/HttpService.yaml +++ b/yaml/types/HttpService.yaml @@ -108,4 +108,5 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Http Description: Http is a service used for HTTP communications and requests. diff --git a/yaml/types/IOService.yaml b/yaml/types/IOService.yaml index 5317ca0..94a2371 100644 --- a/yaml/types/IOService.yaml +++ b/yaml/types/IOService.yaml @@ -61,5 +61,6 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: IO Description: Class for interacting with IO in project, only usable with scripts with the respective permission. diff --git a/yaml/types/Image3D.yaml b/yaml/types/Image3D.yaml index 11a02cb..44f4998 100644 --- a/yaml/types/Image3D.yaml +++ b/yaml/types/Image3D.yaml @@ -6,46 +6,54 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Specifies the image of the decal. - Name: TextureScale Type: Vector2 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The scale of the texture on the decal. - Name: TextureOffset Type: Vector2 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The offset of the texture on the decal. - Name: Color Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the color of the decal. - Name: CastShadows Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the decal should cast shadows. - Name: Shaded Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the decal should be affected by lighting. - Name: FaceCamera Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not the decal should always face the camera. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Decals are objects that can have an image texture and are placed in the world. diff --git a/yaml/types/ImageAsset.yaml b/yaml/types/ImageAsset.yaml index 03a1367..535e89a 100644 --- a/yaml/types/ImageAsset.yaml +++ b/yaml/types/ImageAsset.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Base class for image assets diff --git a/yaml/types/InputAction.yaml b/yaml/types/InputAction.yaml index 18d9e0d..34b569f 100644 --- a/yaml/types/InputAction.yaml +++ b/yaml/types/InputAction.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: Base class for input action diff --git a/yaml/types/InputActionAxis.yaml b/yaml/types/InputActionAxis.yaml index 3b24b69..9d3f65a 100644 --- a/yaml/types/InputActionAxis.yaml +++ b/yaml/types/InputActionAxis.yaml @@ -6,22 +6,26 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Collection of negative inputs - Name: Positive Type: InputButtonCollection IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Collection of positive inputs - Name: Value Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The value of the input Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: InputActionAxis is a class that represents input action of axis type. diff --git a/yaml/types/InputActionButton.yaml b/yaml/types/InputActionButton.yaml index 99906b7..eb5249c 100644 --- a/yaml/types/InputActionButton.yaml +++ b/yaml/types/InputActionButton.yaml @@ -6,12 +6,14 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Collection of button inputs. - Name: IsPressed Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Returns true if any of the button in the collection is currently being pressed. - Name: Weight @@ -19,6 +21,7 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Returns the current analog input of the button. Methods: [] Events: @@ -31,4 +34,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: InputActionButton is a class that represents input action of button type. diff --git a/yaml/types/InputActionVector2.yaml b/yaml/types/InputActionVector2.yaml index b2c2c6b..3680eb9 100644 --- a/yaml/types/InputActionVector2.yaml +++ b/yaml/types/InputActionVector2.yaml @@ -6,34 +6,40 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Collection of up inputs. - Name: Down Type: InputButtonCollection IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Collection of down inputs. - Name: Left Type: InputButtonCollection IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Collection of left inputs. - Name: Right Type: InputButtonCollection IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Collection of right inputs. - Name: Value Type: Vector2 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The value of this input Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: InputActionVector2 is a class that represents input action of Vector2 type. diff --git a/yaml/types/InputButton.yaml b/yaml/types/InputButton.yaml index 7abf1da..e4b6e54 100644 --- a/yaml/types/InputButton.yaml +++ b/yaml/types/InputButton.yaml @@ -6,6 +6,7 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Key code for this button Methods: - Name: New @@ -26,8 +27,24 @@ Methods: IsObsolete: false IsStatic: true Description: Create new button of this keycode + - Name: __eq + ReturnType: boolean + Parameters: + - Name: a + Type: InputButton + IsOptional: false + DefaultValue: "" + - Name: b + Type: InputButton + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: InputButton is a class that represents a button KeyCode diff --git a/yaml/types/InputButtonCollection.yaml b/yaml/types/InputButtonCollection.yaml index be4fc61..90c4fd1 100644 --- a/yaml/types/InputButtonCollection.yaml +++ b/yaml/types/InputButtonCollection.yaml @@ -28,4 +28,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: A collection of Input Buttons diff --git a/yaml/types/InputService.yaml b/yaml/types/InputService.yaml index a39f5de..c0a8a5d 100644 --- a/yaml/types/InputService.yaml +++ b/yaml/types/InputService.yaml @@ -6,66 +6,77 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the game window is currently focused. - Name: IsTouchscreen Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the input device is a touchscreen. - Name: IsGameFocused Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the game is currently focused. - Name: IsInputFocused Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether an input is currently focused. - Name: IsGamepadConnected Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether a gamepad is currently connected. - Name: IsMenuOpened Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the game menu is currently opened. - Name: CursorLocked Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the cursor is currently locked. - Name: CursorVisible Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the cursor is currently visible. - Name: MousePosition Type: Vector2 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates the current position of the mouse cursor. - Name: ScreenWidth Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates the width of the screen. - Name: ScreenHeight Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates the height of the screen. Methods: - Name: GetMouseWorldPosition @@ -179,5 +190,6 @@ Events: IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Input Description: InputService is a class used for retrieving user input data, such as the mouse and keyboard. diff --git a/yaml/types/InsertService.yaml b/yaml/types/InsertService.yaml index 6f7921e..dcad7a1 100644 --- a/yaml/types/InsertService.yaml +++ b/yaml/types/InsertService.yaml @@ -39,5 +39,6 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Insert Description: Insert is a class used for inserting user-generated models into your game via scripts. diff --git a/yaml/types/Instance.yaml b/yaml/types/Instance.yaml index 1195419..bafd454 100644 --- a/yaml/types/Instance.yaml +++ b/yaml/types/Instance.yaml @@ -6,12 +6,14 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Defines the parent of this instance in the hierarchy. - Name: EditableChildren Type: boolean IsAccessibleByScripts: false IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determine if children is editable, this is to be used if this instance is a Linked model. Only used in creator. - Name: Tags @@ -19,6 +21,7 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Tags associated with this instance. Methods: - Name: GetDescendants @@ -65,6 +68,28 @@ Methods: IsObsolete: false IsStatic: false Description: Finds a child of this instance by class name. + - Name: FindAncestorByClass + ReturnType: Instance + Parameters: + - Name: className + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: FindChildByIndex + ReturnType: Instance + Parameters: + - Name: index + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: MoveChild ReturnType: nil Parameters: @@ -208,6 +233,28 @@ Methods: IsObsolete: false IsStatic: false Description: Sets the parent of this instance. + - Name: __index + ReturnType: any + Parameters: + - Name: indexer + Type: any + IsOptional: false + DefaultValue: null + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: __newindex + ReturnType: nil + Parameters: + - Name: indexer + Type: any + IsOptional: false + DefaultValue: null + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation Events: - Name: ChildAdded Arguments: @@ -233,5 +280,6 @@ Events: IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Instance is the base class of all classes. Every class derives from it and has all properties, events and functions Instance has. diff --git a/yaml/types/InstanceValue.yaml b/yaml/types/InstanceValue.yaml index f84e7ad..947f2a6 100644 --- a/yaml/types/InstanceValue.yaml +++ b/yaml/types/InstanceValue.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The value of this object. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: InstanceValue is an object that holds an Instance value. diff --git a/yaml/types/IntValue.yaml b/yaml/types/IntValue.yaml index 1fc2609..e578947 100644 --- a/yaml/types/IntValue.yaml +++ b/yaml/types/IntValue.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The value of this object. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: IntValue is an object that holds an integer value. diff --git a/yaml/types/InteractionPrompt.yaml b/yaml/types/InteractionPrompt.yaml index 9098a71..1756261 100644 --- a/yaml/types/InteractionPrompt.yaml +++ b/yaml/types/InteractionPrompt.yaml @@ -6,30 +6,35 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: WIP - Name: SubTitle Type: string IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: WIP - Name: HoldDuration Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: WIP - Name: Key Type: KeyCodeEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: WIP - Name: UseDefaultUI Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: WIP Methods: [] Events: @@ -45,4 +50,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: WIP class, not functional yet diff --git a/yaml/types/Inventory.yaml b/yaml/types/Inventory.yaml index e7bc2ef..1f0a9b2 100644 --- a/yaml/types/Inventory.yaml +++ b/yaml/types/Inventory.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: Inventory is a container for Tools, equippable by player. diff --git a/yaml/types/Light.yaml b/yaml/types/Light.yaml index 054fdbf..4ab9c95 100644 --- a/yaml/types/Light.yaml +++ b/yaml/types/Light.yaml @@ -6,28 +6,33 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Sets the color of the light. - Name: Brightness Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Sets the brightness of the light. - Name: Specular Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Sets the specular intensity of the light. - Name: Shadows Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Enables or disables shadows cast by the light. Methods: [] Events: [] IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Light is an abstract base class for all light objects in the world. diff --git a/yaml/types/Lighting.yaml b/yaml/types/Lighting.yaml index a1f38d2..f250adb 100644 --- a/yaml/types/Lighting.yaml +++ b/yaml/types/Lighting.yaml @@ -6,48 +6,56 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Sets the skybox to one of the preset skyboxes. - Name: AmbientSource Type: AmbientSourceEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the source of ambient lighting in the place. - Name: AmbientColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Sets the ambient color of the lighting in the place. - Name: FogEnabled Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Enables or disables fog in the place. - Name: FogColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Sets the color of the fog in the place. - Name: FogStartDistance Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Sets the distance from the camera at which fog begins to appear. - Name: FogEndDistance Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Sets the distance from the camera at which fog stops appearing. Methods: [] Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Lighting Description: Lighting is responsible for controlling the state of the lighting in the place. It provides many different options for creators to enhance and fine-tune the visuals of their worlds. diff --git a/yaml/types/LightingModifier.yaml b/yaml/types/LightingModifier.yaml index 0442dc2..24c7d3f 100644 --- a/yaml/types/LightingModifier.yaml +++ b/yaml/types/LightingModifier.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Base class for lighting modifiers diff --git a/yaml/types/Marker3D.yaml b/yaml/types/Marker3D.yaml index f407765..506b0e4 100644 --- a/yaml/types/Marker3D.yaml +++ b/yaml/types/Marker3D.yaml @@ -6,17 +6,20 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Length of this Marker - Name: AppearOnTop Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determine if this marker should appear on top of everything else in 3D Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Marker3D is a object that allows marking a specific point in world. This will hint an axis gizmo in local test and creator. diff --git a/yaml/types/Mesh.yaml b/yaml/types/Mesh.yaml index d4c7a62..a74fae4 100644 --- a/yaml/types/Mesh.yaml +++ b/yaml/types/Mesh.yaml @@ -6,54 +6,63 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The mesh asset used by this Mesh. - Name: IncludeOffset Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Whether to keep the offset of the mesh or recenter it. - Name: CollisionType Type: CollisionTypeEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The type of collision shape to apply to the mesh. - Name: PlayAnimationOnStart Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Whether to play the mesh's animation automatically when the mesh is loaded. - Name: UsePartColor Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Whether to use the color of the part this mesh is attached to. - Name: Color Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color of the mesh. - Name: CastShadows Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Whether the mesh casts shadows. - Name: CurrentAnimation Type: string IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates the name of the current animation playing on the mesh. - Name: IsAnimationPlaying Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether an animation is currently playing on the mesh. Methods: - Name: PlayAnimation @@ -93,10 +102,18 @@ Methods: IsObsolete: false IsStatic: false Description: Gets a list of all animations available on the mesh. + - Name: GetAnimationInfo + ReturnType: table + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Represents a part that can have custom mesh applied to it, the mesh may be from the Polytoria Store (Hats, Tools and Heads) or user-uploaded meshes. diff --git a/yaml/types/MeshAnimationInfo.yaml b/yaml/types/MeshAnimationInfo.yaml new file mode 100644 index 0000000..2bd8dab --- /dev/null +++ b/yaml/types/MeshAnimationInfo.yaml @@ -0,0 +1,31 @@ +Name: MeshAnimationInfo +BaseType: null +Properties: + - Name: Name + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: Length + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: IsPlaying + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +StaticAlias: null +Description: Missing Documentation diff --git a/yaml/types/MeshAsset.yaml b/yaml/types/MeshAsset.yaml index 53d76af..6ab54ad 100644 --- a/yaml/types/MeshAsset.yaml +++ b/yaml/types/MeshAsset.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Base class for mesh assets diff --git a/yaml/types/Model.yaml b/yaml/types/Model.yaml index 6d372bb..0678716 100644 --- a/yaml/types/Model.yaml +++ b/yaml/types/Model.yaml @@ -6,5 +6,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Model is an instance that can hold other instances, and which transform affects its children. diff --git a/yaml/types/ModuleScript.yaml b/yaml/types/ModuleScript.yaml index 963731d..c1416e2 100644 --- a/yaml/types/ModuleScript.yaml +++ b/yaml/types/ModuleScript.yaml @@ -6,6 +6,7 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: ModuleScripts are specialized scripts to hold data that can be accessed by other scripts using the require() function. It is important to define and return a table in a ModuleScript. When the place starts, the server diff --git a/yaml/types/NPC.yaml b/yaml/types/NPC.yaml index ce9ad76..70b6950 100644 --- a/yaml/types/NPC.yaml +++ b/yaml/types/NPC.yaml @@ -6,120 +6,140 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The offset to the seat at which the NPC is positioned when sitting. - Name: Health Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The current health of the NPC. - Name: MaxHealth Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The maximum health of the NPC. - Name: JumpPower Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the jump power of the NPC. - Name: WalkSpeed Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the walking speed of the NPC. - Name: UseNametag Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the NPC uses a nametag. - Name: NametagOffset Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the offset position of the NPC's nametag. - Name: DisplayName Type: string IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the display name of the NPC. - Name: JumpSound Type: Sound IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the sound played when the NPC jumps. - Name: IsSitting Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the NPC is currently sitting. - Name: IsDead Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the NPC is currently dead. - Name: HoldingTool Type: Tool IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates the tool currently held by the NPC. - Name: SittingIn Type: Seat IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates the seat in which the NPC is currently sitting. - Name: Character Type: CharacterModel IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The character model associated with the NPC. - Name: MoveTarget Type: Dynamic IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the instance the NPC should walk towards. - Name: OnGround Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the NPC is currently on the ground. - Name: OnCeiling Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the NPC is currently on the ceiling. - Name: NavDestinationDistance Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates the distance to the navigation destination. - Name: NavDestinationReached Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the NPC has reached its navigation destination. - Name: NavDestinationValid Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the navigation destination is valid. Methods: - Name: Kill @@ -247,6 +267,7 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: NPC (non-player character) is an object similar to a Player but that can be controlled by code. Like players, it can walk and jump, and its body part colors can be customized. diff --git a/yaml/types/NetMessage.yaml b/yaml/types/NetMessage.yaml index a222dab..2879d93 100644 --- a/yaml/types/NetMessage.yaml +++ b/yaml/types/NetMessage.yaml @@ -221,5 +221,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: Represents a network message used for communication between clients and servers. diff --git a/yaml/types/NetworkEvent.yaml b/yaml/types/NetworkEvent.yaml index 07095d1..151e185 100644 --- a/yaml/types/NetworkEvent.yaml +++ b/yaml/types/NetworkEvent.yaml @@ -6,6 +6,7 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false 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 arrive reliably. @@ -69,6 +70,7 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null 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/NetworkedObject.yaml b/yaml/types/NetworkedObject.yaml index 0e6ee28..e6a2580 100644 --- a/yaml/types/NetworkedObject.yaml +++ b/yaml/types/NetworkedObject.yaml @@ -6,24 +6,28 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Name of this object - Name: ClassName Type: string IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Class name of this object - Name: Shared Type: ScriptSharedTable IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: A shared table accessible by scripts. - Name: NetworkedObjectID Type: string IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns networked ID of this object. Networked ID are always unique per network session. - Name: ObjectID @@ -31,12 +35,14 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns object ID of this object. Object ID originates from the .poly file. - Name: ExistInNetwork Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns true if this object exists in network, false if this object is spawned by the local client. Methods: @@ -85,6 +91,32 @@ Methods: IsObsolete: false IsStatic: false Description: Deletes the instance (same as Destroy method) + - Name: __tostring + ReturnType: string + Parameters: + - Name: obj + Type: NetworkedObject + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __eq + ReturnType: boolean + Parameters: + - Name: a + Type: any + IsOptional: false + DefaultValue: "" + - Name: b + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation Events: - Name: PropertyChanged Arguments: @@ -103,5 +135,6 @@ Events: IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null 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 d64148a..4d8de16 100644 --- a/yaml/types/NewServerRequestData.yaml +++ b/yaml/types/NewServerRequestData.yaml @@ -6,12 +6,14 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Target place path. - Name: MaxPlayers Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: How much player slot should the new server allocates for. Methods: - Name: New @@ -25,5 +27,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: NewServerRequestData represents the request data for a new server instance, to be used with PlacesService. diff --git a/yaml/types/NumberRange.yaml b/yaml/types/NumberRange.yaml index 1e74823..a319ad5 100644 --- a/yaml/types/NumberRange.yaml +++ b/yaml/types/NumberRange.yaml @@ -1,17 +1,19 @@ Name: NumberRange -BaseType: ValueType +BaseType: null Properties: - Name: Min Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the minimum value of the range. - Name: Max Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the maximum value of the range. Methods: - Name: New @@ -46,5 +48,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: NumberRange is a data type that represents a range between two numbers, defined by a minimum and maximum value. diff --git a/yaml/types/NumberValue.yaml b/yaml/types/NumberValue.yaml index 9160191..bba50c4 100644 --- a/yaml/types/NumberValue.yaml +++ b/yaml/types/NumberValue.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The value of this object. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: NumberValue is an object that holds a number value. diff --git a/yaml/types/PTAudioAsset.yaml b/yaml/types/PTAudioAsset.yaml index ce5f336..df425ea 100644 --- a/yaml/types/PTAudioAsset.yaml +++ b/yaml/types/PTAudioAsset.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: false IsReadOnly: false IsObsolete: false + IsStatic: false Description: The audio ID to load Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Audio asset which is loaded from Polytoria diff --git a/yaml/types/PTCallback.yaml b/yaml/types/PTCallback.yaml index c74877d..f9bc426 100644 --- a/yaml/types/PTCallback.yaml +++ b/yaml/types/PTCallback.yaml @@ -6,5 +6,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: A function that doesn't expect a return value. This will sometimes be referred as `function` diff --git a/yaml/types/PTFunction.yaml b/yaml/types/PTFunction.yaml index 61e64e8..a9852a0 100644 --- a/yaml/types/PTFunction.yaml +++ b/yaml/types/PTFunction.yaml @@ -6,5 +6,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: A function that expects a return value. This will sometimes be referred as `function` diff --git a/yaml/types/PTImageAsset.yaml b/yaml/types/PTImageAsset.yaml index d176db8..31ff499 100644 --- a/yaml/types/PTImageAsset.yaml +++ b/yaml/types/PTImageAsset.yaml @@ -6,16 +6,19 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Asset ID of this image - Name: ImageType Type: ImageTypeEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Image type of this image Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: An image asset that's loaded from Polytoria. diff --git a/yaml/types/PTMeshAsset.yaml b/yaml/types/PTMeshAsset.yaml index 4e41854..0ac2686 100644 --- a/yaml/types/PTMeshAsset.yaml +++ b/yaml/types/PTMeshAsset.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: false IsReadOnly: false IsObsolete: false + IsStatic: false Description: Asset ID of this mesh Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: A mesh asset that's loaded from Polytoria. diff --git a/yaml/types/PTSignal.yaml b/yaml/types/PTSignal.yaml index dd03ab9..6728e97 100644 --- a/yaml/types/PTSignal.yaml +++ b/yaml/types/PTSignal.yaml @@ -24,6 +24,17 @@ Methods: IsObsolete: false IsStatic: false Description: Disconnect a function from this signal + - Name: __tostring + ReturnType: string + Parameters: + - Name: signal + Type: PTSignal + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation - Name: Wait ReturnType: any Parameters: [] @@ -46,4 +57,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: A signal which scripts can subscribe to diff --git a/yaml/types/Part.yaml b/yaml/types/Part.yaml index 8085515..197d617 100644 --- a/yaml/types/Part.yaml +++ b/yaml/types/Part.yaml @@ -6,28 +6,33 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the shape of the part. - Name: Material Type: PartMaterialEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the material of the part. - Name: Color Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the color of the part. - Name: CastShadows Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the part casts shadows. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Parts represent the basic building blocks of the world. diff --git a/yaml/types/Particles.yaml b/yaml/types/Particles.yaml index 14cca26..9d2fefb 100644 --- a/yaml/types/Particles.yaml +++ b/yaml/types/Particles.yaml @@ -6,42 +6,49 @@ Properties: IsAccessibleByScripts: false IsReadOnly: false IsObsolete: false + IsStatic: false Description: The image used for the particles. - Name: Color Type: ColorSeries IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color gradient used for the particles. - Name: Lifetime Type: NumberRange IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the lifetime of a particle. - Name: Amount Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the number of particles emitted. - Name: Gravity Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the gravity effect applied to the particles. - Name: Shaded Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the particles are shaded. - Name: Autoplay Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the particle system plays automatically. Methods: - Name: Play @@ -73,5 +80,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Particles represents a particle system that can be used to create various visual effects. diff --git a/yaml/types/Physical.yaml b/yaml/types/Physical.yaml index 44d5ab6..ed9cc12 100644 --- a/yaml/types/Physical.yaml +++ b/yaml/types/Physical.yaml @@ -6,24 +6,28 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether this object is affected by physics. - Name: CanCollide Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether this object can collide with other objects. - Name: Velocity Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the linear velocity of this object. - Name: AngularVelocity Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the angular velocity of this object. Methods: - Name: SetNetworkAuthority @@ -37,6 +41,13 @@ Methods: IsObsolete: false IsStatic: false Description: Sets the network authority of this object to the specified player. + - Name: GetTouching + ReturnType: table + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: MovePosition ReturnType: nil Parameters: @@ -84,4 +95,5 @@ Events: IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Physical represents an object affected by physics in the world. diff --git a/yaml/types/PhysicalModel.yaml b/yaml/types/PhysicalModel.yaml index 1ed7308..ff2b9d0 100644 --- a/yaml/types/PhysicalModel.yaml +++ b/yaml/types/PhysicalModel.yaml @@ -6,5 +6,6 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: PhysicalModel is a object that represent a group of objects, that's affected by physics. diff --git a/yaml/types/PlacesService.yaml b/yaml/types/PlacesService.yaml index b5737b4..1077da1 100644 --- a/yaml/types/PlacesService.yaml +++ b/yaml/types/PlacesService.yaml @@ -88,4 +88,5 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Places Description: PlacesService is a service that is used to join players to other places diff --git a/yaml/types/Player.yaml b/yaml/types/Player.yaml index c46ad63..b426339 100644 --- a/yaml/types/Player.yaml +++ b/yaml/types/Player.yaml @@ -6,126 +6,147 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The unique ID of the player. - Name: CanMove Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the player can move. - Name: SprintSpeed Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the sprinting speed of the player. - Name: Stamina Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the current stamina of the player. - Name: MaxStamina Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the maximum stamina of the player. - Name: UseStamina Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the player uses stamina. - Name: StaminaRegen Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the rate at which the player's stamina regenerates. - Name: StaminaBurn Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the rate at which the player's stamina depletes while sprinting. - Name: RespawnTime Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the time the player has to wait before respawning. - Name: UseHeadTurning Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the player uses head turning. - Name: UseBubbleChat Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the player uses bubble chat. - Name: AutoLoadAppearance Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the player's appearance is automatically loaded. - Name: NetworkPing Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The amount of network latency (ping) the player is experiencing. - Name: IsAdmin Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Determines whether the player is an administrator. - Name: IsCreator Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Determines whether the player is the creator of the game. - Name: ChatColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the chat color of the player. - Name: IsLocal Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Determines whether the player is the local player. - Name: IsClimbing Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Determines whether the player is currently climbing. - Name: ClimbingTruss Type: Truss IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Determines the truss the player is currently climbing. - Name: UserPlatform Type: ClientPlatformEnum IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Determines the platform the player is using. - Name: Inventory Type: Inventory IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The inventory of the player. Methods: - Name: Jump @@ -179,4 +200,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: Player represents a user playing the game. diff --git a/yaml/types/PlayerDefaults.yaml b/yaml/types/PlayerDefaults.yaml index 1189ec8..3512f4b 100644 --- a/yaml/types/PlayerDefaults.yaml +++ b/yaml/types/PlayerDefaults.yaml @@ -6,96 +6,112 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The default maximum health of the player. - Name: WalkSpeed Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The default walking speed of the player. - Name: SprintSpeed Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The default sprinting speed of the player. - Name: JumpPower Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The default jump power of the player. - Name: RespawnTime Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The default time the player has to wait before respawning. - Name: ChatColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The default chat color of the player. - Name: CanMove Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the player can move by default. - Name: StaminaBurn Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The rate at which the player's stamina depletes while sprinting. - Name: UseStamina Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the player uses stamina. - Name: StaminaEnabled Type: boolean IsAccessibleByScripts: false IsReadOnly: false IsObsolete: false + IsStatic: false Description: Legacy value for stamina. - Name: Stamina Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the default stamina of players. - Name: MaxStamina Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the default maximum stamina of players. - Name: StaminaRegen Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the rate at which the player's stamina regenerates. - Name: UseHeadTurning Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the player uses head turning by default. - Name: UseBubbleChat Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the player uses bubble chat by default. - Name: AutoLoadAppearance Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the player's appearance is automatically loaded by default. Methods: @@ -110,5 +126,6 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: PlayerDefaults Description: PlayerDefaults is a service used for storing the default values of the Player when created. diff --git a/yaml/types/PlayerGUI.yaml b/yaml/types/PlayerGUI.yaml index b37d7d6..fa08c3c 100644 --- a/yaml/types/PlayerGUI.yaml +++ b/yaml/types/PlayerGUI.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: PlayerGUI Description: PlayerGUI is a class that contains all custom GUIs. diff --git a/yaml/types/Players.yaml b/yaml/types/Players.yaml index 68788ce..35a96f0 100644 --- a/yaml/types/Players.yaml +++ b/yaml/types/Players.yaml @@ -6,18 +6,21 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The player who is currently playing the game. - Name: PlayerCollisionEnabled Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether or not collisions between players are enabled. - Name: PlayersCount Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The number of players currently in the game. Methods: - Name: GetPlayers @@ -63,4 +66,5 @@ Events: IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Players Description: Players is the container class for all Player instances. diff --git a/yaml/types/PointLight.yaml b/yaml/types/PointLight.yaml index bc7302c..636d4fc 100644 --- a/yaml/types/PointLight.yaml +++ b/yaml/types/PointLight.yaml @@ -6,11 +6,13 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The range of the point light's illumination. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: PointLight is a type of light that emits light in all directions from a single point. diff --git a/yaml/types/PolytorianModel.yaml b/yaml/types/PolytorianModel.yaml index 688d97f..8487f20 100644 --- a/yaml/types/PolytorianModel.yaml +++ b/yaml/types/PolytorianModel.yaml @@ -6,72 +6,84 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The head color - Name: TorsoColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The torso color - Name: LeftArmColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The left arm color - Name: RightArmColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The right arm color - Name: LeftLegColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The left leg color - Name: RightLegColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The right leg color - Name: FaceImage Type: ImageAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The face image to use - Name: ShirtImage Type: ImageAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The shirt image to use - Name: PantsImage Type: ImageAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The pants image to use - Name: TorsoMesh Type: MeshAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The torso mesh to use - Name: Ragdolling Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false 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` - Name: RagdollRotation @@ -79,6 +91,7 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns the current global ragdoll rotation, if ragdoll haven't starts yet. Returns `Vector3.Zero` Methods: @@ -129,6 +142,73 @@ Methods: IsObsolete: false IsStatic: false Description: Clear current appearance. + - Name: SetBoneOverrideTo + ReturnType: nil + Parameters: + - Name: attachment + Type: CharacterAttachmentEnum + IsOptional: false + DefaultValue: "" + - Name: to + Type: boolean + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Set Bone override mode + - Name: SetBoneOverridePosition + ReturnType: nil + Parameters: + - Name: attachment + Type: CharacterAttachmentEnum + IsOptional: false + DefaultValue: "" + - Name: pos + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Set bone override position + - Name: SetBoneOverrideRotation + ReturnType: nil + Parameters: + - Name: attachment + Type: CharacterAttachmentEnum + IsOptional: false + DefaultValue: "" + - Name: euler + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Set bone override rotation + - Name: GetBoneOverridePosition + ReturnType: Vector3 + Parameters: + - Name: attachment + Type: CharacterAttachmentEnum + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Get bone override position + - Name: GetBoneOverrideRotation + ReturnType: Vector3 + Parameters: + - Name: attachment + Type: CharacterAttachmentEnum + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Get bone override rotation Events: - Name: RagdollStarted Arguments: "" @@ -139,4 +219,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: PolytorianModel is a CharacterModel that represent default Polytoria Character. diff --git a/yaml/types/PreferencesService.yaml b/yaml/types/PreferencesService.yaml index 6ec09b5..ebbb7b6 100644 --- a/yaml/types/PreferencesService.yaml +++ b/yaml/types/PreferencesService.yaml @@ -6,12 +6,14 @@ Properties: IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Determines whether the player has photo mode enabled. - Name: UsePostProcessing Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Determines whether the player has post-processing effects enabled. Methods: [] Events: @@ -25,5 +27,6 @@ Events: IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Preferences Description: PreferencesService is a service that allows scripts to access some of the user preferences diff --git a/yaml/types/PresenceService.yaml b/yaml/types/PresenceService.yaml index 56fa46a..98edc16 100644 --- a/yaml/types/PresenceService.yaml +++ b/yaml/types/PresenceService.yaml @@ -6,12 +6,14 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Current activity status. - Name: CoverImage Type: PTImageAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Activity cover image. Methods: - Name: ResetTimer @@ -25,5 +27,6 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Presence Description: PresenceService is a service that allows scripts to set the active status of the player. Which will be used to display in supported integrations. diff --git a/yaml/types/ProceduralSky.yaml b/yaml/types/ProceduralSky.yaml index 71d4c2c..7420c40 100644 --- a/yaml/types/ProceduralSky.yaml +++ b/yaml/types/ProceduralSky.yaml @@ -6,35 +6,41 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The size of the sun in the sky. - Name: SkyTint Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The tint color of the sky. - Name: HorizonColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color of the horizon in the sky. - Name: GroundColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color of the ground in the sky. - Name: Exposure Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The exposure level of the sky. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: ProceduralSky is a type of sky that generates its appearance procedurally based on the position of the sun and its properties. diff --git a/yaml/types/PurchasesService.yaml b/yaml/types/PurchasesService.yaml index 70f8289..de5f7c2 100644 --- a/yaml/types/PurchasesService.yaml +++ b/yaml/types/PurchasesService.yaml @@ -37,4 +37,5 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Purchases Description: Service responsible for handling in-game purchases and ownership verification. diff --git a/yaml/types/Quaternion.yaml b/yaml/types/Quaternion.yaml index 4519ae6..aaa58a4 100644 --- a/yaml/types/Quaternion.yaml +++ b/yaml/types/Quaternion.yaml @@ -6,30 +6,35 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The X component of the quaternion. - Name: Y Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The Y component of the quaternion. - Name: Z Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The Z component of the quaternion. - Name: W Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The W component of the quaternion. - Name: Identity Type: Quaternion IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: The identity rotation. Methods: - Name: New @@ -62,6 +67,77 @@ Methods: IsObsolete: false IsStatic: true Description: Creates a new Quaternion object with the specified components. + - Name: __add + ReturnType: Quaternion + Parameters: + - Name: a + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: b + Type: Quaternion + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __sub + ReturnType: Quaternion + Parameters: + - Name: a + Type: any + IsOptional: false + DefaultValue: "" + - Name: b + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __mul + ReturnType: any + Parameters: + - Name: a + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: b + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __eq + ReturnType: boolean + Parameters: + - Name: a + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: b + Type: Quaternion + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __tostring + ReturnType: string + Parameters: + - Name: v + Type: Quaternion + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation - Name: Angle ReturnType: Quaternion Parameters: @@ -312,4 +388,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: Represents a quaternion used for rotations. diff --git a/yaml/types/RayResult.yaml b/yaml/types/RayResult.yaml index 329032d..ce93eb8 100644 --- a/yaml/types/RayResult.yaml +++ b/yaml/types/RayResult.yaml @@ -1,45 +1,52 @@ Name: RayResult -BaseType: ValueType +BaseType: null Properties: - Name: Origin Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The origin point of the ray. - Name: Direction Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The direction vector of the ray. - Name: Position Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The position where the ray hit an object. - Name: Normal Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The surface normal at the point where the ray hit. - Name: Distance Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The distance from the ray's origin to the hit point. - Name: Instance Type: Instance IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The instance that was hit by the ray. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: RayResult is a data type that contains data about a raycast result. diff --git a/yaml/types/ResourceAsset.yaml b/yaml/types/ResourceAsset.yaml index 095ae9f..c4ef885 100644 --- a/yaml/types/ResourceAsset.yaml +++ b/yaml/types/ResourceAsset.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Base class for resource based assets diff --git a/yaml/types/Script.yaml b/yaml/types/Script.yaml index c81cabd..db943a2 100644 --- a/yaml/types/Script.yaml +++ b/yaml/types/Script.yaml @@ -6,18 +6,28 @@ Properties: IsAccessibleByScripts: false IsReadOnly: false IsObsolete: false + IsStatic: false Description: The source code of the script as a string. + - Name: IsEnabled + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Determine if this script should run, can be set to false in runtime to stop running script when it yields. - Name: LinkedScript Type: FileLinkAsset IsAccessibleByScripts: false IsReadOnly: false IsObsolete: false + IsStatic: false Description: A linked script asset associated with this script. - Name: Compatibility Type: boolean IsAccessibleByScripts: false IsReadOnly: false IsObsolete: false + IsStatic: false Description: Indicates whether the script is running in compatibility mode. Methods: - Name: Call @@ -54,5 +64,6 @@ Events: [] IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Scripts are abstract base classes representing Lua code that can be executed in the game. diff --git a/yaml/types/ScriptService.yaml b/yaml/types/ScriptService.yaml index 0351746..bd8fd8b 100644 --- a/yaml/types/ScriptService.yaml +++ b/yaml/types/ScriptService.yaml @@ -6,5 +6,6 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: ScriptService Description: ScriptService is a service used for storing scripts and local scripts. It is also responsible for managing their execution within the game. diff --git a/yaml/types/ScriptSharedTable.yaml b/yaml/types/ScriptSharedTable.yaml index 40e742d..aa1b639 100644 --- a/yaml/types/ScriptSharedTable.yaml +++ b/yaml/types/ScriptSharedTable.yaml @@ -1,10 +1,37 @@ Name: ScriptSharedTable BaseType: null Properties: [] -Methods: [] +Methods: + - Name: __index + ReturnType: any + Parameters: + - Name: index + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: __newindex + ReturnType: nil + Parameters: + - Name: index + Type: string + IsOptional: false + DefaultValue: "" + - Name: val + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: Shared table of object. This class provides a table which any scripts can modify. diff --git a/yaml/types/Seat.yaml b/yaml/types/Seat.yaml index 837a704..011ac93 100644 --- a/yaml/types/Seat.yaml +++ b/yaml/types/Seat.yaml @@ -6,12 +6,14 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Indicates who is currently occupying the seat. - Name: CanNPCSit Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether NPCs are allowed to sit on this seat or only players. Methods: [] Events: @@ -28,4 +30,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Seats are parts the player can sit on. diff --git a/yaml/types/ServerHidden.yaml b/yaml/types/ServerHidden.yaml index 063f4e2..c3c3da3 100644 --- a/yaml/types/ServerHidden.yaml +++ b/yaml/types/ServerHidden.yaml @@ -6,6 +6,7 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: ServerHidden Description: ServerHidden, similar to Hidden, is a container for objects that are meant to be hidden. Unlike Hidden, ServerHidden won't replicate its contents to clients and can only be accessed by the server. diff --git a/yaml/types/ServerScript.yaml b/yaml/types/ServerScript.yaml index 5e635bc..2944c3b 100644 --- a/yaml/types/ServerScript.yaml +++ b/yaml/types/ServerScript.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: ServerScript is a script that runs on the server. diff --git a/yaml/types/Sky.yaml b/yaml/types/Sky.yaml index ba52ed9..bc29b7f 100644 --- a/yaml/types/Sky.yaml +++ b/yaml/types/Sky.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: Sky is an abstract base class representing the sky in the game world. diff --git a/yaml/types/Sound.yaml b/yaml/types/Sound.yaml index 77999e1..3d02467 100644 --- a/yaml/types/Sound.yaml +++ b/yaml/types/Sound.yaml @@ -6,24 +6,28 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The audio asset to be played by the sound. - Name: Volume Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The volume level of the sound. - Name: Pitch Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The pitch level of the sound. - Name: Autoplay Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the sound should start playing automatically when loaded. - Name: Loop @@ -31,42 +35,56 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the sound should loop when it reaches the end. - Name: PlayInWorld Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the sound should be played in the 3D world space. + - Name: Paused + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Determines if this sound is paused - Name: MaxDistance Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The maximum distance at which the sound can be heard. - Name: Time Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Indicates the current playback position of the sound in seconds. - Name: Playing Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the sound is currently playing. - Name: Loading Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the sound is currently loading. - Name: Length Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The total length of the sound in seconds. Methods: - Name: Play @@ -88,6 +106,13 @@ Methods: IsStatic: false 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. - Name: Stop ReturnType: nil Parameters: [] @@ -102,4 +127,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Sounds are objects that can be placed in the world and play audio. diff --git a/yaml/types/SpotLight.yaml b/yaml/types/SpotLight.yaml index 6914fd8..60ff831 100644 --- a/yaml/types/SpotLight.yaml +++ b/yaml/types/SpotLight.yaml @@ -6,17 +6,20 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The maximum distance the light can reach. - Name: Angle Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The angle of the spotlight's cone. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: SpotLight is a source of light emitting in a specific direction and angle that can be placed in the world. diff --git a/yaml/types/StringValue.yaml b/yaml/types/StringValue.yaml index fc6307e..bbf5724 100644 --- a/yaml/types/StringValue.yaml +++ b/yaml/types/StringValue.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The value of this object. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: StringValue is an object that holds a string value. diff --git a/yaml/types/SunLight.yaml b/yaml/types/SunLight.yaml index 2231c28..28fb3ae 100644 --- a/yaml/types/SunLight.yaml +++ b/yaml/types/SunLight.yaml @@ -6,5 +6,6 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: SunLight is the main directional light source representing the sun in the game world. diff --git a/yaml/types/Temporary.yaml b/yaml/types/Temporary.yaml index 8920f0a..ffb71d3 100644 --- a/yaml/types/Temporary.yaml +++ b/yaml/types/Temporary.yaml @@ -6,5 +6,6 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: A temporary container. All class that were instantiated from `Instance.New` will have this class as their first parent. diff --git a/yaml/types/Text3D.yaml b/yaml/types/Text3D.yaml index f673069..9ec4d51 100644 --- a/yaml/types/Text3D.yaml +++ b/yaml/types/Text3D.yaml @@ -6,64 +6,75 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The text content displayed. - Name: FontSize Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The size of the font used for the text. - Name: Color Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color of the text. - Name: OutlineWidth Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The width of the text outline. - Name: OutlineColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color of the text outline. - Name: FaceCamera Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the text should always be facing the camera. - Name: HorizontalAlignment Type: TextHorizontalAlignmentEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the horizontal alignment of the text. - Name: VerticalAlignment Type: TextVerticalAlignmentEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the vertical alignment of the text. - Name: FontAsset Type: FontAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The font asset used for the text. - Name: UseRichText Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the text should be parsed as rich text. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Text3D is a class that represents 3D text in the game world. diff --git a/yaml/types/Tool.yaml b/yaml/types/Tool.yaml index 7feb5c9..8a33aa8 100644 --- a/yaml/types/Tool.yaml +++ b/yaml/types/Tool.yaml @@ -6,18 +6,21 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the tool can be dropped by the player. - Name: IconImage Type: ImageAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The icon for this tool, appears in inventory. - Name: Holder Type: NPC IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines who is currently holding this tool. Methods: - Name: Activate @@ -63,4 +66,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Tools are objects that can be held by the player. diff --git a/yaml/types/Truss.yaml b/yaml/types/Truss.yaml index be7e645..f011d25 100644 --- a/yaml/types/Truss.yaml +++ b/yaml/types/Truss.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The speed at which the player can climb the truss. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Trusses are parts that can be climbed by the player. diff --git a/yaml/types/TweenObject.yaml b/yaml/types/TweenObject.yaml index ae11923..504beea 100644 --- a/yaml/types/TweenObject.yaml +++ b/yaml/types/TweenObject.yaml @@ -6,30 +6,35 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines if this tween is looped - Name: Parallel Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines if this tween will run all the tweens in parallel - Name: SpeedScale Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the speed scale of this tween - Name: IsRunning Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns whether or not this tween is running - Name: ElapsedTime Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Returns the elapsed time of this tween Methods: - Name: SetDirection @@ -265,4 +270,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: An object that represents tween diff --git a/yaml/types/TweenService.yaml b/yaml/types/TweenService.yaml index 2734718..97cbb26 100644 --- a/yaml/types/TweenService.yaml +++ b/yaml/types/TweenService.yaml @@ -16,4 +16,5 @@ Events: [] IsStatic: true IsAbstract: false IsInstantiatable: false +StaticAlias: Tween Description: TweenService is a service for managing tweens diff --git a/yaml/types/UIButton.yaml b/yaml/types/UIButton.yaml index fd6fbb0..61d235f 100644 --- a/yaml/types/UIButton.yaml +++ b/yaml/types/UIButton.yaml @@ -9,4 +9,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: UIButton is a class that represents a clickable button UI element. diff --git a/yaml/types/UIField.yaml b/yaml/types/UIField.yaml index de8ba11..ef2316a 100644 --- a/yaml/types/UIField.yaml +++ b/yaml/types/UIField.yaml @@ -6,72 +6,98 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The offset of the UI element in pixels. - Name: PositionRelative Type: Vector2 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The position of the UI element relative to its parent. - Name: Rotation Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The rotation of the UI element in degrees. - Name: SizeOffset Type: Vector2 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The size offset of the UI element in pixels. - Name: SizeRelative Type: Vector2 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The size of the UI element relative to its parent. - Name: ClipDescendants Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the UI element clips its descendants. - Name: PivotPoint Type: Vector2 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The pivot point of the UI element. - Name: Scale Type: Vector2 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The scale of the UI element. - Name: Visible Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the UI element is visible. - Name: MaskMode Type: MaskModeEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the mask mode of the UI element. + - Name: IgnoreMouse + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: If true, this UI field can grab the UI focus via cursor. + - Name: ZIndex + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: The Z-Index layer value - Name: AbsoluteSize Type: Vector2 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The absolute size of the UI element in pixels. - Name: IsVisibleInTree Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the UI element is visible in the UI hierarchy. Methods: [] Events: @@ -96,4 +122,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: UIField is the abstract base class of all UI classes. diff --git a/yaml/types/UIHVLayout.yaml b/yaml/types/UIHVLayout.yaml index 31d2858..176c305 100644 --- a/yaml/types/UIHVLayout.yaml +++ b/yaml/types/UIHVLayout.yaml @@ -6,17 +6,20 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The spacing between child elements in the layout. - Name: ChildAlignment Type: UILayoutAlignmentEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the alignment of child elements within the layout. Methods: [] Events: [] IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: UIHVLayout is an abstract class that provides horizontal and vertical layout functionality for UI elements. diff --git a/yaml/types/UIHorizontalLayout.yaml b/yaml/types/UIHorizontalLayout.yaml index d471ad2..3b7b4f6 100644 --- a/yaml/types/UIHorizontalLayout.yaml +++ b/yaml/types/UIHorizontalLayout.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: UIHorizontalLayout is a class that aligns all of its children horizontally. diff --git a/yaml/types/UIImage.yaml b/yaml/types/UIImage.yaml index db36d08..152f622 100644 --- a/yaml/types/UIImage.yaml +++ b/yaml/types/UIImage.yaml @@ -6,28 +6,33 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The image asset used for the image. - Name: Color Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color applied to the image. - Name: StretchMode Type: ImageStretchModeEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines how the image is stretched within the view. - Name: Loading Type: boolean IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: Indicates whether the image is currently loading. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: UIImage is a class that can be used to display images. diff --git a/yaml/types/UILabel.yaml b/yaml/types/UILabel.yaml index ea0aed1..f584faa 100644 --- a/yaml/types/UILabel.yaml +++ b/yaml/types/UILabel.yaml @@ -6,58 +6,68 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The text of the label. - Name: TextColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color of the text. - Name: OutlineWidth Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The width of the text outline. - Name: OutlineColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color of the text outline. - Name: HorizontalAlignment Type: TextHorizontalAlignmentEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the horizontal alignment of the text. - Name: VerticalAlignment Type: TextVerticalAlignmentEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the vertical alignment of the text. - Name: FontSize Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The font size of the text. - Name: UseRichText Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the text uses rich text formatting. - Name: FontAsset Type: FontAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The font asset used for the text. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: UILabel is a class that can be used to display text. diff --git a/yaml/types/UIScrollView.yaml b/yaml/types/UIScrollView.yaml index de66025..6770f6f 100644 --- a/yaml/types/UIScrollView.yaml +++ b/yaml/types/UIScrollView.yaml @@ -6,16 +6,19 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the horizontal scroll mode of the scroll view. - Name: VerticalScrollMode Type: ScrollModeEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the vertical scroll mode of the scroll view. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: UIScrollView is a class that allows the user to scroll content within a view. diff --git a/yaml/types/UITextInput.yaml b/yaml/types/UITextInput.yaml index 36670bb..2c996e8 100644 --- a/yaml/types/UITextInput.yaml +++ b/yaml/types/UITextInput.yaml @@ -6,60 +6,70 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The text of the label. - Name: TextColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color of the text. - Name: JustifyText Type: TextHorizontalAlignmentEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines how text is justified. - Name: FontSize Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The font size of the label. - Name: IsMultiline Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the text input supports multiple lines. - Name: Placeholder Type: string IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The placeholder text displayed when the input is empty. - Name: PlaceholderColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color of the placeholder text. - Name: ReadOnlyColor Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The color of the text when the input is read-only. - Name: IsReadOnly Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines whether the text input is read-only. - Name: FontAsset Type: FontAsset IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The font asset used for the text. Methods: - Name: Focus @@ -83,4 +93,5 @@ Events: IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: UITextInput is a class that allows the user to enter text. diff --git a/yaml/types/UIVerticalLayout.yaml b/yaml/types/UIVerticalLayout.yaml index 0c143bb..732a6cc 100644 --- a/yaml/types/UIVerticalLayout.yaml +++ b/yaml/types/UIVerticalLayout.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: UIVerticalLayout is a class that aligns all of its children vertically. diff --git a/yaml/types/UIView.yaml b/yaml/types/UIView.yaml index 60becc8..1d4972e 100644 --- a/yaml/types/UIView.yaml +++ b/yaml/types/UIView.yaml @@ -6,28 +6,33 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the border color of the UI. - Name: Color Type: Color IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the color of the UI. - Name: BorderWidth Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the width of the border of the UI. - Name: CornerRadius Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the corner radius of the UI. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: UIView is a class that displays a rectangle in your place's UI. diff --git a/yaml/types/UIViewport.yaml b/yaml/types/UIViewport.yaml index 0fce678..a2c9691 100644 --- a/yaml/types/UIViewport.yaml +++ b/yaml/types/UIViewport.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: UIViewport is a UI object that allows displaying 3D content on 2D UI diff --git a/yaml/types/ValueBase.yaml b/yaml/types/ValueBase.yaml index 63f683e..090301a 100644 --- a/yaml/types/ValueBase.yaml +++ b/yaml/types/ValueBase.yaml @@ -9,4 +9,5 @@ Events: IsStatic: false IsAbstract: true IsInstantiatable: false +StaticAlias: null Description: ValueBase is an abstract base class for objects that hold a value. diff --git a/yaml/types/Vector2.yaml b/yaml/types/Vector2.yaml index 1c8b9e8..4cb70a1 100644 --- a/yaml/types/Vector2.yaml +++ b/yaml/types/Vector2.yaml @@ -6,66 +6,77 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The X component of the vector. - Name: Y Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The Y component of the vector. - Name: Down Type: Vector2 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector2.New(0, -1). - Name: Left Type: Vector2 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector2.New(-1, 0). - Name: One Type: Vector2 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector2.New(1, 1). - Name: Zero Type: Vector2 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector2.New(0, 0). - Name: Right Type: Vector2 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector2.New(1, 0). - Name: Up Type: Vector2 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector2.New(0, 1). - Name: Magnitude Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The length of the vector. - Name: Normalized Type: Vector2 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The normalized version of the vector. - Name: SqrMagnitude Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The squared length of the vector. Methods: - Name: New @@ -101,6 +112,174 @@ Methods: IsObsolete: false IsStatic: true Description: Returns a new Vector2 with the given x and y components. + - Name: __add + ReturnType: Vector2 + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __sub + ReturnType: Vector2 + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __mul + ReturnType: any + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: b + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __div + ReturnType: Vector2 + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: b + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __mod + ReturnType: Vector2 + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __unm + ReturnType: Vector2 + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __pow + ReturnType: Vector2 + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __eq + ReturnType: boolean + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __lt + ReturnType: boolean + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __le + ReturnType: boolean + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __len + ReturnType: number + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __tostring + ReturnType: string + Parameters: + - Name: v + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation - Name: Angle ReturnType: number Parameters: @@ -294,4 +473,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: Vector2 is a 2D vector with an x and y component. diff --git a/yaml/types/Vector2Value.yaml b/yaml/types/Vector2Value.yaml index 4bddb04..ba3caa1 100644 --- a/yaml/types/Vector2Value.yaml +++ b/yaml/types/Vector2Value.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The value of this object. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Vector2Value is an object that holds a Vector2 value. diff --git a/yaml/types/Vector3.yaml b/yaml/types/Vector3.yaml index 453a96f..9e0fb74 100644 --- a/yaml/types/Vector3.yaml +++ b/yaml/types/Vector3.yaml @@ -6,84 +6,98 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The X component of the vector. - Name: Y Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The Y component of the vector. - Name: Z Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The Z component of the vector. - Name: Forward Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector3.New(0, 0, -1). - Name: Back Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector3.New(0, 0, 1). - Name: Down Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector3.New(0, -1, 0). - Name: Left Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector3.New(-1, 0, 0). - Name: One Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector3.New(1, 1, 1). - Name: Zero Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector3.New(0, 0, 0). - Name: Right Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector3.New(1, 0, 0). - Name: Up Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: true Description: Shorthand for Vector3.New(0, 1, 0). - Name: Magnitude Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The length of the vector. - Name: Normalized Type: Vector3 IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The normalized version of the vector. - Name: SqrMagnitude Type: number IsAccessibleByScripts: true IsReadOnly: true IsObsolete: false + IsStatic: false Description: The squared length of the vector. Methods: - Name: New @@ -154,6 +168,174 @@ Methods: IsStatic: true Description: Returns a new Vector3 with the given Vector2 components and a z component of 0. + - Name: __add + ReturnType: Vector3 + Parameters: + - Name: a + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __sub + ReturnType: Vector3 + Parameters: + - Name: a + Type: any + IsOptional: false + DefaultValue: "" + - Name: b + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __mul + ReturnType: any + Parameters: + - Name: a + Type: any + IsOptional: false + DefaultValue: "" + - Name: b + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __div + ReturnType: Vector3 + Parameters: + - Name: a + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: b + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __mod + ReturnType: Vector3 + Parameters: + - Name: a + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __unm + ReturnType: Vector3 + Parameters: + - Name: a + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __pow + ReturnType: Vector3 + Parameters: + - Name: a + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __eq + ReturnType: boolean + Parameters: + - Name: a + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __lt + ReturnType: boolean + Parameters: + - Name: a + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __le + ReturnType: boolean + Parameters: + - Name: a + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __len + ReturnType: number + Parameters: + - Name: a + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: __tostring + ReturnType: string + Parameters: + - Name: v + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation - Name: Angle ReturnType: number Parameters: @@ -367,4 +549,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: false +StaticAlias: null Description: Vector3 is a 3D vector with an x, y and z component. diff --git a/yaml/types/Vector3Value.yaml b/yaml/types/Vector3Value.yaml index f702042..d430584 100644 --- a/yaml/types/Vector3Value.yaml +++ b/yaml/types/Vector3Value.yaml @@ -6,10 +6,12 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: The value of this object. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Vector3Value is an object that holds a Vector3 value. diff --git a/yaml/types/Vehicle.yaml b/yaml/types/Vehicle.yaml index 5decd1f..17c16c1 100644 --- a/yaml/types/Vehicle.yaml +++ b/yaml/types/Vehicle.yaml @@ -6,40 +6,47 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the forward force limit in kg/s. - Name: SteerLimit Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the steering limit in degrees. - Name: Force Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the forward force in kg/s. - Name: Brake Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the break amount in kg/s. - Name: Steering Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the steering angle in degrees - Name: Driver Type: Player IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the current driver of this vehicle. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: Vehicle class represents a vehicle that can be driven by a player diff --git a/yaml/types/VehicleSeat.yaml b/yaml/types/VehicleSeat.yaml index 0b4e21b..f25441f 100644 --- a/yaml/types/VehicleSeat.yaml +++ b/yaml/types/VehicleSeat.yaml @@ -6,4 +6,5 @@ Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: A seat for Vehicle diff --git a/yaml/types/VehicleWheel.yaml b/yaml/types/VehicleWheel.yaml index ab0fcfd..7f31513 100644 --- a/yaml/types/VehicleWheel.yaml +++ b/yaml/types/VehicleWheel.yaml @@ -6,22 +6,26 @@ Properties: IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines if this wheel should be used for traction. - Name: UseForSteering Type: boolean IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines if this wheel should be used for steering. - Name: Radius Type: number IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false + IsStatic: false Description: Determines the radius for this wheel. Methods: [] Events: [] IsStatic: false IsAbstract: false IsInstantiatable: true +StaticAlias: null Description: A wheel for the vehicle