Polytoria/Docs-v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

2.0.0-beta40

Browse Source
This commit is contained in:
maji
2026-01-17 21:42:26 +07:00
parent 882aa45e96
commit 4b7b5eb163
141 changed files with 1460 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
yaml/types/Accessory.yaml
View File

@@ -6,11 +6,13 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Specifies the character attachment point Description: Specifies the character attachment point
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Accessory represents a attachable object that can be equipped by a Description: Accessory represents a attachable object that can be equipped by a
CharacterModel. CharacterModel.

41
yaml/types/AchievementsService.yaml
View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determine if achievement sound effect should play when user Description: Determine if achievement sound effect should play when user
receives an achievement receives an achievement
- Name: NotifyAchievements - Name: NotifyAchievements
@@ -13,28 +14,10 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determine if achievement toast should show when user receives an Description: Determine if achievement toast should show when user receives an
achievement achievement
Methods: 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 - Name: AwardAsync
ReturnType: nil ReturnType: nil
Parameters: Parameters:
@@ -50,25 +33,6 @@ Methods:
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Award achievement to the user asynchronously. 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 - Name: HasAchievementAsync
ReturnType: boolean ReturnType: boolean
Parameters: Parameters:
@@ -93,4 +57,5 @@ Events:
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Achievements
Description: Service for managing achievements Description: Service for managing achievements

1
yaml/types/Animation.yaml
View File

@@ -6,4 +6,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: WIP class Description: WIP class

1
yaml/types/Animator.yaml
View File

@@ -42,4 +42,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: WIP class Description: WIP class

54
yaml/types/AssetsService.yaml Normal file
View File

@@ -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

1
yaml/types/AudioAsset.yaml
View File

@@ -6,4 +6,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: true IsAbstract: true
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Abstract class for audio Description: Abstract class for audio

1
yaml/types/BaseAsset.yaml
View File

@@ -6,4 +6,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: true IsAbstract: true
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Base class for all assets Description: Base class for all assets

1
yaml/types/BindableEvent.yaml
View File

@@ -22,5 +22,6 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: BindableEvent are events that can be called to communicate between Description: BindableEvent are events that can be called to communicate between
scripts in the same boundary. scripts in the same boundary.

4
yaml/types/BodyPosition.yaml
View File

@@ -6,18 +6,21 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the target position that the body applies forces to get to. Description: Determines the target position that the body applies forces to get to.
- Name: Force - Name: Force
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines how much force the body applies. Description: Determines how much force the body applies.
- Name: AcceptanceDistance - Name: AcceptanceDistance
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines how close the body has to be to the target position to Description: Determines how close the body has to be to the target position to
stop applying forces to it. stop applying forces to it.
Methods: [] Methods: []
@@ -25,5 +28,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: BodyPosition are objects that apply a force to their parent until Description: BodyPosition are objects that apply a force to their parent until
it moves toward the target position. it moves toward the target position.

2
yaml/types/BoolValue.yaml
View File

@@ -6,10 +6,12 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The value of this object. Description: The value of this object.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: BoolValue is a ValueBase that stores a boolean. Description: BoolValue is a ValueBase that stores a boolean.

33
yaml/types/Bounds.yaml
View File

@@ -6,36 +6,42 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates the center point of the bounds. Description: Indicates the center point of the bounds.
- Name: Size - Name: Size
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the size of the bounds. Description: Determines the size of the bounds.
- Name: Extents - Name: Extents
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates the extents of the bounds. Description: Indicates the extents of the bounds.
- Name: Start - Name: Start
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The origin point Description: The origin point
- Name: End - Name: End
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The ending point Description: The ending point
- Name: Volume - Name: Volume
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates the volume of the bounds. Description: Indicates the volume of the bounds.
Methods: Methods:
- Name: New - Name: New
@@ -60,6 +66,32 @@ Methods:
IsObsolete: false IsObsolete: false
IsStatic: true IsStatic: true
Description: Creates a new Bounds object with the specified position and size. 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 - Name: ClosestPoint
ReturnType: Vector3 ReturnType: Vector3
Parameters: Parameters:
@@ -188,4 +220,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Represents a bounding box in 3D space. Description: Represents a bounding box in 3D space.

2
yaml/types/BuiltInAudioAsset.yaml
View File

@@ -6,10 +6,12 @@ Properties:
IsAccessibleByScripts: false IsAccessibleByScripts: false
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The target audio to use Description: The target audio to use
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Audio asset that's built-in with the client Description: Audio asset that's built-in with the client

2
yaml/types/BuiltInFontAsset.yaml
View File

@@ -6,10 +6,12 @@ Properties:
IsAccessibleByScripts: false IsAccessibleByScripts: false
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Target font to use Description: Target font to use
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Font asset that's built-in with the client Description: Font asset that's built-in with the client

24
yaml/types/Camera.yaml
View File

@@ -6,36 +6,42 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines or returns the camera's current mode. Description: Determines or returns the camera's current mode.
- Name: FOV - Name: FOV
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines or returns the camera's field of view. Description: Determines or returns the camera's field of view.
- Name: ClipThroughWalls - Name: ClipThroughWalls
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the camera should clip through walls. Description: Determines whether or not the camera should clip through walls.
- Name: MinDistance - Name: MinDistance
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The camera's minimum distance from the player in Follow mode. Description: The camera's minimum distance from the player in Follow mode.
- Name: MaxDistance - Name: MaxDistance
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines camera's maximum distance from the player in Follow mode. Description: Determines camera's maximum distance from the player in Follow mode.
- Name: Distance - Name: Distance
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the distance between the camera and the player when the Description: Determines the distance between the camera and the player when the
camera is in Follow mode. camera is in Follow mode.
- Name: ScrollSensitivity - Name: ScrollSensitivity
@@ -43,12 +49,14 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the scroll move speed of the camera. Description: Determines the scroll move speed of the camera.
- Name: Orthographic - Name: Orthographic
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the camera should render in orthographic Description: Determines whether or not the camera should render in orthographic
(2D) mode or not (3D). (2D) mode or not (3D).
- Name: FollowLerp - Name: FollowLerp
@@ -56,90 +64,105 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not to use lerping in Follow mode. Description: Determines whether or not to use lerping in Follow mode.
- Name: LerpSpeed - Name: LerpSpeed
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the lerp speed of the camera when lerping is enabled. Description: Determines the lerp speed of the camera when lerping is enabled.
- Name: OrthographicSize - Name: OrthographicSize
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the half-size of the camera when in orthographic mode. Description: Determines the half-size of the camera when in orthographic mode.
- Name: PositionOffset - Name: PositionOffset
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the camera's offset from its position. Description: Determines the camera's offset from its position.
- Name: RotationOffset - Name: RotationOffset
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the camera's offset from its rotation. Description: Determines the camera's offset from its rotation.
- Name: IsFirstPerson - Name: IsFirstPerson
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns whether or not the camera is in first person. Description: Returns whether or not the camera is in first person.
- Name: CanLock - Name: CanLock
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determine if camera can be ctrl locked. Description: Determine if camera can be ctrl locked.
- Name: SensitivityMultiplier - Name: SensitivityMultiplier
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Multipler for camera sensitivity Description: Multipler for camera sensitivity
- Name: Sensitivity - Name: Sensitivity
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Current sensitivity of the camera Description: Current sensitivity of the camera
- Name: HorizontalSpeed - Name: HorizontalSpeed
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the horizontal movement speed of the camera in Follow mode. Description: Determines the horizontal movement speed of the camera in Follow mode.
- Name: VerticalSpeed - Name: VerticalSpeed
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the vertical move speed of the camera. Description: Determines the vertical move speed of the camera.
- Name: ScrollLerpSpeed - Name: ScrollLerpSpeed
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the lerp amount when scrolling Description: Determines the lerp amount when scrolling
- Name: CtrlLocked - Name: CtrlLocked
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determine if camera is in Ctrl lock mode Description: Determine if camera is in Ctrl lock mode
- Name: AlwaysLocked - Name: AlwaysLocked
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determine if camera should always be in locked mode Description: Determine if camera should always be in locked mode
- Name: Target - Name: Target
Type: Dynamic Type: Dynamic
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The target of Follow mode Description: The target of Follow mode
Methods: Methods:
- Name: ViewportPointToRay - Name: ViewportPointToRay
@@ -258,4 +281,5 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Camera is a class that represents the local player's camera. Description: Camera is a class that represents the local player's camera.

