diff --git a/.husky/post-checkout b/.husky/post-checkout index ca7fcb400..5abf8ed93 100755 --- a/.husky/post-checkout +++ b/.husky/post-checkout @@ -1,3 +1,3 @@ #!/bin/sh -command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-checkout' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; } +command -v git-lfs >/dev/null 2>&1 || { printf >&2 "\n%s\n\n" "This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-checkout' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks')."; exit 2; } git lfs post-checkout "$@" diff --git a/.husky/post-commit b/.husky/post-commit index 52b339cb3..b8b76c2c4 100755 --- a/.husky/post-commit +++ b/.husky/post-commit @@ -1,3 +1,3 @@ #!/bin/sh -command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-commit' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; } +command -v git-lfs >/dev/null 2>&1 || { printf >&2 "\n%s\n\n" "This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-commit' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks')."; exit 2; } git lfs post-commit "$@" diff --git a/.husky/post-merge b/.husky/post-merge index a912e667a..726f90989 100755 --- a/.husky/post-merge +++ b/.husky/post-merge @@ -1,3 +1,3 @@ #!/bin/sh -command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-merge' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; } +command -v git-lfs >/dev/null 2>&1 || { printf >&2 "\n%s\n\n" "This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-merge' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks')."; exit 2; } git lfs post-merge "$@" diff --git a/.husky/pre-push b/.husky/pre-push index 0f0089bc2..5f26dc455 100755 --- a/.husky/pre-push +++ b/.husky/pre-push @@ -1,3 +1,3 @@ #!/bin/sh -command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'pre-push' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; } +command -v git-lfs >/dev/null 2>&1 || { printf >&2 "\n%s\n\n" "This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'pre-push' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks')."; exit 2; } git lfs pre-push "$@" diff --git a/content/common/navigation/engine/reference.yaml b/content/common/navigation/engine/reference.yaml index 9c588034e..9cad966cd 100644 --- a/content/common/navigation/engine/reference.yaml +++ b/content/common/navigation/engine/reference.yaml @@ -1710,6 +1710,11 @@ navigation: type: engineapi source: /reference/engine/classes/PathfindingService.yaml ignoreTranslation: true + - title: PerformanceControlService + path: /reference/engine/classes/PerformanceControlService + type: engineapi + source: /reference/engine/classes/PerformanceControlService.yaml + ignoreTranslation: true - title: PermissionsService path: /reference/engine/classes/PermissionsService type: engineapi @@ -2895,6 +2900,11 @@ navigation: type: engineapi source: /reference/engine/classes/VideoFrame.yaml ignoreTranslation: true + - title: VideoPlayer + path: /reference/engine/classes/VideoPlayer + type: engineapi + source: /reference/engine/classes/VideoPlayer.yaml + ignoreTranslation: true - title: VideoService path: /reference/engine/classes/VideoService type: engineapi @@ -3838,6 +3848,11 @@ navigation: type: engineapi source: /reference/engine/enums/DeviceFeatureType.yaml ignoreTranslation: true + - title: DeviceForm + path: /reference/engine/enums/DeviceForm + type: engineapi + source: /reference/engine/enums/DeviceForm.yaml + ignoreTranslation: true - title: DeviceLevel path: /reference/engine/enums/DeviceLevel type: engineapi @@ -4208,11 +4223,6 @@ navigation: type: engineapi source: /reference/engine/enums/InputType.yaml ignoreTranslation: true - - title: Intent - path: /reference/engine/enums/Intent - type: engineapi - source: /reference/engine/enums/Intent.yaml - ignoreTranslation: true - title: InterpolationThrottlingMode path: /reference/engine/enums/InterpolationThrottlingMode type: engineapi @@ -4273,6 +4283,11 @@ navigation: type: engineapi source: /reference/engine/enums/LexemeType.yaml ignoreTranslation: true + - title: LightingStyle + path: /reference/engine/enums/LightingStyle + type: engineapi + source: /reference/engine/enums/LightingStyle.yaml + ignoreTranslation: true - title: Limb path: /reference/engine/enums/Limb type: engineapi @@ -4668,11 +4683,6 @@ navigation: type: engineapi source: /reference/engine/enums/ProximityPromptStyle.yaml ignoreTranslation: true - - title: Quality - path: /reference/engine/enums/Quality - type: engineapi - source: /reference/engine/enums/Quality.yaml - ignoreTranslation: true - title: QualityLevel path: /reference/engine/enums/QualityLevel type: engineapi diff --git a/content/en-us/reference/engine/classes/AssetService.yaml b/content/en-us/reference/engine/classes/AssetService.yaml index aa9caa317..48a9ead79 100644 --- a/content/en-us/reference/engine/classes/AssetService.yaml +++ b/content/en-us/reference/engine/classes/AssetService.yaml @@ -17,6 +17,105 @@ tags: deprecation_message: '' properties: [] methods: + - name: AssetService:CreateAssetAsync + summary: | + Creates a new asset from the given object. + description: | + Creates a new asset from the given object in Plugin or Open Cloud Luau Execution context. + code_samples: + - AssetService-CreateAssetAsync + parameters: + - name: object + type: Object + default: + summary: | + The object to be created as an asset. + - name: assetType + type: AssetType + default: + summary: | + Currently supported types are: + + - `Enum.AssetType.Model` – with `object` as any valid `Class.Instance` root. + - `Enum.AssetType.Plugin` – with `object` as any valid `Class.Instance` root. + - `Enum.AssetType.Mesh` – with `object` as any valid `Class.EditableMesh` root. + - `Enum.AssetType.Image` – with `object` as any valid `Class.EditableImage` root. + - name: options + type: Dictionary? + default: + summary: | + Options table containing asset metadata: + + - `Name` – Name of the asset as a string. Defaults to `[object.Name]`. + - `Description` – Description of the asset as a string. Defaults to `"Created with AssetService:CreateAssetAsync"`. + - `CreatorId` – ID of the asset creator as a number. Defaults to the logged in Roblox Studio user for Plugin context. Required for Open Cloud Luau Execution context. + - `CreatorType` – `Enum.AssetCreatorType` indicating the type of asset creator. Defaults to `Enum.AssetCreatorType.User` in Plugin context. Required for Open Cloud Luau Execution context. + - `IsPackage` – Boolean value, only applicable to the `Enum.AssetType.Model` type. Defaults to `true`. + returns: + - type: Tuple + summary: | + The `Enum.CreateAssetResult` and asset ID pair if successful. + tags: + - Yields + deprecation_message: '' + security: None + thread_safety: Unsafe + capabilities: + - PluginOrOpenCloud + writeCapabilities: + - PluginOrOpenCloud + - name: AssetService:CreateAssetVersionAsync + summary: | + Creates a new version for an existing asset from the given object. + description: | + Creates a new version for an existing asset from the given object in Plugin or Open Cloud Luau Execution context. + code_samples: + - AssetService-CreateAssetVersionAsync + parameters: + - name: object + type: Object + default: + summary: | + The object to be created as an asset. + - name: assetType + type: AssetType + default: + summary: | + Currently supported types are: + + - `Enum.AssetType.Model` – with `object` as any valid `Class.Instance` root. + - `Enum.AssetType.Plugin` – with `object` as any valid `Class.Instance` root. + - `Enum.AssetType.Mesh` – with `object` as any valid `Class.EditableMesh` root. + - `Enum.AssetType.Image` – with `object` as any valid `Class.EditableImage` root. + - name: targetAssetId + type: int64 + default: + summary: | + The ID of the asset for the new version. + - name: options + type: Dictionary? + default: + summary: | + Options table containing asset metadata: + + - `Name` – A `string`. Name of the asset. Default: object.Name. + - `Description` – A `string`. Description of the asset. Default: "Created with AssetService:CreateAssetAsync". + - `CreatorId` – A `number`. ID of the asset creator. Default: The logged in Roblox Studio user for Plugin context. Required for Open Cloud Luau Execution context. + - `CreatorType` – A `Enum.AssetCreatorType`. Type of asset creator. Default: `Enum.AssetCreatorType.User` in Plugin context. Required for Open Cloud Luau Execution context. + - `IsPackage` – A `bool`. Only applicable to the `Enum.AssetType.Model` type. Default: true. + returns: + - type: Tuple + summary: | + The `Enum.CreateAssetResult` and asset version number pair if successful. + tags: + - Yields + deprecation_message: '' + security: None + thread_safety: Unsafe + capabilities: + - PluginOrOpenCloud + writeCapabilities: + - PluginOrOpenCloud - name: AssetService:CreateEditableImage summary: | Creates a new `Class.EditableImage`. @@ -88,64 +187,6 @@ methods: thread_safety: Unsafe capabilities: [] writeCapabilities: [] - - name: AssetService:CreateAssetAsync - summary: '' - description: '' - code_samples: [] - parameters: - - name: object - type: Object - default: - summary: '' - - name: assetType - type: AssetType - default: - summary: '' - - name: requestParameters - type: Dictionary - default: nil - summary: '' - returns: - - type: Tuple - summary: '' - tags: - - Yields - deprecation_message: '' - security: None - thread_safety: Unsafe - capabilities: [] - writeCapabilities: [] - - name: AssetService:CreateAssetVersionAsync - summary: '' - description: '' - code_samples: [] - parameters: - - name: object - type: Object - default: - summary: '' - - name: assetType - type: AssetType - default: - summary: '' - - name: assetId - type: int64 - default: - summary: '' - - name: requestParameters - type: Dictionary - default: nil - summary: '' - returns: - - type: Tuple - summary: '' - tags: - - Yields - deprecation_message: '' - security: None - thread_safety: Unsafe - capabilities: [] - writeCapabilities: [] - name: AssetService:CreateEditableImageAsync summary: | Creates a new `Class.EditableImage` object populated with the given image. diff --git a/content/en-us/reference/engine/classes/Attachment.yaml b/content/en-us/reference/engine/classes/Attachment.yaml index 4d34eb6af..d6a0b601a 100644 --- a/content/en-us/reference/engine/classes/Attachment.yaml +++ b/content/en-us/reference/engine/classes/Attachment.yaml @@ -7,10 +7,9 @@ summary: | `Class.Bone`, or another `Class.Attachment`. description: | An `Attachment` defines a point and orientation relative to a parent - `Class.BasePart`, `Class.Bone`, or another `Attachment`. The offset is - stored in the `Class.Attachment.CFrame|CFrame` property. The offset can also - be set through other properties, such as - `Class.Attachment.WorldCFrame|WorldCFrame`. + `Class.BasePart`, `Class.Bone`, or another `Attachment`. The offset is stored + in the `Class.Attachment.CFrame|CFrame` property. The offset can also be set + through other properties, such as `Class.Attachment.WorldCFrame|WorldCFrame`. Attachments are used by several kinds of `Class.Constraint|Constraints` and are also valid alternatives to `Class.BasePart` as a parent for objects such @@ -303,8 +302,8 @@ properties: - Deprecated deprecation_message: | This item has been superseded by - `Class.Attachment.WorldOrientation|WorldOrientation` which - should be used in new work. + `Class.Attachment.WorldOrientation|WorldOrientation` which should be used + in new work. security: read: None write: None diff --git a/content/en-us/reference/engine/classes/Camera.yaml b/content/en-us/reference/engine/classes/Camera.yaml index 1d73c9fae..e5404304b 100644 --- a/content/en-us/reference/engine/classes/Camera.yaml +++ b/content/en-us/reference/engine/classes/Camera.yaml @@ -12,20 +12,20 @@ description: | The most important camera properties are: - - `Class.Camera.CFrame|CFrame` which represents the position and orientation of the - camera. + - `Class.Camera.CFrame|CFrame` which represents the position and orientation + of the camera. - - `Class.Camera.CameraType|CameraType` which is read by the experience's camera scripts - and determines how the camera should update each frame. + - `Class.Camera.CameraType|CameraType` which is read by the experience's + camera scripts and determines how the camera should update each frame. - - `Class.Camera.CameraSubject|CameraSubject` which is read by the experience's camera - scripts and determines what object the camera should follow. + - `Class.Camera.CameraSubject|CameraSubject` which is read by the experience's + camera scripts and determines what object the camera should follow. - - `Class.Camera.FieldOfView|FieldOfView` which represents the visible extent of the - observable world. + - `Class.Camera.FieldOfView|FieldOfView` which represents the visible extent + of the observable world. - - `Class.Camera.Focus|Focus` which represents the point the camera is looking at. - It's important this property is set, as certain visuals will be more + - `Class.Camera.Focus|Focus` which represents the point the camera is looking + at. It's important this property is set, as certain visuals will be more detailed and will update more frequently depending on how close they are to the focus point. @@ -53,9 +53,14 @@ properties: You can move the camera by setting this property. However, the default camera scripts also set it, so you should either: - - Set the camera `Class.Camera.CameraType|CameraType` to `Enum.CameraType.Scriptable` so that the default camera scripts will not update the camera's `Datatype.CFrame`. This method is simplest and recommended in most cases. + - Set the camera `Class.Camera.CameraType|CameraType` to + `Enum.CameraType.Scriptable` so that the default camera scripts will not + update the camera's `Datatype.CFrame`. This method is simplest and + recommended in most cases. - - Completely replace the default camera scripts with alternatives. This approach is only recommended if you do not need any default camera functionality. + - Completely replace the default camera scripts with alternatives. This + approach is only recommended if you do not need any default camera + functionality. The most intuitive way to position and orient the `Class.Camera` is by using the `Datatype.CFrame.lookAt()` constructor. In the following @@ -136,8 +141,8 @@ properties: - When set to a `Class.BasePart`, the camera scripts follow its position, with a vertical offset in the case of `Class.VehicleSeat|VehicleSeats`. - `CameraSubject` cannot be set to `nil`. Attempting to do so will revert - it to its previous value. + `CameraSubject` cannot be set to `nil`. Attempting to do so will revert it + to its previous value. To restore `CameraSubject` to its default value, set it to the local character's `Class.Humanoid`: @@ -147,7 +152,7 @@ properties: local Workspace = game:GetService("Workspace") local localPlayer = Players.LocalPlayer - local camera = Workspace.CurrentCamera + local camera = Workspace.CurrentCamera local function resetCameraSubject() if camera and localPlayer.Character then @@ -178,17 +183,17 @@ properties: description: | The default Roblox camera scripts have several built-in behaviors. Setting this property toggles between the various `Enum.CameraType` behaviors. - Note that some camera types require a valid `Class.Camera.CameraSubject|CameraSubject` - to work correctly. + Note that some camera types require a valid + `Class.Camera.CameraSubject|CameraSubject` to work correctly. The default camera scripts will not move or update the camera if - `CameraType` is set to `Enum.CameraType.Scriptable`. For more - information on positioning and orienting the camera manually, see + `CameraType` is set to `Enum.CameraType.Scriptable`. For more information + on positioning and orienting the camera manually, see `Class.Camera.CFrame|CFrame`. - For all `CameraType` settings **except** `Enum.CameraType.Scriptable`, - the `Class.Camera.CameraSubject|CameraSubject` property represents the - object whose position the camera's `Class.Camera.Focus|Focus` is set to. + For all `CameraType` settings **except** `Enum.CameraType.Scriptable`, the + `Class.Camera.CameraSubject|CameraSubject` property represents the object + whose position the camera's `Class.Camera.Focus|Focus` is set to. code_samples: type: CameraType tags: [] @@ -206,7 +211,8 @@ properties: - name: Camera.CoordinateFrame summary: '' description: | - The old version of the `Class.Camera.CFrame|CFrame` property which functions identically to it. + The old version of the `Class.Camera.CFrame|CFrame` property which + functions identically to it. This item should be used in a `Class.LocalScript` in order to work as expected online. @@ -261,10 +267,10 @@ properties: summary: | Sets the angle of the camera's vertical field of view. description: | - The `FieldOfView` (FOV) property sets how many degrees in the vertical direction - the camera can view. This property is clamped between `1` and `120` - degrees and defaults at `70`. Very low or very high fields of view are not - recommended as they can be disorientating to players. + The `FieldOfView` (FOV) property sets how many degrees in the vertical + direction the camera can view. This property is clamped between `1` and + `120` degrees and defaults at `70`. Very low or very high fields of view + are not recommended as they can be disorientating to players. Note that uniform scaling is enforced, meaning the vertical and horizontal field of view are always related by the aspect ratio of the screen. @@ -397,9 +403,9 @@ properties: `Datatype.CFrame` of the head. - `Class.VRService:RecenterUserHeadCFrame()` which is used to recenter the head to the current position and orientation of the VR device. - - The `Class.Camera:GetRenderCFrame()|GetRenderCFrame()` method which returns the - `Class.Camera.CFrame|CFrame` combined with the `Datatype.CFrame` of the user's - head. + - The `Class.Camera:GetRenderCFrame()|GetRenderCFrame()` method which + returns the `Class.Camera.CFrame|CFrame` combined with the + `Datatype.CFrame` of the user's head. code_samples: type: bool tags: [] @@ -418,8 +424,8 @@ properties: summary: | Sets the scale of the user's perspective of the world when using VR. description: | - `HeadScale` is the scale of the user's perspective of the world when - using VR. + `HeadScale` is the scale of the user's perspective of the world when using + VR. The size of 1 stud in VR is `0.3 meters / HeadScale`, meaning that larger `HeadScale` values equate to the world looking smaller from the user's @@ -428,8 +434,8 @@ properties: This property is automatically controlled by `Class.VRService.AutomaticScaling` to align the player's perspective with - the size of their avatar. If you intend to control `HeadScale` yourself - or use custom characters, toggle `Class.VRService.AutomaticScaling` to + the size of their avatar. If you intend to control `HeadScale` yourself or + use custom characters, toggle `Class.VRService.AutomaticScaling` to `Enum.VRScaling.Off`. This property should not be confused with `Class.Humanoid.HeadScale` which @@ -454,8 +460,8 @@ properties: Sets the angle of the camera's field of view along the longest viewport axis. description: | - The `MaxAxisFieldOfView` property sets how many degrees along the - longest viewport axis the camera can view. + The `MaxAxisFieldOfView` property sets how many degrees along the longest + viewport axis the camera can view. When the longest axis is the vertical axis, this property will behave similar to the `Class.Camera.FieldOfView|FieldOfView` property. This is @@ -515,7 +521,8 @@ properties: device. description: | This property toggles whether to apply tilt and roll from the - `Class.Camera.CFrame|CFrame` property while the player is using a VR device. + `Class.Camera.CFrame|CFrame` property while the player is using a VR + device. To prevent motion sickness, the horizon should remain level. Tilting and rolling the player's view while using a VR device can cause a disconnect @@ -572,12 +579,10 @@ properties: ##### Camera Updates Only the `Class.Camera` currently referred to by - `Class.Workspace.CurrentCamera` has its - `ViewportSize` updated each frame during the - `Class.RunService.PreRender|PreRender` step. The - `ViewportSize` of all other cameras in your - experience won't be updated, including those used for - `Class.ViewportFrame|ViewportFrames`. + `Class.Workspace.CurrentCamera` has its `ViewportSize` updated each frame + during the `Class.RunService.PreRender|PreRender` step. The `ViewportSize` + of all other cameras in your experience won't be updated, including those + used for `Class.ViewportFrame|ViewportFrames`. code_samples: type: Vector2 tags: @@ -603,8 +608,8 @@ properties: - NotReplicated - Deprecated deprecation_message: | - This property is a deprecated variant of `Class.Camera.Focus|Focus` which should - be used instead. + This property is a deprecated variant of `Class.Camera.Focus|Focus` which + should be used instead. security: read: None write: None @@ -622,12 +627,11 @@ methods: `Class.Camera.Focus|Focus` in order to make sure there is no obstructions between the `Class.Camera.Focus|Focus` and `Class.Camera.CFrame|CFrame`. description: | - This method is used by `PopperCam` in the default camera scripts to - ensure obstructions do not come between the `Class.Camera` and its - subject. + This method is used by `PopperCam` in the default camera scripts to ensure + obstructions do not come between the `Class.Camera` and its subject. - This method will check all `Class.BasePart|BaseParts` and - `Class.Terrain` in the `Class.Workspace` with the following exceptions: + This method will check all `Class.BasePart|BaseParts` and `Class.Terrain` + in the `Class.Workspace` with the following exceptions: - Any `Class.Instance` specified in the `ignoreList` (including its descendants) will be ignored @@ -665,7 +669,7 @@ methods: Returns the current 'pan' speed of the `Class.Camera`. description: | This method is broken and should not be used. - + This method returns the current pan speed of the `Class.Camera`. The pan speed of the `Class.Camera` describes the speed at which the @@ -681,8 +685,8 @@ methods: tags: - Deprecated deprecation_message: | - This method has been deprecated and no longer works. It should not be - used in new work. + This method has been deprecated and no longer works. It should not be used + in new work. security: None thread_safety: Unsafe capabilities: [] @@ -752,11 +756,11 @@ methods: Returns the actual `Datatype.CFrame`where the `Class.Camera` is being rendered, accounting for any roll applied and the impact of VR devices. description: | - This method returns the actual `Datatype.CFrame` of the `Class.Camera` - as it is rendered, including the impact of VR (VR head transformations are + This method returns the actual `Datatype.CFrame` of the `Class.Camera` as + it is rendered, including the impact of VR (VR head transformations are not applied to the `Class.Camera.CFrame|CFrame` property, so it is best - practice to use `Class.Camera:GetRenderCFrame()|GetRenderCFrame()` to obtain the "true" - `Datatype.CFrame` of a player's view). + practice to use `Class.Camera:GetRenderCFrame()|GetRenderCFrame()` to + obtain the "true" `Datatype.CFrame` of a player's view). For example, when using VR, the `Class.Camera` is actually rendered at the following `Datatype.CFrame`: @@ -789,17 +793,18 @@ methods: - name: Camera:GetRoll summary: | Returns in radians the current roll, or rotation around the camera's - Z-axis, applied to the `Class.Camera` using `Class.Camera:SetRoll()|SetRoll()`. + Z-axis, applied to the `Class.Camera` using + `Class.Camera:SetRoll()|SetRoll()`. description: | This method returns, in radians, the current roll applied to the - `Class.Camera` using `Class.Camera:SetRoll()|SetRoll()`. Roll is defined as rotation - around the camera's Z-axis. + `Class.Camera` using `Class.Camera:SetRoll()|SetRoll()`. Roll is defined + as rotation around the camera's Z-axis. - This method only returns roll applied using the `Class.Camera:SetRoll()|SetRoll()` - method. Roll manually applied to the camera's - `Class.Camera.CFrame|CFrame` is not accounted for. To obtain the actual - roll of the `Class.Camera`, including roll manually applied, you can use - the following snippet: + This method only returns roll applied using the + `Class.Camera:SetRoll()|SetRoll()` method. Roll manually applied to the + camera's `Class.Camera.CFrame|CFrame` is not accounted for. To obtain the + actual roll of the `Class.Camera`, including roll manually applied, you + can use the following snippet: ```lua local function getActualRoll() @@ -817,9 +822,9 @@ methods: returns: - type: float summary: | - The current roll applied by `Class.Camera:SetRoll()|SetRoll()`, in radians. - tags: - - Deprecated + The current roll applied by `Class.Camera:SetRoll()|SetRoll()`, in + radians. + tags: [] deprecation_message: | This method has been deprecated. security: None @@ -877,16 +882,18 @@ methods: orientated towards the camera's `Class.Camera.Focus|Focus`. When the tween has completed, the camera's - `Class.Camera.InterpolationFinished|InterpolationFinished` event will fire. + `Class.Camera.InterpolationFinished|InterpolationFinished` event will + fire. - If this method is called while the `Class.Camera` is already tweening, - the older tween will be stopped (without firing - `Class.Camera.InterpolationFinished|InterpolationFinished`) and overridden by the new tween. + If this method is called while the `Class.Camera` is already tweening, the + older tween will be stopped (without firing + `Class.Camera.InterpolationFinished|InterpolationFinished`) and overridden + by the new tween. - Interpolate can only be used if the current `Class.Camera.CameraType|CameraType` is - `Scriptable`, regardless of whether the default camera scripts are being - used. If it is used with any other `Class.Camera.CameraType|CameraType` an error will - be thrown. + Interpolate can only be used if the current + `Class.Camera.CameraType|CameraType` is `Scriptable`, regardless of + whether the default camera scripts are being used. If it is used with any + other `Class.Camera.CameraType|CameraType` an error will be thrown. You are advised to use `Class.TweenService` to tween the `Class.Camera` instead as it is more reliable and offers a variety of easing styles. See @@ -945,14 +952,13 @@ methods: Pans the `Class.Camera` around the `Class.Camera.Focus|Focus` in 45 degree increments around the **Y** axis. description: | - This method pans the `Class.Camera` around the - `Class.Camera.Focus|Focus` in 45 degree increments around the **Y** axis. + This method pans the `Class.Camera` around the `Class.Camera.Focus|Focus` + in 45 degree increments around the **Y** axis. The rotation is applied to the camera's `Class.Camera.CFrame|CFrame` property. - This method pans the `Class.Camera` in 45 degree increments, for - example: + This method pans the `Class.Camera` in 45 degree increments, for example: ```lua workspace.CurrentCamera:PanUnits(1) -- 45 degrees @@ -986,11 +992,10 @@ methods: at a set depth from the `Class.Camera` orientated in the camera's direction. Accounts for the GUI inset. description: | - This method creates a unit `Datatype.Ray` from a 2D position on the - screen (defined in pixels), accounting for the GUI inset. The - `Datatype.Ray` originates from the `Datatype.Vector3` equivalent of the 2D - position in the world at the given depth (in studs) away from the - `Class.Camera`. + This method creates a unit `Datatype.Ray` from a 2D position on the screen + (defined in pixels), accounting for the GUI inset. The `Datatype.Ray` + originates from the `Datatype.Vector3` equivalent of the 2D position in + the world at the given depth (in studs) away from the `Class.Camera`. As this method acknowledges the GUI inset, the offset applied to GUI elements (such as from the top bar) is accounted for. This means the @@ -1022,16 +1027,16 @@ methods: type: float default: summary: | - The position on the **X** axis, in pixels, of the screen point at which to - originate the `Datatype.Ray`. This position accounts for the GUI - inset. + The position on the **X** axis, in pixels, of the screen point at + which to originate the `Datatype.Ray`. This position accounts for the + GUI inset. - name: 'y' type: float default: summary: | - The position on the **Y** axis, in pixels, of the screen point at which to - originate the `Datatype.Ray`. This position accounts for the GUI - inset. + The position on the **Y** axis, in pixels, of the screen point at + which to originate the `Datatype.Ray`. This position accounts for the + GUI inset. - name: depth type: float default: 0 @@ -1056,8 +1061,8 @@ methods: Sets the `Enum.CameraPanMode` to be used by the `Class.Camera` on mobile devices. description: | - This method sets the `Enum.CameraPanMode` to be used by the - `Class.Camera` on mobile devices. + This method sets the `Enum.CameraPanMode` to be used by the `Class.Camera` + on mobile devices. When the \*'EdgeBump' `Enum.CameraPanMode` is used, swipe to pan is disabled and the edge bump camera controls are enabled. @@ -1087,9 +1092,9 @@ methods: description: | This method is outdated and no longer considered best practice. - This method sets the current roll, in radians, of the `Class.Camera`. - The roll is applied after the `Class.Camera.CFrame|CFrame` and represents - the rotation around the camera's Z-axis. + This method sets the current roll, in radians, of the `Class.Camera`. The + roll is applied after the `Class.Camera.CFrame|CFrame` and represents the + rotation around the camera's Z-axis. For example, the following would invert the `Class.Camera`: @@ -1100,21 +1105,23 @@ methods: SetRoll has no effect on any roll applied using the `Class.Camera.CFrame|CFrame` property. Roll applied using SetRoll is not reflected in the `Class.Camera.CFrame|CFrame` property but is reflected in - the `Datatype.CFrame` returned by`Class.Camera:GetRenderCFrame()|GetRenderCFrame()`. + the `Datatype.CFrame` returned + by`Class.Camera:GetRenderCFrame()|GetRenderCFrame()`. - This method can only be used when the - `Class.Camera.CameraType|CameraType` is set to `Scriptable`, regardless - of whether the default camera scripts are being used. If it is used with - any other `Class.Camera.CameraType|CameraType` a warning is given in the - output. + This method can only be used when the `Class.Camera.CameraType|CameraType` + is set to `Scriptable`, regardless of whether the default camera scripts + are being used. If it is used with any other + `Class.Camera.CameraType|CameraType` a warning is given in the output. Any roll applied using this method will be lost when the `Class.Camera.CameraType|CameraType` is changed from `Scriptable`. - To obtain the roll set using this method use `Class.Camera:GetRoll()|GetRoll()`. + To obtain the roll set using this method use + `Class.Camera:GetRoll()|GetRoll()`. As this method is outdated, you are advised to instead apply roll to the - `Class.Camera` using the `Class.Camera.CFrame|CFrame` property. For example: + `Class.Camera` using the `Class.Camera.CFrame|CFrame` property. For + example: ```lua local currentCFrame = workspace.CurrentCamera.CFrame @@ -1131,8 +1138,7 @@ methods: returns: - type: void summary: '' - tags: - - Deprecated + tags: [] deprecation_message: | This method has been deprecated. Instead use the `Class.Camera.CFrame|CFrame` property to 'roll' the `Class.Camera`. @@ -1146,12 +1152,11 @@ methods: degree increments around the camera's **X** axis. description: | This method tilts the `Class.Camera` by rotating it around the - `Class.Camera.Focus|Focus` around the camera's **X** axis by a given multiple - of 10 degrees. + `Class.Camera.Focus|Focus` around the camera's **X** axis by a given + multiple of 10 degrees. The rotation is applied to the camera's `Class.Camera.CFrame|CFrame` - property and - is constrained between `-81.05` and `81.05` degrees. + property and is constrained between `-81.05` and `81.05` degrees. code_samples: parameters: - name: units @@ -1272,9 +1277,8 @@ methods: and whether this point is within the bounds of the screen. Accounts for the GUI inset. description: | - This method returns the screen location and depth of a - `Datatype.Vector3` `worldPoint` and whether this point is within the - bounds of the screen. + This method returns the screen location and depth of a `Datatype.Vector3` + `worldPoint` and whether this point is within the bounds of the screen. This method takes in account the current GUI inset, such as the space occupied by the top bar, meaning that the 2D position returned is in the @@ -1310,10 +1314,10 @@ methods: summary: | A tuple containing, in order: - - A `Datatype.Vector3` whose **X** and **Y** components represent the offset - of the `worldPoint` from the top left corner of the screen, in - pixels. The `Datatype.Vector3` **Z** component represents the depth - of the `worldPoint` from the screen (in studs). + - A `Datatype.Vector3` whose **X** and **Y** components represent the + offset of the `worldPoint` from the top left corner of the screen, + in pixels. The `Datatype.Vector3` **Z** component represents the + depth of the `worldPoint` from the screen (in studs). - A boolean indicating if the `worldPoint` is within the bounds of the screen. @@ -1329,9 +1333,8 @@ methods: and whether this point is within the bounds of the screen. Does not account for the GUI inset. description: | - This method returns the screen location and depth of a - `Datatype.Vector3` `worldPoint` and whether this point is within the - bounds of the screen. + This method returns the screen location and depth of a `Datatype.Vector3` + `worldPoint` and whether this point is within the bounds of the screen. This method does not take in account the current GUI inset, such as the space occupied by the top bar, meaning that the 2D position returned is @@ -1412,15 +1415,15 @@ events: using`Class.Camera:Interpolate()|Interpolate()`. description: | This event fires when the `Class.Camera` has finished interpolating using - the `Class.Camera:Interpolate()` method. It will not fire if a tween is interrupted due to `Class.Camera:Interpolate()` being called again. + the `Class.Camera:Interpolate()` method. It will not fire if a tween is + interrupted due to `Class.Camera:Interpolate()` being called again. You are advised to use `Class.TweenService` to animate the `Class.Camera` instead, as it is more reliable and provides more options for easing styles. code_samples: parameters: [] - tags: - - Deprecated + tags: [] deprecation_message: | This event has been deprecated. Instead use `Class.TweenService` to smoothly animate the `Class.Camera`. diff --git a/content/en-us/reference/engine/classes/ContentProvider.yaml b/content/en-us/reference/engine/classes/ContentProvider.yaml index 95f2a9194..63331fd15 100644 --- a/content/en-us/reference/engine/classes/ContentProvider.yaml +++ b/content/en-us/reference/engine/classes/ContentProvider.yaml @@ -172,11 +172,11 @@ methods: Queues an asset to be downloaded by the `Class.ContentProvider`. description: | Usually, content is loaded only when it starts being used. That explains - why it often takes a moment for an image to appear in a - `Class.GuiObject`, or a `Mesh|mesh` to appear in a - `Class.BasePart|part`, or why a `Class.Sound|sound` doesn't play for the - first time. All because the asset has not yet finished loading. Preload is - used to load this content beforehand, so that it works instantly. + why it often takes a moment for an image to appear in a `Class.GuiObject`, + or a `Mesh|mesh` to appear in a `Class.BasePart|part`, or why a + `Class.Sound|sound` doesn't play for the first time. All because the asset + has not yet finished loading. Preload is used to load this content + beforehand, so that it works instantly. code_samples: - ContentProvider-Preload1 parameters: diff --git a/content/en-us/reference/engine/classes/DataStore.yaml b/content/en-us/reference/engine/classes/DataStore.yaml index f7e70718d..78460674b 100644 --- a/content/en-us/reference/engine/classes/DataStore.yaml +++ b/content/en-us/reference/engine/classes/DataStore.yaml @@ -57,7 +57,7 @@ methods: description: | This function retrieves the key version that was current at a given time as well as a `Class.DataStoreKeyInfo` instance. - code_samples: + code_samples: - retrieving-datastore-versions-by-time parameters: - name: key @@ -72,8 +72,8 @@ methods: type: int64 default: summary: | - Unix timestamp in milliseconds for which the requested version was - current. Must be greater than zero. Must not be more than ten minutes + Unix timestamp in milliseconds for which the requested version was + current. Must be greater than zero. Must not be more than ten minutes in the future. returns: - type: Tuple diff --git a/content/en-us/reference/engine/classes/DataStoreService.yaml b/content/en-us/reference/engine/classes/DataStoreService.yaml index 27e159ae2..456198d3b 100644 --- a/content/en-us/reference/engine/classes/DataStoreService.yaml +++ b/content/en-us/reference/engine/classes/DataStoreService.yaml @@ -188,7 +188,7 @@ methods: given prefix. - name: pageSize type: int - default: 32 + default: 0 summary: | **(Optional)** Number of items to be returned in each page. By default is 32. diff --git a/content/en-us/reference/engine/classes/DebugSettings.yaml b/content/en-us/reference/engine/classes/DebugSettings.yaml index f0d8c9fd0..6999fa6df 100644 --- a/content/en-us/reference/engine/classes/DebugSettings.yaml +++ b/content/en-us/reference/engine/classes/DebugSettings.yaml @@ -13,6 +13,7 @@ inherits: tags: - NotCreatable - Settings + - NotReplicated - NotBrowsable deprecation_message: '' properties: diff --git a/content/en-us/reference/engine/classes/EditableImage.yaml b/content/en-us/reference/engine/classes/EditableImage.yaml index e597cf10a..23824983e 100644 --- a/content/en-us/reference/engine/classes/EditableImage.yaml +++ b/content/en-us/reference/engine/classes/EditableImage.yaml @@ -34,8 +34,7 @@ description: | published experiences. To enable the use of `Class.EditableImage`, you must be 13+ age verified and ID verified. After you are verified, open **Studio**. Select **File > Game Settings > Security** and enable the **Allow Mesh & Image - APIs** toggle. Remember to review the Terms of Use before enabling the - toggle. + APIs** toggle. Remember to review the Terms of Use before enabling the toggle. #### Permissions diff --git a/content/en-us/reference/engine/classes/EditableMesh.yaml b/content/en-us/reference/engine/classes/EditableMesh.yaml index 8741e967c..602d01613 100644 --- a/content/en-us/reference/engine/classes/EditableMesh.yaml +++ b/content/en-us/reference/engine/classes/EditableMesh.yaml @@ -161,10 +161,11 @@ tags: deprecation_message: '' properties: - name: EditableMesh.FixedSize - summary: 'Returns `true` if a mesh is fixed-size.' - description: | - Fixed-sized meshes allow changing the values of vertex attributes - but do not allow vertices and triangles to be added or deleted. + summary: | + Returns `true` if a mesh is fixed-size. + description: | + Fixed-sized meshes allow changing the values of vertex attributes but do + not allow vertices and triangles to be added or deleted. code_samples: [] type: bool tags: diff --git a/content/en-us/reference/engine/classes/GameSettings.yaml b/content/en-us/reference/engine/classes/GameSettings.yaml index aa0b11d3f..cfe384f1b 100644 --- a/content/en-us/reference/engine/classes/GameSettings.yaml +++ b/content/en-us/reference/engine/classes/GameSettings.yaml @@ -13,6 +13,7 @@ inherits: tags: - NotCreatable - Settings + - NotReplicated - NotBrowsable deprecation_message: '' properties: diff --git a/content/en-us/reference/engine/classes/GuiBase2d.yaml b/content/en-us/reference/engine/classes/GuiBase2d.yaml index c2be382ed..0e500ce9a 100644 --- a/content/en-us/reference/engine/classes/GuiBase2d.yaml +++ b/content/en-us/reference/engine/classes/GuiBase2d.yaml @@ -26,8 +26,9 @@ properties: renders as a result of its ancestors' sizes and positions. Note that the object's `Class.GuiObject.AnchorPoint|AnchorPoint` influences `Class.GuiBase2d.AbsolutePosition|AbsolutePosition`. - - See also `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` and `Class.GuiBase2d.AbsoluteSize|AbsoluteSize`. + + See also `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` and + `Class.GuiBase2d.AbsoluteSize|AbsoluteSize`. code_samples: type: Vector2 tags: @@ -55,7 +56,8 @@ properties: element, in degrees. It does **not** perform bounds checking, so its value may not be in the range `0` to `360`. - See also `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` and `Class.GuiBase2d.AbsoluteSize|AbsoluteSize`. + See also `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` and + `Class.GuiBase2d.AbsoluteSize|AbsoluteSize`. code_samples: type: float tags: @@ -75,13 +77,15 @@ properties: writeCapabilities: [] - name: GuiBase2d.AbsoluteSize summary: | - Describes the actual screen size of a `Class.GuiBase2d` element, in pixels. + Describes the actual screen size of a `Class.GuiBase2d` element, in + pixels. description: | `Class.GuiBase2d.AbsoluteSize|AbsoluteSize` is a read-only property that describes the actual screen size of a `Class.GuiBase2d` element, in pixels. - See also `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` and `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation`. + See also `Class.GuiBase2d.AbsolutePosition|AbsolutePosition` and + `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation`. code_samples: type: Vector2 tags: @@ -167,7 +171,7 @@ properties: `Class.GuiBase2d.AutoLocalize|AutoLocalize` must be set to `true` on the `Class.GuiBase2d` and its ancestors for automated localization to be applied. - + You can set this to reference a `Class.LocalizationTable` anywhere in the `Class.DataModel`. The `Class.GuiBase2d` object and all of its children will try to use that specific `Class.LocalizationTable` and its ancestors @@ -283,7 +287,7 @@ properties: Allows for customization of how gamepad selection can move between buttons, which are descendants of the selection group, leave the group, and select other buttons. - + Setting `Class.GuiBase2d.SelectionGroup|SelectionGroup` to `true` exposes the `Class.GuiBase2d.SelectionBehaviorUp|SelectionBehaviorUp`, `Class.GuiBase2d.SelectionBehaviorDown|SelectionBehaviorDown`, @@ -316,7 +320,8 @@ events: - name: GuiBase2d.SelectionChanged summary: | Fires when the gamepad selection moves to, leaves, or changes within the - connected `Class.GuiBase2d` or any descendant `Class.GuiObject|GuiObjects`. + connected `Class.GuiBase2d` or any descendant + `Class.GuiObject|GuiObjects`. description: | This event fires when the gamepad selection moves to, leaves, or changes within the connected `Class.GuiBase2d` or any descendant diff --git a/content/en-us/reference/engine/classes/GuiButton.yaml b/content/en-us/reference/engine/classes/GuiButton.yaml index 3c5f1755e..cf88f9477 100644 --- a/content/en-us/reference/engine/classes/GuiButton.yaml +++ b/content/en-us/reference/engine/classes/GuiButton.yaml @@ -108,9 +108,11 @@ properties: writeCapabilities: [] - name: GuiButton.Style summary: | - Sets the style of the `Class.GuiButton` based on a list of pre-determined styles. + Sets the style of the `Class.GuiButton` based on a list of pre-determined + styles. description: | - Sets the style of the `Class.GuiButton` based on a list of pre-determined styles. + Sets the style of the `Class.GuiButton` based on a list of pre-determined + styles. code_samples: type: ButtonStyle tags: [] @@ -210,7 +212,8 @@ events: Fires when the user releases their left mouse button off of the `Class.GuiButton`. description: | - This event fires when the user releases their left mouse button off of the `Class.GuiButton`. + This event fires when the user releases their left mouse button off of the + `Class.GuiButton`. For an event requiring the user to press **and** release their left mouse on a `Class.GuiButton` in order for the event to fire, consider using @@ -288,9 +291,11 @@ events: writeCapabilities: [] - name: GuiButton.MouseButton2Up summary: | - Fires when the user releases their right mouse button off of the `Class.GuiButton`. + Fires when the user releases their right mouse button off of the + `Class.GuiButton`. description: | - This event fires when the user releases their right mouse button off of the `Class.GuiButton`. + This event fires when the user releases their right mouse button off of + the `Class.GuiButton`. For an event requiring the user to press **and** release their right mouse on a `Class.GuiButton` in order for the event to fire, consider using diff --git a/content/en-us/reference/engine/classes/GuiObject.yaml b/content/en-us/reference/engine/classes/GuiObject.yaml index a61db433d..2b3009ff0 100644 --- a/content/en-us/reference/engine/classes/GuiObject.yaml +++ b/content/en-us/reference/engine/classes/GuiObject.yaml @@ -71,11 +71,10 @@ properties: Determines the origin point of a `Class.GuiObject`, relative to its absolute size. description: | - This property determines the origin point of a - `Class.GuiObject`, relative to its absolute size. The origin point - determines from where the element is positioned (through - `Class.GuiObject.Position`) and from which the rendered - `Class.GuiObject.Size` expands. + This property determines the origin point of a `Class.GuiObject`, relative + to its absolute size. The origin point determines from where the element + is positioned (through `Class.GuiObject.Position`) and from which the + rendered `Class.GuiObject.Size` expands. See [here](../../../ui/positioning-and-sizing.md#anchorpoint) for illustrated diagrams and details. @@ -104,9 +103,10 @@ properties: and other content to a UI object at edit or run time, and the size will adjust to fit that content. - When `Class.GuiObject.AutomaticSize|AutomaticSize` is set to an `Enum.AutomaticSize` value to anything - other than `Enum.AutomaticSize|None`, this UI object may resize depending - on its child content. + When `Class.GuiObject.AutomaticSize|AutomaticSize` is set to an + `Enum.AutomaticSize` value to anything other than + `Enum.AutomaticSize|None`, this UI object may resize depending on its + child content. For more information on how to use this property and how it works, please see [here](../../../ui/size-modifiers.md#automatic-sizing). @@ -349,8 +349,8 @@ properties: Determines whether a `Class.GuiObject` (and its descendants) can be dragged around the screen. description: | - This indicates whether a `Class.GuiObject` (and its descendants) can - be dragged around the screen. + This indicates whether a `Class.GuiObject` (and its descendants) can be + dragged around the screen. code_samples: type: bool tags: @@ -687,12 +687,12 @@ properties: This property determines whether the `Class.GuiObject` can be selected when navigating GUIs using a gamepad. - If this property is `true`, a GUI can be selected. Selecting a GUI also sets - the `Class.GuiService.SelectedObject` property to that object. + If this property is `true`, a GUI can be selected. Selecting a GUI also + sets the `Class.GuiService.SelectedObject` property to that object. When this is `false`, the GUI cannot be selected. However, setting this to - `false` when a GUI is selected will not deselect it nor change the value of - the `Class.GuiService.SelectedObject` property. + `false` when a GUI is selected will not deselect it nor change the value + of the `Class.GuiService.SelectedObject` property. Add `Class.GuiObject.SelectionGained` and `Class.GuiObject.SelectionLost` will not fire for the element. To deselect a GuiObject, you must change @@ -916,9 +916,10 @@ properties: relative to others. By default, `Class.GuiObject|GuiObjects` render in ascending priority - order where those with lower `Class.GuiObject.ZIndex|ZIndex` values are rendered under those with - higher values. You can change the render order within a `Class.ScreenGui`, - `Class.SurfaceGui`, or `Class.BillboardGui` by changing the value of its + order where those with lower `Class.GuiObject.ZIndex|ZIndex` values are + rendered under those with higher values. You can change the render order + within a `Class.ScreenGui`, `Class.SurfaceGui`, or `Class.BillboardGui` by + changing the value of its `Class.LayerCollector.ZIndexBehavior|ZIndexBehavior`. If you are unsure if you'll need to add an element between two existing @@ -1021,8 +1022,8 @@ methods: `Enum.EasingStyle`. This function will return whether the tween will play. Normally this will - always return `true`, but it will return `false` if another tween is active - and override is set to `false`. + always return `true`, but it will return `false` if another tween is + active and override is set to `false`. See also `Class.GuiObject:TweenSize()` and `Class.GuiObject:TweenSizeAndPosition()`. @@ -1089,8 +1090,8 @@ methods: and `Enum.EasingStyle`. This function will return whether the tween will play. Normally this will - always return `true`, but it will return `false` if another tween is active - and override is set to `false`. + always return `true`, but it will return `false` if another tween is + active and override is set to `false`. See also `Class.GuiObject:TweenSize()` and `Class.GuiObject:TweenSizeAndPosition()`. @@ -1300,8 +1301,7 @@ events: default: summary: | An `Class.InputObject`, which contains useful data for querying user - input such as the`Enum.UserInputType`, - `Enum.UserInputState`, and + input such as the`Enum.UserInputType`, `Enum.UserInputState`, and `Class.InputObject.Position`. tags: [] deprecation_message: '' @@ -1342,14 +1342,14 @@ events: type: int default: summary: | - The mouse's **X** screen coordinate in pixels, relative to the top left - corner of the screen. + The mouse's **X** screen coordinate in pixels, relative to the top + left corner of the screen. - name: 'y' type: int default: summary: | - The mouse's **Y** screen coordinate in pixels, relative to the top left - corner of the screen. + The mouse's **Y** screen coordinate in pixels, relative to the top + left corner of the screen. tags: [] deprecation_message: '' security: None @@ -1385,14 +1385,14 @@ events: type: int default: summary: | - The mouse's **X** screen coordinate in pixels, relative to the top left - corner of the screen. + The mouse's **X** screen coordinate in pixels, relative to the top + left corner of the screen. - name: 'y' type: int default: summary: | - The mouse's **Y** screen coordinate in pixels, relative to the top left - corner of the screen. + The mouse's **Y** screen coordinate in pixels, relative to the top + left corner of the screen. tags: [] deprecation_message: '' security: None @@ -1451,14 +1451,14 @@ events: type: int default: summary: | - The mouse's **X** screen coordinate in pixels, relative to the top left - corner of the screen. + The mouse's **X** screen coordinate in pixels, relative to the top + left corner of the screen. - name: 'y' type: int default: summary: | - The mouse's **Y** screen coordinate in pixels, relative to the top left - corner of the screen. + The mouse's **Y** screen coordinate in pixels, relative to the top + left corner of the screen. tags: [] deprecation_message: '' security: None @@ -1492,14 +1492,14 @@ events: type: int default: summary: | - The mouse's **X** screen coordinate in pixels, relative to the top left - corner of the screen. + The mouse's **X** screen coordinate in pixels, relative to the top + left corner of the screen. - name: 'y' type: int default: summary: | - The mouse's **Y** screen coordinate in pixels, relative to the top left - corner of the screen. + The mouse's **Y** screen coordinate in pixels, relative to the top + left corner of the screen. tags: [] deprecation_message: '' security: None @@ -1517,9 +1517,10 @@ events: mouse is over a GUI element. This event fires merely as an indicator of the wheel's forward movement. - This means that the **X** and **Y** mouse coordinate arguments do not change as a - result of this event. These coordinates only change when the mouse moves, - which can be tracked by the `Class.GuiObject.MouseMoved` event. + This means that the **X** and **Y** mouse coordinate arguments do not + change as a result of this event. These coordinates only change when the + mouse moves, which can be tracked by the `Class.GuiObject.MouseMoved` + event. ##### See Also @@ -1598,11 +1599,11 @@ events: Fires when the player starts, continues and stops long-pressing the UI element. description: | - This event fires after a brief moment when the player - holds their finger on the UI element using a touch-enabled device. It - fires with a table of `Datatype.Vector2` that describe the relative screen - positions of the fingers involved in the gesture. In addition, it fires - multiple times: `Enum.UserInputState.Begin` after a brief delay, + This event fires after a brief moment when the player holds their finger + on the UI element using a touch-enabled device. It fires with a table of + `Datatype.Vector2` that describe the relative screen positions of the + fingers involved in the gesture. In addition, it fires multiple times: + `Enum.UserInputState.Begin` after a brief delay, `Enum.UserInputState.Change` if the player moves their finger during the gesture, and finally `Enum.UserInputState.End`. The delay is platform dependent; in Studio it is a little longer than one second. @@ -1639,8 +1640,8 @@ events: summary: | Fires when the player moves their finger on the UI element. description: | - This event fires when the player moves their finger on the UI - element using a touch-enabled device. It fires shortly before + This event fires when the player moves their finger on the UI element + using a touch-enabled device. It fires shortly before `Class.GuiObject.TouchSwipe` would, and does not fire with `Class.GuiObject.TouchTap`. This event is useful for allowing the player to manipulate the position of UI elements on the screen. @@ -1689,13 +1690,13 @@ events: Fires when the player performs a pinch or pull gesture using two fingers on the UI element. description: | - This event fires when the player uses two fingers to make a - pinch or pull gesture on the UI element using a touch-enabled device. A - **pinch** happens when two or more fingers move closer together, and a - **pull** happens when they move apart. This event fires in conjunction - with `Class.GuiObject.TouchPan`. This event is useful for allowing the - player to manipulate the scale (size) of UI elements on the screen, and is - most often used for zooming features. + This event fires when the player uses two fingers to make a pinch or pull + gesture on the UI element using a touch-enabled device. A **pinch** + happens when two or more fingers move closer together, and a **pull** + happens when they move apart. This event fires in conjunction with + `Class.GuiObject.TouchPan`. This event is useful for allowing the player + to manipulate the scale (size) of UI elements on the screen, and is most + often used for zooming features. This event fires with a table of `Datatype.Vector2` that describe the relative screen positions of the fingers involved in the gesture. In @@ -1743,12 +1744,12 @@ events: Fires when the player performs a rotation gesture using two fingers on the UI element. description: | - This event fires when the player uses two fingers to make a - pinch or pull gesture on the UI element using a touch-enabled device. - Rotation occurs when the angle of the line between two fingers changes. - This event fires in conjunction with `Class.GuiObject.TouchPan`. This - event is useful for allowing the player to manipulate the rotation of UI - elements on the screen. + This event fires when the player uses two fingers to make a pinch or pull + gesture on the UI element using a touch-enabled device. Rotation occurs + when the angle of the line between two fingers changes. This event fires + in conjunction with `Class.GuiObject.TouchPan`. This event is useful for + allowing the player to manipulate the rotation of UI elements on the + screen. This event fires with a table of `Datatype.Vector2` that describe the relative screen positions of the fingers involved in the gesture. In @@ -1794,11 +1795,11 @@ events: summary: | Fires when the player performs a swipe gesture on the UI element. description: | - This event fires when the player performs a swipe gesture on the - UI element using a touch-enabled device. It fires with the direction of - the gesture (Up, Down, Left or Right) and the number of touch points - involved in the gesture. Swipe gestures are often used to change tabs in - mobile UIs. + This event fires when the player performs a swipe gesture on the UI + element using a touch-enabled device. It fires with the direction of the + gesture (Up, Down, Left or Right) and the number of touch points involved + in the gesture. Swipe gestures are often used to change tabs in mobile + UIs. Since this event only requires one finger, it can be simulated in Studio using the emulator and a mouse. @@ -1826,9 +1827,9 @@ events: summary: | Fires when the player performs a tap gesture on the UI element. description: | - This event fires when the player performs a tap gesture on the UI - element using a touch-enabled device. A tap is a quick single touch - without any movement involved (a longer press would fire + This event fires when the player performs a tap gesture on the UI element + using a touch-enabled device. A tap is a quick single touch without any + movement involved (a longer press would fire `Class.GuiObject.TouchLongPress`, and moving during the touch would fire `Class.GuiObject.TouchPan` and/or `Class.GuiObject.TouchSwipe`). It fires with a table of `Datatype.Vector2` objects that describe the relative diff --git a/content/en-us/reference/engine/classes/ImageButton.yaml b/content/en-us/reference/engine/classes/ImageButton.yaml index 4483c380d..98d719f98 100644 --- a/content/en-us/reference/engine/classes/ImageButton.yaml +++ b/content/en-us/reference/engine/classes/ImageButton.yaml @@ -42,11 +42,13 @@ properties: description: | This property is a content-type property that should hold the asset ID of a decal or image uploaded to Roblox. It functions identically to - `Class.Decal.Texture` with regards to loading the image from Roblox. The rendered image will be colorized using + `Class.Decal.Texture` with regards to loading the image from Roblox. The + rendered image will be colorized using `Class.ImageButton.ImageColor3|ImageColor3`. - + Note that it is possible to make the image render as tiled, scaled to fit, - or 9-sliced by adjusting the `Class.ImageButton.ScaleType|ScaleType` property. + or 9-sliced by adjusting the `Class.ImageButton.ScaleType|ScaleType` + property. code_samples: - Image-Hover-Lock type: ContentId @@ -67,10 +69,10 @@ properties: summary: | Determines how a rendered image will be colorized. description: | - This property determines how an image is colorized. When set to - white, no colorization occurs. This property is very useful for reusing - image assets: If the source image is completely white with transparency, - you can set the entire color of the image at once with this property. + This property determines how an image is colorized. When set to white, no + colorization occurs. This property is very useful for reusing image + assets: If the source image is completely white with transparency, you can + set the entire color of the image at once with this property. code_samples: - Image-Hover-Lock type: Color3 @@ -92,11 +94,11 @@ properties: The image content displayed by the UI element. Supports asset URIs and `Class.EditableImage` objects. description: | - This property should hold an [asset - URI](../../../projects/assets/index.md#asset-uris) or a reference to an - `Class.EditableImage` object. The asset URI can reference a decal or image - uploaded to Roblox. It functions identically to `Class.Decal.Texture` with - regards to loading the image. + This property should hold an + [asset URI](../../../projects/assets/index.md#asset-uris) or a reference + to an `Class.EditableImage` object. The asset URI can reference a decal or + image uploaded to Roblox. It functions identically to + `Class.Decal.Texture` with regards to loading the image. The rendered image will be colorized using `Class.ImageButton.ImageColor3|ImageColor3`. It is possible to make the diff --git a/content/en-us/reference/engine/classes/ImageLabel.yaml b/content/en-us/reference/engine/classes/ImageLabel.yaml index 4ad32b93c..18288c46b 100644 --- a/content/en-us/reference/engine/classes/ImageLabel.yaml +++ b/content/en-us/reference/engine/classes/ImageLabel.yaml @@ -64,10 +64,10 @@ properties: summary: | Determines how a rendered image will be colorized. description: | - This property determines how an image is colorized. When set - to white, no colorization occurs. This property is very useful for reusing - image assets; if the source image is completely white with transparency, - you can set the entire color of the image at once with this property. + This property determines how an image is colorized. When set to white, no + colorization occurs. This property is very useful for reusing image + assets; if the source image is completely white with transparency, you can + set the entire color of the image at once with this property. code_samples: [] type: Color3 tags: [] @@ -166,8 +166,8 @@ properties: summary: | Determines the transparency of the rendered image. description: | - This property determines the alpha of a UI element's rendered image. - A value of `0` is completely opaque and a value of `1` is completely + This property determines the alpha of a UI element's rendered image. A + value of `0` is completely opaque and a value of `1` is completely transparent (invisible). code_samples: - Oscillate-ImageTransparency @@ -189,8 +189,8 @@ properties: summary: | Indicates whether the image has finished loading from Roblox. description: | - This property indicates if the `Class.ImageLabel.Image` property - has finished loading from Roblox. Images declined by moderation will never + This property indicates if the `Class.ImageLabel.Image` property has + finished loading from Roblox. Images declined by moderation will never load. code_samples: - Image-Load-Time @@ -239,9 +239,9 @@ properties: Determines how an image will scale if displayed in a UI element whose size differs from the source image. description: | - This property determines in what way an - `Class.ImageLabel.Image` is rendered when the UI element's absolute size - differs from the source image's size. + This property determines in what way an `Class.ImageLabel.Image` is + rendered when the UI element's absolute size differs from the source + image's size. By default, this property is `Enum.ScaleType.Stretch` which will simply stretch/compact the image dimensions so it fits the UI element's space @@ -280,8 +280,8 @@ properties: summary: | Sets the slice boundaries of a 9-sliced image. description: | - This property sets the slice boundaries of a 9-sliced image - when `Class.ImageLabel.ScaleType|ScaleType` is set to + This property sets the slice boundaries of a 9-sliced image when + `Class.ImageLabel.ScaleType|ScaleType` is set to `Enum.ScaleType.Slice|Enum.ScaleType.Slice`. Please note that this property is only visible in the [Properties](../../../studio/properties.md) window under this condition. @@ -333,11 +333,12 @@ properties: summary: | Sets the tiling size of the `Class.ImageLabel`. description: | - This property sets the tiling size of the `Class.ImageLabel` with a default of + This property sets the tiling size of the `Class.ImageLabel` with a + default of `Datatype.UDim2.new(1, 0, 1, 0)`. Tiling starts at the top-left corner of the image. This property is only active - if the `Class.ImageLabel.ScaleType|ScaleType` for the `Class.ImageLabel` is set - to `Enum.ScaleType.Tile`. + if the `Class.ImageLabel.ScaleType|ScaleType` for the `Class.ImageLabel` + is set to `Enum.ScaleType.Tile`. code_samples: - Image-ScaleType-Demo type: UDim2 diff --git a/content/en-us/reference/engine/classes/Lighting.yaml b/content/en-us/reference/engine/classes/Lighting.yaml index 00934934e..1bc2c2949 100644 --- a/content/en-us/reference/engine/classes/Lighting.yaml +++ b/content/en-us/reference/engine/classes/Lighting.yaml @@ -3,13 +3,13 @@ type: class category: Lighting memory_category: Instances summary: | - The `Lighting` service controls global lighting in an experience. It - includes a range of adjustable properties that you can use to change how - lighting appears and interacts with other objects. + The `Lighting` service controls global lighting in an experience. It includes + a range of adjustable properties that you can use to change how lighting + appears and interacts with other objects. description: | - The `Lighting` service controls global lighting in an experience. It - includes a range of adjustable properties that you can use to change how - lighting appears and interacts with other objects, as summarized in + The `Lighting` service controls global lighting in an experience. It includes + a range of adjustable properties that you can use to change how lighting + appears and interacts with other objects, as summarized in [Lighting Properties](../../../environment/lighting.md). @@ -21,8 +21,9 @@ description: | In addition, `Lighting` (along with `Class.Workspace.CurrentCamera`) may - contain [post‑processing effects](../../../environment/post-processing-effects.md) such as `Class.SunRaysEffect` and - `Class.BlurEffect`. + contain + [post‑processing effects](../../../environment/post-processing-effects.md) + such as `Class.SunRaysEffect` and `Class.BlurEffect`. code_samples: inherits: - Instance @@ -39,10 +40,10 @@ properties: `Ambient` is the lighting hue applied to areas that are occluded from the sky, such as indoor areas. - `Ambient` defaults to `[0, 0, 0]` (black). As long as the red, green, - and blue channels of this property do not exceed the corresponding - channels in `Class.Lighting.OutdoorAmbient|OutdoorAmbient`, the change in - hue will be reserved for areas occluded from the sun/moon. + `Ambient` defaults to `[0, 0, 0]` (black). As long as the red, green, and + blue channels of this property do not exceed the corresponding channels in + `Class.Lighting.OutdoorAmbient|OutdoorAmbient`, the change in hue will be + reserved for areas occluded from the sun/moon. Note that when `Class.Lighting.GlobalShadows|GlobalShadows` is disabled, there is no distinction between areas occluded from the sky and @@ -252,7 +253,9 @@ properties: description: | This property determines the exposure compensation amount which applies a bias to the exposure level of the scene prior to the tonemap step. - Defaults to `0` (no exposure compensation) and has a range from `-5` to `5`. A value of `1` indicates twice as much exposure and `-1` means half as much exposure. + Defaults to `0` (no exposure compensation) and has a range from `-5` to + `5`. A value of `1` indicates twice as much exposure and `-1` means half + as much exposure. code_samples: type: float tags: [] @@ -272,7 +275,8 @@ properties: summary: | A `Datatype.Color3` value giving the hue of `Lighting` fog. description: | - A `Datatype.Color3` value giving the hue of `Lighting` fog. Note that fog properties are hidden when `Lighting` contains an `Class.Atmosphere` + A `Datatype.Color3` value giving the hue of `Lighting` fog. Note that fog + properties are hidden when `Lighting` contains an `Class.Atmosphere` object. code_samples: type: Color3 @@ -318,8 +322,8 @@ properties: begins to show. description: | The depth from the `Class.Workspace.CurrentCamera`, in studs, at which fog - begins to show. Note that fog properties are hidden when - `Lighting` contains an `Class.Atmosphere` object. + begins to show. Note that fog properties are hidden when `Lighting` + contains an `Class.Atmosphere` object. code_samples: type: float tags: [] @@ -399,11 +403,11 @@ properties: capabilities: - Environment writeCapabilities: [] - - name: Lighting.Intent + - name: Lighting.LightingStyle summary: '' description: '' code_samples: [] - type: Intent + type: LightingStyle tags: - NotScriptable deprecation_message: '' @@ -428,7 +432,7 @@ properties: and blue channels of `Class.Lighting.Ambient|Ambient` do not exceed the corresponding channels in `OutdoorAmbient`, the hue of the lighting in outdoor areas will be determined by this property. - + The effective `OutdoorAmbient` value is clamped to be greater than or equal to `Class.Lighting.Ambient|Ambient` in all channels, meaning that if a channel of `Class.Lighting.Ambient|Ambient` exceeds its corresponding @@ -486,11 +490,11 @@ properties: capabilities: - Environment writeCapabilities: [] - - name: Lighting.Quality + - name: Lighting.PrioritizeLightingQuality summary: '' description: '' code_samples: [] - type: Quality + type: bool tags: - NotScriptable deprecation_message: '' @@ -561,9 +565,9 @@ properties: description: | Determines the lighting system for rendering the 3D world. This property is non‑scriptable and only modifiable in Studio. See `Enum.Technology` for - available options and [Lighting - Technology](../../../environment/lighting.md#technology) for detailed - descriptions and visual effects of each option. + available options and + [Lighting Technology](../../../environment/lighting.md#technology) for + detailed descriptions and visual effects of each option. code_samples: type: Technology tags: [] @@ -585,7 +589,9 @@ properties: `Lighting`. description: | A 24-hour string representation of the current time of day used by - `Lighting`. Note that this property does not correspond with the actual time of day and will not change during gameplay unless it has been changed by a script. + `Lighting`. Note that this property does not correspond with the actual + time of day and will not change during gameplay unless it has been changed + by a script. For a numeric measure of `Lighting` time, use `Class.Lighting.ClockTime|ClockTime`. Changing @@ -639,10 +645,11 @@ methods: Returns a `Datatype.Vector3` representing the direction of the moon from the position `(0, 0, 0)`. Note that when the moon has "set" and is no longer visible, the `Datatype.Vector3` - returned by this method will continue to point towards the moon below - the horizon. + returned by this method will continue to point towards the moon below the + horizon. - `Class.Lighting:GetSunDirection()|GetSunDirection()` is a variant of this method for obtaining the direction of the sun. + `Class.Lighting:GetSunDirection()|GetSunDirection()` is a variant of this + method for obtaining the direction of the sun. code_samples: parameters: [] returns: @@ -666,11 +673,10 @@ methods: returns: - type: float summary: '' - tags: - - Deprecated + tags: [] deprecation_message: | - There is currently no way to change the moon's phase, and thus this - method should not be used. + There is currently no way to change the moon's phase, and thus this method + should not be used. security: None thread_safety: Unsafe capabilities: [] @@ -680,11 +686,13 @@ methods: Returns a `Datatype.Vector3` representing the direction of the sun. description: | Returns a `Datatype.Vector3` representing the direction of the sun from - the position `(0, 0, 0)`. Note that when the sun has "set" and is no longer visible, the - `Datatype.Vector3` returned by this method will continue to point - towards the sun below the horizon. + the position `(0, 0, 0)`. Note that when + the sun has "set" and is no longer visible, the `Datatype.Vector3` + returned by this method will continue to point towards the sun below the + horizon. - `Class.Lighting:GetMoonDirection()|GetMoonDirection()` is a variant of this method for obtaining the direction of the moon. + `Class.Lighting:GetMoonDirection()|GetMoonDirection()` is a variant of + this method for obtaining the direction of the moon. code_samples: parameters: [] returns: @@ -699,10 +707,13 @@ methods: writeCapabilities: [] - name: Lighting:SetMinutesAfterMidnight summary: | - Sets `Class.Lighting.TimeOfDay|TimeOfDay` and `Class.Lighting.ClockTime|ClockTime` to the - given number of minutes after midnight. + Sets `Class.Lighting.TimeOfDay|TimeOfDay` and + `Class.Lighting.ClockTime|ClockTime` to the given number of minutes after + midnight. description: | - Sets `Class.Lighting.TimeOfDay|TimeOfDay` and `Class.Lighting.ClockTime|ClockTime` to the given number of minutes after midnight. + Sets `Class.Lighting.TimeOfDay|TimeOfDay` and + `Class.Lighting.ClockTime|ClockTime` to the given number of minutes after + midnight. This method allows a numerical value to be used, for example in a day/night cycle `Class.Script`, without the need to convert to a string in @@ -710,7 +721,9 @@ methods: allows values greater than 24 hours to be given that correspond to times in the next day. - The following code sample includes a simple day/night cycle script. The speed of time and the initial time can be changed using the `TIME_SPEED` and `START_TIME` parameters. + The following code sample includes a simple day/night cycle script. The + speed of time and the initial time can be changed using the `TIME_SPEED` + and `START_TIME` parameters. ```lua local Lighting = game:GetService("Lighting") @@ -786,14 +799,17 @@ methods: events: - name: Lighting.LightingChanged summary: | - This event fires when a `Lighting` property is changed or a - `Class.Sky` is added or removed from `Lighting`. + This event fires when a `Lighting` property is changed or a `Class.Sky` is + added or removed from `Lighting`. description: | - This event fires when a `Lighting` property is changed or a - `Class.Sky` is added or removed from `Lighting`, with some exceptions: - - - Changing `Class.Lighting.GlobalShadows|GlobalShadows` will not fire this event. - - Changing fog properties `Class.Lighting.FogColor|FogColor`, `Class.Lighting.FogStart|FogStart`, or `Class.Lighting.FogEnd|FogEnd` will not fire this event. + This event fires when a `Lighting` property is changed or a `Class.Sky` is + added or removed from `Lighting`, with some exceptions: + + - Changing `Class.Lighting.GlobalShadows|GlobalShadows` will not fire this + event. + - Changing fog properties `Class.Lighting.FogColor|FogColor`, + `Class.Lighting.FogStart|FogStart`, or `Class.Lighting.FogEnd|FogEnd` + will not fire this event. In cases where this behavior is not desired, the `Class.Object.Changed` event or `Class.Object:GetPropertyChangedSignal()` method can be used. diff --git a/content/en-us/reference/engine/classes/LuaSettings.yaml b/content/en-us/reference/engine/classes/LuaSettings.yaml index 9cf1d0dd6..36900869c 100644 --- a/content/en-us/reference/engine/classes/LuaSettings.yaml +++ b/content/en-us/reference/engine/classes/LuaSettings.yaml @@ -13,6 +13,7 @@ inherits: tags: - NotCreatable - Settings + - NotReplicated deprecation_message: '' properties: [] methods: [] diff --git a/content/en-us/reference/engine/classes/ModuleScript.yaml b/content/en-us/reference/engine/classes/ModuleScript.yaml index c947b5577..f2b43cdea 100644 --- a/content/en-us/reference/engine/classes/ModuleScript.yaml +++ b/content/en-us/reference/engine/classes/ModuleScript.yaml @@ -45,8 +45,7 @@ description: | name set to `MainModule`, it can be uploaded as a model and required using `Global.LuaGlobals.require()` with the model's asset ID. Then it can be loaded into your experience, although this logic only works on the server and will - error on the client. If other users want to use the module, it must be - public. + error on the client. If other users want to use the module, it must be public. code_samples: - Simple-ModuleScript-Example - Simple-ModuleScript-Usage diff --git a/content/en-us/reference/engine/classes/NetworkSettings.yaml b/content/en-us/reference/engine/classes/NetworkSettings.yaml index 5b191a237..3db137ea2 100644 --- a/content/en-us/reference/engine/classes/NetworkSettings.yaml +++ b/content/en-us/reference/engine/classes/NetworkSettings.yaml @@ -14,6 +14,7 @@ inherits: tags: - NotCreatable - Service + - NotReplicated - NotBrowsable deprecation_message: '' properties: diff --git a/content/en-us/reference/engine/classes/OpenCloudService.yaml b/content/en-us/reference/engine/classes/OpenCloudService.yaml index f46f08502..0d3e794d4 100644 --- a/content/en-us/reference/engine/classes/OpenCloudService.yaml +++ b/content/en-us/reference/engine/classes/OpenCloudService.yaml @@ -45,6 +45,10 @@ methods: type: Dictionary default: summary: '' + - name: headers + type: Dictionary + default: nil + summary: '' returns: - type: Dictionary summary: '' diff --git a/content/en-us/reference/engine/classes/PerformanceControlService.yaml b/content/en-us/reference/engine/classes/PerformanceControlService.yaml new file mode 100644 index 000000000..868bfc80a --- /dev/null +++ b/content/en-us/reference/engine/classes/PerformanceControlService.yaml @@ -0,0 +1,36 @@ +name: PerformanceControlService +type: class +category: +memory_category: Instances +summary: '' +description: '' +code_samples: [] +inherits: + - Instance +tags: + - NotCreatable + - Service + - NotReplicated +deprecation_message: '' +properties: [] +methods: + - name: PerformanceControlService:IsCrossExperienceLaunchFeasible + summary: '' + description: '' + code_samples: [] + parameters: + - name: type + type: string + default: + summary: '' + returns: + - type: bool + summary: '' + tags: [] + deprecation_message: '' + security: RobloxScriptSecurity + thread_safety: Unsafe + capabilities: [] + writeCapabilities: [] +events: [] +callbacks: [] diff --git a/content/en-us/reference/engine/classes/PhysicsSettings.yaml b/content/en-us/reference/engine/classes/PhysicsSettings.yaml index 4ba30f0c3..8b94a21c7 100644 --- a/content/en-us/reference/engine/classes/PhysicsSettings.yaml +++ b/content/en-us/reference/engine/classes/PhysicsSettings.yaml @@ -13,6 +13,7 @@ inherits: tags: - NotCreatable - Settings + - NotReplicated deprecation_message: '' properties: - name: PhysicsSettings.AllowSleep diff --git a/content/en-us/reference/engine/classes/PlayerGui.yaml b/content/en-us/reference/engine/classes/PlayerGui.yaml index 0915cf7aa..b8a2e93d5 100644 --- a/content/en-us/reference/engine/classes/PlayerGui.yaml +++ b/content/en-us/reference/engine/classes/PlayerGui.yaml @@ -128,10 +128,10 @@ methods: summary: | Sets the transparency of the top bar. description: | - This method sets the transparency of the top bar - `Class.CoreGui`. A value of `0` is completely opaque and a value of `1` is - completely transparent. Values outside of the range `[0, 1]` are clamped. - The default transparency of the topbar is `0.5`. + This method sets the transparency of the top bar `Class.CoreGui`. A value + of `0` is completely opaque and a value of `1` is completely transparent. + Values outside of the range `[0, 1]` are clamped. The default transparency + of the topbar is `0.5`. Using the `Class.StarterGui:SetCore()` method with the `"TopbarEnabled"` option allows you to enable/disable the entire topbar and all of its diff --git a/content/en-us/reference/engine/classes/Players.yaml b/content/en-us/reference/engine/classes/Players.yaml index 774b4a76f..a3504bc9e 100644 --- a/content/en-us/reference/engine/classes/Players.yaml +++ b/content/en-us/reference/engine/classes/Players.yaml @@ -53,9 +53,9 @@ properties: Indicates whether or not bubble chat is enabled. It is set with the `Class.Players:SetChatStyle()` method. description: | - This property indicates whether or not bubble chat is enabled. - It is set with the `Class.Players:SetChatStyle()` method using the - `Enum.ChatStyle` enum. + This property indicates whether or not bubble chat is enabled. It is set + with the `Class.Players:SetChatStyle()` method using the `Enum.ChatStyle` + enum. When this chat mode is enabled, the game displays chats in the chat user interface at the top-left corner of the screen. @@ -82,9 +82,8 @@ properties: summary: | Indicates whether `Class.Character|Characters` will respawn automatically. description: | - This property indicates whether - `Class.Character|Characters` will respawn automatically. The default value - is true. + This property indicates whether `Class.Character|Characters` will respawn + automatically. The default value is true. If this property is disabled (false), player `Class.Character|Characters` will not spawn until the `Class.Player:LoadCharacter()` function is called @@ -141,8 +140,8 @@ properties: summary: | The `Class.Player` that the `Class.LocalScript` is running for. description: | - This read-only property refers to the `Class.Player` - whose client is running the experience. + This read-only property refers to the `Class.Player` whose client is + running the experience. This property is only defined for `Class.LocalScript|LocalScripts` and `Class.ModuleScript|ModuleScripts` required by them, since they run on the @@ -168,11 +167,10 @@ properties: summary: | The maximum number of players that can be in a server. description: | - This property determines the maximum number of players that - can be in a server. This property can only be set through a specific - place's settings on the - [Creator Dashboard](https://create.roblox.com/dashboard/creations) or - through [Game Settings](../../../studio/game-settings.md). + This property determines the maximum number of players that can be in a + server. This property can only be set through a specific place's settings + on the [Creator Dashboard](https://create.roblox.com/dashboard/creations) + or through [Game Settings](../../../studio/game-settings.md). code_samples: type: int tags: @@ -218,10 +216,9 @@ properties: summary: | The preferred number of players for a server. description: | - This property indicates the number of players to which - Roblox's matchmaker will fill servers. This number will be less than the - maximum number of players (`Class.Players.MaxPlayers`) supported by the - experience. + This property indicates the number of players to which Roblox's matchmaker + will fill servers. This number will be less than the maximum number of + players (`Class.Players.MaxPlayers`) supported by the experience. code_samples: type: int tags: @@ -242,9 +239,9 @@ properties: summary: | Controls the amount of time taken for a players character to respawn. description: | - This property controls the time, in seconds, it takes for a - player to respawn when `Class.Players.CharacterAutoLoads` is true. It - defaults to 5.0 seconds. + This property controls the time, in seconds, it takes for a player to + respawn when `Class.Players.CharacterAutoLoads` is true. It defaults to + 5.0 seconds. This is useful when you want to change how long it takes to respawn based on the type of your experience but don't want to handle spawning players @@ -370,8 +367,8 @@ methods: Returns the `Class.Player` with the given `Class.Player.UserId|UserId` if they are in-game. description: | - This function searches each `Class.Player` in `Class.Players` for - one whose `Class.Player.UserId` matches the given UserId. If such a player + This function searches each `Class.Player` in `Class.Players` for one + whose `Class.Player.UserId` matches the given UserId. If such a player does not exist, it simply returns `nil`. It is equivalent to the following function: @@ -411,8 +408,8 @@ methods: writeCapabilities: [] - name: Players:GetPlayerFromCharacter summary: | - Returns the `Class.Player` whose `Class.Player.Character` - matches the given instance, or `nil` if one cannot be found. + Returns the `Class.Player` whose `Class.Player.Character` matches the + given instance, or `nil` if one cannot be found. description: | This function returns the `Class.Player` associated with the given `Class.Player.Character`, or `nil` if one cannot be found. It is @@ -530,8 +527,8 @@ methods: writeCapabilities: [] - name: Players:TeamChat summary: | - Makes the local player chat the given message, which will only be - viewable by users on the same team. + Makes the local player chat the given message, which will only be viewable + by users on the same team. description: | This function makes the `Class.Players.LocalPlayer` chat the given message, which will only be viewable by users on the same team. Since this @@ -1121,9 +1118,9 @@ methods: This method errors if no account exists with the given UserId. If you aren't certain such an account exists, it's recommended to wrap calls to - this function with `Global.LuaGlobals.pcall()`. In addition, you can manually cache results to - make future calls with the same UserId fast. See the code samples to learn - more. + this function with `Global.LuaGlobals.pcall()`. In addition, you can + manually cache results to make future calls with the same UserId fast. See + the code samples to learn more. code_samples: - Name-From-UserId - Name-From-UserId-Cache @@ -1155,9 +1152,9 @@ methods: This method errors if no account exists with the given username. If you aren't certain such an account exists, it's recommended to wrap calls to - this function with `Global.LuaGlobals.pcall()`. In addition, you can manually cache results to - quickly make future calls with the same username. See the code samples to - learn more. + this function with `Global.LuaGlobals.pcall()`. In addition, you can + manually cache results to quickly make future calls with the same + username. See the code samples to learn more. code_samples: - UserId-From-Name - UserId-From-Name-Cache @@ -1307,9 +1304,9 @@ events: summary: | Fires when a player enters the game. description: | - This event fires when a player enters the game. This is used - to fire an event when a player joins a game, such as loading the player's - saved `Class.GlobalDataStore` data. + This event fires when a player enters the game. This is used to fire an + event when a player joins a game, such as loading the player's saved + `Class.GlobalDataStore` data. This can be used alongside the `Class.Players.PlayerRemoving` event, which fires when a player is about to leave the game. For instance, if you would diff --git a/content/en-us/reference/engine/classes/RenderSettings.yaml b/content/en-us/reference/engine/classes/RenderSettings.yaml index e84153d66..470502dda 100644 --- a/content/en-us/reference/engine/classes/RenderSettings.yaml +++ b/content/en-us/reference/engine/classes/RenderSettings.yaml @@ -14,6 +14,7 @@ inherits: tags: - NotCreatable - Service + - NotReplicated - NotBrowsable deprecation_message: '' properties: diff --git a/content/en-us/reference/engine/classes/ReplicatedStorage.yaml b/content/en-us/reference/engine/classes/ReplicatedStorage.yaml index 28717602f..be7c5344a 100644 --- a/content/en-us/reference/engine/classes/ReplicatedStorage.yaml +++ b/content/en-us/reference/engine/classes/ReplicatedStorage.yaml @@ -10,7 +10,7 @@ description: | `Class.ModuleScript`, `Class.RemoteFunction`, `Class.RemoteEvent`, and other objects that are useful to both server-side `Class.Script|Scripts` and client-side `Class.LocalScript|LocalScripts`. - + Objects parented to this service are fully replicated to clients and normal replication rules apply. Any changes that are made on the client persist but won't be replicated to the server, and client changes may be overwritten if @@ -22,7 +22,7 @@ description: | eventually run on a `Class.Player` client such as `Class.StarterPlayerScripts`, `Class.StarterCharacterScripts`, or `Class.StarterGui`. - + Similarly, `Class.Script|Scripts` do not run when parented to this service unless you change their `Enum.RunContext` property from the default value of `Enum.RunContext.Legacy|Legacy`. Server `Class.Script|Scripts` that run on diff --git a/content/en-us/reference/engine/classes/ScreenGui.yaml b/content/en-us/reference/engine/classes/ScreenGui.yaml index 18e722424..6de782abb 100644 --- a/content/en-us/reference/engine/classes/ScreenGui.yaml +++ b/content/en-us/reference/engine/classes/ScreenGui.yaml @@ -9,8 +9,9 @@ description: | displayed on the user's screen. A `Class.ScreenGui` only shows if parented to a player's `Class.PlayerGui`; parenting a `Class.ScreenGui` to `Class.StarterGui` ensures it clones into each player's `Class.PlayerGui` when - they join the experience and their character first spawns. See [On‑Screen UI - Containers](../../../ui/on-screen-containers.md) for further details. + they join the experience and their character first spawns. See + [On‑Screen UI Containers](../../../ui/on-screen-containers.md) for further + details. Example ScreenGui with various GuiObject children, including a Frame, TextLabel, TextBox, and ImageButton. @@ -75,12 +76,13 @@ properties: writeCapabilities: [] - name: ScreenGui.DisplayOrder summary: | - Controls the Z-index order in which multiple `Class.ScreenGui` containers are - drawn. + Controls the Z-index order in which multiple `Class.ScreenGui` containers + are drawn. description: | - This property controls the Z-index order in which multiple `Class.ScreenGui` - containers are drawn. Those with a higher `Class.ScreenGui.DisplayOrder|DisplayOrder` will be drawn on - top of those with a lower value. + This property controls the Z-index order in which multiple + `Class.ScreenGui` containers are drawn. Those with a higher + `Class.ScreenGui.DisplayOrder|DisplayOrder` will be drawn on top of those + with a lower value. code_samples: type: int tags: [] @@ -137,10 +139,10 @@ properties: screen cutouts. description: | This property specifies whether automatic UI compatibility transformations - are applied to descendant "fullscreen" `Class.GuiObject|GuiObjects` of - the `Class.ScreenGui` on displays with screen cutouts. Eligibility occurs - if the total area of the descendant `Class.GuiObject` (including any - applied border or `Class.UIStroke`) covers the device's safe area both + are applied to descendant "fullscreen" `Class.GuiObject|GuiObjects` of the + `Class.ScreenGui` on displays with screen cutouts. Eligibility occurs if + the total area of the descendant `Class.GuiObject` (including any applied + border or `Class.UIStroke`) covers the device's safe area both horizontally and vertically. See the `Enum.SafeAreaCompatibility` enum reference for details. diff --git a/content/en-us/reference/engine/classes/Selection.yaml b/content/en-us/reference/engine/classes/Selection.yaml index 7832fa379..28c89c656 100644 --- a/content/en-us/reference/engine/classes/Selection.yaml +++ b/content/en-us/reference/engine/classes/Selection.yaml @@ -186,4 +186,15 @@ events: thread_safety: Unsafe capabilities: [] writeCapabilities: [] + - name: Selection.SelectionChangedThisFrame + summary: '' + description: '' + code_samples: [] + parameters: [] + tags: [] + deprecation_message: '' + security: RobloxScriptSecurity + thread_safety: Unsafe + capabilities: [] + writeCapabilities: [] callbacks: [] diff --git a/content/en-us/reference/engine/classes/Sound.yaml b/content/en-us/reference/engine/classes/Sound.yaml index 52e66e409..dc56bb87e 100644 --- a/content/en-us/reference/engine/classes/Sound.yaml +++ b/content/en-us/reference/engine/classes/Sound.yaml @@ -150,8 +150,7 @@ properties: writeCapabilities: [] - name: Sound.IsPlaying summary: | - Read-only property which returns `true` when the `Class.Sound` is - playing. + Read-only property which returns `true` when the `Class.Sound` is playing. description: | This read-only property returns true when the `Class.Sound` is playing. @@ -185,24 +184,24 @@ properties: `Class.Sound.PlaybackRegion|PlaybackRegion`, in seconds. - If `Class.Sound.LoopRegion|LoopRegion.Min` `>` - `Class.Sound.PlaybackRegion|PlaybackRegion.Min`, the loop starts from - `Class.Sound.LoopRegion|LoopRegion.Min`. + `Class.Sound.PlaybackRegion|PlaybackRegion.Min`, the loop starts from + `Class.Sound.LoopRegion|LoopRegion.Min`. - If `Class.Sound.LoopRegion|LoopRegion.Min` `<` - `Class.Sound.PlaybackRegion|PlaybackRegion.Min`, the loop starts from - `Class.Sound.PlaybackRegion|PlaybackRegion.Min`. + `Class.Sound.PlaybackRegion|PlaybackRegion.Min`, the loop starts from + `Class.Sound.PlaybackRegion|PlaybackRegion.Min`. - If `Class.Sound.LoopRegion|LoopRegion.Max` `>` - `Class.Sound.PlaybackRegion|PlaybackRegion.Max`, the loop starts at - `Class.Sound.PlaybackRegion|PlaybackRegion.Max`. + `Class.Sound.PlaybackRegion|PlaybackRegion.Max`, the loop starts at + `Class.Sound.PlaybackRegion|PlaybackRegion.Max`. - If `Class.Sound.LoopRegion|LoopRegion.Max` `<` - `Class.Sound.PlaybackRegion|PlaybackRegion.Max`, the loop starts at - **exactly** that time. + `Class.Sound.PlaybackRegion|PlaybackRegion.Max`, the loop starts at + **exactly** that time. - If `Class.Sound.LoopRegion|LoopRegion.Min` `==` - `Class.Sound.LoopRegion|LoopRegion.Max`, the `Class.Sound` uses the - `Class.Sound.PlaybackRegion|PlaybackRegion` property instead. + `Class.Sound.LoopRegion|LoopRegion.Max`, the `Class.Sound` uses the + `Class.Sound.PlaybackRegion|PlaybackRegion` property instead. code_samples: [] type: NumberRange tags: [] @@ -226,7 +225,7 @@ properties: This sets whether or not the `Class.Sound` repeats once it has finished playing. Looped sounds are suitable for a range of applications including music and background ambient sounds. - + The `Class.Sound.DidLoop|DidLoop` event can be used to track the number of times as sound has looped. code_samples: @@ -404,16 +403,21 @@ properties: `Class.Sound.TimeLength|TimeLength`, in seconds. - If `Class.Sound.PlaybackRegion|PlaybackRegion.Min` `>` `0`, the sound - begins to play from the `Class.Sound.PlaybackRegion|PlaybackRegion.Min` - time. + begins to play from the `Class.Sound.PlaybackRegion|PlaybackRegion.Min` + time. - - If `Class.Sound.PlaybackRegion|PlaybackRegion.Min` `<` `0`, the sound begins to play from `0`. + - If `Class.Sound.PlaybackRegion|PlaybackRegion.Min` `<` `0`, the sound + begins to play from `0`. - - If `Class.Sound.PlaybackRegion|PlaybackRegion.Max` `>` `Class.Sound.TimeLength`, the sound stops at `Class.Sound.TimeLength`. + - If `Class.Sound.PlaybackRegion|PlaybackRegion.Max` `>` + `Class.Sound.TimeLength`, the sound stops at `Class.Sound.TimeLength`. - - If `Class.Sound.PlaybackRegion|PlaybackRegion.Max` `<` `Class.Sound.TimeLength`, the sound stops at **exactly** that time. + - If `Class.Sound.PlaybackRegion|PlaybackRegion.Max` `<` + `Class.Sound.TimeLength`, the sound stops at **exactly** that time. - - If `Class.Sound.PlaybackRegion|PlaybackRegion.Min` `==` `Class.Sound.PlaybackRegion|PlaybackRegion.Max`, this property is inactive. + - If `Class.Sound.PlaybackRegion|PlaybackRegion.Min` `==` + `Class.Sound.PlaybackRegion|PlaybackRegion.Max`, this property is + inactive. code_samples: [] type: NumberRange tags: [] @@ -488,8 +492,7 @@ properties: In Studio's [Properties](../../../studio/properties.md) window, while in **Edit** mode, toggling `Class.Sound.Playing|Playing` to `true` does not - begin playing the sound, but the sound will begin playing during - runtime. + begin playing the sound, but the sound will begin playing during runtime. This property should not be confused with `Class.Sound.IsPlaying|IsPlaying` which is a read-only property. @@ -582,7 +585,7 @@ properties: This property controls how the volume of a `Class.Sound` which is parented to a `Class.BasePart` or `Class.Attachment` attenuates (fades out) as the distance between the listener and parent changes. - + For details on the different modes, see `Enum.RollOffMode`. code_samples: type: RollOffMode @@ -671,9 +674,8 @@ properties: writeCapabilities: [] - name: Sound.TimePosition summary: | - Progress of the `Class.Sound` in seconds. Can be changed to move - the playback position of the `Class.Sound` both before and during - playback. + Progress of the `Class.Sound` in seconds. Can be changed to move the + playback position of the `Class.Sound` both before and during playback. description: | This property reflects the progress of the `Class.Sound` in seconds. It can be changed to move the playback position of the sound both before and @@ -691,7 +693,7 @@ properties: ``` local newPosition = 1.5 - + if newPosition >= sound.TimeLength then newPosition = newPosition - sound.TimeLength end @@ -718,7 +720,8 @@ properties: summary: | The volume of the `Class.Sound`. description: | - The volume of the `Class.Sound`. Can be set between `0` and `10` and defaults to `0.5`. + The volume of the `Class.Sound`. Can be set between `0` and `10` and + defaults to `0.5`. Note that if the `Class.Sound` is a member of a `Class.SoundGroup`, its playback volume (but not its `Class.Sound.Volume|Volume` property) will be @@ -979,9 +982,11 @@ events: writeCapabilities: [] - name: Sound.Paused summary: | - Fires whenever the `Class.Sound` is paused using `Class.Sound:Pause()|Pause()`. + Fires whenever the `Class.Sound` is paused using + `Class.Sound:Pause()|Pause()`. description: | - Fires whenever the `Class.Sound` is paused using `Class.Sound:Pause()|Pause()`. + Fires whenever the `Class.Sound` is paused using + `Class.Sound:Pause()|Pause()`. code_samples: - Sound-Functions parameters: @@ -989,7 +994,8 @@ events: type: string default: summary: | - The `Class.Sound.SoundId|SoundId` of the `Class.Sound` that was paused. + The `Class.Sound.SoundId|SoundId` of the `Class.Sound` that was + paused. tags: [] deprecation_message: '' security: None @@ -1012,7 +1018,8 @@ events: type: string default: summary: | - The `Class.Sound.SoundId|SoundId` of the `Class.Sound` that was played. + The `Class.Sound.SoundId|SoundId` of the `Class.Sound` that was + played. tags: [] deprecation_message: '' security: None diff --git a/content/en-us/reference/engine/classes/SoundGroup.yaml b/content/en-us/reference/engine/classes/SoundGroup.yaml index 1abd2cca5..72165abbd 100644 --- a/content/en-us/reference/engine/classes/SoundGroup.yaml +++ b/content/en-us/reference/engine/classes/SoundGroup.yaml @@ -13,7 +13,7 @@ description: | acts as a multiplier, meaning a `Class.Sound` with volume `0.5` assigned to a `Class.SoundGroup` with a volume of `0.5` will have an effective volume of `0.25`. - + If the `Class.SoundGroup` has any `Class.SoundEffect|SoundEffects` as children, those effects will be applied to all of the `Class.Sound|Sounds` in the group. diff --git a/content/en-us/reference/engine/classes/SoundService.yaml b/content/en-us/reference/engine/classes/SoundService.yaml index 4c008a8bf..0249f5a9e 100644 --- a/content/en-us/reference/engine/classes/SoundService.yaml +++ b/content/en-us/reference/engine/classes/SoundService.yaml @@ -87,10 +87,12 @@ properties: - name: SoundService.DistanceFactor summary: | The number of studs to be considered a meter by `Class.SoundService` when - calculating volume attenuation of `Class.Sound|Sounds` parented to a `Class.BasePart` or `Class.Attachment`. + calculating volume attenuation of `Class.Sound|Sounds` parented to a + `Class.BasePart` or `Class.Attachment`. description: | The number of studs to be considered a meter by `Class.SoundService` when - calculating volume attenuation of `Class.Sound|Sounds` parented to a `Class.BasePart` or `Class.Attachment`. + calculating volume attenuation of `Class.Sound|Sounds` parented to a + `Class.BasePart` or `Class.Attachment`. By default, this property is `3.33`, meaning that a meter is considered 3.33 studs for the purposes of volume attenuation. The greater the @@ -116,7 +118,8 @@ properties: writeCapabilities: [] - name: SoundService.DopplerScale summary: | - Degree to which the pitch of a `Class.Sound` varies due to the Doppler effect. + Degree to which the pitch of a `Class.Sound` varies due to the Doppler + effect. description: | This property determines the degree to which the pitch of a `Class.Sound` varies due to the Doppler effect, a phenomenon whereby the pitch of a @@ -225,7 +228,8 @@ methods: description: | This method returns the `Class.SoundService` current listener type and what is set as the listener, meaning the point from which audio in the - experience is "heard" by the player. By default, the listener is set to `Class.Workspace.CurrentCamera`. The listener can be changed using + experience is "heard" by the player. By default, the listener is set to + `Class.Workspace.CurrentCamera`. The listener can be changed using `Class.SoundService:SetListener()|SetListener()`. The first result returned is the listener's `Enum.ListenerType` and the @@ -257,8 +261,6 @@ methods: - - code_samples: parameters: [] returns: @@ -344,7 +346,7 @@ methods: By default, the listener is set to `Class.Workspace.CurrentCamera`, but a range of different types of listeners can be used. - + The listener can be retrieved using `Class.SoundService:GetListener()|GetListener()`. code_samples: diff --git a/content/en-us/reference/engine/classes/StarterGui.yaml b/content/en-us/reference/engine/classes/StarterGui.yaml index fe3cb6a21..c8e90347c 100644 --- a/content/en-us/reference/engine/classes/StarterGui.yaml +++ b/content/en-us/reference/engine/classes/StarterGui.yaml @@ -7,8 +7,8 @@ summary: | `Class.PlayerGui` of `Class.Player|Players`. Also provides a range of functions for interacting with the `Class.CoreGui`. description: | - `Class.StarterGui` is a container object designed to hold `Class.LayerCollector` - objects such as `Class.ScreenGui|ScreenGuis`. + `Class.StarterGui` is a container object designed to hold + `Class.LayerCollector` objects such as `Class.ScreenGui|ScreenGuis`. When a `Class.Player.Character` spawns, the contents of their `Class.PlayerGui` (if any) are emptied. Children of the `Class.StarterGui` are @@ -19,9 +19,9 @@ description: | only be placed into each player's `Class.PlayerGui` once and will not be deleted when the `Class.Player` respawns. - `Class.StarterGui` also includes a range of functions allowing you to interact with - the `Class.CoreGui`. For example `Class.StarterGui:SetCoreGuiEnabled()` can be - used to disable elements of the `Class.CoreGui`, and + `Class.StarterGui` also includes a range of functions allowing you to interact + with the `Class.CoreGui`. For example `Class.StarterGui:SetCoreGuiEnabled()` + can be used to disable elements of the `Class.CoreGui`, and `Class.StarterGui:SetCore()` can perform a range of functions including creating notifications and system messages. code_samples: @@ -73,8 +73,8 @@ properties: - Deprecated deprecation_message: | This property is deprecated. Use `Class.LayerCollector.ResetOnSpawn` to - control the resetting behavior for individual - `Class.LayerCollector` objects. + control the resetting behavior for individual `Class.LayerCollector` + objects. security: read: None write: None diff --git a/content/en-us/reference/engine/classes/StarterPlayer.yaml b/content/en-us/reference/engine/classes/StarterPlayer.yaml index ff21da7a7..de442938d 100644 --- a/content/en-us/reference/engine/classes/StarterPlayer.yaml +++ b/content/en-us/reference/engine/classes/StarterPlayer.yaml @@ -8,7 +8,8 @@ summary: | description: | A service which allows the defaults of properties in the `Class.Player` object to be set. When a player enters the server, each property of the player object - is set to the current value of the corresponding property in `Class.StarterPlayer`. + is set to the current value of the corresponding property in + `Class.StarterPlayer`. Additionally, you may add four objects to this service: @@ -33,9 +34,8 @@ properties: Describes the current game's permission levels regarding custom avatar animations from the website. description: | - This property describes the current game's - permission levels regarding custom avatar `Class.Animation|Animations` - from the website. + This property describes the current game's permission levels regarding + custom avatar `Class.Animation|Animations` from the website. As such, this value cannot be changed from within the game. It can only be changed by changing the game's permission levels within the game's @@ -62,8 +62,8 @@ properties: Sets whether the character will automatically jump when hitting an obstacle on a mobile device. description: | - This property sets whether the character will - automatically jump when hitting an obstacle on a mobile device. + This property sets whether the character will automatically jump when + hitting an obstacle on a mobile device. This property is copied from the `Class.StarterPlayer` to a `Class.Player` when they join the game. Following that. the value of this property is @@ -111,8 +111,8 @@ properties: The maximum distance the player's default camera is allowed to zoom out in studs. description: | - This property sets the maximum distance in studs - the camera can be from the character with the default cameras. + This property sets the maximum distance in studs the camera can be from + the character with the default cameras. This property sets the default value of `Class.Player.CameraMaxZoomDistance` for each player who joins the game. @@ -139,8 +139,8 @@ properties: The minimum distance in studs the player's default camera is allowed to zoom in. description: | - This property sets the minimum distance in studs - the camera can be from the character with the default cameras. + This property sets the minimum distance in studs the camera can be from + the character with the default cameras. This property sets the default value of `Class.Player.CameraMinZoomDistance` for each player who joins the game. @@ -208,10 +208,9 @@ properties: Determines the starting value of `Class.Humanoid.JumpHeight` for `Class.Player.Character`. description: | - This property determines the starting value of - `Class.Humanoid.JumpHeight` for a player's - `Class.Player.Character`. The value of this property defaults to - 7.2 studs. + This property determines the starting value of `Class.Humanoid.JumpHeight` + for a player's `Class.Player.Character`. The value of this property + defaults to 7.2 studs. This property is only visible in the Properties window If `Class.StarterPlayer.CharacterUseJumpPower` is set to `false`, as it would @@ -239,11 +238,10 @@ properties: Determines the starting value of `Class.Humanoid.JumpPower` for `Class.Player.Character`. description: | - This property determines the starting value of - `Class.Humanoid.JumpPower` for a player's - `Class.Player.Character`. The value of this property defaults to - 50 and when applied to the player's `Class.Humanoid` it will be - constrained between 0 and 1000. + This property determines the starting value of `Class.Humanoid.JumpPower` + for a player's `Class.Player.Character`. The value of this property + defaults to 50 and when applied to the player's `Class.Humanoid` it will + be constrained between 0 and 1000. This property is only visible in the Properties window If `Class.StarterPlayer.CharacterUseJumpPower` is set to `true`, as it would @@ -272,10 +270,10 @@ properties: `Class.Player.Character`. description: | This property determines the starting value of - `Class.Humanoid.MaxSlopeAngle` for a player's - `Class.Player.Character`. It defaults to 89°, so humanoids can - climb pretty much any slope they want by default. When applied to the - player's `Class.Humanoid` it will be constrained between 0 and 89. + `Class.Humanoid.MaxSlopeAngle` for a player's `Class.Player.Character`. It + defaults to 89°, so humanoids can climb pretty much any slope they want by + default. When applied to the player's `Class.Humanoid` it will be + constrained between 0 and 89. Since this property is only relevant for characters being spawned in the future, changing it will not change any existing player characters. @@ -300,11 +298,11 @@ properties: `Class.Player.Character`. description: | `CharacterUseJumpPower` determines the starting value of - `Class.Humanoid.UseJumpPower` for a player's - `Class.Player.Character`. Toggling it will change which property - is visible in the properties window: - `Class.StarterPlayer.CharacterJumpHeight|CharacterJumpHeight` (false) or - `Class.StarterPlayer.CharacterJumpPower` (true). Defaults to true. + `Class.Humanoid.UseJumpPower` for a player's `Class.Player.Character`. + Toggling it will change which property is visible in the properties + window: `Class.StarterPlayer.CharacterJumpHeight|CharacterJumpHeight` + (false) or `Class.StarterPlayer.CharacterJumpPower` (true). Defaults to + true. Since this property is only relevant for characters being spawned in the future, changing it will not change any existing player characters. @@ -328,9 +326,8 @@ properties: Determines the starting value of `Class.Humanoid.WalkSpeed` for `Class.Player.Character`. description: | - This property determines the starting value of - `Class.Humanoid.WalkSpeed` for a player's - `Class.Player.Character`. This property defaults to 16. + This property determines the starting value of `Class.Humanoid.WalkSpeed` + for a player's `Class.Player.Character`. This property defaults to 16. Since this property is only relevant for characters being spawned in the future, changing it will not change any existing player characters. @@ -379,8 +376,8 @@ properties: Lets developer overwrite the default camera mode for each player if the player is on a computer. description: | - This property lets the developer overwrite - the player's camera mode if the player is on a computer. + This property lets the developer overwrite the player's camera mode if the + player is on a computer. This is the default property for players joining the game. It can be changed for individual players by settings the @@ -415,8 +412,8 @@ properties: Lets developer overwrite the player's movement mode if the player is on a computer. description: | - This property lets the developer overwrite the - player's movement mode if the player is on a computer. + This property lets the developer overwrite the player's movement mode if + the player is on a computer. This is the default property for players joining the game. It can be changed for individual players by settings the @@ -451,8 +448,8 @@ properties: Lets developer overwrite the default camera movement mode for each player if the player is on a mobile device. description: | - This property lets the developer overwrite the - player's camera mode if the player is on a touch device. + This property lets the developer overwrite the player's camera mode if the + player is on a touch device. This is the default property for players joining the game. It can be changed for individual players by settings the @@ -486,8 +483,8 @@ properties: Lets developer overwrite the player's movement mode if the player is on a touch device. description: | - This property lets the developer overwrite the - player's movement mode if the player is on a touch device. + This property lets the developer overwrite the player's movement mode if + the player is on a touch device. This is the default property for players joining the game. It can be changed for individual players by settings the @@ -539,8 +536,7 @@ properties: summary: | Determines if a player can toggle mouse lock by default. description: | - This property determines if a player can toggle - mouse lock by default. + This property determines if a player can toggle mouse lock by default. Mouselock will lock the player's cursor to the center of the screen. Moving the mouse will rotate the `Class.Camera` and `Class.Player` will @@ -571,10 +567,9 @@ properties: Sets the distance at which this player will see other `Class.Humanoid` health bars. If set to 0, the health bars will not be displayed. description: | - This property sets the distance in studs at which - this player will see other `Class.Humanoid` health bars. If set to 0, the - health bars will not be displayed. This property is set to 100 studs by - default. + This property sets the distance in studs at which this player will see + other `Class.Humanoid` health bars. If set to 0, the health bars will not + be displayed. This property is set to 100 studs by default. To change the display distance for a player once they join the game, you can set the `Class.Player.HealthDisplayDistance` property. @@ -600,8 +595,8 @@ properties: summary: | Whether or not the appearance of a player's character should be loaded. description: | - This property sets whether or not the appearance - of a player's character should be loaded. + This property sets whether or not the appearance of a player's character + should be loaded. Setting this to `false` results in the player having no clothes (including hats), body colors, body packages or anything else related to the @@ -679,7 +674,8 @@ properties: names. description: | Sets the distance at which this player will see other `Class.Humanoid` - names. If set to `0`, names are hidden. This property is set to `100` studs by default. + names. If set to `0`, names are hidden. This property is set to `100` + studs by default. To change the display distance for a player once they join the game, you can set the `Class.Player.NameDisplayDistance` property. diff --git a/content/en-us/reference/engine/classes/TaskScheduler.yaml b/content/en-us/reference/engine/classes/TaskScheduler.yaml index 70ecbe8b7..957a93938 100644 --- a/content/en-us/reference/engine/classes/TaskScheduler.yaml +++ b/content/en-us/reference/engine/classes/TaskScheduler.yaml @@ -14,6 +14,7 @@ inherits: tags: - NotCreatable - Service + - NotReplicated deprecation_message: '' properties: - name: TaskScheduler.SchedulerDutyCycle diff --git a/content/en-us/reference/engine/classes/TextBox.yaml b/content/en-us/reference/engine/classes/TextBox.yaml index 026c99758..1b02d63be 100644 --- a/content/en-us/reference/engine/classes/TextBox.yaml +++ b/content/en-us/reference/engine/classes/TextBox.yaml @@ -123,11 +123,10 @@ properties: `Class.TextBox.SelectionStart|SelectionStart` property, it is possible to both get and set selected text within a `Class.TextBox`. - Note that the units of this property are **bytes** and that - many unicode characters such as emoji are longer than 1 byte. For - instance, if a player types in "Hello👋" ("Hello" - immediately followed by the waving hand sign), the cursor position - would be `10`, not `7`, since the emoji uses 4 bytes. + Note that the units of this property are **bytes** and that many unicode + characters such as emoji are longer than 1 byte. For instance, if a player + types in "Hello👋" ("Hello" immediately followed by the waving hand sign), + the cursor position would be `10`, not `7`, since the emoji uses 4 bytes. code_samples: - textbox-selections type: int @@ -567,11 +566,10 @@ properties: Determines the color of rendered text. description: | This property determines the color of all the text rendered by a - `Class.GuiObject` element. This property along with - `Class.TextBox.Font`, `Class.TextBox.TextSize` and - `Class.TextBox.TextTransparency` will determine the visual properties of - text. Text is rendered after the text stroke - (`Class.TextBox.TextStrokeColor3`). + `Class.GuiObject` element. This property along with `Class.TextBox.Font`, + `Class.TextBox.TextSize` and `Class.TextBox.TextTransparency` will + determine the visual properties of text. Text is rendered after the text + stroke (`Class.TextBox.TextStrokeColor3`). It's important that text is easily read by players! Be sure to choose colors with little-to-no saturation, like white, grey, or black. Make sure @@ -894,12 +892,12 @@ properties: writeCapabilities: [] - name: TextBox.TextWrapped summary: | - Determines if text wraps to multiple lines within the - `Class.GuiObject` element space, truncating excess text. + Determines if text wraps to multiple lines within the `Class.GuiObject` + element space, truncating excess text. description: | When enabled, this property will render text on multiple lines within a - `Class.TextBox` element's space so that `Class.TextBox.TextBounds` - will never exceed the `Class.GuiBase2d.AbsoluteSize` of the GUI element. + `Class.TextBox` element's space so that `Class.TextBox.TextBounds` will + never exceed the `Class.GuiBase2d.AbsoluteSize` of the GUI element. This is achieved by breaking long lines of text into multiple lines. Line breaks will prefer whitespace; should a long unbroken word exceed the diff --git a/content/en-us/reference/engine/classes/TextButton.yaml b/content/en-us/reference/engine/classes/TextButton.yaml index 6ed147725..61637b549 100644 --- a/content/en-us/reference/engine/classes/TextButton.yaml +++ b/content/en-us/reference/engine/classes/TextButton.yaml @@ -24,8 +24,8 @@ properties: description: | This property provides a copy of `Class.TextButton.Text|Text` that contains exactly what is being rendered by the `Class.TextButton`. This is - useful for eliminating style tags used for [rich - text](../../../ui/rich-text.md) markup; for example, when + useful for eliminating style tags used for + [rich text](../../../ui/rich-text.md) markup; for example, when `Class.TextButton.RichText|RichText` is enabled, the `Class.TextButton.ContentText|ContentText` property shows the text as it appears to the user. @@ -79,7 +79,7 @@ properties: With the exception of the `Enum.Font.Legacy` font, each font will render text with the line height equal to the `Class.TextButton.TextSize|TextSize` property. - + The `Enum.Font.Code` font is the only monospace font. It has the unique property that each character has the exact same width and height ratio of 1:2, where the width of each character is approximately half the @@ -113,8 +113,8 @@ properties: allows setting fonts that don't exist in `Enum.Font`. This property is kept in sync with the `Class.TextButton.Font|Font` - property, such that when setting `Class.TextButton.FontFace|FontFace`, - the font is set to the corresponding `Enum.Font` value or to + property, such that when setting `Class.TextButton.FontFace|FontFace`, the + font is set to the corresponding `Enum.Font` value or to `Enum.Font.Unknown` if there are no matches. code_samples: [] type: Font @@ -142,8 +142,8 @@ properties: - NotReplicated - Deprecated deprecation_message: | - This property is deprecated in favor of `Class.TextButton|TextSize` which is an integer and not an enum and thus offers far more options for - sizes. + This property is deprecated in favor of `Class.TextButton|TextSize` which + is an integer and not an enum and thus offers far more options for sizes. security: read: None write: None @@ -208,8 +208,9 @@ properties: description: | This property controls the maximum number of graphemes (or units of text) that are shown on the `Class.TextButton`. It is primarily provided as an - easy way to create a [typewriter effect](../../../ui/animation.md#typewriter-effect) where the characters appear one - at a time. + easy way to create a + [typewriter effect](../../../ui/animation.md#typewriter-effect) where the + characters appear one at a time. Changing the property does not change the position or size of the visible graphemes; the layout will be calculated as if all graphemes are visible. @@ -271,7 +272,8 @@ properties: writeCapabilities: [] - name: TextButton.RichText summary: | - Determines whether the `Class.TextButton` renders its text using rich text formatting. + Determines whether the `Class.TextButton` renders its text using rich text + formatting. description: | This property determines whether the `Class.TextButton` renders its text using [rich text](../../../ui/rich-text.md) markup to style sections of @@ -433,11 +435,11 @@ properties: writeCapabilities: [] - name: TextButton.TextFits summary: | - A boolean representation of whether the button's text fits within the - size of it. + A boolean representation of whether the button's text fits within the size + of it. description: | - A boolean representation of whether the button's text fits within the - size of it. + A boolean representation of whether the button's text fits within the size + of it. code_samples: type: bool tags: @@ -476,11 +478,12 @@ properties: Here are the core differences between the two properties: - `Class.TextButton.TextScaled|TextScaled` scales the content (text) to - accommodate the UI. Without careful consideration, some text may become - unreadable if scaled too small. + accommodate the UI. Without careful consideration, some text may become + unreadable if scaled too small. - - `Class.GuiObject.AutomaticSize|AutomaticSize` resizes the UI to accommodate content while maintaining a consistent font size. For more - information, see [here](../../../ui/size-modifiers.md#automatic-sizing). + - `Class.GuiObject.AutomaticSize|AutomaticSize` resizes the UI to + accommodate content while maintaining a consistent font size. For more + information, see [here](../../../ui/size-modifiers.md#automatic-sizing). Additionally, it's recommended that you avoid applying both `Class.GuiObject.AutomaticSize|AutomaticSize` and @@ -562,7 +565,7 @@ properties: This property sets the transparency of the stroke, or outline, of rendered text. Along with `Class.TextButton.TextStrokeColor3|TextStrokeColor3`, it determines the final visual appearance of the text stroke. - + Note that text stroke is multiple renderings of the same transparency, so this property is essentially multiplicative on itself four times over. Therefore, it's recommended to set @@ -590,8 +593,8 @@ properties: summary: | Determines the transparency of rendered text. description: | - This property determines the transparency of all the text - rendered by the `Class.TextButton`. + This property determines the transparency of all the text rendered by the + `Class.TextButton`. code_samples: type: float tags: [] @@ -629,9 +632,11 @@ properties: writeCapabilities: [] - name: TextButton.TextWrap summary: | - Determines whether or not text should wrap at the edges of the `Class.TextButton` element's space. + Determines whether or not text should wrap at the edges of the + `Class.TextButton` element's space. description: | - This property determines whether or not text should wrap at the edges of the `Class.TextButton` element's space. + This property determines whether or not text should wrap at the edges of + the `Class.TextButton` element's space. code_samples: type: bool tags: @@ -653,15 +658,15 @@ properties: writeCapabilities: [] - name: TextButton.TextWrapped summary: | - Determines if text wraps to multiple lines within the - `Class.TextButton` element's space, truncating excess text. + Determines if text wraps to multiple lines within the `Class.TextButton` + element's space, truncating excess text. description: | When enabled, this property will render text on multiple lines within a `Class.TextButton` element's space so that `Class.TextButton.TextBounds|TextBounds` will never exceed the `Class.GuiBase2d.AbsoluteSize` of the element. This is achieved by breaking long lines of text into multiple lines. - + Line breaks will prefer whitespace; should a long unbroken word exceed the width of the element, that word will be broken into multiple lines. @@ -693,7 +698,7 @@ properties: the object's space. It is used in conjunction with `Class.TextButton.TextYAlignment|TextYAlignment` to fully determine text alignment on both axes. - + Note that this property won't affect the read-only properties `Class.TextButton.TextBounds|TextBounds` and `Class.TextButton.TextFits|TextFits`. diff --git a/content/en-us/reference/engine/classes/TextLabel.yaml b/content/en-us/reference/engine/classes/TextLabel.yaml index b0d4c9fe7..8a8b070f2 100644 --- a/content/en-us/reference/engine/classes/TextLabel.yaml +++ b/content/en-us/reference/engine/classes/TextLabel.yaml @@ -32,14 +32,13 @@ properties: A copy of `Class.TextLabel.Text` that contains exactly what is being rendered by the `Class.TextLabel`. description: | - This property provides a copy of `Class.TextLabel.Text|Text` that - contains exactly what is being rendered by the `Class.TextLabel`. This is - useful for eliminating style tags used for [rich - text](../../../ui/rich-text.md) markup; for example, when - `Class.TextLabel.RichText|RichText` is enabled, the - `Class.TextLabel.ContentText|ContentText` property shows the text as it - appears to the user. - + This property provides a copy of `Class.TextLabel.Text|Text` that contains + exactly what is being rendered by the `Class.TextLabel`. This is useful + for eliminating style tags used for [rich text](../../../ui/rich-text.md) + markup; for example, when `Class.TextLabel.RichText|RichText` is enabled, + the `Class.TextLabel.ContentText|ContentText` property shows the text as + it appears to the user. + @@ -87,16 +86,16 @@ properties: and/or light variants. With the exception of the `Enum.Font.Legacy` font, each font will render - text with the line height equal to the - `Class.TextLabel.TextSize|TextSize` property. - + text with the line height equal to the `Class.TextLabel.TextSize|TextSize` + property. + The `Enum.Font.Code` font is the only monospace font. It has the unique property that each character has the exact same width and height ratio of 1:2, where the width of each character is approximately half the `Class.TextLabel.TextSize|TextSize` property. - This property is kept in sync with the - `Class.TextLabel.FontFace|FontFace` property. + This property is kept in sync with the `Class.TextLabel.FontFace|FontFace` + property. code_samples: - Show-All-Fonts type: Font @@ -123,8 +122,8 @@ properties: allows setting fonts that don't exist in `Enum.Font`. This property is kept in sync with the `Class.TextLabel.Font|Font` - property, such that when setting `Class.TextLabel.FontFace|FontFace`, - the font is set to the corresponding `Enum.Font` value or to + property, such that when setting `Class.TextLabel.FontFace|FontFace`, the + font is set to the corresponding `Enum.Font` value or to `Enum.Font.Unknown` if there are no matches. code_samples: [] type: Font @@ -152,8 +151,8 @@ properties: - NotReplicated - Deprecated deprecation_message: | - This property is deprecated in favor of `Class.TextLabel|TextSize` which is an integer and not an enum and thus offers far more options for - sizes. + This property is deprecated in favor of `Class.TextLabel|TextSize` which + is an integer and not an enum and thus offers far more options for sizes. security: read: None write: None @@ -218,8 +217,9 @@ properties: description: | This property controls the maximum number of graphemes (or units of text) that are shown on the `Class.TextLabel`. It is primarily provided as an - easy way to create a [typewriter effect](../../../ui/animation.md#typewriter-effect) where the characters appear one - at a time. + easy way to create a + [typewriter effect](../../../ui/animation.md#typewriter-effect) where the + characters appear one at a time. Changing the property does not change the position or size of the visible graphemes; the layout will be calculated as if all graphemes are visible. @@ -281,7 +281,8 @@ properties: writeCapabilities: [] - name: TextLabel.RichText summary: | - Determines whether the `Class.TextLabel` renders its text using rich text formatting. + Determines whether the `Class.TextLabel` renders its text using rich text + formatting. description: | This property determines whether the `Class.TextLabel` renders its text using [rich text](../../../ui/rich-text.md) markup to style sections of @@ -386,8 +387,8 @@ properties: - NotReplicated - Deprecated deprecation_message: | - This item has been superseded by `Class.TextLabel.TextColor3` which - should be used in all new work. + This item has been superseded by `Class.TextLabel.TextColor3` which should + be used in all new work. security: read: None write: None @@ -443,11 +444,11 @@ properties: writeCapabilities: [] - name: TextLabel.TextFits summary: | - A boolean representation of whether the label's text fits within the - size of it. + A boolean representation of whether the label's text fits within the size + of it. description: | - A boolean representation of whether the label's text fits within the - size of it. + A boolean representation of whether the label's text fits within the size + of it. code_samples: type: bool tags: @@ -470,8 +471,8 @@ properties: Changes whether text is resized to fit within the `Class.TextLabel`. description: | This property determines whether text is scaled so that it fills the - label's entire space. When enabled, `Class.TextLabel.TextSize|TextSize` - is ignored and `Class.TextLabel.TextWrapped|TextWrapped` is automatically + label's entire space. When enabled, `Class.TextLabel.TextSize|TextSize` is + ignored and `Class.TextLabel.TextWrapped|TextWrapped` is automatically enabled. This property is useful for rendering text elements within `Class.BillboardGui|BillboardGuis`. When this property is used for [on-screen UI](../../../ui/on-screen-containers.md), it may be helpful to @@ -486,11 +487,12 @@ properties: are the core differences between the two properties: - `Class.TextLabel.TextScaled|TextScaled` scales the content (text) to - accommodate the UI. Without careful consideration, some text may become - unreadable if scaled too small. + accommodate the UI. Without careful consideration, some text may become + unreadable if scaled too small. - - `Class.GuiObject.AutomaticSize|AutomaticSize` resizes the UI to accommodate content while maintaining a consistent font size. For more - information, see [here](../../../ui/size-modifiers.md#automatic-sizing). + - `Class.GuiObject.AutomaticSize|AutomaticSize` resizes the UI to + accommodate content while maintaining a consistent font size. For more + information, see [here](../../../ui/size-modifiers.md#automatic-sizing). Additionally, it's recommended that you avoid applying both `Class.GuiObject.AutomaticSize|AutomaticSize` and @@ -571,12 +573,12 @@ properties: This property sets the transparency of the stroke, or outline, of rendered text. Along with `Class.TextLabel.TextStrokeColor3|TextStrokeColor3`, it determines the final visual appearance of the text stroke. - + Note that text stroke is multiple renderings of the same transparency, so this property is essentially multiplicative on itself four times over. Therefore, it's recommended to set - `Class.TextLabel.TextStrokeTransparency|TextStrokeTransparency` to a - value in the range of `0.75` to `1` for more a more subtle effect. + `Class.TextLabel.TextStrokeTransparency|TextStrokeTransparency` to a value + in the range of `0.75` to `1` for more a more subtle effect. As a powerful alternative which supports color gradients, see `Class.UIStroke`. @@ -599,8 +601,8 @@ properties: summary: | Determines the transparency of rendered text. description: | - This property determines the transparency of all the text - rendered by the `Class.TextLabel`. + This property determines the transparency of all the text rendered by the + `Class.TextLabel`. code_samples: type: float tags: [] @@ -638,9 +640,11 @@ properties: writeCapabilities: [] - name: TextLabel.TextWrap summary: | - Determines whether or not text should wrap at the edges of the `Class.TextLabel` element's space. + Determines whether or not text should wrap at the edges of the + `Class.TextLabel` element's space. description: | - This property determines whether or not text should wrap at the edges of the `Class.TextLabel` element's space. + This property determines whether or not text should wrap at the edges of + the `Class.TextLabel` element's space. code_samples: type: bool tags: @@ -662,15 +666,15 @@ properties: writeCapabilities: [] - name: TextLabel.TextWrapped summary: | - Determines if text wraps to multiple lines within the - `Class.TextLabel` element's space, truncating excess text. + Determines if text wraps to multiple lines within the `Class.TextLabel` + element's space, truncating excess text. description: | When enabled, this property will render text on multiple lines within a `Class.TextLabel` element's space so that `Class.TextLabel.TextBounds|TextBounds` will never exceed the `Class.GuiBase2d.AbsoluteSize` of the element. This is achieved by breaking long lines of text into multiple lines. - + Line breaks will prefer whitespace; should a long unbroken word exceed the width of the element, that word will be broken into multiple lines. @@ -702,7 +706,7 @@ properties: the object's space. It is used in conjunction with `Class.TextLabel.TextYAlignment|TextYAlignment` to fully determine text alignment on both axes. - + Note that this property won't affect the read-only properties `Class.TextLabel.TextBounds|TextBounds` and `Class.TextLabel.TextFits|TextFits`. diff --git a/content/en-us/reference/engine/classes/Texture.yaml b/content/en-us/reference/engine/classes/Texture.yaml index f6dd339f3..e1d07e183 100644 --- a/content/en-us/reference/engine/classes/Texture.yaml +++ b/content/en-us/reference/engine/classes/Texture.yaml @@ -14,7 +14,7 @@ description: | repeat when the `Class.BasePart` is resized. The size of the repeating textures is determined by the `Class.Texture.StudsPerTileU|StudsPerTileU` and `Class.Texture.StudsPerTileV|StudsPerTileV` properties. - + The applied image is determined by the `Class.Decal.Texture|Texture` property. For information on how to upload images, see [Assets](../../../projects/assets/index.md). @@ -34,7 +34,8 @@ properties: coordinate. description: | `Class.Texture.OffsetStudsU|OffsetStudsU` determines how far the rendered - texture is offset on the horizontal axis, in studs, as visualized [here](../../../parts/textures-decals.md#offsetting-textures). + texture is offset on the horizontal axis, in studs, as visualized + [here](../../../parts/textures-decals.md#offsetting-textures). See also `Class.Texture.OffsetStudsV|OffsetStudsV`. code_samples: @@ -58,7 +59,8 @@ properties: coordinate. description: | `Class.Texture.OffsetStudsV|OffsetStudsV` determines how far the rendered - texture is offset on the vertical axis, in studs, as visualized [here](../../../parts/textures-decals.md#offsetting-textures). + texture is offset on the vertical axis, in studs, as visualized + [here](../../../parts/textures-decals.md#offsetting-textures). See also `Class.Texture.OffsetStudsU|OffsetStudsU`. code_samples: diff --git a/content/en-us/reference/engine/classes/TweenService.yaml b/content/en-us/reference/engine/classes/TweenService.yaml index 9b3d5e2a7..913af6e3a 100644 --- a/content/en-us/reference/engine/classes/TweenService.yaml +++ b/content/en-us/reference/engine/classes/TweenService.yaml @@ -47,9 +47,9 @@ methods: Creates a new `Class.Tween` given the object whose properties are to be tweened, a `Datatype.TweenInfo`, and a dictionary of goal property values. description: | - This constructor creates a new `Class.Tween` from three - arguments: the object to tween, the `Datatype.TweenInfo` specifications, - and a table containing the properties to tween and values to tween to. + This constructor creates a new `Class.Tween` from three arguments: the + object to tween, the `Datatype.TweenInfo` specifications, and a table + containing the properties to tween and values to tween to. The `propertyTable` parameter needs to be a dictionary where the keys are the string names of the property (for example `Position`, `Transparency`, diff --git a/content/en-us/reference/engine/classes/UGCValidationService.yaml b/content/en-us/reference/engine/classes/UGCValidationService.yaml index 8e35e1fdc..f4b601be3 100644 --- a/content/en-us/reference/engine/classes/UGCValidationService.yaml +++ b/content/en-us/reference/engine/classes/UGCValidationService.yaml @@ -112,6 +112,46 @@ methods: thread_safety: Unsafe capabilities: [] writeCapabilities: [] + - name: UGCValidationService:ReportUGCValidationCounter + summary: '' + description: '' + code_samples: [] + parameters: + - name: success + type: bool + default: + summary: '' + - name: validationType + type: string + default: + summary: '' + returns: + - type: void + summary: '' + tags: [] + deprecation_message: '' + security: RobloxScriptSecurity + thread_safety: Unsafe + capabilities: [] + writeCapabilities: [] + - name: UGCValidationService:ReportUGCValidationFailureTelemetry + summary: '' + description: '' + code_samples: [] + parameters: + - name: errorType + type: string + default: + summary: '' + returns: + - type: void + summary: '' + tags: [] + deprecation_message: '' + security: RobloxScriptSecurity + thread_safety: Unsafe + capabilities: [] + writeCapabilities: [] - name: UGCValidationService:ValidateEditableMeshUVDuplicates summary: '' description: '' diff --git a/content/en-us/reference/engine/classes/UICorner.yaml b/content/en-us/reference/engine/classes/UICorner.yaml index d292d73cf..9377ccbea 100644 --- a/content/en-us/reference/engine/classes/UICorner.yaml +++ b/content/en-us/reference/engine/classes/UICorner.yaml @@ -38,16 +38,17 @@ properties: summary: | Determines the radius of the component. description: | - A `Datatype.UDim` property that determines the radius of the `Class.UICorner` - component, internally calculated as follows: + A `Datatype.UDim` property that determines the radius of the + `Class.UICorner` component, internally calculated as follows: - The radius of the **X** axis is always the same as the radius of **Y** axis. - `Datatype.UDim.Scale|Scale` rounding will always apply to the **minimum** width or height. - - Rounded rectangles will always be in a "pill" shape if `Class.UICorner.CornerRadius|CornerRadius` is - set to a value that leads to a calculated result greater than half of - the rectangle's minimum width or height. + - Rounded rectangles will always be in a "pill" shape if + `Class.UICorner.CornerRadius|CornerRadius` is set to a value that leads + to a calculated result greater than half of the rectangle's minimum + width or height. code_samples: type: UDim tags: [] diff --git a/content/en-us/reference/engine/classes/UIDragDetector.yaml b/content/en-us/reference/engine/classes/UIDragDetector.yaml index e275ace3a..6ee44386c 100644 --- a/content/en-us/reference/engine/classes/UIDragDetector.yaml +++ b/content/en-us/reference/engine/classes/UIDragDetector.yaml @@ -11,19 +11,19 @@ description: | spinners. Key features include: - Place a `Class.UIDragDetector` under any `Class.GuiObject` instance to make - it draggable via all inputs without a single line of code. + it draggable via all inputs without a single line of code. - Choose from several `Class.UIDragDetector.DragStyle|DragStyle` options, - define how the object responds to motion via - `Class.UIDragDetector.ResponseStyle|ResponseStyle`, and optionally apply axis, - movement limits, or drag boundaries. + define how the object responds to motion via + `Class.UIDragDetector.ResponseStyle|ResponseStyle`, and optionally apply + axis, movement limits, or drag boundaries. - Scripts can respond to manipulation of dragged objects to drive logic - responses, such as adjusting settings. + responses, such as adjusting settings. - `Class.UIDragDetector|UIDragDetectors` work in Studio as long as you're - **not** using the **Select**, **Move**, **Scale**, or **Rotate** tools, nor - certain plugins or Studio's **UI** editor tools. + **not** using the **Select**, **Move**, **Scale**, or **Rotate** tools, nor + certain plugins or Studio's **UI** editor tools. code_samples: [] inherits: - UIComponent diff --git a/content/en-us/reference/engine/classes/UIListLayout.yaml b/content/en-us/reference/engine/classes/UIListLayout.yaml index d81345a31..e33d10df5 100644 --- a/content/en-us/reference/engine/classes/UIListLayout.yaml +++ b/content/en-us/reference/engine/classes/UIListLayout.yaml @@ -65,9 +65,9 @@ properties: Controls how to distribute extra horizontal space. description: | When the list layout's `Class.UIListLayout.FillDirection|FillDirection` is - set to `Enum.FillDirection.Horizontal`, the `Class.UIListLayout.HorizontalFlex|HorizontalFlex` property - specifies how to distribute extra horizontal space in the parent - container. + set to `Enum.FillDirection.Horizontal`, the + `Class.UIListLayout.HorizontalFlex|HorizontalFlex` property specifies how + to distribute extra horizontal space in the parent container.
@@ -106,11 +106,12 @@ properties: In **vertical** list layouts (`Class.UIListLayout.FillDirection|FillDirection` set to - `Enum.FillDirection.Vertical`), the `Class.UIListLayout.HorizontalFlex|HorizontalFlex` property specifies - how to distribute the siblings across the **horizontal cross‑direction**. - In such layouts, a setting of `Enum.UIFlexAlignment.Fill` makes the - siblings fill the entire horizontal space while vertical spacing adheres - to `Class.UIListLayout.VerticalFlex|VerticalFlex`. + `Enum.FillDirection.Vertical`), the + `Class.UIListLayout.HorizontalFlex|HorizontalFlex` property specifies how + to distribute the siblings across the **horizontal cross‑direction**. In + such layouts, a setting of `Enum.UIFlexAlignment.Fill` makes the siblings + fill the entire horizontal space while vertical spacing adheres to + `Class.UIListLayout.VerticalFlex|VerticalFlex`. Diagram showing how HorizontalFlex affects the horizontal size of sibling UI objects when the UIListLayout fill direction is set to vertical. @@ -224,8 +225,9 @@ properties: Controls how to distribute extra vertical space. description: | When the list layout's `Class.UIListLayout.FillDirection|FillDirection` is - set to `Enum.FillDirection.Vertical`, the `Class.UIListLayout.VerticalFlex|VerticalFlex` property - specifies how to distribute extra vertical space in the parent container. + set to `Enum.FillDirection.Vertical`, the + `Class.UIListLayout.VerticalFlex|VerticalFlex` property specifies how to + distribute extra vertical space in the parent container.
@@ -264,10 +266,11 @@ properties: In **horizontal** list layouts (`Class.UIListLayout.FillDirection|FillDirection` set to - `Enum.FillDirection.Horizontal`), the `Class.UIListLayout.VerticalFlex|VerticalFlex` property specifies - how to distribute the siblings across the **vertical cross direction**. In - such layouts, a setting of `Enum.UIFlexAlignment.Fill` makes the siblings - fill the entire vertical space while horizontal spacing adheres to + `Enum.FillDirection.Horizontal`), the + `Class.UIListLayout.VerticalFlex|VerticalFlex` property specifies how to + distribute the siblings across the **vertical cross direction**. In such + layouts, a setting of `Enum.UIFlexAlignment.Fill` makes the siblings fill + the entire vertical space while horizontal spacing adheres to `Class.UIListLayout.HorizontalFlex|HorizontalFlex`. Diagram showing how VerticalFlex affects the vertical size of sibling UI objects when the UIListLayout fill direction is set to horizontal. diff --git a/content/en-us/reference/engine/classes/UISizeConstraint.yaml b/content/en-us/reference/engine/classes/UISizeConstraint.yaml index d3140853f..e900fc9f3 100644 --- a/content/en-us/reference/engine/classes/UISizeConstraint.yaml +++ b/content/en-us/reference/engine/classes/UISizeConstraint.yaml @@ -9,8 +9,9 @@ description: | The `Class.UISizeConstraint` ensures a `Class.GuiObject` does not become larger or smaller than the `Class.UISizeConstraint.MaxSize|MaxSize` and `Class.UISizeConstraint.MinSize|MinSize`. For example, if - `Class.UISizeConstraint.MaxSize|MaxSize` is set to `(200, - 200)` and `Class.UISizeConstraint.MinSize|MinSize` to `(200, 200)` and + `Class.UISizeConstraint.MinSize|MinSize` to `(100, 100)`, the constrained object cannot scale to be larger than 200×200 pixels or smaller than 100×100 pixels. diff --git a/content/en-us/reference/engine/classes/UIStroke.yaml b/content/en-us/reference/engine/classes/UIStroke.yaml index 38704d8d7..93f6e968e 100644 --- a/content/en-us/reference/engine/classes/UIStroke.yaml +++ b/content/en-us/reference/engine/classes/UIStroke.yaml @@ -5,7 +5,8 @@ memory_category: Instances summary: | Applies an outline to text or a UI border. description: | - `Class.UIStroke` applies an outline to text or a UI border. Key features include: + `Class.UIStroke` applies an outline to text or a UI border. Key features + include: - Adjust the `Class.UIStroke.Color|Color` and `Class.UIStroke.Thickness|Thickness` of the stroke outline. @@ -30,8 +31,9 @@ properties: Determines whether to apply the stroke to the object's border instead of the text itself. description: | - When a `Class.UIStroke` instance is applied to a text object, this property determines whether to apply the stroke to the - object's border instead of the text itself. + When a `Class.UIStroke` instance is applied to a text object, this + property determines whether to apply the stroke to the object's border + instead of the text itself.
@@ -60,8 +62,8 @@ properties: summary: | Determines the stroke color. description: | - Determines the `Class.UIStroke` color. You can also insert a `Class.UIGradient` - instance as a child to create gradient strokes. + Determines the `Class.UIStroke` color. You can also insert a + `Class.UIGradient` instance as a child to create gradient strokes.
@@ -90,8 +92,8 @@ properties: summary: | Determines whether the stroke in visible. description: | - This property determines whether the `Class.UIStroke` is visible. When set to - `false`, the stroke will not be rendered. Defaults to `true`. + This property determines whether the `Class.UIStroke` is visible. When set + to `false`, the stroke will not be rendered. Defaults to `true`. code_samples: type: bool tags: [] diff --git a/content/en-us/reference/engine/classes/UserInputService.yaml b/content/en-us/reference/engine/classes/UserInputService.yaml index 5b01e48b7..20d691a6c 100644 --- a/content/en-us/reference/engine/classes/UserInputService.yaml +++ b/content/en-us/reference/engine/classes/UserInputService.yaml @@ -1932,7 +1932,8 @@ methods: control the navigation `Class.GuiObject|GuiObjects`. description: | This function returns `true` if the specified `Enum.UserInputType` gamepad - is allowed to control Navigation and Selection `Class.GuiObject|GuiObjects`. + is allowed to control Navigation and Selection + `Class.GuiObject|GuiObjects`. If you want to set a navigation gamepad, you can use `Class.UserInputService:SetNavigationGamepad()`. You can also use @@ -2643,74 +2644,6 @@ events: thread_safety: Unsafe capabilities: [] writeCapabilities: [] - - name: UserInputService.TouchDrag - summary: | - Fires when a user drags at least one finger on a - `Class.UserInputService.TouchEnabled|TouchEnabled` device at a speed - above a certain threshold. - description: | - The `TouchDrag` event fires when a user drags at least one finger on a - `Class.UserInputService.TouchEnabled|TouchEnabled` device at a speed - above a certain threshold. - - This event triggers the first time this speed is exceeded, even if - the user has not lifted their finger from the device. - Use it to detect the start of a directional drag gesture and to track - the movement of the user's finger along a specified axis. - - You can use `TouchDrag` with `Class.UserInputService.TouchSwipe|TouchSwipe`. - For example, you can use `TouchDrag` in a scrolling list of clothing accessory - items to detect when a user horizontally drags on an item to reveal context actions, - and then use `Class.UserInputService.TouchSwipe|TouchSwipe` to detect the - user's finger swipe when they add the item to their outfit. - - The `TouchDrag` event only fires when the Roblox client window is in focus, and - it can only be used in a `Class.LocalScript`. Inputs are not captured when the - window is minimized. - - For more precise tracking of touch input movement, - use `Class.UserInputService.TouchMoved`. - - ##### See Also - - - `Class.UserInputService.TouchTap` - - `Class.UserInputService.TouchTapInWorld` - - `Class.UserInputService.TouchLongPress` - - `Class.UserInputService.TouchMoved` - - `Class.UserInputService.TouchPan` - - `Class.UserInputService.TouchPinch` - - `Class.UserInputService.TouchRotate` - - `Class.UserInputService.TouchStarted` - - `Class.UserInputService.TouchSwipe` - - `Class.UserInputService.TouchEnded` - code_samples: - - UserInputService-TouchDrag - parameters: - - name: swipeDirection - type: SwipeDirection - default: - summary: | - Indicates the direction the user swiped. - - name: numberOfTouches - type: int - default: - summary: | - The number of touches (for example, fingers) involved in the gesture. - - name: gameProcessedEvent - type: bool - default: - summary: | - Indicates whether the Roblox engine internally observed this input and - acted on it. Generally, this refers to UI processing; if a button - is touched or clicked from this input, `gameProcessedEvent` returns - `true`. This also applies to input events connected through - `Class.ContextActionService`. - tags: [] - deprecation_message: '' - security: None - thread_safety: Unsafe - capabilities: [] - writeCapabilities: [] - name: UserInputService.TouchEnded summary: | Fired when a user releases their finger from the screen on a TouchEnabled @@ -3258,10 +3191,9 @@ events: writeCapabilities: [] - name: UserInputService.TouchSwipe summary: | - Fires on a - `Class.UserInputService.TouchEnabled|TouchEnabled` device when a user - places their finger(s) down on the screen, pans across the screen, and - lifts their finger off with a certain speed of movement. + Fires on a `Class.UserInputService.TouchEnabled|TouchEnabled` device when + a user places their finger(s) down on the screen, pans across the screen, + and lifts their finger off with a certain speed of movement. description: | The `TouchSwipe` event fires when a user swipes their fingers on a `Class.UserInputService.TouchEnabled|TouchEnabled` device. @@ -3331,8 +3263,8 @@ events: screen on a `Class.UserInputService.TouchEnabled|TouchEnabled` device. This event will fire regardless of whether the user touches/taps the game - world or a `Class.GuiObject` element. If you are looking for an event - that only fires when the user touches/taps the game world, use + world or a `Class.GuiObject` element. If you are looking for an event that + only fires when the user touches/taps the game world, use `Class.UserInputService.TouchTapInWorld`. To check if a user's device is TouchEnabled, and that touch events will diff --git a/content/en-us/reference/engine/classes/VideoPlayer.yaml b/content/en-us/reference/engine/classes/VideoPlayer.yaml new file mode 100644 index 000000000..ae2ef08c2 --- /dev/null +++ b/content/en-us/reference/engine/classes/VideoPlayer.yaml @@ -0,0 +1,295 @@ +name: VideoPlayer +type: class +category: +memory_category: Instances +summary: '' +description: '' +code_samples: [] +inherits: + - Instance +tags: + - NotBrowsable +deprecation_message: '' +properties: + - name: VideoPlayer.Asset + summary: '' + description: '' + code_samples: [] + type: ContentId + tags: [] + deprecation_message: '' + security: + read: None + write: None + thread_safety: ReadSafe + category: Asset + serialization: + can_load: true + can_save: true + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer.AutoLoad + summary: '' + description: '' + code_samples: [] + type: bool + tags: [] + deprecation_message: '' + security: + read: None + write: None + thread_safety: ReadSafe + category: Asset + serialization: + can_load: true + can_save: true + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer.IsPlaying + summary: '' + description: '' + code_samples: [] + type: bool + tags: [] + deprecation_message: '' + security: + read: None + write: RobloxSecurity + thread_safety: ReadSafe + category: Playback + serialization: + can_load: false + can_save: false + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer.IsReady + summary: '' + description: '' + code_samples: [] + type: bool + tags: + - ReadOnly + - NotReplicated + deprecation_message: '' + security: + read: None + write: None + thread_safety: ReadSafe + category: Asset + serialization: + can_load: false + can_save: false + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer.Looping + summary: '' + description: '' + code_samples: [] + type: bool + tags: [] + deprecation_message: '' + security: + read: None + write: None + thread_safety: ReadSafe + category: Playback + serialization: + can_load: true + can_save: true + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer.PlaybackSpeed + summary: '' + description: '' + code_samples: [] + type: float + tags: [] + deprecation_message: '' + security: + read: None + write: None + thread_safety: ReadSafe + category: Playback + serialization: + can_load: true + can_save: true + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer.Resolution + summary: '' + description: '' + code_samples: [] + type: Vector2 + tags: + - ReadOnly + - NotReplicated + deprecation_message: '' + security: + read: None + write: None + thread_safety: ReadSafe + category: Asset + serialization: + can_load: false + can_save: false + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer.Thumbnail + summary: '' + description: '' + code_samples: [] + type: ContentId + tags: [] + deprecation_message: '' + security: + read: None + write: None + thread_safety: ReadSafe + category: Asset + serialization: + can_load: true + can_save: true + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer.TimeLength + summary: '' + description: '' + code_samples: [] + type: double + tags: + - ReadOnly + - NotReplicated + deprecation_message: '' + security: + read: None + write: None + thread_safety: ReadSafe + category: Asset + serialization: + can_load: false + can_save: false + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer.TimePosition + summary: '' + description: '' + code_samples: [] + type: double + tags: [] + deprecation_message: '' + security: + read: None + write: None + thread_safety: ReadSafe + category: Playback + serialization: + can_load: true + can_save: true + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer.Volume + summary: '' + description: '' + code_samples: [] + type: float + tags: [] + deprecation_message: '' + security: + read: None + write: None + thread_safety: ReadSafe + category: State + serialization: + can_load: true + can_save: true + capabilities: [] + writeCapabilities: [] +methods: + - name: VideoPlayer:GetConnectedWires + summary: '' + description: '' + code_samples: [] + parameters: + - name: pin + type: string + default: + summary: '' + returns: + - type: Instances + summary: '' + tags: [] + deprecation_message: '' + security: None + thread_safety: Unsafe + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer:Play + summary: '' + description: '' + code_samples: [] + parameters: [] + returns: + - type: void + summary: '' + tags: [] + deprecation_message: '' + security: None + thread_safety: Unsafe + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer:SetStudioPreview + summary: '' + description: '' + code_samples: [] + parameters: + - name: isPreview + type: bool + default: + summary: '' + returns: + - type: void + summary: '' + tags: [] + deprecation_message: '' + security: RobloxScriptSecurity + thread_safety: Unsafe + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer:Stop + summary: '' + description: '' + code_samples: [] + parameters: [] + returns: + - type: void + summary: '' + tags: [] + deprecation_message: '' + security: None + thread_safety: Unsafe + capabilities: [] + writeCapabilities: [] +events: + - name: VideoPlayer.Ended + summary: '' + description: '' + code_samples: [] + parameters: [] + tags: [] + deprecation_message: '' + security: None + thread_safety: Unsafe + capabilities: [] + writeCapabilities: [] + - name: VideoPlayer.Looped + summary: '' + description: '' + code_samples: [] + parameters: [] + tags: [] + deprecation_message: '' + security: None + thread_safety: Unsafe + capabilities: [] + writeCapabilities: [] +callbacks: [] diff --git a/content/en-us/reference/engine/classes/VoiceChatService.yaml b/content/en-us/reference/engine/classes/VoiceChatService.yaml index 497efd439..493cbef05 100644 --- a/content/en-us/reference/engine/classes/VoiceChatService.yaml +++ b/content/en-us/reference/engine/classes/VoiceChatService.yaml @@ -80,6 +80,20 @@ properties: capabilities: [] writeCapabilities: [] methods: + - name: VoiceChatService:rejoinVoice + summary: '' + description: '' + code_samples: [] + parameters: [] + returns: + - type: void + summary: '' + tags: [] + deprecation_message: '' + security: RobloxScriptSecurity + thread_safety: Unsafe + capabilities: [] + writeCapabilities: [] - name: VoiceChatService:IsVoiceEnabledForUserIdAsync summary: | Returns whether or not the given user has voice enabled. diff --git a/content/en-us/reference/engine/classes/Workspace.yaml b/content/en-us/reference/engine/classes/Workspace.yaml index a2b3bb071..397df0a22 100644 --- a/content/en-us/reference/engine/classes/Workspace.yaml +++ b/content/en-us/reference/engine/classes/Workspace.yaml @@ -1175,30 +1175,30 @@ methods: summary: | Returns the server's Unix time in seconds. description: | - `Class.Workspace:GetServerTimeNow()|GetServerTimeNow()` returns the client's best approximation of the - current time on the server. This is useful for creating synchronized - experiences as every client will get about the same results regardless of - their timezone or local clock. + `Class.Workspace:GetServerTimeNow()|GetServerTimeNow()` returns the + client's best approximation of the current time on the server. This is + useful for creating synchronized experiences as every client will get + about the same results regardless of their timezone or local clock. This returns a Unix timestamp, similar to `Library.os|os.time()`, that can be used with `Library.os|os.date()` or with `Datatype.DateTime.fromUnixTimestamp()`. The timestamp returned by this function is smoothed so that: - + - It is monotonic; its value will never decrease. - It moves at the same rate as the local clock to within 0.6%. - `Class.Workspace:GetServerTimeNow()|GetServerTimeNow()` is expensive - to call compared to `Datatype.DateTime.now()`, and is less precise than + `Class.Workspace:GetServerTimeNow()|GetServerTimeNow()` is expensive to + call compared to `Datatype.DateTime.now()`, and is less precise than `Library.os|os.clock()`, so it should be used to make sure an event starts at the right real world time or to adjust things periodically to keep a series of events in sync. - + This function relies on the server, so calling it from a client that isn't - connected will throw an error. Also note that this function is not suitable - for things like timed rewards as it is not secure compared to tracking - such timers on the server. + connected will throw an error. Also note that this function is not + suitable for things like timed rewards as it is not secure compared to + tracking such timers on the server. See also: diff --git a/content/en-us/reference/engine/datatypes/CatalogSearchParams.yaml b/content/en-us/reference/engine/datatypes/CatalogSearchParams.yaml index 67b6db6b4..51892283c 100644 --- a/content/en-us/reference/engine/datatypes/CatalogSearchParams.yaml +++ b/content/en-us/reference/engine/datatypes/CatalogSearchParams.yaml @@ -141,10 +141,30 @@ properties: - name: CatalogSearchParams.CreatorName type: string summary: | - Search for items with the given creator. + Search for items with the given creator name. default: '' description: | - Search for items with the given creator. + Search for items with the given creator name. Specify whether to search users, groups, or both with `Datatype.CatalogSearchParams.CreatorType`. + code_samples: [] + tags: [] + deprecation_message: '' + - name: CatalogSearchParams.CreatorType + type: Enum.CreatorTypeFilter + summary: | + Search for items created by the given creator type. + default: Enum.CreatorTypeFilter.All + description: | + Search for items created by the given creator type. When unspecified, it defaults to returning creations from both `Enum.CreatorTypeFilter.User` and `Enum.CreatorTypeFilter.Group`. Searching by `Datatype.CatalogSearchParams.CreatorId` with `Enum.CreatorTypeFilter.All` results in a HTTP 400 Bad Request error. + code_samples: [] + tags: [] + deprecation_message: '' + - name: CatalogSearchParams.CreatorId + type: number + summary: | + Search for items created by the given creator ID. + default: 0 + description: | + Search for items created by the single creator ID. Specify user or group with `Datatype.CatalogSearchParams.CreatorType`. Searching by creator ID **and** creator name is not supported; specify one, not both. code_samples: [] tags: [] deprecation_message: '' diff --git a/content/en-us/reference/engine/datatypes/Random.yaml b/content/en-us/reference/engine/datatypes/Random.yaml index 58f7f6d14..d67254939 100644 --- a/content/en-us/reference/engine/datatypes/Random.yaml +++ b/content/en-us/reference/engine/datatypes/Random.yaml @@ -55,7 +55,7 @@ methods: summary: | Returns a pseudorandom number uniformly distributed over `[0, 1]`. description: | - Returns a uniform pseudorandom real number in the range of 0 to 1, + Returns a uniform pseudorandom real number in the range of 0 to 1, inclusive. parameters: returns: @@ -68,8 +68,8 @@ methods: summary: | Returns a pseudorandom number uniformly distributed over `[min, max]`. description: | - Returns a uniform pseudorandom real number in the range of `min` to - `max`, inclusive. + Returns a uniform pseudorandom real number in the range of `min` to `max`, + inclusive. parameters: - name: min type: number diff --git a/content/en-us/reference/engine/datatypes/UDim.yaml b/content/en-us/reference/engine/datatypes/UDim.yaml index 4915fe38c..91cf26383 100644 --- a/content/en-us/reference/engine/datatypes/UDim.yaml +++ b/content/en-us/reference/engine/datatypes/UDim.yaml @@ -50,9 +50,11 @@ functions: math_operations: - operation: + summary: | - Produces a `Datatype.UDim` representing the sum of the two `Datatype.UDim` values. + Produces a `Datatype.UDim` representing the sum of the two `Datatype.UDim` + values. description: | - Produces a `Datatype.UDim` representing the sum of the two `Datatype.UDim` values. + Produces a `Datatype.UDim` representing the sum of the two `Datatype.UDim` + values. type_a: UDim type_b: UDim return_type: UDim @@ -61,11 +63,11 @@ math_operations: deprecation_message: '' - operation: '-' summary: | - Produces a `Datatype.UDim` representing the difference between the two `Datatype.UDim` - values. + Produces a `Datatype.UDim` representing the difference between the two + `Datatype.UDim` values. description: | - Produces a `Datatype.UDim` representing the difference between the two `Datatype.UDim` - values. + Produces a `Datatype.UDim` representing the difference between the two + `Datatype.UDim` values. type_a: UDim type_b: UDim return_type: UDim diff --git a/content/en-us/reference/engine/datatypes/UDim2.yaml b/content/en-us/reference/engine/datatypes/UDim2.yaml index 71a22017f..d97f240a2 100644 --- a/content/en-us/reference/engine/datatypes/UDim2.yaml +++ b/content/en-us/reference/engine/datatypes/UDim2.yaml @@ -165,11 +165,12 @@ properties: methods: - name: UDim2:Lerp summary: | - Returns a `Datatype.UDim2` interpolated linearly between the value and the given - goal. + Returns a `Datatype.UDim2` interpolated linearly between the value and the + given goal. description: | - Returns a `Datatype.UDim2` interpolated linearly between this `Datatype.UDim2` and the given - `goal`. The `alpha` value should be a number between `0` and `1`. + Returns a `Datatype.UDim2` interpolated linearly between this + `Datatype.UDim2` and the given `goal`. The `alpha` value should be a + number between `0` and `1`. parameters: - name: goal type: UDim2 @@ -189,11 +190,11 @@ functions: math_operations: - operation: + summary: | - Produces a `Datatype.UDim2` with components that are the sum of the respective - components of the two `Datatype.UDim2` objects. + Produces a `Datatype.UDim2` with components that are the sum of the + respective components of the two `Datatype.UDim2` objects. description: | - Produces a `Datatype.UDim2` with components that are the sum of the respective - components of the two `Datatype.UDim2` objects. + Produces a `Datatype.UDim2` with components that are the sum of the + respective components of the two `Datatype.UDim2` objects. type_a: UDim2 type_b: UDim2 return_type: UDim2 diff --git a/content/en-us/reference/engine/enums/DeviceForm.yaml b/content/en-us/reference/engine/enums/DeviceForm.yaml new file mode 100644 index 000000000..77b23c380 --- /dev/null +++ b/content/en-us/reference/engine/enums/DeviceForm.yaml @@ -0,0 +1,33 @@ +name: DeviceForm +type: enum +summary: '' +description: '' +code_samples: [] +tags: [] +deprecation_message: '' +items: + - name: Console + summary: '' + value: 0 + tags: [] + deprecation_message: '' + - name: Phone + summary: '' + value: 1 + tags: [] + deprecation_message: '' + - name: Tablet + summary: '' + value: 2 + tags: [] + deprecation_message: '' + - name: Desktop + summary: '' + value: 3 + tags: [] + deprecation_message: '' + - name: VR + summary: '' + value: 4 + tags: [] + deprecation_message: '' diff --git a/content/en-us/reference/engine/enums/Intent.yaml b/content/en-us/reference/engine/enums/LightingStyle.yaml similarity index 87% rename from content/en-us/reference/engine/enums/Intent.yaml rename to content/en-us/reference/engine/enums/LightingStyle.yaml index d6b1f0a46..ee188285c 100644 --- a/content/en-us/reference/engine/enums/Intent.yaml +++ b/content/en-us/reference/engine/enums/LightingStyle.yaml @@ -1,4 +1,4 @@ -name: Intent +name: LightingStyle type: enum summary: '' description: '' @@ -11,7 +11,7 @@ items: value: 0 tags: [] deprecation_message: '' - - name: Flat + - name: Soft summary: '' value: 1 tags: [] diff --git a/content/en-us/reference/engine/enums/Quality.yaml b/content/en-us/reference/engine/enums/Quality.yaml deleted file mode 100644 index 4b4054898..000000000 --- a/content/en-us/reference/engine/enums/Quality.yaml +++ /dev/null @@ -1,18 +0,0 @@ -name: Quality -type: enum -summary: '' -description: '' -code_samples: [] -tags: [] -deprecation_message: '' -items: - - name: Performance - summary: '' - value: 0 - tags: [] - deprecation_message: '' - - name: Quality - summary: '' - value: 1 - tags: [] - deprecation_message: ''