2.0.0-beta40

This commit is contained in:
maji
2026-01-17 21:44:06 +07:00
parent 298e473b8c
commit 71ec65e2fd
92 changed files with 1203 additions and 52 deletions

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Specifies the character attachment point
Methods: []
Events: []

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determine if achievement sound effect should play when user
receives an achievement
- Name: NotifyAchievements
@@ -13,28 +14,10 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determine if achievement toast should show when user receives an
achievement
Methods:
- Name: Award
ReturnType: nil
Parameters:
- Name: userID
Type: number
IsOptional: false
DefaultValue: ""
- Name: achievementID
Type: number
IsOptional: false
DefaultValue: ""
- Name: callback
Type: function
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Award achievement to the user
- Name: AwardAsync
ReturnType: nil
Parameters:
@@ -50,25 +33,6 @@ Methods:
IsObsolete: false
IsStatic: false
Description: Award achievement to the user asynchronously.
- Name: HasAchievement
ReturnType: nil
Parameters:
- Name: userID
Type: number
IsOptional: false
DefaultValue: ""
- Name: achievementID
Type: number
IsOptional: false
DefaultValue: ""
- Name: callback
Type: function
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Check if user of ID has the achievement.
- Name: HasAchievementAsync
ReturnType: boolean
Parameters:

View File

@@ -6,18 +6,21 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the target position that the body applies forces to get to.
- Name: Force
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines how much force the body applies.
- Name: AcceptanceDistance
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines how close the body has to be to the target position to
stop applying forces to it.
Methods: []

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The value of this object.
Methods: []
Events: []

View File

@@ -6,36 +6,42 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates the center point of the bounds.
- Name: Size
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the size of the bounds.
- Name: Extents
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates the extents of the bounds.
- Name: Start
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The origin point
- Name: End
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The ending point
- Name: Volume
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates the volume of the bounds.
Methods:
- Name: New
@@ -60,6 +66,32 @@ Methods:
IsObsolete: false
IsStatic: true
Description: Creates a new Bounds object with the specified position and size.
- Name: __eq
ReturnType: boolean
Parameters:
- Name: a
Type: Bounds
IsOptional: false
DefaultValue: ""
- Name: b
Type: Bounds
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __tostring
ReturnType: string
Parameters:
- Name: v
Type: Bounds
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: ClosestPoint
ReturnType: Vector3
Parameters:

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The target audio to use
Methods: []
Events: []

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Target font to use
Methods: []
Events: []

View File

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

View File

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

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The animator for this character
Methods:
- Name: GetAttachment

View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Red color component
- Name: G
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Green color component
- Name: B
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Blue color component
- Name: A
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Alpha (opacity) color component
Methods:
- Name: New
@@ -86,6 +90,77 @@ Methods:
IsObsolete: false
IsStatic: true
Description: Creates a new Color with the set R, G, B and A values
- Name: __add
ReturnType: Color
Parameters:
- Name: a
Type: Color
IsOptional: false
DefaultValue: ""
- Name: b
Type: Color
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __sub
ReturnType: Color
Parameters:
- Name: a
Type: Color
IsOptional: false
DefaultValue: ""
- Name: b
Type: Color
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __mul
ReturnType: any
Parameters:
- Name: a
Type: Color
IsOptional: false
DefaultValue: ""
- Name: b
Type: any
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __eq
ReturnType: boolean
Parameters:
- Name: a
Type: Color
IsOptional: false
DefaultValue: ""
- Name: b
Type: Color
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __tostring
ReturnType: string
Parameters:
- Name: v
Type: Color
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: Random
ReturnType: Color
Parameters: []

View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determine the brightness adjustment
- Name: Contrast
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determine the contrast adjustment
- Name: Saturation
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determine the saturation adjustment
- Name: TintColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determine the tint color
Methods: []
Events: []

View File

@@ -1,11 +1,12 @@
Name: ColorSeries
BaseType: ValueType
BaseType: null
Properties:
- Name: PointCount
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns the point count of this color series
Methods:
- Name: New

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The value of this object.
Methods: []
Events: []

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not the user card (in the upper right hand
corner above the leaderboard) is visible.
- Name: UseChat
@@ -13,42 +14,56 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not the chat box is visible.
- Name: UseHealthBar
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not the player's health bar is visible.
- Name: UseLeaderboard
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not the player list/leaderboard is visible.
- Name: UseHotbar
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not the hot bar is visible.
- Name: UseBackpack
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: UseMenuButton
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not the menu button is visible.
- Name: UseEmoteWheel
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not the emote wheel is visible.
- Name: CanRespawn
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not the player can respawn.
Methods: []
Events: []