5
yaml/types/CaptureService.yaml
View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns whenever the capture is on cooldown. Description: Returns whenever the capture is on cooldown.
- Name: CanCapture - Name: CanCapture
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines if user/scripts can take a picture. Description: Determines if user/scripts can take a picture.
- Name: DefaultCaptureOverlay - Name: DefaultCaptureOverlay
Type: UIField Type: UIField
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Default capture overlay for all captures Description: Default capture overlay for all captures
- Name: SpectatorAttach - Name: SpectatorAttach
Type: Dynamic Type: Dynamic
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Attaches a spectator camera at dynamic for use with spectator mode. Description: Attaches a spectator camera at dynamic for use with spectator mode.
Methods: Methods:
- Name: TakePhotoAtDynamic - Name: TakePhotoAtDynamic
@@ -74,4 +78,5 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Capture
Description: Service for capturing photos Description: Service for capturing photos

2
yaml/types/CharacterModel.yaml
View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The animator for this character Description: The animator for this character
Methods: Methods:
- Name: GetAttachment - Name: GetAttachment
@@ -23,4 +24,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Base class for Character Models Description: Base class for Character Models

1
yaml/types/ChatService.yaml
View File

@@ -45,4 +45,5 @@ Events:
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Chat
Description: Chat is a static class used for various actions regarding the chat. Description: Chat is a static class used for various actions regarding the chat.

1
yaml/types/ClientScript.yaml
View File

@@ -6,5 +6,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: ClientScript is a script that runs locally for each player. It can Description: ClientScript is a script that runs locally for each player. It can
only see what the player can see. only see what the player can see.

76
yaml/types/Color.yaml
View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Red color component Description: Red color component
- Name: G - Name: G
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Green color component Description: Green color component
- Name: B - Name: B
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Blue color component Description: Blue color component
- Name: A - Name: A
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Alpha (opacity) color component Description: Alpha (opacity) color component
Methods: Methods:
- Name: New - Name: New
@@ -86,6 +90,77 @@ Methods:
IsObsolete: false IsObsolete: false
IsStatic: true IsStatic: true
Description: Creates a new Color with the set R, G, B and A values 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 - Name: Random
ReturnType: Color ReturnType: Color
Parameters: [] Parameters: []
@@ -127,6 +202,7 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: >- Description: >-
Color is a data type that represents a color. Color is a data type that represents a color.

5
yaml/types/ColorAdjustModifier.yaml
View File

@@ -6,29 +6,34 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determine the brightness adjustment Description: Determine the brightness adjustment
- Name: Contrast - Name: Contrast
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determine the contrast adjustment Description: Determine the contrast adjustment
- Name: Saturation - Name: Saturation
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determine the saturation adjustment Description: Determine the saturation adjustment
- Name: TintColor - Name: TintColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determine the tint color Description: Determine the tint color
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: ColorAdjustModifier is a LightingModifier that allows the Description: ColorAdjustModifier is a LightingModifier that allows the
adjustment of lighting adjustment of lighting

11
yaml/types/ColorSeries.yaml
View File

@@ -1,11 +1,12 @@
Name: ColorSeries Name: ColorSeries
BaseType: ValueType BaseType: null
Properties: Properties:
- Name: PointCount - Name: PointCount
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns the point count of this color series Description: Returns the point count of this color series
Methods: Methods:
- Name: New - Name: New
@@ -30,6 +31,13 @@ Methods:
IsObsolete: false IsObsolete: false
IsStatic: true IsStatic: true
Description: Create color series by this color range Description: Create color series by this color range
- Name: Clear
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: SetColor - Name: SetColor
ReturnType: nil ReturnType: nil
Parameters: Parameters:
@@ -108,5 +116,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Color series is a data type that represents a collection of color Description: Color series is a data type that represents a collection of color
and points, also known as gradient. and points, also known as gradient.

2
yaml/types/ColorValue.yaml
View File

@@ -6,10 +6,12 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The value of this object. Description: The value of this object.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: ColorValue is an object that holds a Color value. Description: ColorValue is an object that holds a Color value.

16
yaml/types/CoreUIService.yaml
View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the user card (in the upper right hand Description: Determines whether or not the user card (in the upper right hand
corner above the leaderboard) is visible. corner above the leaderboard) is visible.
- Name: UseChat - Name: UseChat
@@ -13,46 +14,61 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the chat box is visible. Description: Determines whether or not the chat box is visible.
- Name: UseHealthBar - Name: UseHealthBar
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the player's health bar is visible. Description: Determines whether or not the player's health bar is visible.
- Name: UseLeaderboard - Name: UseLeaderboard
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the player list/leaderboard is visible. Description: Determines whether or not the player list/leaderboard is visible.
- Name: UseHotbar - Name: UseHotbar
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the hot bar is visible. 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 - Name: UseMenuButton
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the menu button is visible. Description: Determines whether or not the menu button is visible.
- Name: UseEmoteWheel - Name: UseEmoteWheel
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the emote wheel is visible. Description: Determines whether or not the emote wheel is visible.
- Name: CanRespawn - Name: CanRespawn
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the player can respawn. Description: Determines whether or not the player can respawn.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: CoreUI
Description: CoreUI is a static class that allows for the toggling of certain core GUI. Description: CoreUI is a static class that allows for the toggling of certain core GUI.

1
yaml/types/CreatorContextService.yaml
View File

@@ -6,6 +6,7 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: CreatorContext
Description: CreatorContextService is a service that manage per game specific Description: CreatorContextService is a service that manage per game specific
tools, such as Selections and History. This class is only available in the tools, such as Selections and History. This class is only available in the
creator. creator.

3
yaml/types/CreatorGUI.yaml
View File

@@ -3,8 +3,9 @@ BaseType: PlayerGUI
Properties: [] Properties: []
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: PlayerGUI
Description: CreatorGUI is an object that allows GUI to overlay on top of the 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. viewport in the creator. This class is only available in the creator.

1
yaml/types/CreatorHistory.yaml
View File

@@ -46,5 +46,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: CreatorHistory is a class that manages history (undo-redo) of this Description: CreatorHistory is a class that manages history (undo-redo) of this
game instance. This class is only available in the creator. game instance. This class is only available in the creator.

10
yaml/types/CreatorInterface.yaml
View File

@@ -6,59 +6,69 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns the target tool mode Description: Returns the target tool mode
- Name: TargetPartColor - Name: TargetPartColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns the target part color Description: Returns the target part color
- Name: TargetPartMaterial - Name: TargetPartMaterial
Type: PartMaterialEnum Type: PartMaterialEnum
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns the target part material Description: Returns the target part material
- Name: MoveSnapEnabled - Name: MoveSnapEnabled
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns the move snapping value Description: Returns the move snapping value
- Name: MoveSnapping - Name: MoveSnapping
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns whenever the move snapping is enabled by the user Description: Returns whenever the move snapping is enabled by the user
- Name: UserMoveSnapping - Name: UserMoveSnapping
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns the move snapping value defined by the user Description: Returns the move snapping value defined by the user
- Name: RotateSnapEnabled - Name: RotateSnapEnabled
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns whenever the rotate snapping is enabled by the user Description: Returns whenever the rotate snapping is enabled by the user
- Name: RotateSnapping - Name: RotateSnapping
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns the rotate snapping value Description: Returns the rotate snapping value
- Name: UserRotateSnapping - Name: UserRotateSnapping
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns the rotate snapping value defined by the user Description: Returns the rotate snapping value defined by the user
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: CreatorInterface represent the user interface of the creator. This Description: CreatorInterface represent the user interface of the creator. This
class is only available in the creator. class is only available in the creator.

1
yaml/types/CreatorSelections.yaml
View File

@@ -68,5 +68,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: CreatorSelections is an object that manages selections in the game Description: CreatorSelections is an object that manages selections in the game
instance. This class is only available in the creator. instance. This class is only available in the creator.

10
yaml/types/CreatorService.yaml
View File

