perform a switch to yaml

This commit is contained in:
maji
2025-12-30 01:10:38 +07:00
parent ea66d3d901
commit cbda781eb1
336 changed files with 8953 additions and 11523 deletions

16
yaml/types/Accessory.yaml Normal file
View File

@@ -0,0 +1,16 @@
Name: Accessory
BaseType: Dynamic
Properties:
- Name: TargetAttachment
Type: CharacterAttachmentEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Specifies the character attachment point
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Accessory represents a attachable object that can be equipped by a
CharacterModel.

View File

@@ -0,0 +1,96 @@
Name: AchievementsService
BaseType: Instance
Properties:
- Name: UseAchievementSound
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determine if achievement sound effect should play when user
receives an achievement
- Name: NotifyAchievements
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determine if achievement toast should show when user receives an
achievement
Methods:
- Name: Award
ReturnType: nil
Parameters:
- Name: userID
Type: number
IsOptional: false
DefaultValue: ""
- Name: achievementID
Type: number
IsOptional: false
DefaultValue: ""
- Name: callback
Type: function
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Award achievement to the user
- Name: AwardAsync
ReturnType: nil
Parameters:
- Name: userID
Type: number
IsOptional: false
DefaultValue: ""
- Name: achievementID
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Award achievement to the user asynchronously.
- Name: HasAchievement
ReturnType: nil
Parameters:
- Name: userID
Type: number
IsOptional: false
DefaultValue: ""
- Name: achievementID
Type: number
IsOptional: false
DefaultValue: ""
- Name: callback
Type: function
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Check if user of ID has the achievement.
- Name: HasAchievementAsync
ReturnType: boolean
Parameters:
- Name: userID
Type: number
IsOptional: false
DefaultValue: ""
- Name: achievementID
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Check if player of ID has the achievement, asynchronously.
Events:
- Name: GotAchievement
Arguments:
Name: achievementID
Type: number
Description: Fires when the local player got an achievement
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: Service for managing achievements

View File

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

45
yaml/types/Animator.yaml Normal file
View File

@@ -0,0 +1,45 @@
Name: Animator
BaseType: Instance
Properties: []
Methods:
- Name: PlayAnimation
ReturnType: nil
Parameters:
- Name: animationKey
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: PlayOneshotAnimation
ReturnType: nil
Parameters:
- Name: animationKey
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: StopAnimation
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: StopOneshotAnimation
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Missing Documentation

View File

@@ -0,0 +1,53 @@
Name: AssetService
BaseType: Instance
Properties: []
Methods:
- Name: NewAsset
ReturnType: BaseAsset
Parameters:
- Name: assetClassName
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Create new asset with the class name
- Name: NewPTImage
ReturnType: PTImageAsset
Parameters:
- Name: imgID
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Create new image from Polytoria with the target ID
- Name: NewPTAudio
ReturnType: PTAudioAsset
Parameters:
- Name: audioID
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Create new audio from Polytoria with the target ID
- Name: NewPTMesh
ReturnType: PTMeshAsset
Parameters:
- Name: assetID
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Create new mesh from Polytoria with the target ID
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: Service for managing assets

View File

@@ -0,0 +1,9 @@
Name: AudioAsset
BaseType: ResourceAsset
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: true
IsInstantiatable: false
Description: Abstract class for audio

View File

@@ -0,0 +1,9 @@
Name: BaseAsset
BaseType: NetworkedObject
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: true
IsInstantiatable: false
Description: Base class for all assets

View File

@@ -0,0 +1,26 @@
Name: BindableEvent
BaseType: Instance
Properties: []
Methods:
- Name: Invoke
ReturnType: nil
Parameters:
- Name: par
Type: any
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Invoke this event with parameters
Events:
- Name: Invoked
Arguments:
Name: ...
Type: any
Description: Fires when this event has been invoked
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: BindableEvent are events that can be called to communicate between
scripts in the same boundary.

View File

@@ -0,0 +1,29 @@
Name: BodyPosition
BaseType: Instance
Properties:
- Name: TargetPosition
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the target position that the body applies forces to get to.
- Name: Force
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines how much force the body applies.
- Name: AcceptanceDistance
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines how close the body has to be to the target position to
stop applying forces to it.
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: BodyPosition are objects that apply a force to their parent until
it moves toward the target position.

15
yaml/types/BoolValue.yaml Normal file
View File

@@ -0,0 +1,15 @@
Name: BoolValue
BaseType: ValueBase
Properties:
- Name: Value
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The value of this object.
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: BoolValue is a ValueBase that stores a boolean.

191
yaml/types/Bounds.yaml Normal file
View File

@@ -0,0 +1,191 @@
Name: Bounds
BaseType: null
Properties:
- Name: Center
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates the center point of the bounds.
- Name: Size
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the size of the bounds.
- Name: Extents
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates the extents of the bounds.
- Name: Start
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: End
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: Volume
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates the volume of the bounds.
Methods:
- Name: New
ReturnType: Bounds
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Creates a new Bounds object with the specified position and size.
- Name: New
ReturnType: Bounds
Parameters:
- Name: position
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: size
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Creates a new Bounds object with the specified position and size.
- Name: ClosestPoint
ReturnType: Vector3
Parameters:
- Name: bounds
Type: Bounds
IsOptional: false
DefaultValue: ""
- Name: point
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Calculates the closest point on the bounds to the specified point.
- Name: Contains
ReturnType: boolean
Parameters:
- Name: bounds
Type: Bounds
IsOptional: false
DefaultValue: ""
- Name: point
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Returns whether the bounds contain the specified point.
- Name: Encapsulate
ReturnType: Bounds
Parameters:
- Name: bounds
Type: Bounds
IsOptional: false
DefaultValue: ""
- Name: point
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Expands the bounds by the specified amount.
- Name: Expand
ReturnType: Bounds
Parameters:
- Name: bounds
Type: Bounds
IsOptional: false
DefaultValue: ""
- Name: amount
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Expands the bounds by the specified amount.
- Name: Intersects
ReturnType: boolean
Parameters:
- Name: bounds
Type: Bounds
IsOptional: false
DefaultValue: ""
- Name: other
Type: Bounds
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Determines whether the bounds intersect with another bounds.
- Name: SetMinMax
ReturnType: Bounds
Parameters:
- Name: bounds
Type: Bounds
IsOptional: false
DefaultValue: ""
- Name: min
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: max
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Sets the minimum and maximum points of the bounds.
- Name: Distance
ReturnType: number
Parameters:
- Name: bounds
Type: Bounds
IsOptional: false
DefaultValue: ""
- Name: point
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Calculates the distance from the bounds to the specified point.
- Name: SqrDistance
ReturnType: number
Parameters:
- Name: bounds
Type: Bounds
IsOptional: false
DefaultValue: ""
- Name: point
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Calculates the squared distance from the bounds to the specified point.
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: Represents a bounding box in 3D space.

View File

@@ -0,0 +1,15 @@
Name: BuiltInAudioAsset
BaseType: AudioAsset
Properties:
- Name: AudioPreset
Type: BuiltInAudioPresetEnum
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
Description: The target audio to use
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Audio asset that's built-in with the client

View File

@@ -0,0 +1,15 @@
Name: BuiltInFontAsset
BaseType: FontAsset
Properties:
- Name: FontPreset
Type: BuiltInTextFontPresetEnum
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
Description: Target font to use
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Font asset that's built-in with the client

261
yaml/types/Camera.yaml Normal file
View File