View File

@@ -6,54 +6,63 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns the target tool mode
- Name: TargetPartColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns the target part color
- Name: TargetPartMaterial
Type: PartMaterialEnum
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns the target part material
- Name: MoveSnapEnabled
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns the move snapping value
- Name: MoveSnapping
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns whenever the move snapping is enabled by the user
- Name: UserMoveSnapping
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns the move snapping value defined by the user
- Name: RotateSnapEnabled
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns whenever the rotate snapping is enabled by the user
- Name: RotateSnapping
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns the rotate snapping value
- Name: UserRotateSnapping
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns the rotate snapping value defined by the user
Methods: []
Events: []

View File

@@ -6,24 +6,21 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: The interface
- Name: Clipboard
Type: CreatorClipboard
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
Description: The clipboard
- Name: CurrentGame
Type: Game
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Current active game
- Name: LocalTestActive
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns true if local test is active
Methods: []
Events:

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The key identifying this Datastore connection.
Methods:
- Name: GetAsync

View File

@@ -6,18 +6,21 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The image texture applied to the decal.
- Name: Energy
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Energy multiplier for the decal.
- Name: Color
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color tint applied to the decal.
Methods: []
Events: []

View File

@@ -6,72 +6,84 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The position of the object.
- Name: Rotation
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The rotation of the object.
- Name: Size
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The size of the object.
- Name: LocalPosition
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The position of the object relative to its parent.
- Name: LocalRotation
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The rotation of the object relative to its parent.
- Name: LocalSize
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The size of the object relative to its parent.
- Name: Quaternion
Type: Quaternion
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The rotation of the object represented as a quaternion.
- Name: LocalQuaternion
Type: Quaternion
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: Locked
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the object can be selected in the Creator.
- Name: Forward
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The forward direction vector of the object.
- Name: Right
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The right direction vector of the object.
- Name: Up
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The up direction vector of the object.
Methods:
- Name: LookAt

View File

@@ -6,54 +6,63 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color of the entity.
- Name: CastShadows
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the entity casts shadows.
- Name: IsSpawn
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the part can be used as a spawn location or not.
- Name: UseGravity
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the entity is affected by gravity.
- Name: Mass
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the mass of the entity.
- Name: Friction
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the friction of the entity.
- Name: Drag
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the drag (air resistance) of the entity.
- Name: AngularDrag
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the angular drag of the entity.
- Name: Bounciness
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the bounciness of the entity.
Methods:
- Name: AddForce

View File

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

View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the radius of this explosion
- Name: Force
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the force of this explosion that will be applied to
affected hits
- Name: AffectAnchored
@@ -19,18 +21,21 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines if this explosion should affect anchored parts or not
- Name: Damage
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Damage that is affected to player
- Name: AffectPredicate
Type: function
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: |-
A predicate function deciding whenever this part should be accepted or not

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The ID of the file
Methods: []
Events: []

View File

@@ -1,6 +1,27 @@
Name: GUI
BaseType: UIField
Properties: []
BaseType: Instance
Properties:
- Name: Visible
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: ZIndex
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: AbsoluteSize
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Methods: []
Events: []
IsStatic: false

View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the canvas size for this GUI
- Name: Shaded
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines if this GUI3D should be affected by lighting
- Name: FaceCamera
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines if this GUI3D always face the camera?
- Name: Transparent
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines if the background should be transparent. Recommended to
be set to false if transparent background is not needed.
Methods: []

View File

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

View File

@@ -6,30 +6,35 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the force used to drag this object.
- Name: MaxRange
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the max range that this object can be dragged.
- Name: PermissionMode
Type: GrabbablePermissionModeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the permission mode for this grabber
- Name: Dragger
Type: Player
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns the current dragger
- Name: PermissionPredicate
Type: function
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: >-
A predicate function deciding whenever this player can grab this object.
`PermissionMode` must be set to `GrabbablePermissionMode.Scripted`

View File

@@ -6,72 +6,84 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the color emitting off the sun.
- Name: SunDiscMultiplier
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the multiplier of the sun.
- Name: SunDiscExponent
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the exponent of the sun.
- Name: SunHaloColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the color of the sun halo.
- Name: SunHaloExponent
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the exponent of the sun halo.
- Name: SunHaloContribution
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the contribution of the sun halo.
- Name: HorizonLineColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the horizon line's color.
- Name: HorizonLineExponent
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the horizon line's exponent.
- Name: HorizonLineContribution
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines how much the horizon line contributes.
- Name: SkyGradientTop
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the top color of the gradient.
- Name: SkyGradientBottom
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the bottom color of the gradient.
- Name: SkyGradientExponent
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the gradient's exponent.
Methods: []
Events: []