@@ -6,24 +6,21 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: true
Description: The interface Description: The interface
- Name: Clipboard
Type: CreatorClipboard
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The clipboard
- Name: CurrentGame - Name: CurrentGame
Type: Game Type: Game
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: true
Description: Current active game Description: Current active game
- Name: LocalTestActive - Name: LocalTestActive
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns true if local test is active Description: Returns true if local test is active
Methods: [] Methods: []
Events: Events:
@@ -36,5 +33,6 @@ Events:
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Creator
Description: CreatorService is the class that manages the creator. This class is Description: CreatorService is the class that manages the creator. This class is
only available in the creator. only available in the creator.

2
yaml/types/Datastore.yaml
View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The key identifying this Datastore connection. Description: The key identifying this Datastore connection.
Methods: Methods:
- Name: GetAsync - Name: GetAsync
@@ -53,4 +54,5 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Datastore is an object that represent datastore connection. Description: Datastore is an object that represent datastore connection.

1
yaml/types/DatastoreService.yaml
View File

@@ -17,5 +17,6 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Datastore
Description: Datastore (not to be confused with the Datastore data type) is a Description: Datastore (not to be confused with the Datastore data type) is a
service used for storing data between place sessions. service used for storing data between place sessions.

4
yaml/types/Decal.yaml
View File

@@ -6,23 +6,27 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The image texture applied to the decal. Description: The image texture applied to the decal.
- Name: Energy - Name: Energy
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Energy multiplier for the decal. Description: Energy multiplier for the decal.
- Name: Color - Name: Color
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The color tint applied to the decal. Description: The color tint applied to the decal.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Decals are objects that can have an image texture and are wrapped Description: Decals are objects that can have an image texture and are wrapped
around other objects. around other objects.

19
yaml/types/Dynamic.yaml
View File

@@ -6,66 +6,84 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The position of the object. Description: The position of the object.
- Name: Rotation - Name: Rotation
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The rotation of the object. Description: The rotation of the object.
- Name: Size - Name: Size
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The size of the object. Description: The size of the object.
- Name: LocalPosition - Name: LocalPosition
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The position of the object relative to its parent. Description: The position of the object relative to its parent.
- Name: LocalRotation - Name: LocalRotation
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The rotation of the object relative to its parent. Description: The rotation of the object relative to its parent.
- Name: LocalSize - Name: LocalSize
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The size of the object relative to its parent. Description: The size of the object relative to its parent.
- Name: Quaternion - Name: Quaternion
Type: Quaternion Type: Quaternion
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The rotation of the object represented as a quaternion. 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 - Name: Locked
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the object can be selected in the Creator. Description: Determines whether the object can be selected in the Creator.
- Name: Forward - Name: Forward
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The forward direction vector of the object. Description: The forward direction vector of the object.
- Name: Right - Name: Right
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The right direction vector of the object. Description: The right direction vector of the object.
- Name: Up - Name: Up
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The up direction vector of the object. Description: The up direction vector of the object.
Methods: Methods:
- Name: LookAt - Name: LookAt
@@ -212,5 +230,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Dynamic is the base class where all objects with a position, Description: Dynamic is the base class where all objects with a position,
rotation and scale derive from. rotation and scale derive from.

10
yaml/types/Entity.yaml
View File

@@ -6,54 +6,63 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The color of the entity. Description: The color of the entity.
- Name: CastShadows - Name: CastShadows
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the entity casts shadows. Description: Determines whether the entity casts shadows.
- Name: IsSpawn - Name: IsSpawn
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the part can be used as a spawn location or not. Description: Determines whether the part can be used as a spawn location or not.
- Name: UseGravity - Name: UseGravity
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the entity is affected by gravity. Description: Determines whether the entity is affected by gravity.
- Name: Mass - Name: Mass
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the mass of the entity. Description: Determines the mass of the entity.
- Name: Friction - Name: Friction
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the friction of the entity. Description: Determines the friction of the entity.
- Name: Drag - Name: Drag
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the drag (air resistance) of the entity. Description: Determines the drag (air resistance) of the entity.
- Name: AngularDrag - Name: AngularDrag
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the angular drag of the entity. Description: Determines the angular drag of the entity.
- Name: Bounciness - Name: Bounciness
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the bounciness of the entity. Description: Determines the bounciness of the entity.
Methods: Methods:
- Name: AddForce - Name: AddForce
@@ -139,5 +148,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: true IsAbstract: true
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Entity represents a physics object that's related to building Description: Entity represents a physics object that's related to building
blocks (inherited by Part and Mesh) blocks (inherited by Part and Mesh)

5
yaml/types/Environment.yaml
View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the current camera which player is using to view Description: Determines the current camera which player is using to view
- Name: Gravity - Name: Gravity
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The direction and strength of gravity in the world. Description: The direction and strength of gravity in the world.
- Name: PartDestroyHeight - Name: PartDestroyHeight
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The height at which unanchored parts are destroyed when they fall below it. Description: The height at which unanchored parts are destroyed when they fall below it.
- Name: AutoGenerateNavMesh - Name: AutoGenerateNavMesh
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not to automatically build a navigation mesh Description: Determines whether or not to automatically build a navigation mesh
for NPC pathfinding. This property is disabled by default so there are no for NPC pathfinding. This property is disabled by default so there are no
performance issues with larger maps. performance issues with larger maps.
@@ -143,5 +147,6 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Environment
Description: Environment is the primary object intended for storing active Description: Environment is the primary object intended for storing active
objects in the place. objects in the place.

6
yaml/types/Explosion.yaml
View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the radius of this explosion Description: Determines the radius of this explosion
- Name: Force - Name: Force
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the force of this explosion that will be applied to Description: Determines the force of this explosion that will be applied to
affected hits affected hits
- Name: AffectAnchored - Name: AffectAnchored
@@ -19,18 +21,21 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines if this explosion should affect anchored parts or not Description: Determines if this explosion should affect anchored parts or not
- Name: Damage - Name: Damage
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Damage that is affected to player Description: Damage that is affected to player
- Name: AffectPredicate - Name: AffectPredicate
Type: function Type: function
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: |- Description: |-
A predicate function deciding whenever this part should be accepted or not A predicate function deciding whenever this part should be accepted or not
@@ -51,5 +56,6 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Explosion is a deadly explosion killing players and applying force Description: Explosion is a deadly explosion killing players and applying force
to parts at the given position. to parts at the given position.

2
yaml/types/FileLinkAsset.yaml
View File

@@ -6,10 +6,12 @@ Properties:
IsAccessibleByScripts: false IsAccessibleByScripts: false
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The ID of the file Description: The ID of the file
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Represents a link to a file path in the file system Description: Represents a link to a file path in the file system

1
yaml/types/FilterService.yaml
View File

@@ -17,4 +17,5 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Filter
Description: FilterService is a service which processes and filter user inputs Description: FilterService is a service which processes and filter user inputs

1
yaml/types/Folder.yaml
View File

@@ -6,4 +6,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Folder is similar to a model, used for storing objects in the place. Description: Folder is similar to a model, used for storing objects in the place.

1
yaml/types/FontAsset.yaml
View File

@@ -6,4 +6,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: true IsAbstract: true
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Base class for font assets Description: Base class for font assets

26
yaml/types/GUI.yaml
View File

@@ -1,9 +1,31 @@
Name: GUI Name: GUI
BaseType: UIField BaseType: Instance
Properties: [] 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: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: GUI is a class that is used to create a GUI. Description: GUI is a class that is used to create a GUI.

5
yaml/types/GUI3D.yaml
View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the canvas size for this GUI Description: Determines the canvas size for this GUI
- Name: Shaded - Name: Shaded
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines if this GUI3D should be affected by lighting Description: Determines if this GUI3D should be affected by lighting
- Name: FaceCamera - Name: FaceCamera
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines if this GUI3D always face the camera? Description: Determines if this GUI3D always face the camera?
- Name: Transparent - Name: Transparent
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines if the background should be transparent. Recommended to Description: Determines if the background should be transparent. Recommended to
be set to false if transparent background is not needed. be set to false if transparent background is not needed.
Methods: [] Methods: []
@@ -31,4 +35,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: GUI3D is a class that allows GUI to be displayed in a 3D space. Description: GUI3D is a class that allows GUI to be displayed in a 3D space.

6
yaml/types/Game.yaml
View File