@@ -0,0 +1,261 @@
Name: Camera
BaseType: Dynamic
Properties:
- Name: Mode
Type: CameraModeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines or returns the camera's current mode.
- Name: FOV
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines or returns the camera's field of view.
- Name: ClipThroughWalls
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not the camera should clip through walls.
- Name: MinDistance
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The camera's minimum distance from the player in Follow mode.
- Name: MaxDistance
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines camera's maximum distance from the player in Follow mode.
- Name: Distance
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the distance between the camera and the player when the
camera is in Follow mode.
- Name: ScrollSensitivity
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the scroll move speed of the camera.
- Name: Orthographic
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not the camera should render in orthographic
(2D) mode or not (3D).
- Name: FollowLerp
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not to use lerping in Follow mode.
- Name: LerpSpeed
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the lerp speed of the camera when lerping is enabled.
- Name: OrthographicSize
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the half-size of the camera when in orthographic mode.
- Name: PositionOffset
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the camera's offset from its position.
- Name: RotationOffset
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the camera's offset from its rotation.
- Name: IsFirstPerson
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Returns whether or not the camera is in first person.
- Name: CanLock
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determine if camera can be ctrl locked.
- Name: SensitivityMultiplier
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Multipler for camera sensitivity
- Name: Sensitivity
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Current sensitivity of the camera
- Name: HorizontalSpeed
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the horizontal movement speed of the camera in Follow mode.
- Name: VerticalSpeed
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the vertical move speed of the camera.
- Name: ScrollLerpSpeed
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the lerp amount when scrolling
- Name: CtrlLocked
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determine if camera is in Ctrl lock mode
- Name: AlwaysLocked
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determine if camera should always be in locked mode
- Name: Target
Type: Dynamic
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The target of Follow mode
Methods:
- Name: ViewportPointToRay
ReturnType: RayResult
Parameters:
- Name: pos
Type: Vector2
IsOptional: false
DefaultValue: ""
- Name: ignoreList
Type: table
IsOptional: true
DefaultValue: null
- Name: maxDistance
Type: number
IsOptional: true
DefaultValue: "10000"
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Cast a ray from the camera at the specified ViewportPoint (Vector3
with components with values in range of 0 - 1 describing how far a point
is to to right and to the top of the screen) into the game world
- Name: ScreenPointToRay
ReturnType: RayResult
Parameters:
- Name: pos
Type: Vector2
IsOptional: false
DefaultValue: ""
- Name: ignoreList
Type: table
IsOptional: true
DefaultValue: null
- Name: maxDistance
Type: number
IsOptional: true
DefaultValue: "10000"
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Cast a ray from the camera at screen point into the game world
- Name: ViewportToScreenPoint
ReturnType: Vector2
Parameters:
- Name: pos
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Transforms `pos` from viewport space into screen space.
- Name: ViewportToWorldPoint
ReturnType: Vector3
Parameters:
- Name: pos
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Transforms `pos` from viewport space into world space.
- Name: WorldToViewportPoint
ReturnType: Vector2
Parameters:
- Name: pos
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Transforms `pos` from world space into viewport space.
- Name: WorldToScreenPoint
ReturnType: Vector2
Parameters:
- Name: pos
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Transforms `pos` from world space into screen space.
- Name: ScreenToViewportPoint
ReturnType: Vector2
Parameters:
- Name: pos
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Transforms `pos` from screen space into viewport space.
- Name: ScreenToWorldPoint
ReturnType: Vector3
Parameters:
- Name: pos
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Transforms `pos` from screen space into world space.
Events:
- Name: FirstPersonEntered
Arguments: ""
Description: Fires when camera has entered first person
- Name: FirstPersonExited
Arguments: ""
Description: Fires when camera has exited first person
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Camera is a class that represents the local player's camera.

View File

@@ -0,0 +1,77 @@
Name: CaptureService
BaseType: Instance
Properties:
- Name: OnCooldown
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Returns whenever the capture is on cooldown.
- Name: CanCapture
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines if user/scripts can take a picture.
- Name: DefaultCaptureOverlay
Type: UIField
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Default capture overlay for all captures
- Name: SpectatorAttach
Type: Dynamic
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Attaches a spectator camera at dynamic for use with spectator mode.
Methods:
- Name: TakePhotoAtDynamic
ReturnType: nil
Parameters:
- Name: dyn
Type: Dynamic
IsOptional: false
DefaultValue: ""
- Name: photoSize
Type: Vector2
IsOptional: true
DefaultValue: null
- Name: overlay
Type: UIField
IsOptional: true
DefaultValue: null
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Take a photo at dynamic
- Name: TakePhotoAt
ReturnType: nil
Parameters:
- Name: pos
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: rot
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: photoSize
Type: Vector2
IsOptional: true
DefaultValue: null
- Name: overlay
Type: UIField
IsOptional: true
DefaultValue: null
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Take photo at `pos` for position and `rot` for rotation, optional
`photoSize` defines the size, and optional UI `overlay` can be passed to
include it in the result photo.
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: Service for capturing photos

View File

@@ -0,0 +1,26 @@
Name: CharacterModel
BaseType: Dynamic
Properties:
- Name: Animator
Type: Animator
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The animator for this character
Methods:
- Name: GetAttachment
ReturnType: Dynamic
Parameters:
- Name: attachmentEnum
Type: CharacterAttachmentEnum
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Get attachment dynamic from this character
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Base class for Character Models

View File

@@ -0,0 +1,48 @@
Name: ChatService
BaseType: Instance
Properties: []
Methods:
- Name: BroadcastMessage
ReturnType: nil
Parameters:
- Name: msg
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Sends a chat message to all players.
- Name: UnicastMessage
ReturnType: nil
Parameters:
- Name: msg
Type: string
IsOptional: false
DefaultValue: ""
- Name: plr
Type: Player
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Sends a chat message to a specific player.
Events:
- Name: NewChatMessage
Arguments:
- Name: sender
Type: Player
- Name: message
Type: string
Description: Fires when new chat message has been received from player
- Name: MessageReceived
Arguments:
Name: message
Type: string
Description: Fires when new message has been received from either
`BroadcastMessage` or `UnicastMessage`
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: Chat is a static class used for various actions regarding the chat.

View File

@@ -0,0 +1,10 @@
Name: ClientScript
BaseType: Script
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: ClientScript is a script that runs locally for each player. It can
only see what the player can see.

133
yaml/types/Color.yaml Normal file
View File

@@ -0,0 +1,133 @@
Name: Color
BaseType: null
Properties:
- Name: R
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Red color component
- Name: G
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Green color component
- Name: B
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Blue color component
- Name: A
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Alpha (opacity) color component
Methods:
- Name: New
ReturnType: Color
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Creates a new Color with the set R, G, B and A values
- Name: New
ReturnType: Color
Parameters:
- Name: d
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Creates a new Color with the set R, G, B and A values
- Name: New
ReturnType: Color
Parameters:
- Name: r
Type: number
IsOptional: false
DefaultValue: ""
- Name: g
Type: number
IsOptional: false
DefaultValue: ""
- Name: b
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Creates a new Color with the set R, G, B and A values
- Name: New
ReturnType: Color
Parameters:
- Name: r
Type: number
IsOptional: false
DefaultValue: ""
- Name: g
Type: number
IsOptional: false
DefaultValue: ""
- Name: b
Type: number
IsOptional: false
DefaultValue: ""
- Name: a
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Creates a new Color with the set R, G, B and A values
- Name: Random
ReturnType: Color
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Returns a random color with an alpha value of 1.
- Name: FromHex
ReturnType: Color
Parameters:
- Name: hex
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Creates a new Color from the specified hex value.
- Name: Lerp
ReturnType: Color
Parameters:
- Name: a
Type: Color
IsOptional: false
DefaultValue: ""
- Name: b
Type: Color
IsOptional: false
DefaultValue: ""
- Name: t
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Linearly interpolates colors a and b by t.
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: >-
Color is a data type that represents a color.
The alpha property is between 0 and 1. 0 is fully transparent and 1 is fully visible.

View File

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

112
yaml/types/ColorSeries.yaml Normal file
View File

@@ -0,0 +1,112 @@
Name: ColorSeries
BaseType: ValueType
Properties:
- Name: PointCount
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Returns the point count of this color series
Methods:
- Name: New
ReturnType: ColorSeries
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Create color series by this color range
- Name: New
ReturnType: ColorSeries
Parameters:
- Name: min
Type: Color
IsOptional: false
DefaultValue: ""
- Name: max
Type: Color
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Create color series by this color range
- Name: SetColor
ReturnType: nil
Parameters:
- Name: point
Type: number
IsOptional: false
DefaultValue: ""
- Name: color
Type: Color
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Sets the color at the specified point in the color series.
- Name: RemovePoint
ReturnType: nil
Parameters:
- Name: point
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Removes the point at the specified index from the color series.
- Name: SetOffset
ReturnType: nil
Parameters:
- Name: point
Type: number
IsOptional: false
DefaultValue: ""
- Name: offset
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Sets the offset at the specified point in the color series.
- Name: GetColor
ReturnType: Color
Parameters:
- Name: point
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets the color at the specified point in the color series.
- Name: GetOffset
ReturnType: number
Parameters:
- Name: point
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets the offset at the specified point in the color series.
- Name: Lerp
ReturnType: Color
Parameters:
- Name: t
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Interpolates between colors in the series based on the parameter t.
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: Color series is a data type that represents a collection of color
and points, also known as gradient.

View File

@@ -0,0 +1,15 @@
Name: ColorValue
BaseType: ValueBase
Properties:
- Name: Value
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The value of this object.
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: ColorValue is an object that holds a Color value.

View File

@@ -0,0 +1,58 @@
Name: CoreUIService
BaseType: Instance
Properties:
- Name: UseUserCard
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not the user card (in the upper right hand
corner above the leaderboard) is visible.
- Name: UseChat
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not the chat box is visible.
- Name: UseHealthBar
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not the player's health bar is visible.
- Name: UseLeaderboard
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not the player list/leaderboard is visible.
- Name: UseHotbar
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not the hot bar is visible.
- Name: UseMenuButton
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not the menu button is visible.
- Name: UseEmoteWheel
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not the emote wheel is visible.
- Name: CanRespawn
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not the player can respawn.
Methods: []
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: CoreUI is a static class that allows for the toggling of certain core GUI.