View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The target endpoint of the HTTP request.
- Name: Method
Type: HttpRequestMethodEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The HTTP method used for the request.
- Name: Body
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The payload sent with the request.
- Name: Headers
Type: table
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: A table of HTTP headers to include with the request, represented as
key-value pairs.
Methods:

View File

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

View File

@@ -6,42 +6,49 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Specifies the image of the decal.
- Name: TextureScale
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The scale of the texture on the decal.
- Name: TextureOffset
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The offset of the texture on the decal.
- Name: Color
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the color of the decal.
- Name: CastShadows
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not the decal should cast shadows.
- Name: Shaded
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not the decal should be affected by lighting.
- Name: FaceCamera
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not the decal should always face the camera.
Methods: []
Events: []

View File

@@ -6,18 +6,21 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Collection of negative inputs
- Name: Positive
Type: InputButtonCollection
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Collection of positive inputs
- Name: Value
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The value of the input
Methods: []
Events: []

View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Collection of button inputs.
- Name: IsPressed
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Returns true if any of the button in the collection is currently
being pressed.
- Name: Weight
@@ -19,6 +21,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Returns the current analog input of the button.
Methods: []
Events:

View File

@@ -6,30 +6,35 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Collection of up inputs.
- Name: Down
Type: InputButtonCollection
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Collection of down inputs.
- Name: Left
Type: InputButtonCollection
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Collection of left inputs.
- Name: Right
Type: InputButtonCollection
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Collection of right inputs.
- Name: Value
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The value of this input
Methods: []
Events: []

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Key code for this button
Methods:
- Name: New
@@ -26,6 +27,21 @@ Methods:
IsObsolete: false
IsStatic: true
Description: Create new button of this keycode
- Name: __eq
ReturnType: boolean
Parameters:
- Name: a
Type: InputButton
IsOptional: false
DefaultValue: ""
- Name: b
Type: InputButton
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
Events: []
IsStatic: false
IsAbstract: false

View File

@@ -6,66 +6,77 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the game window is currently focused.
- Name: IsTouchscreen
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the input device is a touchscreen.
- Name: IsGameFocused
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the game is currently focused.
- Name: IsInputFocused
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether an input is currently focused.
- Name: IsGamepadConnected
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether a gamepad is currently connected.
- Name: IsMenuOpened
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the game menu is currently opened.
- Name: CursorLocked
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the cursor is currently locked.
- Name: CursorVisible
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the cursor is currently visible.
- Name: MousePosition
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates the current position of the mouse cursor.
- Name: ScreenWidth
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates the width of the screen.
- Name: ScreenHeight
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates the height of the screen.
Methods:
- Name: GetMouseWorldPosition

View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Defines the parent of this instance in the hierarchy.
- Name: EditableChildren
Type: boolean
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determine if children is editable, this is to be used if this
instance is a Linked model. Only used in creator.
- Name: Tags
@@ -19,6 +21,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Tags associated with this instance.
Methods:
- Name: GetDescendants
@@ -65,6 +68,17 @@ Methods:
IsObsolete: false
IsStatic: false
Description: Finds a child of this instance by class name.
- Name: FindAncestorByClass
ReturnType: Instance
Parameters:
- Name: className
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: FindChildByIndex
ReturnType: Instance
Parameters:
@@ -219,6 +233,28 @@ Methods:
IsObsolete: false
IsStatic: false
Description: Sets the parent of this instance.
- Name: __index
ReturnType: any
Parameters:
- Name: indexer
Type: any
IsOptional: false
DefaultValue: null
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: __newindex
ReturnType: nil
Parameters:
- Name: indexer
Type: any
IsOptional: false
DefaultValue: null
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Events:
- Name: ChildAdded
Arguments:

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The value of this object.
Methods: []
Events: []

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The value of this object.
Methods: []
Events: []

View File

@@ -6,30 +6,35 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: WIP
- Name: SubTitle
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: WIP
- Name: HoldDuration
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: WIP
- Name: Key
Type: KeyCodeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: WIP
- Name: UseDefaultUI
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: WIP
Methods: []
Events:

View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Sets the color of the light.
- Name: Brightness
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Sets the brightness of the light.
- Name: Specular
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Sets the specular intensity of the light.
- Name: Shadows
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Enables or disables shadows cast by the light.
Methods: []
Events: []