@@ -6,30 +6,35 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns true if this current session is being tested locally Description: Returns true if this current session is being tested locally
- Name: GameID - Name: GameID
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The ID of the current Polytoria place. Description: The ID of the current Polytoria place.
- Name: ServerID - Name: ServerID
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The server ID of the current instance. Description: The server ID of the current instance.
- Name: UpTime - Name: UpTime
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The uptime of this game in seconds. Description: The uptime of this game in seconds.
- Name: InstanceCount - Name: InstanceCount
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The total number of instances currently loaded. Description: The total number of instances currently loaded.
Methods: [] Methods: []
Events: Events:
@@ -45,5 +50,6 @@ Events:
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: game
Description: Game is the root object in the Polytoria instance tree. It is the Description: Game is the root object in the Polytoria instance tree. It is the
object from which everything is descended. object from which everything is descended.

6
yaml/types/Grabbable.yaml
View File

@@ -6,30 +6,35 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the force used to drag this object. Description: Determines the force used to drag this object.
- Name: MaxRange - Name: MaxRange
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the max range that this object can be dragged. Description: Determines the max range that this object can be dragged.
- Name: PermissionMode - Name: PermissionMode
Type: GrabbablePermissionModeEnum Type: GrabbablePermissionModeEnum
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the permission mode for this grabber Description: Determines the permission mode for this grabber
- Name: Dragger - Name: Dragger
Type: Player Type: Player
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns the current dragger Description: Returns the current dragger
- Name: PermissionPredicate - Name: PermissionPredicate
Type: function Type: function
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: >- Description: >-
A predicate function deciding whenever this player can grab this object. A predicate function deciding whenever this player can grab this object.
`PermissionMode` must be set to `GrabbablePermissionMode.Scripted` `PermissionMode` must be set to `GrabbablePermissionMode.Scripted`
@@ -59,5 +64,6 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Grabbable represents a object that can be dragged by user. It can 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. be parented to Physical to give user ability to drag that object.

13
yaml/types/GradientSky.yaml
View File

@@ -6,76 +6,89 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the color emitting off the sun. Description: Determines the color emitting off the sun.
- Name: SunDiscMultiplier - Name: SunDiscMultiplier
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the multiplier of the sun. Description: Determines the multiplier of the sun.
- Name: SunDiscExponent - Name: SunDiscExponent
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the exponent of the sun. Description: Determines the exponent of the sun.
- Name: SunHaloColor - Name: SunHaloColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the color of the sun halo. Description: Determines the color of the sun halo.
- Name: SunHaloExponent - Name: SunHaloExponent
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the exponent of the sun halo. Description: Determines the exponent of the sun halo.
- Name: SunHaloContribution - Name: SunHaloContribution
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the contribution of the sun halo. Description: Determines the contribution of the sun halo.
- Name: HorizonLineColor - Name: HorizonLineColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the horizon line's color. Description: Determines the horizon line's color.
- Name: HorizonLineExponent - Name: HorizonLineExponent
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the horizon line's exponent. Description: Determines the horizon line's exponent.
- Name: HorizonLineContribution - Name: HorizonLineContribution
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines how much the horizon line contributes. Description: Determines how much the horizon line contributes.
- Name: SkyGradientTop - Name: SkyGradientTop
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the top color of the gradient. Description: Determines the top color of the gradient.
- Name: SkyGradientBottom - Name: SkyGradientBottom
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the bottom color of the gradient. Description: Determines the bottom color of the gradient.
- Name: SkyGradientExponent - Name: SkyGradientExponent
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the gradient's exponent. Description: Determines the gradient's exponent.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: GradientSky is a class that is used to set a gradient skybox in the world. Description: GradientSky is a class that is used to set a gradient skybox in the world.

1
yaml/types/Hidden.yaml
View File

@@ -6,4 +6,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Hidden is a object used for hiding instances. Description: Hidden is a object used for hiding instances.

5
yaml/types/HttpRequestData.yaml
View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The target endpoint of the HTTP request. Description: The target endpoint of the HTTP request.
- Name: Method - Name: Method
Type: HttpRequestMethodEnum Type: HttpRequestMethodEnum
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The HTTP method used for the request. Description: The HTTP method used for the request.
- Name: Body - Name: Body
Type: string Type: string
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The payload sent with the request. Description: The payload sent with the request.
- Name: Headers - Name: Headers
Type: table Type: table
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: A table of HTTP headers to include with the request, represented as Description: A table of HTTP headers to include with the request, represented as
key-value pairs. key-value pairs.
Methods: Methods:
@@ -38,4 +42,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: HttpRequestData represents the data required to construct an HTTP request Description: HttpRequestData represents the data required to construct an HTTP request

5
yaml/types/HttpResponseData.yaml
View File

@@ -6,18 +6,21 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether the HTTP request completed successfully. Description: Indicates whether the HTTP request completed successfully.
- Name: StatusCode - Name: StatusCode
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The HTTP status code returned by the server. Description: The HTTP status code returned by the server.
- Name: Headers - Name: Headers
Type: table Type: table
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: A table containing the HTTP response headers returned by the Description: A table containing the HTTP response headers returned by the
server, represented as key-value pairs. server, represented as key-value pairs.
- Name: Body - Name: Body
@@ -25,10 +28,12 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The response payload returned by the server as a string buffer. Description: The response payload returned by the server as a string buffer.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: HttpResponseData represents the result of an HTTP request. Description: HttpResponseData represents the result of an HTTP request.

1
yaml/types/HttpService.yaml
View File

@@ -108,4 +108,5 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Http
Description: Http is a service used for HTTP communications and requests. Description: Http is a service used for HTTP communications and requests.

1
yaml/types/IOService.yaml
View File

@@ -61,5 +61,6 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: IO
Description: Class for interacting with IO in project, only usable with scripts Description: Class for interacting with IO in project, only usable with scripts
with the respective permission. with the respective permission.

8
yaml/types/Image3D.yaml
View File

@@ -6,46 +6,54 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Specifies the image of the decal. Description: Specifies the image of the decal.
- Name: TextureScale - Name: TextureScale
Type: Vector2 Type: Vector2
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The scale of the texture on the decal. Description: The scale of the texture on the decal.
- Name: TextureOffset - Name: TextureOffset
Type: Vector2 Type: Vector2
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The offset of the texture on the decal. Description: The offset of the texture on the decal.
- Name: Color - Name: Color
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the color of the decal. Description: Determines the color of the decal.
- Name: CastShadows - Name: CastShadows
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the decal should cast shadows. Description: Determines whether or not the decal should cast shadows.
- Name: Shaded - Name: Shaded
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the decal should be affected by lighting. Description: Determines whether or not the decal should be affected by lighting.
- Name: FaceCamera - Name: FaceCamera
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not the decal should always face the camera. Description: Determines whether or not the decal should always face the camera.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Decals are objects that can have an image texture and are placed in the world. Description: Decals are objects that can have an image texture and are placed in the world.

1
yaml/types/ImageAsset.yaml
View File

@@ -6,4 +6,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: true IsAbstract: true
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Base class for image assets Description: Base class for image assets

1
yaml/types/InputAction.yaml
View File

@@ -6,4 +6,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Base class for input action Description: Base class for input action

4
yaml/types/InputActionAxis.yaml
View File

@@ -6,22 +6,26 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Collection of negative inputs Description: Collection of negative inputs
- Name: Positive - Name: Positive
Type: InputButtonCollection Type: InputButtonCollection
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Collection of positive inputs Description: Collection of positive inputs
- Name: Value - Name: Value
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The value of the input Description: The value of the input
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: InputActionAxis is a class that represents input action of axis type. Description: InputActionAxis is a class that represents input action of axis type.

4
yaml/types/InputActionButton.yaml
View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Collection of button inputs. Description: Collection of button inputs.
- Name: IsPressed - Name: IsPressed
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns true if any of the button in the collection is currently Description: Returns true if any of the button in the collection is currently
being pressed. being pressed.
- Name: Weight - Name: Weight
@@ -19,6 +21,7 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns the current analog input of the button. Description: Returns the current analog input of the button.
Methods: [] Methods: []
Events: Events:
@@ -31,4 +34,5 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: InputActionButton is a class that represents input action of button type. Description: InputActionButton is a class that represents input action of button type.

6
yaml/types/InputActionVector2.yaml
View File