View File

@@ -0,0 +1,11 @@
Name: CreatorContextService
BaseType: Instance
Properties: []
Methods: []
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: CreatorContextService is a service that manage per game specific
tools, such as Selections and History. This class is only available in the
creator.

View File

@@ -0,0 +1,10 @@
Name: CreatorGUI
BaseType: PlayerGUI
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
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.

View File

@@ -0,0 +1,50 @@
Name: CreatorHistory
BaseType: Instance
Properties: []
Methods:
- Name: NewAction
ReturnType: nil
Parameters:
- Name: title
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: AddDoCallback
ReturnType: nil
Parameters:
- Name: callback
Type: function
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: AddUndoCallback
ReturnType: nil
Parameters:
- Name: callback
Type: function
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: CommitAction
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: CreatorHistory is a class that manages history (undo-redo) of this
game instance. This class is only available in the creator.

View File

@@ -0,0 +1,64 @@
Name: CreatorInterface
BaseType: null
Properties:
- Name: ToolMode
Type: ToolModeEnum
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: TargetPartColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: TargetPartMaterial
Type: PartMaterialEnum
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: MoveSnapEnabled
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: MoveSnapping
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: UserMoveSnapping
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: RotateSnapEnabled
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: RotateSnapping
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: UserRotateSnapping
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: CreatorInterface represent the user interface of the creator. This
class is only available in the creator.

View File

@@ -0,0 +1,152 @@
Name: CreatorSelections
BaseType: Instance
Properties: []
Methods:
- Name: Select
ReturnType: nil
Parameters:
- Name: instance
Type: Instance
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: SelectChild
ReturnType: nil
Parameters:
- Name: instance
Type: Instance
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: Deselect
ReturnType: nil
Parameters:
- Name: instance
Type: Instance
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: SelectOnly
ReturnType: nil
Parameters:
- Name: instance
Type: Instance
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: DeselectAll
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: GroupInstances
ReturnType: Dynamic
Parameters:
- Name: instances
Type: table
IsOptional: false
DefaultValue: ""
- Name: asPhysical
Type: boolean
IsOptional: true
DefaultValue: "False"
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: UngroupModel
ReturnType: table
Parameters:
- Name: model
Type: Instance
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: UngroupModels
ReturnType: table
Parameters:
- Name: models
Type: table
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: DuplicateInstances
ReturnType: table
Parameters:
- Name: instances
Type: table
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: GroupSelected
ReturnType: nil
Parameters:
- Name: asPhysical
Type: boolean
IsOptional: true
DefaultValue: "False"
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: UngroupSelected
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: DeleteSelected
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: DuplicateSelected
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: HasSelected
ReturnType: boolean
Parameters:
- Name: instance
Type: Instance
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: CreatorSelections is an object that manages selections in the game
instance. This class is only available in the creator.

View File

@@ -0,0 +1,40 @@
Name: CreatorService
BaseType: null
Properties:
- Name: Interface
Type: CreatorInterface
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: Clipboard
Type: CreatorClipboard
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: CurrentGame
Type: Game
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: LocalTestActive
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
Methods: []
Events:
- Name: LocalTestStarted
Arguments: ""
Description: Fires when local testing starts
- Name: LocalTestStopped
Arguments: ""
Description: Fires when local testing ends
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: CreatorService is the class that manages the creator. This class is
only available in the creator.

56
yaml/types/Datastore.yaml Normal file
View File

@@ -0,0 +1,56 @@
Name: Datastore
BaseType: null
Properties:
- Name: Key
Type: string
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The key identifying this Datastore connection.
Methods:
- Name: GetAsync
ReturnType: any
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Retrieves a value from the datastore asynchronously using the
specified key.
- Name: SetAsync
ReturnType: nil
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
- Name: value
Type: any
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Stores a value in the datastore asynchronously using the specified key.
- Name: RemoveAsync
ReturnType: nil
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Removes a value from the datastore asynchronously using the specified key.
Events:
- Name: Loaded
Arguments: ""
Description: Fires when this datastore has been loaded
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: Datastore is an object that represent datastore connection.

View File

@@ -0,0 +1,21 @@
Name: DatastoreService
BaseType: Instance
Properties: []
Methods:
- Name: GetDatastore
ReturnType: Datastore
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Attempts to get a Datastore object from the Datastore service.
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: Datastore (not to be confused with the Datastore data type) is a
service used for storing data between place sessions.

28
yaml/types/Decal.yaml Normal file
View File

@@ -0,0 +1,28 @@
Name: Decal
BaseType: Dynamic
Properties:
- Name: Image
Type: ImageAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The image texture applied to the decal.
- Name: Energy
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: Color
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The color tint applied to the decal.
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Decals are objects that can have an image texture and are wrapped
around other objects.

238
yaml/types/Dynamic.yaml Normal file
View File

@@ -0,0 +1,238 @@
Name: Dynamic
BaseType: Instance
Properties:
- Name: Position
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The position of the object.
- Name: Rotation
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The rotation of the object.
- Name: Size
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The size of the object.
- Name: LocalPosition
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The position of the object relative to its parent.
- Name: LocalRotation
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The rotation of the object relative to its parent.
- Name: LocalSize
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The size of the object relative to its parent.
- Name: Quaternion
Type: Quaternion
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The rotation of the object represented as a quaternion.
- Name: Locked
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the object can be selected in the Creator.
- Name: Forward
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The forward direction vector of the object.
- Name: Right
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The right direction vector of the object.
- Name: Up
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The up direction vector of the object.
Methods:
- Name: LookAt
ReturnType: nil
Parameters:
- Name: target
Type: any
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Orients the object to look at a target with a specified up vector.
- Name: LookAt
ReturnType: nil
Parameters:
- Name: target
Type: any
IsOptional: false
DefaultValue: ""
- Name: up
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Orients the object to look at a target with a specified up vector.
- Name: MovePosition
ReturnType: nil
Parameters:
- Name: position
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: MoveRotation
ReturnType: nil
Parameters:
- Name: rotation
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: Translate
ReturnType: nil
Parameters:
- Name: translation
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Moves the transform in the direction and distance of translation.
- Name: RotateAround
ReturnType: nil
Parameters:
- Name: point
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: axis
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: angle
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Rotates the object around a point by the specified Euler angles.
- Name: Rotate
ReturnType: nil
Parameters:
- Name: eulerAngles
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Rotates the object by the specified Euler angles.
- Name: InverseTransformPoint
ReturnType: Vector3
Parameters:
- Name: point
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Transforms a point from world space to local space.
- Name: TransformPoint
ReturnType: Vector3
Parameters:
- Name: point
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Transforms a point from local space to world space.
- Name: InverseTransformDirection
ReturnType: Vector3
Parameters:
- Name: direction
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Transforms a direction from world space to local space.
- Name: TransformDirection
ReturnType: Vector3
Parameters:
- Name: direction
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Transforms a direction from local space to world space.
- Name: InverseTransformVector
ReturnType: Vector3
Parameters:
- Name: vector
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Transforms a vector from world space to local space.
- Name: InverseTransformPosition
ReturnType: Vector3
Parameters:
- Name: position
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Transforms a position from world space to local space.
- Name: GetBounds
ReturnType: Bounds
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets the bounding box of the object.
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Dynamic is the base class where all objects with a position,
rotation and scale derive from.

143
yaml/types/Entity.yaml Normal file
View File

@@ -0,0 +1,143 @@
Name: Entity
BaseType: Physical
Properties:
- Name: Color
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The color of the entity.
- Name: CastShadows
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the entity casts shadows.
- Name: IsSpawn
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the part can be used as a spawn location or not.
- Name: UseGravity
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the entity is affected by gravity.
- Name: Mass
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the mass of the entity.
- Name: Friction
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the friction of the entity.
- Name: Drag
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the drag (air resistance) of the entity.
- Name: AngularDrag
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the angular drag of the entity.
- Name: Bounciness
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the bounciness of the entity.
Methods:
- Name: AddForce
ReturnType: nil
Parameters:
- Name: force
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: mode
Type: ForceModeEnum
IsOptional: true
DefaultValue: Force
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Applies a force to the entity.
- Name: AddTorque
ReturnType: nil
Parameters:
- Name: force
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: mode
Type: ForceModeEnum
IsOptional: true
DefaultValue: Force
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Applies a rotational force to the entity.
- Name: AddForceAtPosition
ReturnType: nil
Parameters:
- Name: force
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: position
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: mode
Type: ForceModeEnum
IsOptional: true
DefaultValue: Force
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Applies a force to the entity from a specific position.
- Name: AddRelativeForce
ReturnType: nil
Parameters:
- Name: force
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: mode
Type: ForceModeEnum
IsOptional: true
DefaultValue: Force
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Adds a force to the part relative to its own rotation.
- Name: AddRelativeTorque
ReturnType: nil
Parameters:
- Name: torque
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: mode
Type: ForceModeEnum
IsOptional: true
DefaultValue: Force
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Adds a rotational force to the part relative to its own rotation.
Events: []
IsStatic: false
IsAbstract: true
IsInstantiatable: false
Description: Entity represents a physics object that's related to building
blocks (inherited by Part and Mesh)

