Skip to content

Commit

Permalink
update Open Source Docs from Roblox internal teams
Browse files Browse the repository at this point in the history
  • Loading branch information
rbx-open-source-docs[bot] committed Dec 5, 2024
1 parent 144bff6 commit 55fb5c3
Show file tree
Hide file tree
Showing 61 changed files with 1,251 additions and 772 deletions.
2 changes: 1 addition & 1 deletion .husky/post-checkout
Original file line number Diff line number Diff line change
@@ -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 "$@"
2 changes: 1 addition & 1 deletion .husky/post-commit
Original file line number Diff line number Diff line change
@@ -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 "$@"
2 changes: 1 addition & 1 deletion .husky/post-merge
Original file line number Diff line number Diff line change
@@ -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 "$@"
2 changes: 1 addition & 1 deletion .husky/pre-push
Original file line number Diff line number Diff line change
@@ -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 "$@"
30 changes: 20 additions & 10 deletions content/common/navigation/engine/reference.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
157 changes: 99 additions & 58 deletions content/en-us/reference/engine/classes/AssetService.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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.
Expand Down
11 changes: 5 additions & 6 deletions content/en-us/reference/engine/classes/Attachment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading

0 comments on commit 55fb5c3

Please sign in to comment.