@@ -6,34 +6,40 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Collection of up inputs. Description: Collection of up inputs.
- Name: Down - Name: Down
Type: InputButtonCollection Type: InputButtonCollection
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Collection of down inputs. Description: Collection of down inputs.
- Name: Left - Name: Left
Type: InputButtonCollection Type: InputButtonCollection
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Collection of left inputs. Description: Collection of left inputs.
- Name: Right - Name: Right
Type: InputButtonCollection Type: InputButtonCollection
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Collection of right inputs. Description: Collection of right inputs.
- Name: Value - Name: Value
Type: Vector2 Type: Vector2
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The value of this input Description: The value of this input
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: InputActionVector2 is a class that represents input action of Vector2 type. Description: InputActionVector2 is a class that represents input action of Vector2 type.

17
yaml/types/InputButton.yaml
View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Key code for this button Description: Key code for this button
Methods: Methods:
- Name: New - Name: New
@@ -26,8 +27,24 @@ Methods:
IsObsolete: false IsObsolete: false
IsStatic: true IsStatic: true
Description: Create new button of this keycode 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: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: InputButton is a class that represents a button KeyCode Description: InputButton is a class that represents a button KeyCode

1
yaml/types/InputButtonCollection.yaml
View File

@@ -28,4 +28,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: A collection of Input Buttons Description: A collection of Input Buttons

12
yaml/types/InputService.yaml
View File

@@ -6,66 +6,77 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether the game window is currently focused. Description: Indicates whether the game window is currently focused.
- Name: IsTouchscreen - Name: IsTouchscreen
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether the input device is a touchscreen. Description: Indicates whether the input device is a touchscreen.
- Name: IsGameFocused - Name: IsGameFocused
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether the game is currently focused. Description: Indicates whether the game is currently focused.
- Name: IsInputFocused - Name: IsInputFocused
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether an input is currently focused. Description: Indicates whether an input is currently focused.
- Name: IsGamepadConnected - Name: IsGamepadConnected
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether a gamepad is currently connected. Description: Indicates whether a gamepad is currently connected.
- Name: IsMenuOpened - Name: IsMenuOpened
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether the game menu is currently opened. Description: Indicates whether the game menu is currently opened.
- Name: CursorLocked - Name: CursorLocked
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the cursor is currently locked. Description: Determines whether the cursor is currently locked.
- Name: CursorVisible - Name: CursorVisible
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the cursor is currently visible. Description: Determines whether the cursor is currently visible.
- Name: MousePosition - Name: MousePosition
Type: Vector2 Type: Vector2
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates the current position of the mouse cursor. Description: Indicates the current position of the mouse cursor.
- Name: ScreenWidth - Name: ScreenWidth
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates the width of the screen. Description: Indicates the width of the screen.
- Name: ScreenHeight - Name: ScreenHeight
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates the height of the screen. Description: Indicates the height of the screen.
Methods: Methods:
- Name: GetMouseWorldPosition - Name: GetMouseWorldPosition
@@ -179,5 +190,6 @@ Events:
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Input
Description: InputService is a class used for retrieving user input data, such Description: InputService is a class used for retrieving user input data, such
as the mouse and keyboard. as the mouse and keyboard.

1
yaml/types/InsertService.yaml
View File

@@ -39,5 +39,6 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Insert
Description: Insert is a class used for inserting user-generated models into Description: Insert is a class used for inserting user-generated models into
your game via scripts. your game via scripts.

48
yaml/types/Instance.yaml
View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Defines the parent of this instance in the hierarchy. Description: Defines the parent of this instance in the hierarchy.
- Name: EditableChildren - Name: EditableChildren
Type: boolean Type: boolean
IsAccessibleByScripts: false IsAccessibleByScripts: false
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determine if children is editable, this is to be used if this Description: Determine if children is editable, this is to be used if this
instance is a Linked model. Only used in creator. instance is a Linked model. Only used in creator.
- Name: Tags - Name: Tags
@@ -19,6 +21,7 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Tags associated with this instance. Description: Tags associated with this instance.
Methods: Methods:
- Name: GetDescendants - Name: GetDescendants
@@ -65,6 +68,28 @@ Methods:
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Finds a child of this instance by class name. 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 - Name: MoveChild
ReturnType: nil ReturnType: nil
Parameters: Parameters:
@@ -208,6 +233,28 @@ Methods:
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Sets the parent of this instance. 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: Events:
- Name: ChildAdded - Name: ChildAdded
Arguments: Arguments:
@@ -233,5 +280,6 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: true IsAbstract: true
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Instance is the base class of all classes. Every class derives from Description: Instance is the base class of all classes. Every class derives from
it and has all properties, events and functions Instance has. it and has all properties, events and functions Instance has.

2
yaml/types/InstanceValue.yaml
View File

@@ -6,10 +6,12 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The value of this object. Description: The value of this object.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: InstanceValue is an object that holds an Instance value. Description: InstanceValue is an object that holds an Instance value.

2
yaml/types/IntValue.yaml
View File

@@ -6,10 +6,12 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The value of this object. Description: The value of this object.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: IntValue is an object that holds an integer value. Description: IntValue is an object that holds an integer value.

6
yaml/types/InteractionPrompt.yaml
View File

@@ -6,30 +6,35 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: WIP Description: WIP
- Name: SubTitle - Name: SubTitle
Type: string Type: string
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: WIP Description: WIP
- Name: HoldDuration - Name: HoldDuration
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: WIP Description: WIP
- Name: Key - Name: Key
Type: KeyCodeEnum Type: KeyCodeEnum
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: WIP Description: WIP
- Name: UseDefaultUI - Name: UseDefaultUI
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: WIP Description: WIP
Methods: [] Methods: []
Events: Events:
@@ -45,4 +50,5 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: WIP class, not functional yet Description: WIP class, not functional yet

1
yaml/types/Inventory.yaml
View File

@@ -6,4 +6,5 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Inventory is a container for Tools, equippable by player. Description: Inventory is a container for Tools, equippable by player.

5
yaml/types/Light.yaml
View File

@@ -6,28 +6,33 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Sets the color of the light. Description: Sets the color of the light.
- Name: Brightness - Name: Brightness
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Sets the brightness of the light. Description: Sets the brightness of the light.
- Name: Specular - Name: Specular
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Sets the specular intensity of the light. Description: Sets the specular intensity of the light.
- Name: Shadows - Name: Shadows
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Enables or disables shadows cast by the light. Description: Enables or disables shadows cast by the light.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: true IsAbstract: true
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Light is an abstract base class for all light objects in the world. Description: Light is an abstract base class for all light objects in the world.

8
yaml/types/Lighting.yaml
View File

@@ -6,48 +6,56 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Sets the skybox to one of the preset skyboxes. Description: Sets the skybox to one of the preset skyboxes.
- Name: AmbientSource - Name: AmbientSource
Type: AmbientSourceEnum Type: AmbientSourceEnum
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the source of ambient lighting in the place. Description: Determines the source of ambient lighting in the place.
- Name: AmbientColor - Name: AmbientColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Sets the ambient color of the lighting in the place. Description: Sets the ambient color of the lighting in the place.
- Name: FogEnabled - Name: FogEnabled
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Enables or disables fog in the place. Description: Enables or disables fog in the place.
- Name: FogColor - Name: FogColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Sets the color of the fog in the place. Description: Sets the color of the fog in the place.
- Name: FogStartDistance - Name: FogStartDistance
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Sets the distance from the camera at which fog begins to appear. Description: Sets the distance from the camera at which fog begins to appear.
- Name: FogEndDistance - Name: FogEndDistance
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Sets the distance from the camera at which fog stops appearing. Description: Sets the distance from the camera at which fog stops appearing.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Lighting
Description: Lighting is responsible for controlling the state of the 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 in the place. It provides many different options for creators to enhance and
fine-tune the visuals of their worlds. fine-tune the visuals of their worlds.

1
yaml/types/LightingModifier.yaml
View File

@@ -6,4 +6,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: true IsAbstract: true
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Base class for lighting modifiers Description: Base class for lighting modifiers

3
yaml/types/Marker3D.yaml
View File

@@ -6,17 +6,20 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Length of this Marker Description: Length of this Marker
- Name: AppearOnTop - Name: AppearOnTop
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determine if this marker should appear on top of everything else in 3D Description: Determine if this marker should appear on top of everything else in 3D
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Marker3D is a object that allows marking a specific point in world. Description: Marker3D is a object that allows marking a specific point in world.
This will hint an axis gizmo in local test and creator. This will hint an axis gizmo in local test and creator.