147
yaml/types/Environment.yaml Normal file
View File

@@ -0,0 +1,147 @@
Name: Environment
BaseType: Instance
Properties:
- Name: CurrentCamera
Type: Camera
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the current camera which player is using to view
- Name: Gravity
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The direction and strength of gravity in the world.
- Name: PartDestroyHeight
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The height at which unanchored parts are destroyed when they fall below it.
- Name: AutoGenerateNavMesh
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not to automatically build a navigation mesh
for NPC pathfinding. This property is disabled by default so there are no
performance issues with larger maps.
Methods:
- Name: Raycast
ReturnType: RayResult
Parameters:
- Name: origin
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: direction
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: maxDistance
Type: number
IsOptional: true
DefaultValue: "10000"
- Name: ignoreList
Type: table
IsOptional: true
DefaultValue: null
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Casts a ray from origin with a specified direction and returns a
RayResult for the first hit object.
- Name: RaycastAll
ReturnType: table
Parameters:
- Name: origin
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: direction
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: maxDistance
Type: number
IsOptional: true
DefaultValue: "1000"
- Name: ignoreList
Type: table
IsOptional: true
DefaultValue: null
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Casts a ray from origin with a specified direction and returns a
RayResult array for all hit objects.
- Name: OverlapSphere
ReturnType: table
Parameters:
- Name: origin
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: radius
Type: number
IsOptional: false
DefaultValue: ""
- Name: ignoreList
Type: table
IsOptional: true
DefaultValue: null
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Returns a list of instances intersecting with the sphere in the
given position and radius.
- Name: OverlapBox
ReturnType: table
Parameters:
- Name: pos
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: size
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: rot
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: ignoreList
Type: table
IsOptional: true
DefaultValue: null
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Returns a list of instances intersecting with the box in the given
position, size and rotation.
- Name: RebuildNavMesh
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Rebuilds the navigation mesh which determines the empty space where
NPCs can pathfind in.
- Name: GetPointOnNavMesh
ReturnType: Vector3
Parameters:
- Name: toPoint
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Returns a point on the navigation mesh at the given position.
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: Environment is the primary object intended for storing active
objects in the place.

55
yaml/types/Explosion.yaml Normal file
View File

@@ -0,0 +1,55 @@
Name: Explosion
BaseType: Dynamic
Properties:
- Name: Radius
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the radius of this explosion
- Name: Force
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the force of this explosion that will be applied to
affected hits
- Name: AffectAnchored
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines if this explosion should affect anchored parts or not
- Name: Damage
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Damage that is affected to player
- Name: AffectPredicate
Type: function
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: |-
A predicate function deciding whenever this part should be accepted or not
Example usage:
```lua
explosion.AffectPredicate = function(hit)
-- always explode
return true
end
```
Methods: []
Events:
- Name: Hitted
Arguments:
Name: hit
Type: Instance
Description: Fires when this explosion affects a hit
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Explosion is a deadly explosion killing players and applying force
to parts at the given position.

View File

@@ -0,0 +1,15 @@
Name: FileLinkAsset
BaseType: BaseAsset
Properties:
- Name: LinkedID
Type: string
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
Description: The ID of the file
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Represents a link to a file path in the file system

View File

@@ -0,0 +1,20 @@
Name: FilterService
BaseType: Instance
Properties: []
Methods:
- Name: Filter
ReturnType: string
Parameters:
- Name: input
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Filter a string
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: FilterService is a service which processes and filter user inputs

9
yaml/types/Folder.yaml Normal file
View File

@@ -0,0 +1,9 @@
Name: Folder
BaseType: Instance
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Folder is similar to a model, used for storing objects in the place.

View File

@@ -0,0 +1,9 @@
Name: FontAsset
BaseType: ResourceAsset
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: true
IsInstantiatable: false
Description: Base class for font assets

9
yaml/types/GUI.yaml Normal file
View File

@@ -0,0 +1,9 @@
Name: GUI
BaseType: UIField
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: GUI is a class that is used to create a GUI.

34
yaml/types/GUI3D.yaml Normal file
View File

@@ -0,0 +1,34 @@
Name: GUI3D
BaseType: Dynamic
Properties:
- Name: CanvasSize
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the canvas size for this GUI
- Name: Shaded
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines if this GUI3D should be affected by lighting
- Name: FaceCamera
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines if this GUI3D always face the camera?
- Name: Transparent
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines if the background should be transparent. Recommended to
be set to false if transparent background is not needed.
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: GUI3D is a class that allows GUI to be displayed in a 3D space.

49
yaml/types/Game.yaml Normal file
View File

@@ -0,0 +1,49 @@
Name: Game
BaseType: Instance
Properties:
- Name: IsLocalTest
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: GameID
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The ID of the current Polytoria place.
- Name: ServerID
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The server ID of the current instance.
- Name: UpTime
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The uptime of this game in seconds.
- Name: InstanceCount
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The total number of instances currently loaded.
Methods: []
Events:
- Name: Ready
Arguments: ""
Description: Fires when the game is ready
- Name: Rendered
Arguments:
Name: delta
Type: number
Description: Fires every frame after the place has been rendered. The `delta`
parameter is the time between the last frame and the current.
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: Game is the root object in the Polytoria instance tree. It is the
object from which everything is descended.

63
yaml/types/Grabbable.yaml Normal file
View File

@@ -0,0 +1,63 @@
Name: Grabbable
BaseType: Instance
Properties:
- Name: Force
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the force used to drag this object.
- Name: MaxRange
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the max range that this object can be dragged.
- Name: PermissionMode
Type: GrabbablePermissionModeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the permission mode for this grabber
- Name: Dragger
Type: Player
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Returns the current dragger
- Name: PermissionPredicate
Type: function
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: >-
A predicate function deciding whenever this player can grab this object.
`PermissionMode` must be set to `GrabbablePermissionMode.Scripted`
Example usage:
```lua
grabbable.PermissionMode = Enums.GrabbablePermissionMode.Scripted
grabbable.PermissionPredicate = function(player)
return player.Name == "Player1"
end
```
Methods: []
Events:
- Name: Grabbed
Arguments:
Name: grabber
Type: Player
Description: Fires when this object has been grabbed
- Name: Released
Arguments: ""
Description: Fires when this object has been released
IsStatic: false
IsAbstract: false
IsInstantiatable: true
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.

View File

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

9
yaml/types/Hidden.yaml Normal file
View File

@@ -0,0 +1,9 @@
Name: Hidden
BaseType: Instance
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: Hidden is a object used for hiding instances.

View File

@@ -0,0 +1,41 @@
Name: HttpRequestData
BaseType: null
Properties:
- Name: URL
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The target endpoint of the HTTP request.
- Name: Method
Type: HttpRequestMethodEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The HTTP method used for the request.
- Name: Body
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The payload sent with the request.
- Name: Headers
Type: table
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: A table of HTTP headers to include with the request, represented as
key-value pairs.
Methods:
- Name: New
ReturnType: HttpRequestData
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Creates and returns a new instance of `HttpRequestData`
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: HttpRequestData represents the data required to construct an HTTP request

View File

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

111
yaml/types/HttpService.yaml Normal file
View File

@@ -0,0 +1,111 @@
Name: HttpService
BaseType: Instance
Properties: []
Methods:
- Name: RequestAsync
ReturnType: HttpResponseData
Parameters:
- Name: data
Type: HttpRequestData
IsOptional: false
DefaultValue: ""
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Send a request using the `HttpRequestData`
- Name: GetAsync
ReturnType: string
Parameters:
- Name: url
Type: string
IsOptional: false
DefaultValue: ""
- Name: headers
Type: table
IsOptional: true
DefaultValue: null
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Sends a GET request to the specified URL.
- Name: PostAsync
ReturnType: string
Parameters:
- Name: url
Type: string
IsOptional: false
DefaultValue: ""
- Name: body
Type: string
IsOptional: false
DefaultValue: ""
- Name: headers
Type: table
IsOptional: true
DefaultValue: null
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Sends a POST request to the specified URL.
- Name: PutAsync
ReturnType: string
Parameters:
- Name: url
Type: string
IsOptional: false
DefaultValue: ""
- Name: body
Type: string
IsOptional: false
DefaultValue: ""
- Name: headers
Type: table
IsOptional: true
DefaultValue: null
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Sends a PUT request to the specified URL.
- Name: DeleteAsync
ReturnType: string
Parameters:
- Name: url
Type: string
IsOptional: false
DefaultValue: ""
- Name: body
Type: string
IsOptional: false
DefaultValue: ""
- Name: headers
Type: table
IsOptional: true
DefaultValue: null
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Sends a DELETE request to the specified url.
- Name: PatchAsync
ReturnType: string
Parameters:
- Name: url
Type: string
IsOptional: false
DefaultValue: ""
- Name: body
Type: string
IsOptional: false
DefaultValue: ""
- Name: headers
Type: table
IsOptional: true
DefaultValue: null
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Sends a PATCH request to the specified url.
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: Http is a service used for HTTP communications and requests.