View File

@@ -6,42 +6,49 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Sets the skybox to one of the preset skyboxes.
- Name: AmbientSource
Type: AmbientSourceEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the source of ambient lighting in the place.
- Name: AmbientColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Sets the ambient color of the lighting in the place.
- Name: FogEnabled
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Enables or disables fog in the place.
- Name: FogColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Sets the color of the fog in the place.
- Name: FogStartDistance
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Sets the distance from the camera at which fog begins to appear.
- Name: FogEndDistance
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Sets the distance from the camera at which fog stops appearing.
Methods: []
Events: []

View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Length of this Marker
- Name: AppearOnTop
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determine if this marker should appear on top of everything else in 3D
Methods: []
Events: []

View File

@@ -6,54 +6,63 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The mesh asset used by this Mesh.
- Name: IncludeOffset
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Whether to keep the offset of the mesh or recenter it.
- Name: CollisionType
Type: CollisionTypeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The type of collision shape to apply to the mesh.
- Name: PlayAnimationOnStart
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Whether to play the mesh's animation automatically when the mesh is loaded.
- Name: UsePartColor
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Whether to use the color of the part this mesh is attached to.
- Name: Color
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color of the mesh.
- Name: CastShadows
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Whether the mesh casts shadows.
- Name: CurrentAnimation
Type: string
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates the name of the current animation playing on the mesh.
- Name: IsAnimationPlaying
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether an animation is currently playing on the mesh.
Methods:
- Name: PlayAnimation

View File

@@ -1,23 +1,26 @@
Name: MeshAnimationInfo
BaseType: ValueType
BaseType: null
Properties:
- Name: Name
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: Length
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: IsPlaying
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Methods: []
Events: []

View File

@@ -6,120 +6,140 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The offset to the seat at which the NPC is positioned when sitting.
- Name: Health
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The current health of the NPC.
- Name: MaxHealth
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The maximum health of the NPC.
- Name: JumpPower
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the jump power of the NPC.
- Name: WalkSpeed
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the walking speed of the NPC.
- Name: UseNametag
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the NPC uses a nametag.
- Name: NametagOffset
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the offset position of the NPC's nametag.
- Name: DisplayName
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the display name of the NPC.
- Name: JumpSound
Type: Sound
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the sound played when the NPC jumps.
- Name: IsSitting
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the NPC is currently sitting.
- Name: IsDead
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the NPC is currently dead.
- Name: HoldingTool
Type: Tool
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates the tool currently held by the NPC.
- Name: SittingIn
Type: Seat
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates the seat in which the NPC is currently sitting.
- Name: Character
Type: CharacterModel
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The character model associated with the NPC.
- Name: MoveTarget
Type: Dynamic
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the instance the NPC should walk towards.
- Name: OnGround
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the NPC is currently on the ground.
- Name: OnCeiling
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the NPC is currently on the ceiling.
- Name: NavDestinationDistance
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates the distance to the navigation destination.
- Name: NavDestinationReached
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the NPC has reached its navigation destination.
- Name: NavDestinationValid
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the navigation destination is valid.
Methods:
- Name: Kill

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines if this network event should send messages reliably.
Recommended to be off if you're passing lot of data that doesn't need to
arrive reliably.

View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Name of this object
- Name: ClassName
Type: string
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Class name of this object
- Name: Shared
Type: ScriptSharedTable
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: A shared table accessible by scripts.
- Name: NetworkedObjectID
Type: string
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns networked ID of this object. Networked ID are always unique
per network session.
- Name: ObjectID
@@ -31,12 +35,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns object ID of this object. Object ID originates from the .poly file.
- Name: ExistInNetwork
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns true if this object exists in network, false if this object
is spawned by the local client.
Methods:
@@ -85,6 +91,32 @@ Methods:
IsObsolete: false
IsStatic: false
Description: Deletes the instance (same as Destroy method)
- Name: __tostring
ReturnType: string
Parameters:
- Name: obj
Type: NetworkedObject
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __eq
ReturnType: boolean
Parameters:
- Name: a
Type: any
IsOptional: false
DefaultValue: ""
- Name: b
Type: any
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
Events:
- Name: PropertyChanged
Arguments:

View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Target place path.
- Name: MaxPlayers
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: How much player slot should the new server allocates for.
Methods:
- Name: New

View File