17
yaml/types/Mesh.yaml
View File

@@ -6,54 +6,63 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The mesh asset used by this Mesh. Description: The mesh asset used by this Mesh.
- Name: IncludeOffset - Name: IncludeOffset
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Whether to keep the offset of the mesh or recenter it. Description: Whether to keep the offset of the mesh or recenter it.
- Name: CollisionType - Name: CollisionType
Type: CollisionTypeEnum Type: CollisionTypeEnum
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The type of collision shape to apply to the mesh. Description: The type of collision shape to apply to the mesh.
- Name: PlayAnimationOnStart - Name: PlayAnimationOnStart
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Whether to play the mesh's animation automatically when the mesh is loaded. Description: Whether to play the mesh's animation automatically when the mesh is loaded.
- Name: UsePartColor - Name: UsePartColor
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Whether to use the color of the part this mesh is attached to. Description: Whether to use the color of the part this mesh is attached to.
- Name: Color - Name: Color
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The color of the mesh. Description: The color of the mesh.
- Name: CastShadows - Name: CastShadows
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Whether the mesh casts shadows. Description: Whether the mesh casts shadows.
- Name: CurrentAnimation - Name: CurrentAnimation
Type: string Type: string
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates the name of the current animation playing on the mesh. Description: Indicates the name of the current animation playing on the mesh.
- Name: IsAnimationPlaying - Name: IsAnimationPlaying
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether an animation is currently playing on the mesh. Description: Indicates whether an animation is currently playing on the mesh.
Methods: Methods:
- Name: PlayAnimation - Name: PlayAnimation
@@ -93,10 +102,18 @@ Methods:
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Gets a list of all animations available on the mesh. 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: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Represents a part that can have custom mesh applied to it, the mesh 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 may be from the Polytoria Store (Hats, Tools and Heads) or user-uploaded
meshes. meshes.

31
yaml/types/MeshAnimationInfo.yaml Normal file
View File

@@ -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

1
yaml/types/MeshAsset.yaml
View File

@@ -6,4 +6,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: true IsAbstract: true
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Base class for mesh assets Description: Base class for mesh assets

1
yaml/types/Model.yaml
View File

@@ -6,5 +6,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Model is an instance that can hold other instances, and which Description: Model is an instance that can hold other instances, and which
transform affects its children. transform affects its children.

1
yaml/types/ModuleScript.yaml
View File

@@ -6,6 +6,7 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: ModuleScripts are specialized scripts to hold data that can be Description: ModuleScripts are specialized scripts to hold data that can be
accessed by other scripts using the require() function. It is important to 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 define and return a table in a ModuleScript. When the place starts, the server

21
yaml/types/NPC.yaml
View File

@@ -6,120 +6,140 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The offset to the seat at which the NPC is positioned when sitting. Description: The offset to the seat at which the NPC is positioned when sitting.
- Name: Health - Name: Health
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The current health of the NPC. Description: The current health of the NPC.
- Name: MaxHealth - Name: MaxHealth
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The maximum health of the NPC. Description: The maximum health of the NPC.
- Name: JumpPower - Name: JumpPower
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the jump power of the NPC. Description: Determines the jump power of the NPC.
- Name: WalkSpeed - Name: WalkSpeed
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the walking speed of the NPC. Description: Determines the walking speed of the NPC.
- Name: UseNametag - Name: UseNametag
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the NPC uses a nametag. Description: Determines whether the NPC uses a nametag.
- Name: NametagOffset - Name: NametagOffset
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the offset position of the NPC's nametag. Description: Determines the offset position of the NPC's nametag.
- Name: DisplayName - Name: DisplayName
Type: string Type: string
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the display name of the NPC. Description: Determines the display name of the NPC.
- Name: JumpSound - Name: JumpSound
Type: Sound Type: Sound
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the sound played when the NPC jumps. Description: Determines the sound played when the NPC jumps.
- Name: IsSitting - Name: IsSitting
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether the NPC is currently sitting. Description: Indicates whether the NPC is currently sitting.
- Name: IsDead - Name: IsDead
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether the NPC is currently dead. Description: Indicates whether the NPC is currently dead.
- Name: HoldingTool - Name: HoldingTool
Type: Tool Type: Tool
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates the tool currently held by the NPC. Description: Indicates the tool currently held by the NPC.
- Name: SittingIn - Name: SittingIn
Type: Seat Type: Seat
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates the seat in which the NPC is currently sitting. Description: Indicates the seat in which the NPC is currently sitting.
- Name: Character - Name: Character
Type: CharacterModel Type: CharacterModel
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The character model associated with the NPC. Description: The character model associated with the NPC.
- Name: MoveTarget - Name: MoveTarget
Type: Dynamic Type: Dynamic
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the instance the NPC should walk towards. Description: Determines the instance the NPC should walk towards.
- Name: OnGround - Name: OnGround
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether the NPC is currently on the ground. Description: Indicates whether the NPC is currently on the ground.
- Name: OnCeiling - Name: OnCeiling
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether the NPC is currently on the ceiling. Description: Indicates whether the NPC is currently on the ceiling.
- Name: NavDestinationDistance - Name: NavDestinationDistance
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates the distance to the navigation destination. Description: Indicates the distance to the navigation destination.
- Name: NavDestinationReached - Name: NavDestinationReached
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether the NPC has reached its navigation destination. Description: Indicates whether the NPC has reached its navigation destination.
- Name: NavDestinationValid - Name: NavDestinationValid
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Indicates whether the navigation destination is valid. Description: Indicates whether the navigation destination is valid.
Methods: Methods:
- Name: Kill - Name: Kill
@@ -247,6 +267,7 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: NPC (non-player character) is an object similar to a Player but 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 that can be controlled by code. Like players, it can walk and jump, and its
body part colors can be customized. body part colors can be customized.

1
yaml/types/NetMessage.yaml
View File

@@ -221,5 +221,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Represents a network message used for communication between clients Description: Represents a network message used for communication between clients
and servers. and servers.

2
yaml/types/NetworkEvent.yaml
View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines if this network event should send messages reliably. Description: Determines if this network event should send messages reliably.
Recommended to be off if you're passing lot of data that doesn't need to Recommended to be off if you're passing lot of data that doesn't need to
arrive reliably. arrive reliably.
@@ -69,6 +70,7 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: NetworkEvents are events that can be called to communicate between Description: NetworkEvents are events that can be called to communicate between
server and client. NetMessages are the class used for sharing data between server and client. NetMessages are the class used for sharing data between
server and client when sending NetworkEvents. server and client when sending NetworkEvents.

33
yaml/types/NetworkedObject.yaml
View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Name of this object Description: Name of this object
- Name: ClassName - Name: ClassName
Type: string Type: string
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Class name of this object Description: Class name of this object
- Name: Shared - Name: Shared
Type: ScriptSharedTable Type: ScriptSharedTable
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: A shared table accessible by scripts. Description: A shared table accessible by scripts.
- Name: NetworkedObjectID - Name: NetworkedObjectID
Type: string Type: string
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns networked ID of this object. Networked ID are always unique Description: Returns networked ID of this object. Networked ID are always unique
per network session. per network session.
- Name: ObjectID - Name: ObjectID
@@ -31,12 +35,14 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns object ID of this object. Object ID originates from the .poly file. Description: Returns object ID of this object. Object ID originates from the .poly file.
- Name: ExistInNetwork - Name: ExistInNetwork
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns true if this object exists in network, false if this object Description: Returns true if this object exists in network, false if this object
is spawned by the local client. is spawned by the local client.
Methods: Methods:
@@ -85,6 +91,32 @@ Methods:
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Deletes the instance (same as Destroy method) 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: Events:
- Name: PropertyChanged - Name: PropertyChanged
Arguments: Arguments:
@@ -103,5 +135,6 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: true IsAbstract: true
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: NetworkedObject is a base class for all object that's synchronized Description: NetworkedObject is a base class for all object that's synchronized
by the network. by the network.

3
yaml/types/NewServerRequestData.yaml
View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Target place path. Description: Target place path.
- Name: MaxPlayers - Name: MaxPlayers
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: How much player slot should the new server allocates for. Description: How much player slot should the new server allocates for.
Methods: Methods:
- Name: New - Name: New
@@ -25,5 +27,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: NewServerRequestData represents the request data for a new server Description: NewServerRequestData represents the request data for a new server
instance, to be used with PlacesService. instance, to be used with PlacesService.