65
yaml/types/IOService.yaml Normal file
View File

@@ -0,0 +1,65 @@
Name: IOService
BaseType: Instance
Properties: []
Methods:
- Name: ReadBytesFromPath
ReturnType: string
Parameters:
- Name: path
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Read the file data from path
- Name: WriteBytesToPath
ReturnType: nil
Parameters:
- Name: path
Type: string
IsOptional: false
DefaultValue: ""
- Name: bytes
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Write data to file in the project
- Name: ListProjectFiles
ReturnType: table
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: List all files in the project
- Name: ReadBytesFromID
ReturnType: string
Parameters:
- Name: id
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Read the file data from linked ID
- Name: GetPathFromID
ReturnType: string
Parameters:
- Name: indexID
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Get the file path from linked ID
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: Class for interacting with IO in project, only usable with scripts
with the respective permission.

51
yaml/types/Image3D.yaml Normal file
View File

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

View File

@@ -0,0 +1,9 @@
Name: ImageAsset
BaseType: ResourceAsset
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: true
IsInstantiatable: false
Description: Base class for image assets

View File

@@ -0,0 +1,9 @@
Name: InputAction
BaseType: null
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: Base class for input action

View File

@@ -0,0 +1,27 @@
Name: InputActionAxis
BaseType: InputAction
Properties:
- Name: Negative
Type: InputButtonCollection
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: Positive
Type: InputButtonCollection
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: Value
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: InputActionAxis is a class that represents input action of axis type.

View File

@@ -0,0 +1,33 @@
Name: InputActionButton
BaseType: InputAction
Properties:
- Name: Buttons
Type: InputButtonCollection
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: IsPressed
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: Weight
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
Methods: []
Events:
- Name: Pressed
Arguments: ""
Description: Fires when this button has been pressed
- Name: Released
Arguments: ""
Description: Fires when this button has been released
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: InputActionButton is a class that represents input action of button type.

View File

@@ -0,0 +1,39 @@
Name: InputActionVector2
BaseType: InputAction
Properties:
- Name: Up
Type: InputButtonCollection
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: Down
Type: InputButtonCollection
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: Left
Type: InputButtonCollection
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: Right
Type: InputButtonCollection
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: Value
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: InputActionVector2 is a class that represents input action of Vector2 type.

View File

@@ -0,0 +1,33 @@
Name: InputButton
BaseType: null
Properties:
- Name: KeyCode
Type: KeyCodeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
Methods:
- Name: New
ReturnType: InputButton
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: New
ReturnType: InputButton
Parameters:
- Name: key
Type: KeyCodeEnum
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: InputButton is a class that represents a button KeyCode

View File

@@ -0,0 +1,31 @@
Name: InputButtonCollection
BaseType: null
Properties: []
Methods:
- Name: AddButton
ReturnType: nil
Parameters:
- Name: btn
Type: InputButton
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: RemoveButton
ReturnType: nil
Parameters:
- Name: btn
Type: InputButton
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: A collection of Input Buttons

View File

@@ -0,0 +1,183 @@
Name: InputService
BaseType: Instance
Properties:
- Name: IsWindowFocused
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether the game window is currently focused.
- Name: IsTouchscreen
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether the input device is a touchscreen.
- Name: IsGameFocused
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether the game is currently focused.
- Name: IsInputFocused
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether an input is currently focused.
- Name: IsGamepadConnected
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether a gamepad is currently connected.
- Name: IsMenuOpened
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether the game menu is currently opened.
- Name: CursorLocked
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the cursor is currently locked.
- Name: CursorVisible
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the cursor is currently visible.
- Name: MousePosition
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates the current position of the mouse cursor.
- Name: ScreenWidth
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates the width of the screen.
- Name: ScreenHeight
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates the height of the screen.
Methods:
- Name: GetMouseWorldPosition
ReturnType: Vector3
Parameters:
- Name: ignoreList
Type: table
IsOptional: true
DefaultValue: null
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Returns the 3D world-space position corresponding to the current
mouse cursor location.
- Name: GetVector2
ReturnType: InputActionVector2
Parameters:
- Name: actionName
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: GetButton
ReturnType: InputActionButton
Parameters:
- Name: actionName
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Returns true if the specified button is being held down.
- Name: GetAxis
ReturnType: InputActionAxis
Parameters:
- Name: actionName
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Returns the value of the specified axis.
- Name: BindButton
ReturnType: InputActionButton
Parameters:
- Name: name
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: BindAxis
ReturnType: InputActionAxis
Parameters:
- Name: name
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: BindVector2
ReturnType: InputActionVector2
Parameters:
- Name: name
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Events:
- Name: GameFocused
Arguments: ""
Description: Fires when the game has been focused
- Name: GameUnfocused
Arguments: ""
Description: Fires when the game has been unfocused
- Name: GamepadConnected
Arguments: ""
Description: Fires when gamepad is connected
- Name: GamepadDisconnected
Arguments: ""
Description: Fires when gamepad has been disconnected
- Name: KeyDown
Arguments:
Name: keycode
Type: KeyCodeEnum
Description: Fires when key has been pressed
- Name: KeyUp
Arguments:
Name: keycode
Type: KeyCodeEnum
Description: Fires when key has been released
- Name: AxisValueChanged
Arguments:
- Name: keycode
Type: KeyCodeEnum
- Name: value
Type: float
Description: Fires when analog input has been changed
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: InputService is a class used for retrieving user input data, such
as the mouse and keyboard.

View File

@@ -0,0 +1,43 @@
Name: InsertService
BaseType: Instance
Properties: []
Methods:
- Name: ModelAsync
ReturnType: Instance
Parameters:
- Name: id
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Inserts a model with the specified ID.
- Name: AccessoryAsync
ReturnType: Accessory
Parameters:
- Name: id
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Inserts an accessory with the specified ID.
- Name: ToolAsync
ReturnType: Tool
Parameters:
- Name: id
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: Insert is a class used for inserting user-generated models into
your game via scripts.

236
yaml/types/Instance.yaml Normal file
View File

@@ -0,0 +1,236 @@
Name: Instance
BaseType: NetworkedObject
Properties:
- Name: Parent
Type: Instance
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Defines the parent of this instance in the hierarchy.
- Name: EditableChildren
Type: boolean
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: Tags
Type: table
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Tags associated with this instance.
Methods:
- Name: GetDescendants
ReturnType: table
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets all descendants of this instance.
- Name: FindChild
ReturnType: Instance
Parameters:
- Name: name
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Finds a child of this instance by name.
- Name: WaitChild
ReturnType: Instance
Parameters:
- Name: name
Type: string
IsOptional: false
DefaultValue: ""
- Name: timeoutSec
Type: number
IsOptional: true
DefaultValue: null
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: FindChildByClass
ReturnType: Instance
Parameters:
- Name: className
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Finds a child of this instance by class name.
- Name: MoveChild
ReturnType: nil
Parameters:
- Name: child
Type: Instance
IsOptional: false
DefaultValue: ""
- Name: index
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: GetChildren
ReturnType: table
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets all children of this instance.
- Name: GetChildrenOfClass
ReturnType: table
Parameters:
- Name: className
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets all children of this instance that are of the specified class.
- Name: IsAncestorOf
ReturnType: boolean
Parameters:
- Name: instance
Type: Instance
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Determines if this instance is an ancestor of the given instance.
- Name: IsDescendantOf
ReturnType: boolean
Parameters:
- Name: instance
Type: Instance
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Determines if this instance is a descendant of the given instance.
- Name: IsDescendantOfClass
ReturnType: boolean
Parameters:
- Name: className
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Determines if this instance is a descendant of the given class.
- Name: New
ReturnType: Instance
Parameters:
- Name: className
Type: string
IsOptional: false
DefaultValue: ""
- Name: parent
Type: Instance
IsOptional: true
DefaultValue: null
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Creates a new instance of the specified class.
- Name: AddTag
ReturnType: nil
Parameters:
- Name: tag
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Adds a tag to this instance.
- Name: RemoveTag
ReturnType: nil
Parameters:
- Name: tag
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Removes a tag from this instance.
- Name: HasTag
ReturnType: boolean
Parameters:
- Name: tag
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Checks if this instance has the specified tag.
- Name: Reparent
ReturnType: nil
Parameters:
- Name: to
Type: Instance
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: GetParent
ReturnType: Instance
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets the parent of this instance.
- Name: SetParent
ReturnType: nil
Parameters:
- Name: newParent
Type: Instance
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Sets the parent of this instance.
Events:
- Name: ChildAdded
Arguments:
Name: child
Type: Instance
Description: Fires when child has been added to this instance
- Name: ChildRemoved
Arguments:
Name: child
Type: Instance
Description: Fires when child has been removed from this instance (either via
reparent or delete)
- Name: ChildDeleting
Arguments:
Name: child
Type: Instance
Description: Fires when child is being deleted from this instance
- Name: ChildDeleted
Arguments:
Name: child
Type: Instance
Description: Fires when child has been deleted from this instance
IsStatic: false
IsAbstract: true
IsInstantiatable: false
Description: Instance is the base class of all classes. Every class derives from
it and has all properties, events and functions Instance has.