@@ -1,17 +1,19 @@
Name: NumberRange
BaseType: ValueType
BaseType: null
Properties:
- Name: Min
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the minimum value of the range.
- Name: Max
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the maximum value of the range.
Methods:
- Name: New

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The value of this object.
Methods: []
Events: []

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The audio ID to load
Methods: []
Events: []

View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Asset ID of this image
- Name: ImageType
Type: ImageTypeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Image type of this image
Methods: []
Events: []

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Asset ID of this mesh
Methods: []
Events: []

View File

@@ -24,6 +24,17 @@ Methods:
IsObsolete: false
IsStatic: false
Description: Disconnect a function from this signal
- Name: __tostring
ReturnType: string
Parameters:
- Name: signal
Type: PTSignal
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: Wait
ReturnType: any
Parameters: []

View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the shape of the part.
- Name: Material
Type: PartMaterialEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the material of the part.
- Name: Color
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the color of the part.
- Name: CastShadows
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the part casts shadows.
Methods: []
Events: []

View File

@@ -6,42 +6,49 @@ Properties:
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The image used for the particles.
- Name: Color
Type: ColorSeries
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color gradient used for the particles.
- Name: Lifetime
Type: NumberRange
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the lifetime of a particle.
- Name: Amount
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the number of particles emitted.
- Name: Gravity
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the gravity effect applied to the particles.
- Name: Shaded
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the particles are shaded.
- Name: Autoplay
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the particle system plays automatically.
Methods:
- Name: Play

View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether this object is affected by physics.
- Name: CanCollide
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether this object can collide with other objects.
- Name: Velocity
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the linear velocity of this object.
- Name: AngularVelocity
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the angular velocity of this object.
Methods:
- Name: SetNetworkAuthority
@@ -37,6 +41,13 @@ Methods:
IsObsolete: false
IsStatic: false
Description: Sets the network authority of this object to the specified player.
- Name: GetTouching
ReturnType: table
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: MovePosition
ReturnType: nil
Parameters:

View File

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

View File

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

View File

@@ -6,18 +6,21 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The player who is currently playing the game.
- Name: PlayerCollisionEnabled
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not collisions between players are enabled.
- Name: PlayersCount
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The number of players currently in the game.
Methods:
- Name: GetPlayers

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The range of the point light's illumination.
Methods: []
Events: []

View File

@@ -6,72 +6,84 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The head color
- Name: TorsoColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The torso color
- Name: LeftArmColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The left arm color
- Name: RightArmColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The right arm color
- Name: LeftLegColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The left leg color
- Name: RightLegColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The right leg color
- Name: FaceImage
Type: ImageAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The face image to use
- Name: ShirtImage
Type: ImageAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The shirt image to use
- Name: PantsImage
Type: ImageAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The pants image to use
- Name: TorsoMesh
Type: MeshAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The torso mesh to use
- Name: Ragdolling
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns true if this character is ragdolling
- Name: RagdollPosition
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns the current global ragdoll position, if ragdoll haven't
starts yet. Returns `Vector3.Zero`
- Name: RagdollRotation
@@ -79,6 +91,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns the current global ragdoll rotation, if ragdoll haven't
starts yet. Returns `Vector3.Zero`
Methods:
@@ -129,6 +142,73 @@ Methods:
IsObsolete: false
IsStatic: false
Description: Clear current appearance.
- Name: SetBoneOverrideTo
ReturnType: nil
Parameters:
- Name: attachment
Type: CharacterAttachmentEnum
IsOptional: false
DefaultValue: ""
- Name: to
Type: boolean
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: SetBoneOverridePosition
ReturnType: nil
Parameters:
- Name: attachment
Type: CharacterAttachmentEnum
IsOptional: false
DefaultValue: ""
- Name: pos
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: SetBoneOverrideRotation
ReturnType: nil
Parameters:
- Name: attachment
Type: CharacterAttachmentEnum
IsOptional: false
DefaultValue: ""
- Name: euler
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: GetBoneOverridePosition
ReturnType: Vector3
Parameters:
- Name: attachment
Type: CharacterAttachmentEnum
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: GetBoneOverrideRotation
ReturnType: Vector3
Parameters:
- Name: attachment
Type: CharacterAttachmentEnum
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Events:
- Name: RagdollStarted
Arguments: ""

View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Determines whether the player has photo mode enabled.
- Name: UsePostProcessing
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Determines whether the player has post-processing effects enabled.
Methods: []
Events:

View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Current activity status.
- Name: CoverImage
Type: PTImageAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Activity cover image.
Methods:
- Name: ResetTimer

View File