5
yaml/types/NumberRange.yaml
View File

@@ -1,17 +1,19 @@
Name: NumberRange Name: NumberRange
BaseType: ValueType BaseType: null
Properties: Properties:
- Name: Min - Name: Min
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the minimum value of the range. Description: Determines the minimum value of the range.
- Name: Max - Name: Max
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the maximum value of the range. Description: Determines the maximum value of the range.
Methods: Methods:
- Name: New - Name: New
@@ -46,5 +48,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: NumberRange is a data type that represents a range between two Description: NumberRange is a data type that represents a range between two
numbers, defined by a minimum and maximum value. numbers, defined by a minimum and maximum value.

2
yaml/types/NumberValue.yaml
View File

@@ -6,10 +6,12 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The value of this object. Description: The value of this object.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: NumberValue is an object that holds a number value. Description: NumberValue is an object that holds a number value.

2
yaml/types/PTAudioAsset.yaml
View File

@@ -6,10 +6,12 @@ Properties:
IsAccessibleByScripts: false IsAccessibleByScripts: false
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The audio ID to load Description: The audio ID to load
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Audio asset which is loaded from Polytoria Description: Audio asset which is loaded from Polytoria

1
yaml/types/PTCallback.yaml
View File

@@ -6,5 +6,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: A function that doesn't expect a return value. This will sometimes Description: A function that doesn't expect a return value. This will sometimes
be referred as `function` be referred as `function`

1
yaml/types/PTFunction.yaml
View File

@@ -6,5 +6,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: A function that expects a return value. This will sometimes be Description: A function that expects a return value. This will sometimes be
referred as `function` referred as `function`

3
yaml/types/PTImageAsset.yaml
View File

@@ -6,16 +6,19 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Asset ID of this image Description: Asset ID of this image
- Name: ImageType - Name: ImageType
Type: ImageTypeEnum Type: ImageTypeEnum
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Image type of this image Description: Image type of this image
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: An image asset that's loaded from Polytoria. Description: An image asset that's loaded from Polytoria.

2
yaml/types/PTMeshAsset.yaml
View File

@@ -6,10 +6,12 @@ Properties:
IsAccessibleByScripts: false IsAccessibleByScripts: false
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Asset ID of this mesh Description: Asset ID of this mesh
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: A mesh asset that's loaded from Polytoria. Description: A mesh asset that's loaded from Polytoria.

12
yaml/types/PTSignal.yaml
View File

@@ -24,6 +24,17 @@ Methods:
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Disconnect a function from this signal 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 - Name: Wait
ReturnType: any ReturnType: any
Parameters: [] Parameters: []
@@ -46,4 +57,5 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: A signal which scripts can subscribe to Description: A signal which scripts can subscribe to

5
yaml/types/Part.yaml
View File

@@ -6,28 +6,33 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the shape of the part. Description: Determines the shape of the part.
- Name: Material - Name: Material
Type: PartMaterialEnum Type: PartMaterialEnum
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the material of the part. Description: Determines the material of the part.
- Name: Color - Name: Color
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the color of the part. Description: Determines the color of the part.
- Name: CastShadows - Name: CastShadows
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the part casts shadows. Description: Determines whether the part casts shadows.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Parts represent the basic building blocks of the world. Description: Parts represent the basic building blocks of the world.

8
yaml/types/Particles.yaml
View File

@@ -6,42 +6,49 @@ Properties:
IsAccessibleByScripts: false IsAccessibleByScripts: false
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The image used for the particles. Description: The image used for the particles.
- Name: Color - Name: Color
Type: ColorSeries Type: ColorSeries
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The color gradient used for the particles. Description: The color gradient used for the particles.
- Name: Lifetime - Name: Lifetime
Type: NumberRange Type: NumberRange
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the lifetime of a particle. Description: Determines the lifetime of a particle.
- Name: Amount - Name: Amount
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the number of particles emitted. Description: Determines the number of particles emitted.
- Name: Gravity - Name: Gravity
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the gravity effect applied to the particles. Description: Determines the gravity effect applied to the particles.
- Name: Shaded - Name: Shaded
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the particles are shaded. Description: Determines whether the particles are shaded.
- Name: Autoplay - Name: Autoplay
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the particle system plays automatically. Description: Determines whether the particle system plays automatically.
Methods: Methods:
- Name: Play - Name: Play
@@ -73,5 +80,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: Particles represents a particle system that can be used to create Description: Particles represents a particle system that can be used to create
various visual effects. various visual effects.

12
yaml/types/Physical.yaml
View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether this object is affected by physics. Description: Determines whether this object is affected by physics.
- Name: CanCollide - Name: CanCollide
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether this object can collide with other objects. Description: Determines whether this object can collide with other objects.
- Name: Velocity - Name: Velocity
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the linear velocity of this object. Description: Determines the linear velocity of this object.
- Name: AngularVelocity - Name: AngularVelocity
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the angular velocity of this object. Description: Determines the angular velocity of this object.
Methods: Methods:
- Name: SetNetworkAuthority - Name: SetNetworkAuthority
@@ -37,6 +41,13 @@ Methods:
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Sets the network authority of this object to the specified player. 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 - Name: MovePosition
ReturnType: nil ReturnType: nil
Parameters: Parameters:
@@ -84,4 +95,5 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: true IsAbstract: true
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Physical represents an object affected by physics in the world. Description: Physical represents an object affected by physics in the world.

1
yaml/types/PhysicalModel.yaml
View File

@@ -6,5 +6,6 @@ Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: PhysicalModel is a object that represent a group of objects, that's Description: PhysicalModel is a object that represent a group of objects, that's
affected by physics. affected by physics.

1
yaml/types/PlacesService.yaml
View File

@@ -88,4 +88,5 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Places
Description: PlacesService is a service that is used to join players to other places Description: PlacesService is a service that is used to join players to other places

22
yaml/types/Player.yaml
View File

@@ -6,126 +6,147 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The unique ID of the player. Description: The unique ID of the player.
- Name: CanMove - Name: CanMove
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player can move. Description: Determines whether the player can move.
- Name: SprintSpeed - Name: SprintSpeed
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the sprinting speed of the player. Description: Determines the sprinting speed of the player.
- Name: Stamina - Name: Stamina
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the current stamina of the player. Description: Determines the current stamina of the player.
- Name: MaxStamina - Name: MaxStamina
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the maximum stamina of the player. Description: Determines the maximum stamina of the player.
- Name: UseStamina - Name: UseStamina
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player uses stamina. Description: Determines whether the player uses stamina.
- Name: StaminaRegen - Name: StaminaRegen
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the rate at which the player's stamina regenerates. Description: Determines the rate at which the player's stamina regenerates.
- Name: StaminaBurn - Name: StaminaBurn
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the rate at which the player's stamina depletes while sprinting. Description: Determines the rate at which the player's stamina depletes while sprinting.
- Name: RespawnTime - Name: RespawnTime
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the time the player has to wait before respawning. Description: Determines the time the player has to wait before respawning.
- Name: UseHeadTurning - Name: UseHeadTurning
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player uses head turning. Description: Determines whether the player uses head turning.
- Name: UseBubbleChat - Name: UseBubbleChat
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player uses bubble chat. Description: Determines whether the player uses bubble chat.
- Name: AutoLoadAppearance - Name: AutoLoadAppearance
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player's appearance is automatically loaded. Description: Determines whether the player's appearance is automatically loaded.
- Name: NetworkPing - Name: NetworkPing
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The amount of network latency (ping) the player is experiencing. Description: The amount of network latency (ping) the player is experiencing.
- Name: IsAdmin - Name: IsAdmin
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player is an administrator. Description: Determines whether the player is an administrator.
- Name: IsCreator - Name: IsCreator
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player is the creator of the game. Description: Determines whether the player is the creator of the game.
- Name: ChatColor - Name: ChatColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the chat color of the player. Description: Determines the chat color of the player.
- Name: IsLocal - Name: IsLocal
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player is the local player. Description: Determines whether the player is the local player.
- Name: IsClimbing - Name: IsClimbing
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player is currently climbing. Description: Determines whether the player is currently climbing.
- Name: ClimbingTruss - Name: ClimbingTruss
Type: Truss Type: Truss
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the truss the player is currently climbing. Description: Determines the truss the player is currently climbing.
- Name: UserPlatform - Name: UserPlatform
Type: ClientPlatformEnum Type: ClientPlatformEnum
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the platform the player is using. Description: Determines the platform the player is using.
- Name: Inventory - Name: Inventory
Type: Inventory Type: Inventory
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The inventory of the player. Description: The inventory of the player.
Methods: Methods:
- Name: Jump - Name: Jump
@@ -179,4 +200,5 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: null
Description: Player represents a user playing the game. Description: Player represents a user playing the game.