View File

@@ -0,0 +1,15 @@
Name: InstanceValue
BaseType: ValueBase
Properties:
- Name: Value
Type: Instance
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The value of this object.
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: InstanceValue is an object that holds an Instance value.

15
yaml/types/IntValue.yaml Normal file
View File

@@ -0,0 +1,15 @@
Name: IntValue
BaseType: ValueBase
Properties:
- Name: Value
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The value of this object.
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: IntValue is an object that holds an integer value.

View File

@@ -0,0 +1,48 @@
Name: InteractionPrompt
BaseType: Dynamic
Properties:
- Name: Title
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: SubTitle
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: HoldDuration
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: Key
Type: KeyCodeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: UseDefaultUI
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
Methods: []
Events:
- Name: Triggered
Arguments: ""
Description: Missing Documentation
- Name: TriggerStarted
Arguments: ""
Description: Missing Documentation
- Name: TriggerReleased
Arguments: ""
Description: Missing Documentation
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: WIP class, not functional yet

View File

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

33
yaml/types/Light.yaml Normal file
View File

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

53
yaml/types/Lighting.yaml Normal file
View File

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

View File

@@ -0,0 +1,9 @@
Name: LightingModifier
BaseType: Instance
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: true
IsInstantiatable: false
Description: Base class for lighting modifiers

22
yaml/types/Marker3D.yaml Normal file
View File

@@ -0,0 +1,22 @@
Name: Marker3D
BaseType: Dynamic
Properties:
- Name: Length
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: AppearOnTop
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Marker3D is a object that allows marking a specific point in world.
This will hint an axis gizmo in local test and creator.

102
yaml/types/Mesh.yaml Normal file
View File

@@ -0,0 +1,102 @@
Name: Mesh
BaseType: Entity
Properties:
- Name: Asset
Type: MeshAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The mesh asset used by this Mesh.
- Name: IncludeOffset
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Whether to keep the offset of the mesh or recenter it.
- Name: CollisionType
Type: CollisionTypeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The type of collision shape to apply to the mesh.
- Name: PlayAnimationOnStart
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Whether to play the mesh's animation automatically when the mesh is loaded.
- Name: UsePartColor
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Whether to use the color of the part this mesh is attached to.
- Name: Color
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The color of the mesh.
- Name: CastShadows
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Whether the mesh casts shadows.
- Name: CurrentAnimation
Type: string
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates the name of the current animation playing on the mesh.
- Name: IsAnimationPlaying
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether an animation is currently playing on the mesh.
Methods:
- Name: PlayAnimation
ReturnType: nil
Parameters:
- Name: animationName
Type: string
IsOptional: false
DefaultValue: ""
- Name: speed
Type: number
IsOptional: true
DefaultValue: "1"
- Name: loop
Type: boolean
IsOptional: true
DefaultValue: "True"
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Plays the specified animation on the mesh.
- Name: StopAnimation
ReturnType: nil
Parameters:
- Name: animationName
Type: string
IsOptional: true
DefaultValue: null
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Stops the specified animation on the mesh.
- Name: GetAnimations
ReturnType: table
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets a list of all animations available on the mesh.
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Represents a part that can have custom mesh applied to it, the mesh
may be from the Polytoria Store (Hats, Tools and Heads) or user-uploaded
meshes.

View File

@@ -0,0 +1,9 @@
Name: MeshAsset
BaseType: ResourceAsset
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: true
IsInstantiatable: false
Description: Base class for mesh assets

10
yaml/types/Model.yaml Normal file
View File

@@ -0,0 +1,10 @@
Name: Model
BaseType: Dynamic
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Model is an instance that can hold other instances, and which
transform affects its children.

View File

@@ -0,0 +1,13 @@
Name: ModuleScript
BaseType: Script
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: ModuleScripts are specialized scripts to hold data that can be
accessed by other scripts using the require() function. It is important to
define and return a table in a ModuleScript. When the place starts, the server
and the client will run the ModuleScript once and store the result for other
scripts to retrieve with require().

252
yaml/types/NPC.yaml Normal file
View File

@@ -0,0 +1,252 @@
Name: NPC
BaseType: Physical
Properties:
- Name: SeatOffset
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The offset to the seat at which the NPC is positioned when sitting.
- Name: Health
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The current health of the NPC.
- Name: MaxHealth
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The maximum health of the NPC.
- Name: JumpPower
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the jump power of the NPC.
- Name: WalkSpeed
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the walking speed of the NPC.
- Name: UseNametag
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the NPC uses a nametag.
- Name: NametagOffset
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the offset position of the NPC's nametag.
- Name: DisplayName
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the display name of the NPC.
- Name: JumpSound
Type: Sound
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the sound played when the NPC jumps.
- Name: IsSitting
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether the NPC is currently sitting.
- Name: IsDead
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether the NPC is currently dead.
- Name: HoldingTool
Type: Tool
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates the tool currently held by the NPC.
- Name: SittingIn
Type: Seat
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates the seat in which the NPC is currently sitting.
- Name: Character
Type: CharacterModel
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The character model associated with the NPC.
- Name: MoveTarget
Type: Dynamic
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the instance the NPC should walk towards.
- Name: OnGround
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether the NPC is currently on the ground.
- Name: OnCeiling
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether the NPC is currently on the ceiling.
- Name: NavDestinationDistance
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates the distance to the navigation destination.
- Name: NavDestinationReached
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether the NPC has reached its navigation destination.
- Name: NavDestinationValid
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Indicates whether the navigation destination is valid.
Methods:
- Name: Kill
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Kills the NPC.
- Name: Jump
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Makes the NPC jump.
- Name: Sit
ReturnType: nil
Parameters:
- Name: seat
Type: Seat
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Makes the NPC sit on a specified seat.
- Name: Unsit
ReturnType: nil
Parameters:
- Name: addForce
Type: boolean
IsOptional: true
DefaultValue: "True"
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Unsits the NPC from the current seat.
- Name: EquipTool
ReturnType: nil
Parameters:
- Name: tool
Type: Tool
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Equips the NPC with a specified tool.
- Name: DropTool
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Unequips the currently equipped tool from the NPC.
- Name: LoadAppearance
ReturnType: nil
Parameters:
- Name: userID
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Loads the appearance of the NPC based on a user ID.
- Name: ClearAppearance
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Clears the NPC's current appearance.
- Name: SetNavDestination
ReturnType: nil
Parameters:
- Name: pos
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Determines the position the NPC should walk towards.
- Name: Respawn
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Respawns the NPC.
- Name: TakeDamage
ReturnType: nil
Parameters:
- Name: dmg
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Applies damage to the NPC.
- Name: Heal
ReturnType: nil
Parameters:
- Name: amount
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Heals the NPC by a specified amount.
Events:
- Name: Died
Arguments: ""
Description: Triggered when the NPC dies.
- Name: Landed
Arguments: ""
Description: Triggered when the NPC lands on the ground after a jump or fall.
- Name: NavFinished
Arguments: ""
Description: Triggered when the NPC finishes navigating to a destination.
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: NPC (non-player character) is an object similar to a Player but
that can be controlled by code. Like players, it can walk and jump, and its
body part colors can be customized.

225
yaml/types/NetMessage.yaml Normal file
View File