@@ -6,30 +6,35 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The size of the sun in the sky.
- Name: SkyTint
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The tint color of the sky.
- Name: HorizonColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color of the horizon in the sky.
- Name: GroundColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color of the ground in the sky.
- Name: Exposure
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The exposure level of the sky.
Methods: []
Events: []

View File

@@ -6,30 +6,35 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The X component of the quaternion.
- Name: Y
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The Y component of the quaternion.
- Name: Z
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The Z component of the quaternion.
- Name: W
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The W component of the quaternion.
- Name: Identity
Type: Quaternion
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: The identity rotation.
Methods:
- Name: New
@@ -62,6 +67,77 @@ Methods:
IsObsolete: false
IsStatic: true
Description: Creates a new Quaternion object with the specified components.
- Name: __add
ReturnType: Quaternion
Parameters:
- Name: a
Type: Quaternion
IsOptional: false
DefaultValue: ""
- Name: b
Type: Quaternion
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __sub
ReturnType: Quaternion
Parameters:
- Name: a
Type: any
IsOptional: false
DefaultValue: ""
- Name: b
Type: any
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __mul
ReturnType: any
Parameters:
- Name: a
Type: Quaternion
IsOptional: false
DefaultValue: ""
- Name: b
Type: any
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __eq
ReturnType: boolean
Parameters:
- Name: a
Type: Quaternion
IsOptional: false
DefaultValue: ""
- Name: b
Type: Quaternion
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __tostring
ReturnType: string
Parameters:
- Name: v
Type: Quaternion
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: Angle
ReturnType: Quaternion
Parameters:

View File

@@ -1,41 +1,47 @@
Name: RayResult
BaseType: ValueType
BaseType: null
Properties:
- Name: Origin
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The origin point of the ray.
- Name: Direction
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The direction vector of the ray.
- Name: Position
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The position where the ray hit an object.
- Name: Normal
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The surface normal at the point where the ray hit.
- Name: Distance
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The distance from the ray's origin to the hit point.
- Name: Instance
Type: Instance
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The instance that was hit by the ray.
Methods: []
Events: []

View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The source code of the script as a string.
- Name: IsEnabled
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: LinkedScript
Type: FileLinkAsset
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: A linked script asset associated with this script.
- Name: Compatibility
Type: boolean
IsAccessibleByScripts: false
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Indicates whether the script is running in compatibility mode.
Methods:
- Name: Call

View File

@@ -1,7 +1,33 @@
Name: ScriptSharedTable
BaseType: null
Properties: []
Methods: []
Methods:
- Name: __index
ReturnType: any
Parameters:
- Name: index
Type: string
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: __newindex
ReturnType: nil
Parameters:
- Name: index
Type: string
IsOptional: false
DefaultValue: ""
- Name: val
Type: any
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
Events: []
IsStatic: false
IsAbstract: false

View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Indicates who is currently occupying the seat.
- Name: CanNPCSit
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether NPCs are allowed to sit on this seat or only players.
Methods: []
Events:

View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The audio asset to be played by the sound.
- Name: Volume
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The volume level of the sound.
- Name: Pitch
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The pitch level of the sound.
- Name: Autoplay
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the sound should start playing automatically
when loaded.
- Name: Loop
@@ -31,42 +35,56 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the sound should loop when it reaches the end.
- Name: PlayInWorld
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the sound should be played in the 3D world space.
- Name: Paused
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: MaxDistance
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The maximum distance at which the sound can be heard.
- Name: Time
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Indicates the current playback position of the sound in seconds.
- Name: Playing
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the sound is currently playing.
- Name: Loading
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the sound is currently loading.
- Name: Length
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The total length of the sound in seconds.
Methods:
- Name: Play
@@ -88,6 +106,13 @@ Methods:
IsStatic: false
Description: Plays the sound once at the specified volume without affecting the
current playback.
- Name: Pause
ReturnType: nil
Parameters: []
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: Stop
ReturnType: nil
Parameters: []

View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The maximum distance the light can reach.
- Name: Angle
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The angle of the spotlight's cone.
Methods: []
Events: []

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The value of this object.
Methods: []
Events: []

View File

@@ -6,60 +6,70 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The text content displayed.
- Name: FontSize
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The size of the font used for the text.
- Name: Color
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color of the text.
- Name: OutlineWidth
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The width of the text outline.
- Name: OutlineColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color of the text outline.
- Name: FaceCamera
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the text should always be facing the camera.
- Name: HorizontalAlignment
Type: TextHorizontalAlignmentEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the horizontal alignment of the text.
- Name: VerticalAlignment
Type: TextVerticalAlignmentEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the vertical alignment of the text.
- Name: FontAsset
Type: FontAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The font asset used for the text.
- Name: UseRichText
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the text should be parsed as rich text.
Methods: []
Events: []