17
yaml/types/PlayerDefaults.yaml
View File

@@ -6,96 +6,112 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The default maximum health of the player. Description: The default maximum health of the player.
- Name: WalkSpeed - Name: WalkSpeed
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The default walking speed of the player. Description: The default walking speed of the player.
- Name: SprintSpeed - Name: SprintSpeed
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The default sprinting speed of the player. Description: The default sprinting speed of the player.
- Name: JumpPower - Name: JumpPower
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The default jump power of the player. Description: The default jump power of the player.
- Name: RespawnTime - Name: RespawnTime
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The default time the player has to wait before respawning. Description: The default time the player has to wait before respawning.
- Name: ChatColor - Name: ChatColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The default chat color of the player. Description: The default chat color of the player.
- Name: CanMove - Name: CanMove
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player can move by default. Description: Determines whether the player can move by default.
- Name: StaminaBurn - Name: StaminaBurn
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The rate at which the player's stamina depletes while sprinting. Description: The rate at which the player's stamina depletes while sprinting.
- Name: UseStamina - Name: UseStamina
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player uses stamina. Description: Determines whether the player uses stamina.
- Name: StaminaEnabled - Name: StaminaEnabled
Type: boolean Type: boolean
IsAccessibleByScripts: false IsAccessibleByScripts: false
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Legacy value for stamina. Description: Legacy value for stamina.
- Name: Stamina - Name: Stamina
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the default stamina of players. Description: Determines the default stamina of players.
- Name: MaxStamina - Name: MaxStamina
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the default maximum stamina of players. Description: Determines the default maximum stamina of players.
- Name: StaminaRegen - Name: StaminaRegen
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines the rate at which the player's stamina regenerates. Description: Determines the rate at which the player's stamina regenerates.
- Name: UseHeadTurning - Name: UseHeadTurning
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player uses head turning by default. Description: Determines whether the player uses head turning by default.
- Name: UseBubbleChat - Name: UseBubbleChat
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player uses bubble chat by default. Description: Determines whether the player uses bubble chat by default.
- Name: AutoLoadAppearance - Name: AutoLoadAppearance
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether the player's appearance is automatically loaded Description: Determines whether the player's appearance is automatically loaded
by default. by default.
Methods: Methods:
@@ -110,5 +126,6 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: PlayerDefaults
Description: PlayerDefaults is a service used for storing the default values of Description: PlayerDefaults is a service used for storing the default values of
the Player when created. the Player when created.

1
yaml/types/PlayerGUI.yaml
View File

@@ -6,4 +6,5 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: PlayerGUI
Description: PlayerGUI is a class that contains all custom GUIs. Description: PlayerGUI is a class that contains all custom GUIs.

4
yaml/types/Players.yaml
View File

@@ -6,18 +6,21 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The player who is currently playing the game. Description: The player who is currently playing the game.
- Name: PlayerCollisionEnabled - Name: PlayerCollisionEnabled
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Determines whether or not collisions between players are enabled. Description: Determines whether or not collisions between players are enabled.
- Name: PlayersCount - Name: PlayersCount
Type: number Type: number
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The number of players currently in the game. Description: The number of players currently in the game.
Methods: Methods:
- Name: GetPlayers - Name: GetPlayers
@@ -63,4 +66,5 @@ Events:
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Players
Description: Players is the container class for all Player instances. Description: Players is the container class for all Player instances.

2
yaml/types/PointLight.yaml
View File

@@ -6,11 +6,13 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The range of the point light's illumination. Description: The range of the point light's illumination.
Methods: [] Methods: []
Events: [] Events: []
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: PointLight is a type of light that emits light in all directions Description: PointLight is a type of light that emits light in all directions
from a single point. from a single point.

81
yaml/types/PolytorianModel.yaml
View File

@@ -6,72 +6,84 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The head color Description: The head color
- Name: TorsoColor - Name: TorsoColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The torso color Description: The torso color
- Name: LeftArmColor - Name: LeftArmColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The left arm color Description: The left arm color
- Name: RightArmColor - Name: RightArmColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The right arm color Description: The right arm color
- Name: LeftLegColor - Name: LeftLegColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The left leg color Description: The left leg color
- Name: RightLegColor - Name: RightLegColor
Type: Color Type: Color
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The right leg color Description: The right leg color
- Name: FaceImage - Name: FaceImage
Type: ImageAsset Type: ImageAsset
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The face image to use Description: The face image to use
- Name: ShirtImage - Name: ShirtImage
Type: ImageAsset Type: ImageAsset
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The shirt image to use Description: The shirt image to use
- Name: PantsImage - Name: PantsImage
Type: ImageAsset Type: ImageAsset
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The pants image to use Description: The pants image to use
- Name: TorsoMesh - Name: TorsoMesh
Type: MeshAsset Type: MeshAsset
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: The torso mesh to use Description: The torso mesh to use
- Name: Ragdolling - Name: Ragdolling
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns true if this character is ragdolling Description: Returns true if this character is ragdolling
- Name: RagdollPosition - Name: RagdollPosition
Type: Vector3 Type: Vector3
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns the current global ragdoll position, if ragdoll haven't Description: Returns the current global ragdoll position, if ragdoll haven't
starts yet. Returns `Vector3.Zero` starts yet. Returns `Vector3.Zero`
- Name: RagdollRotation - Name: RagdollRotation
@@ -79,6 +91,7 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Returns the current global ragdoll rotation, if ragdoll haven't Description: Returns the current global ragdoll rotation, if ragdoll haven't
starts yet. Returns `Vector3.Zero` starts yet. Returns `Vector3.Zero`
Methods: Methods:
@@ -129,6 +142,73 @@ Methods:
IsObsolete: false IsObsolete: false
IsStatic: false IsStatic: false
Description: Clear current appearance. 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: Events:
- Name: RagdollStarted - Name: RagdollStarted
Arguments: "" Arguments: ""
@@ -139,4 +219,5 @@ Events:
IsStatic: false IsStatic: false
IsAbstract: false IsAbstract: false
IsInstantiatable: true IsInstantiatable: true
StaticAlias: null
Description: PolytorianModel is a CharacterModel that represent default Polytoria Character. Description: PolytorianModel is a CharacterModel that represent default Polytoria Character.

3
yaml/types/PreferencesService.yaml
View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: true
Description: Determines whether the player has photo mode enabled. Description: Determines whether the player has photo mode enabled.
- Name: UsePostProcessing - Name: UsePostProcessing
Type: boolean Type: boolean
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: true IsReadOnly: true
IsObsolete: false IsObsolete: false
IsStatic: true
Description: Determines whether the player has post-processing effects enabled. Description: Determines whether the player has post-processing effects enabled.
Methods: [] Methods: []
Events: Events:
@@ -25,5 +27,6 @@ Events:
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Preferences
Description: PreferencesService is a service that allows scripts to access some Description: PreferencesService is a service that allows scripts to access some
of the user preferences of the user preferences

3
yaml/types/PresenceService.yaml
View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Current activity status. Description: Current activity status.
- Name: CoverImage - Name: CoverImage
Type: PTImageAsset Type: PTImageAsset
IsAccessibleByScripts: true IsAccessibleByScripts: true
IsReadOnly: false IsReadOnly: false
IsObsolete: false IsObsolete: false
IsStatic: false
Description: Activity cover image. Description: Activity cover image.
Methods: Methods:
- Name: ResetTimer - Name: ResetTimer
@@ -25,5 +27,6 @@ Events: []
IsStatic: true IsStatic: true
IsAbstract: false IsAbstract: false
IsInstantiatable: false IsInstantiatable: false
StaticAlias: Presence
Description: PresenceService is a service that allows scripts to set the active 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. status of the player. Which will be used to display in supported integrations.

Some files were not shown because too many files have changed in this diff Show More