@@ -0,0 +1,225 @@
Name: NetMessage
BaseType: null
Properties: []
Methods:
- Name: AddString
ReturnType: nil
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
- Name: value
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Adds a string value to the message with the specified key.
- Name: AddInt
ReturnType: nil
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
- Name: value
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Adds an integer value to the message with the specified key.
- Name: AddBool
ReturnType: nil
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
- Name: value
Type: boolean
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Adds a boolean value to the message with the specified key.
- Name: AddNumber
ReturnType: nil
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
- Name: value
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Adds a number value to the message with the specified key.
- Name: AddVector2
ReturnType: nil
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
- Name: value
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Adds a Vector2 value to the message with the specified key.
- Name: AddVector3
ReturnType: nil
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
- Name: value
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Adds a Vector3 value to the message with the specified key.
- Name: AddColor
ReturnType: nil
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
- Name: value
Type: Color
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Adds a Color value to the message with the specified key.
- Name: AddInstance
ReturnType: nil
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
- Name: value
Type: Instance
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Adds an Instance value to the message with the specified key.
- Name: GetString
ReturnType: string
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets a string value from the message with the specified key.
- Name: GetInt
ReturnType: number
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets an integer value from the message with the specified key.
- Name: GetNumber
ReturnType: number
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets a number value from the message with the specified key.
- Name: GetBool
ReturnType: boolean
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets a boolean value from the message with the specified key.
- Name: GetVector2
ReturnType: Vector2
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets a Vector2 value from the message with the specified key.
- Name: GetVector3
ReturnType: Vector3
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets a Vector3 value from the message with the specified key.
- Name: GetColor
ReturnType: Color
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets a Color value from the message with the specified key.
- Name: GetInstance
ReturnType: Instance
Parameters:
- Name: key
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Gets an Instance value from the message with the specified key.
- Name: New
ReturnType: NetMessage
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Creates a new NetMessage instance.
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: Represents a network message used for communication between clients
and servers.

View File

@@ -0,0 +1,70 @@
Name: NetworkEvent
BaseType: Instance
Properties:
- Name: Reliable
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
Methods:
- Name: InvokeServer
ReturnType: nil
Parameters:
- Name: msg
Type: NetMessage
IsOptional: false
DefaultValue: ""
- Name: _
Type: any
IsOptional: true
DefaultValue: null
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Sends a message to the server.
- Name: InvokeClient
ReturnType: nil
Parameters:
- Name: msg
Type: NetMessage
IsOptional: false
DefaultValue: ""
- Name: player
Type: Player
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Sends a message to a specific client.
- Name: InvokeClients
ReturnType: nil
Parameters:
- Name: msg
Type: NetMessage
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Sends a message to all connected clients.
Events:
- Name: InvokedServer
Arguments:
- Name: sender
Type: Player
- Name: msg
Type: NetMessage
Description: Fires when server receives message from client
- Name: InvokedClient
Arguments:
- Name: sender
Type: nil
- Name: msg
Type: NetMessage
Description: Fires when client receives message from server
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Missing Documentation

View File

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

View File

@@ -0,0 +1,103 @@
Name: NetworkedObject
BaseType: null
Properties:
- Name: Name
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: ClassName
Type: string
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: Shared
Type: ScriptSharedTable
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: NetworkedObjectID
Type: string
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: ObjectID
Type: string
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: ExistInNetwork
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
Methods:
- Name: IsA
ReturnType: boolean
Parameters:
- Name: className
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: Clone
ReturnType: NetworkedObject
Parameters:
- Name: parent
Type: NetworkedObject
IsOptional: true
DefaultValue: null
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: Destroy
ReturnType: nil
Parameters:
- Name: time
Type: number
IsOptional: true
DefaultValue: "0"
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: Delete
ReturnType: nil
Parameters:
- Name: time
Type: number
IsOptional: true
DefaultValue: "0"
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Events:
- Name: PropertyChanged
Arguments:
Name: propertyName
Type: string
Description: Missing Documentation
- Name: Renamed
Arguments: ""
Description: Missing Documentation
- Name: TreeEntered
Arguments: ""
Description: Missing Documentation
- Name: TreeExited
Arguments: ""
Description: Missing Documentation
IsStatic: false
IsAbstract: true
IsInstantiatable: false
Description: Missing Documentation

View File

@@ -0,0 +1,29 @@
Name: NewServerRequestData
BaseType: null
Properties:
- Name: PlacePath
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: MaxPlayers
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
Methods:
- Name: New
ReturnType: NewServerRequestData
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: NewServerRequestData represents the request data for a new server
instance, to be used with PlacesService.

View File

@@ -0,0 +1,50 @@
Name: NumberRange
BaseType: ValueType
Properties:
- Name: Min
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the minimum value of the range.
- Name: Max
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the maximum value of the range.
Methods:
- Name: New
ReturnType: NumberRange
Parameters:
- Name: from
Type: number
IsOptional: false
DefaultValue: ""
- Name: to
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Creates a new NumberRange object with the specified minimum and
maximum values.
- Name: Lerp
ReturnType: number
Parameters:
- Name: t
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Linearly interpolates between the minimum and maximum values of the
range based on the parameter t, which is typically between 0 and 1.
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: NumberRange is a data type that represents a range between two
numbers, defined by a minimum and maximum value.

View File

@@ -0,0 +1,15 @@
Name: NumberValue
BaseType: ValueBase
Properties:
- Name: Value
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The value of this object.
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: NumberValue is an object that holds a number value.

View File

@@ -0,0 +1,15 @@
Name: PTAudioAsset
BaseType: AudioAsset
Properties:
- Name: AudioID
Type: number
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Audio asset which is loaded from Polytoria

View File

@@ -0,0 +1,10 @@
Name: PTCallback
BaseType: null
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: A function that doesn't expect a return value. This will sometimes
be referred as `function`

View File

@@ -0,0 +1,10 @@
Name: PTFunction
BaseType: null
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: A function that expects a return value. This will sometimes be
referred as `function`

View File

@@ -0,0 +1,21 @@
Name: PTImageAsset
BaseType: ImageAsset
Properties:
- Name: ImageID
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Asset ID of this image
- Name: ImageType
Type: ImageTypeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Image type of this image
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: An image asset that's loaded from Polytoria.

View File

@@ -0,0 +1,15 @@
Name: PTMeshAsset
BaseType: MeshAsset
Properties:
- Name: AssetID
Type: number
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
Description: Asset ID of this mesh
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: A mesh asset that's loaded from Polytoria.

49
yaml/types/PTSignal.yaml Normal file
View File

@@ -0,0 +1,49 @@
Name: PTSignal
BaseType: null
Properties: []
Methods:
- Name: Connect
ReturnType: nil
Parameters:
- Name: action
Type: function
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Connect a function to this signal
- Name: Disconnect
ReturnType: nil
Parameters:
- Name: action
Type: function
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Disconnect a function from this signal
- Name: Wait
ReturnType: any
Parameters: []
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Wait until this signal's emitted
- Name: Once
ReturnType: nil
Parameters:
- Name: action
Type: function
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Listen to this signal only once
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: A signal which scripts can subscribe to

33
yaml/types/Part.yaml Normal file
View File

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

77
yaml/types/Particles.yaml Normal file
View File

@@ -0,0 +1,77 @@
Name: Particles
BaseType: Dynamic
Properties:
- Name: Image
Type: ImageAsset
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
Description: The image used for the particles.
- Name: Color
Type: ColorSeries
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The color gradient used for the particles.
- Name: Lifetime
Type: NumberRange
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the lifetime of a particle.
- Name: Amount
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the number of particles emitted.
- Name: Gravity
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the gravity effect applied to the particles.
- Name: Shaded
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the particles are shaded.
- Name: Autoplay
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the particle system plays automatically.
Methods:
- Name: Play
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Starts playing the particle system.
- Name: Stop
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Stops playing the particle system.
- Name: Emit
ReturnType: nil
Parameters:
- Name: count
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Emits a specified number of particles immediately.
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Particles represents a particle system that can be used to create
various visual effects.

65
yaml/types/Physical.yaml Normal file
View File

@@ -0,0 +1,65 @@
Name: Physical
BaseType: Dynamic
Properties:
- Name: Anchored
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether this object is affected by physics.
- Name: CanCollide
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether this object can collide with other objects.
- Name: Velocity
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the linear velocity of this object.
- Name: AngularVelocity
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the angular velocity of this object.
Methods:
- Name: SetNetworkAuthority
ReturnType: nil
Parameters:
- Name: plr
Type: Player
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Sets the network authority of this object to the specified player.
Events:
- Name: Touched
Arguments:
Name: hit
Type: Physical
Description: Fires when this object has collide with other object
- Name: TouchEnded
Arguments:
Name: hit
Type: Physical
Description: Fires when this object has stopped colliding with other object
- Name: MouseEnter
Arguments: ""
Description: Fires when cursor is hovered on this object. Only fired locally
- Name: MouseExit
Arguments: ""
Description: Fires when cursor leaves this object. Only fired locally
- Name: Clicked
Arguments:
Name: player
Type: Player
Description: Fires when this object has been clicked by a player
IsStatic: false
IsAbstract: true
IsInstantiatable: false
Description: Physical represents an object affected by physics in the world.

View File

@@ -0,0 +1,10 @@
Name: PhysicalModel
BaseType: Physical
Properties: []
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: PhysicalModel is a object that represent a group of objects, that's
affected by physics.