View File

@@ -6,18 +6,21 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the tool can be dropped by the player.
- Name: IconImage
Type: ImageAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The icon for this tool, appears in inventory.
- Name: Holder
Type: NPC
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines who is currently holding this tool.
Methods:
- Name: Activate

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The speed at which the player can climb the truss.
Methods: []
Events: []

View File

@@ -6,30 +6,35 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines if this tween is looped
- Name: Parallel
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines if this tween will run all the tweens in parallel
- Name: SpeedScale
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the speed scale of this tween
- Name: IsRunning
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns whether or not this tween is running
- Name: ElapsedTime
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Returns the elapsed time of this tween
Methods:
- Name: SetDirection

View File

@@ -6,72 +6,98 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The offset of the UI element in pixels.
- Name: PositionRelative
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The position of the UI element relative to its parent.
- Name: Rotation
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The rotation of the UI element in degrees.
- Name: SizeOffset
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The size offset of the UI element in pixels.
- Name: SizeRelative
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The size of the UI element relative to its parent.
- Name: ClipDescendants
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the UI element clips its descendants.
- Name: PivotPoint
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The pivot point of the UI element.
- Name: Scale
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The scale of the UI element.
- Name: Visible
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the UI element is visible.
- Name: MaskMode
Type: MaskModeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the mask mode of the UI element.
- Name: IgnoreMouse
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: ZIndex
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Missing Documentation
- Name: AbsoluteSize
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The absolute size of the UI element in pixels.
- Name: IsVisibleInTree
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the UI element is visible in the UI hierarchy.
Methods: []
Events:

View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The spacing between child elements in the layout.
- Name: ChildAlignment
Type: UILayoutAlignmentEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the alignment of child elements within the layout.
Methods: []
Events: []

View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The image asset used for the image.
- Name: Color
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color applied to the image.
- Name: StretchMode
Type: ImageStretchModeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines how the image is stretched within the view.
- Name: Loading
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates whether the image is currently loading.
Methods: []
Events: []

View File

@@ -6,54 +6,63 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The text of the label.
- Name: TextColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color of the text.
- Name: OutlineWidth
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The width of the text outline.
- Name: OutlineColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color of the text outline.
- Name: HorizontalAlignment
Type: TextHorizontalAlignmentEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the horizontal alignment of the text.
- Name: VerticalAlignment
Type: TextVerticalAlignmentEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the vertical alignment of the text.
- Name: FontSize
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The font size of the text.
- Name: UseRichText
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the text uses rich text formatting.
- Name: FontAsset
Type: FontAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The font asset used for the text.
Methods: []
Events: []

View File

@@ -6,12 +6,14 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the horizontal scroll mode of the scroll view.
- Name: VerticalScrollMode
Type: ScrollModeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the vertical scroll mode of the scroll view.
Methods: []
Events: []

View File

@@ -6,60 +6,70 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The text of the label.
- Name: TextColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color of the text.
- Name: JustifyText
Type: TextHorizontalAlignmentEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines how text is justified.
- Name: FontSize
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The font size of the label.
- Name: IsMultiline
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the text input supports multiple lines.
- Name: Placeholder
Type: string
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The placeholder text displayed when the input is empty.
- Name: PlaceholderColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color of the placeholder text.
- Name: ReadOnlyColor
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The color of the text when the input is read-only.
- Name: IsReadOnly
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the text input is read-only.
- Name: FontAsset
Type: FontAsset
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The font asset used for the text.
Methods:
- Name: Focus

View File

@@ -6,24 +6,28 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the border color of the UI.
- Name: Color
Type: Color
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the color of the UI.
- Name: BorderWidth
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the width of the border of the UI.
- Name: CornerRadius
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the corner radius of the UI.
Methods: []
Events: []

View File