View File

@@ -0,0 +1,91 @@
Name: PlacesService
BaseType: Instance
Properties: []
Methods:
- Name: NewServerAsync
ReturnType: string
Parameters:
- Name: placePath
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Request a new server with data
- Name: NewServerAsync
ReturnType: string
Parameters:
- Name: data
Type: NewServerRequestData
IsOptional: false
DefaultValue: ""
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Request a new server with data
- Name: JoinPlaceAsync
ReturnType: nil
Parameters:
- Name: plr
Type: Player
IsOptional: false
DefaultValue: ""
- Name: to
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Join a player to a public server of the specified place
- Name: JoinPlacePartyAsync
ReturnType: nil
Parameters:
- Name: plrs
Type: table
IsOptional: false
DefaultValue: ""
- Name: to
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Join a party of player to a public server of the specified place
- Name: JoinPrivateAsync
ReturnType: nil
Parameters:
- Name: plr
Type: Player
IsOptional: false
DefaultValue: ""
- Name: accessID
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Join a player to a private server of the specified place
- Name: JoinPrivatePartyAsync
ReturnType: nil
Parameters:
- Name: players
Type: table
IsOptional: false
DefaultValue: ""
- Name: accessID
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Join a party of player to a private server of the specified place
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: PlacesService is a service that is used to join players to other places

182
yaml/types/Player.yaml Normal file
View File

@@ -0,0 +1,182 @@
Name: Player
BaseType: NPC
Properties:
- Name: UserID
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The unique ID of the player.
- Name: CanMove
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the player can move.
- Name: SprintSpeed
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the sprinting speed of the player.
- Name: Stamina
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the current stamina of the player.
- Name: MaxStamina
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the maximum stamina of the player.
- Name: UseStamina
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the player uses stamina.
- Name: StaminaRegen
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the rate at which the player's stamina regenerates.
- Name: StaminaBurn
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the rate at which the player's stamina depletes while sprinting.
- Name: RespawnTime
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the time the player has to wait before respawning.
- Name: UseHeadTurning
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the player uses head turning.
- Name: UseBubbleChat
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the player uses bubble chat.
- Name: AutoLoadAppearance
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the player's appearance is automatically loaded.
- Name: NetworkPing
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The amount of network latency (ping) the player is experiencing.
- Name: IsAdmin
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Determines whether the player is an administrator.
- Name: IsCreator
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Determines whether the player is the creator of the game.
- Name: ChatColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the chat color of the player.
- Name: IsLocal
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Determines whether the player is the local player.
- Name: IsClimbing
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Determines whether the player is currently climbing.
- Name: ClimbingTruss
Type: Truss
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Determines the truss the player is currently climbing.
- Name: UserPlatform
Type: ClientPlatformEnum
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Determines the platform the player is using.
- Name: Inventory
Type: Inventory
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The inventory of the player.
Methods:
- Name: Jump
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Makes the player jump.
- Name: Kick
ReturnType: nil
Parameters:
- Name: reason
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Kicks the player from the game with the specified reason.
- Name: UnequipTool
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Unequips the currently equipped tool of the player.
- Name: Respawn
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Respawns the player.
- Name: ResetAppearance
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Resets the player's appearance to the default.
Events:
- Name: Chatted
Arguments:
Name: message
Type: string
Description: Fires when this player chats
- Name: Respawned
Arguments: ""
Description: Fires when this player has respawned
IsStatic: false
IsAbstract: false
IsInstantiatable: false
Description: Player represents a user playing the game.

View File

@@ -0,0 +1,108 @@
Name: PlayerDefaults
BaseType: Hidden
Properties:
- Name: MaxHealth
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The default maximum health of the player.
- Name: WalkSpeed
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The default walking speed of the player.
- Name: SprintSpeed
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The default sprinting speed of the player.
- Name: JumpPower
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The default jump power of the player.
- Name: RespawnTime
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The default time the player has to wait before respawning.
- Name: ChatColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The default chat color of the player.
- Name: CanMove
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the player can move by default.
- Name: StaminaBurn
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The rate at which the player's stamina depletes while sprinting.
- Name: UseStamina
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the player uses stamina.
- Name: Stamina
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the default stamina of players.
- Name: MaxStamina
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the default maximum stamina of players.
- Name: StaminaRegen
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines the rate at which the player's stamina regenerates.
- Name: UseHeadTurning
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the player uses head turning by default.
- Name: UseBubbleChat
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the player uses bubble chat by default.
- Name: AutoLoadAppearance
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether the player's appearance is automatically loaded
by default.
Methods:
- Name: LoadDefaults
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Resets the specified player back to their default values.
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: PlayerDefaults is a service used for storing the default values of
the Player when created.

View File

@@ -0,0 +1,9 @@
Name: PlayerGUI
BaseType: Instance
Properties: []
Methods: []
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: PlayerGUI is a class that contains all custom GUIs.

66
yaml/types/Players.yaml Normal file
View File

@@ -0,0 +1,66 @@
Name: Players
BaseType: Instance
Properties:
- Name: LocalPlayer
Type: Player
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The player who is currently playing the game.
- Name: PlayerCollisionEnabled
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Determines whether or not collisions between players are enabled.
- Name: PlayersCount
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The number of players currently in the game.
Methods:
- Name: GetPlayers
ReturnType: table
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Returns a table containing all the players currently in the game.
- Name: GetPlayer
ReturnType: Player
Parameters:
- Name: username
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Returns the player with the specified username.
- Name: GetPlayerByID
ReturnType: Player
Parameters:
- Name: userID
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Returns the player with the specified user ID.
Events:
- Name: PlayerAdded
Arguments:
Name: player
Type: Player
Description: Fires when player has connected
- Name: PlayerRemoved
Arguments:
Name: player
Type: Player
Description: Fires when player has disconnected
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: Players is the container class for all Player instances.

View File

@@ -0,0 +1,16 @@
Name: PointLight
BaseType: Light
Properties:
- Name: Range
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: The range of the point light's illumination.
Methods: []
Events: []
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: PointLight is a type of light that emits light in all directions
from a single point.

View File

@@ -0,0 +1,185 @@
Name: PolytorianModel
BaseType: CharacterModel
Properties:
- Name: HeadColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: TorsoColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: LeftArmColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: RightArmColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: LeftLegColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: RightLegColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: FaceImage
Type: ImageAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: ShirtImage
Type: ImageAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: PantsImage
Type: ImageAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: TorsoMesh
Type: MeshAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: Ragdolling
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: RagdollPosition
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
- Name: RagdollRotation
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Missing Documentation
Methods:
- Name: StartRagdoll
ReturnType: nil
Parameters:
- Name: force
Type: Vector3
IsOptional: true
DefaultValue: null
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: StopRagdoll
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: GetAttachment
ReturnType: Dynamic
Parameters:
- Name: attachmentEnum
Type: CharacterAttachmentEnum
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: LoadAppearance
ReturnType: nil
Parameters:
- Name: userID
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: ClearAppearance
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: SetAttachmentTransformOverride
ReturnType: nil
Parameters:
- Name: attachment
Type: CharacterAttachmentEnum
IsOptional: false
DefaultValue: ""
- Name: overrideThis
Type: boolean
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: SetAttachmentPositionOverride
ReturnType: nil
Parameters:
- Name: attachment
Type: CharacterAttachmentEnum
IsOptional: false
DefaultValue: ""
- Name: pos
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: SetAttachmentRotationOverride
ReturnType: nil
Parameters:
- Name: attachment
Type: CharacterAttachmentEnum
IsOptional: false
DefaultValue: ""
- Name: rot
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Events:
- Name: RagdollStarted
Arguments: ""
Description: Fires when ragdoll has been started
- Name: RagdollStopped
Arguments: ""
Description: Fires when ragdoll has been stopped
IsStatic: false
IsAbstract: false
IsInstantiatable: true
Description: Missing Documentation

View File

@@ -0,0 +1,29 @@
Name: PreferencesService
BaseType: Instance
Properties:
- Name: UsePhotoMode
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Determines whether the player has photo mode enabled.
- Name: UsePostProcessing
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: Determines whether the player has post-processing effects enabled.
Methods: []
Events:
- Name: SettingChanged
Arguments:
- Name: settingName
Type: string
- Name: setTo
Type: any
Description: Fired when a user preference setting is changed.
IsStatic: true
IsAbstract: false
IsInstantiatable: false
Description: PreferencesService is a service that allows scripts to access some
of the user preferences

View File

@@ -0,0 +1,29 @@
Name: PresenceService
BaseType: Instance
Properties:
- Name: State
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
- Name: CoverImage
Type: PTImageAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
Description: Missing Documentation
Methods:
- Name: ResetTimer
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Events: []
IsStatic: true
IsAbstract: false
IsInstantiatable: false
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.

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