@@ -6,66 +6,77 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The X component of the vector.
- Name: Y
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The Y component of the vector.
- Name: Down
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector2.New(0, -1).
- Name: Left
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector2.New(-1, 0).
- Name: One
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector2.New(1, 1).
- Name: Zero
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector2.New(0, 0).
- Name: Right
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector2.New(1, 0).
- Name: Up
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector2.New(0, 1).
- Name: Magnitude
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The length of the vector.
- Name: Normalized
Type: Vector2
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The normalized version of the vector.
- Name: SqrMagnitude
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The squared length of the vector.
Methods:
- Name: New
@@ -101,6 +112,174 @@ Methods:
IsObsolete: false
IsStatic: true
Description: Returns a new Vector2 with the given x and y components.
- Name: __add
ReturnType: Vector2
Parameters:
- Name: a
Type: Vector2
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __sub
ReturnType: Vector2
Parameters:
- Name: a
Type: Vector2
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __mul
ReturnType: any
Parameters:
- Name: a
Type: Vector2
IsOptional: false
DefaultValue: ""
- Name: b
Type: any
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __div
ReturnType: Vector2
Parameters:
- Name: a
Type: Vector2
IsOptional: false
DefaultValue: ""
- Name: b
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __mod
ReturnType: Vector2
Parameters:
- Name: a
Type: Vector2
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __unm
ReturnType: Vector2
Parameters:
- Name: a
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __pow
ReturnType: Vector2
Parameters:
- Name: a
Type: Vector2
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __eq
ReturnType: boolean
Parameters:
- Name: a
Type: Vector2
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __lt
ReturnType: boolean
Parameters:
- Name: a
Type: Vector2
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __le
ReturnType: boolean
Parameters:
- Name: a
Type: Vector2
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __len
ReturnType: number
Parameters:
- Name: a
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __tostring
ReturnType: string
Parameters:
- Name: v
Type: Vector2
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: Angle
ReturnType: number
Parameters:

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The value of this object.
Methods: []
Events: []

View File

@@ -6,84 +6,98 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The X component of the vector.
- Name: Y
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The Y component of the vector.
- Name: Z
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The Z component of the vector.
- Name: Forward
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector3.New(0, 0, -1).
- Name: Back
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector3.New(0, 0, 1).
- Name: Down
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector3.New(0, -1, 0).
- Name: Left
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector3.New(-1, 0, 0).
- Name: One
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector3.New(1, 1, 1).
- Name: Zero
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector3.New(0, 0, 0).
- Name: Right
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector3.New(1, 0, 0).
- Name: Up
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: true
Description: Shorthand for Vector3.New(0, 1, 0).
- Name: Magnitude
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The length of the vector.
- Name: Normalized
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The normalized version of the vector.
- Name: SqrMagnitude
Type: number
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: The squared length of the vector.
Methods:
- Name: New
@@ -154,6 +168,174 @@ Methods:
IsStatic: true
Description: Returns a new Vector3 with the given Vector2 components and a z
component of 0.
- Name: __add
ReturnType: Vector3
Parameters:
- Name: a
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __sub
ReturnType: Vector3
Parameters:
- Name: a
Type: any
IsOptional: false
DefaultValue: ""
- Name: b
Type: any
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __mul
ReturnType: any
Parameters:
- Name: a
Type: any
IsOptional: false
DefaultValue: ""
- Name: b
Type: any
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __div
ReturnType: Vector3
Parameters:
- Name: a
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: b
Type: number
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __mod
ReturnType: Vector3
Parameters:
- Name: a
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __unm
ReturnType: Vector3
Parameters:
- Name: a
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __pow
ReturnType: Vector3
Parameters:
- Name: a
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __eq
ReturnType: boolean
Parameters:
- Name: a
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __lt
ReturnType: boolean
Parameters:
- Name: a
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __le
ReturnType: boolean
Parameters:
- Name: a
Type: Vector3
IsOptional: false
DefaultValue: ""
- Name: b
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __len
ReturnType: number
Parameters:
- Name: a
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: __tostring
ReturnType: string
Parameters:
- Name: v
Type: Vector3
IsOptional: false
DefaultValue: ""
IsAsync: false
IsObsolete: false
IsStatic: true
Description: Missing Documentation
- Name: Angle
ReturnType: number
Parameters:

View File

@@ -6,6 +6,7 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: The value of this object.
Methods: []
Events: []

View File

@@ -6,36 +6,42 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the forward force limit in kg/s.
- Name: SteerLimit
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the steering limit in degrees.
- Name: Force
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the forward force in kg/s.
- Name: Brake
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the break amount in kg/s.
- Name: Steering
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the steering angle in degrees
- Name: Driver
Type: Player
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the current driver of this vehicle.
Methods: []
Events: []

View File

@@ -6,18 +6,21 @@ Properties:
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines if this wheel should be used for traction.
- Name: UseForSteering
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines if this wheel should be used for steering.
- Name: Radius
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the radius for this wheel.
Methods: []
Events: []