Skip to content

Commit 55fb5c3

Browse files
update Open Source Docs from Roblox internal teams
1 parent 144bff6 commit 55fb5c3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+1251
-772
lines changed

.husky/post-checkout

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/bin/sh
2-
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; }
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; }
33
git lfs post-checkout "$@"

.husky/post-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/bin/sh
2-
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; }
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; }
33
git lfs post-commit "$@"

.husky/post-merge

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/bin/sh
2-
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; }
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; }
33
git lfs post-merge "$@"

.husky/pre-push

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/bin/sh
2-
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; }
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; }
33
git lfs pre-push "$@"

content/common/navigation/engine/reference.yaml

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1710,6 +1710,11 @@ navigation:
17101710
type: engineapi
17111711
source: /reference/engine/classes/PathfindingService.yaml
17121712
ignoreTranslation: true
1713+
- title: PerformanceControlService
1714+
path: /reference/engine/classes/PerformanceControlService
1715+
type: engineapi
1716+
source: /reference/engine/classes/PerformanceControlService.yaml
1717+
ignoreTranslation: true
17131718
- title: PermissionsService
17141719
path: /reference/engine/classes/PermissionsService
17151720
type: engineapi
@@ -2895,6 +2900,11 @@ navigation:
28952900
type: engineapi
28962901
source: /reference/engine/classes/VideoFrame.yaml
28972902
ignoreTranslation: true
2903+
- title: VideoPlayer
2904+
path: /reference/engine/classes/VideoPlayer
2905+
type: engineapi
2906+
source: /reference/engine/classes/VideoPlayer.yaml
2907+
ignoreTranslation: true
28982908
- title: VideoService
28992909
path: /reference/engine/classes/VideoService
29002910
type: engineapi
@@ -3838,6 +3848,11 @@ navigation:
38383848
type: engineapi
38393849
source: /reference/engine/enums/DeviceFeatureType.yaml
38403850
ignoreTranslation: true
3851+
- title: DeviceForm
3852+
path: /reference/engine/enums/DeviceForm
3853+
type: engineapi
3854+
source: /reference/engine/enums/DeviceForm.yaml
3855+
ignoreTranslation: true
38413856
- title: DeviceLevel
38423857
path: /reference/engine/enums/DeviceLevel
38433858
type: engineapi
@@ -4208,11 +4223,6 @@ navigation:
42084223
type: engineapi
42094224
source: /reference/engine/enums/InputType.yaml
42104225
ignoreTranslation: true
4211-
- title: Intent
4212-
path: /reference/engine/enums/Intent
4213-
type: engineapi
4214-
source: /reference/engine/enums/Intent.yaml
4215-
ignoreTranslation: true
42164226
- title: InterpolationThrottlingMode
42174227
path: /reference/engine/enums/InterpolationThrottlingMode
42184228
type: engineapi
@@ -4273,6 +4283,11 @@ navigation:
42734283
type: engineapi
42744284
source: /reference/engine/enums/LexemeType.yaml
42754285
ignoreTranslation: true
4286+
- title: LightingStyle
4287+
path: /reference/engine/enums/LightingStyle
4288+
type: engineapi
4289+
source: /reference/engine/enums/LightingStyle.yaml
4290+
ignoreTranslation: true
42764291
- title: Limb
42774292
path: /reference/engine/enums/Limb
42784293
type: engineapi
@@ -4668,11 +4683,6 @@ navigation:
46684683
type: engineapi
46694684
source: /reference/engine/enums/ProximityPromptStyle.yaml
46704685
ignoreTranslation: true
4671-
- title: Quality
4672-
path: /reference/engine/enums/Quality
4673-
type: engineapi
4674-
source: /reference/engine/enums/Quality.yaml
4675-
ignoreTranslation: true
46764686
- title: QualityLevel
46774687
path: /reference/engine/enums/QualityLevel
46784688
type: engineapi

content/en-us/reference/engine/classes/AssetService.yaml

Lines changed: 99 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,105 @@ tags:
1717
deprecation_message: ''
1818
properties: []
1919
methods:
20+
- name: AssetService:CreateAssetAsync
21+
summary: |
22+
Creates a new asset from the given object.
23+
description: |
24+
Creates a new asset from the given object in Plugin or Open Cloud Luau Execution context.
25+
code_samples:
26+
- AssetService-CreateAssetAsync
27+
parameters:
28+
- name: object
29+
type: Object
30+
default:
31+
summary: |
32+
The object to be created as an asset.
33+
- name: assetType
34+
type: AssetType
35+
default:
36+
summary: |
37+
Currently supported types are:
38+
39+
- `Enum.AssetType.Model` – with `object` as any valid `Class.Instance` root.
40+
- `Enum.AssetType.Plugin` – with `object` as any valid `Class.Instance` root.
41+
- `Enum.AssetType.Mesh` – with `object` as any valid `Class.EditableMesh` root.
42+
- `Enum.AssetType.Image` – with `object` as any valid `Class.EditableImage` root.
43+
- name: options
44+
type: Dictionary?
45+
default:
46+
summary: |
47+
Options table containing asset metadata:
48+
49+
- `Name` – Name of the asset as a string. Defaults to `[object.Name]`.
50+
- `Description` – Description of the asset as a string. Defaults to `"Created with AssetService:CreateAssetAsync"`.
51+
- `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.
52+
- `CreatorType` – `Enum.AssetCreatorType` indicating the type of asset creator. Defaults to `Enum.AssetCreatorType.User` in Plugin context. Required for Open Cloud Luau Execution context.
53+
- `IsPackage` – Boolean value, only applicable to the `Enum.AssetType.Model` type. Defaults to `true`.
54+
returns:
55+
- type: Tuple
56+
summary: |
57+
The `Enum.CreateAssetResult` and asset ID pair if successful.
58+
tags:
59+
- Yields
60+
deprecation_message: ''
61+
security: None
62+
thread_safety: Unsafe
63+
capabilities:
64+
- PluginOrOpenCloud
65+
writeCapabilities:
66+
- PluginOrOpenCloud
67+
- name: AssetService:CreateAssetVersionAsync
68+
summary: |
69+
Creates a new version for an existing asset from the given object.
70+
description: |
71+
Creates a new version for an existing asset from the given object in Plugin or Open Cloud Luau Execution context.
72+
code_samples:
73+
- AssetService-CreateAssetVersionAsync
74+
parameters:
75+
- name: object
76+
type: Object
77+
default:
78+
summary: |
79+
The object to be created as an asset.
80+
- name: assetType
81+
type: AssetType
82+
default:
83+
summary: |
84+
Currently supported types are:
85+
86+
- `Enum.AssetType.Model` – with `object` as any valid `Class.Instance` root.
87+
- `Enum.AssetType.Plugin` – with `object` as any valid `Class.Instance` root.
88+
- `Enum.AssetType.Mesh` – with `object` as any valid `Class.EditableMesh` root.
89+
- `Enum.AssetType.Image` – with `object` as any valid `Class.EditableImage` root.
90+
- name: targetAssetId
91+
type: int64
92+
default:
93+
summary: |
94+
The ID of the asset for the new version.
95+
- name: options
96+
type: Dictionary?
97+
default:
98+
summary: |
99+
Options table containing asset metadata:
100+
101+
- `Name` – A `string`. Name of the asset. Default: object.Name.
102+
- `Description` – A `string`. Description of the asset. Default: "Created with AssetService:CreateAssetAsync".
103+
- `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.
104+
- `CreatorType` – A `Enum.AssetCreatorType`. Type of asset creator. Default: `Enum.AssetCreatorType.User` in Plugin context. Required for Open Cloud Luau Execution context.
105+
- `IsPackage` – A `bool`. Only applicable to the `Enum.AssetType.Model` type. Default: true.
106+
returns:
107+
- type: Tuple
108+
summary: |
109+
The `Enum.CreateAssetResult` and asset version number pair if successful.
110+
tags:
111+
- Yields
112+
deprecation_message: ''
113+
security: None
114+
thread_safety: Unsafe
115+
capabilities:
116+
- PluginOrOpenCloud
117+
writeCapabilities:
118+
- PluginOrOpenCloud
20119
- name: AssetService:CreateEditableImage
21120
summary: |
22121
Creates a new `Class.EditableImage`.
@@ -88,64 +187,6 @@ methods:
88187
thread_safety: Unsafe
89188
capabilities: []
90189
writeCapabilities: []
91-
- name: AssetService:CreateAssetAsync
92-
summary: ''
93-
description: ''
94-
code_samples: []
95-
parameters:
96-
- name: object
97-
type: Object
98-
default:
99-
summary: ''
100-
- name: assetType
101-
type: AssetType
102-
default:
103-
summary: ''
104-
- name: requestParameters
105-
type: Dictionary
106-
default: nil
107-
summary: ''
108-
returns:
109-
- type: Tuple
110-
summary: ''
111-
tags:
112-
- Yields
113-
deprecation_message: ''
114-
security: None
115-
thread_safety: Unsafe
116-
capabilities: []
117-
writeCapabilities: []
118-
- name: AssetService:CreateAssetVersionAsync
119-
summary: ''
120-
description: ''
121-
code_samples: []
122-
parameters:
123-
- name: object
124-
type: Object
125-
default:
126-
summary: ''
127-
- name: assetType
128-
type: AssetType
129-
default:
130-
summary: ''
131-
- name: assetId
132-
type: int64
133-
default:
134-
summary: ''
135-
- name: requestParameters
136-
type: Dictionary
137-
default: nil
138-
summary: ''
139-
returns:
140-
- type: Tuple
141-
summary: ''
142-
tags:
143-
- Yields
144-
deprecation_message: ''
145-
security: None
146-
thread_safety: Unsafe
147-
capabilities: []
148-
writeCapabilities: []
149190
- name: AssetService:CreateEditableImageAsync
150191
summary: |
151192
Creates a new `Class.EditableImage` object populated with the given image.

content/en-us/reference/engine/classes/Attachment.yaml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@ summary: |
77
`Class.Bone`, or another `Class.Attachment`.
88
description: |
99
An `Attachment` defines a point and orientation relative to a parent
10-
`Class.BasePart`, `Class.Bone`, or another `Attachment`. The offset is
11-
stored in the `Class.Attachment.CFrame|CFrame` property. The offset can also
12-
be set through other properties, such as
13-
`Class.Attachment.WorldCFrame|WorldCFrame`.
10+
`Class.BasePart`, `Class.Bone`, or another `Attachment`. The offset is stored
11+
in the `Class.Attachment.CFrame|CFrame` property. The offset can also be set
12+
through other properties, such as `Class.Attachment.WorldCFrame|WorldCFrame`.
1413
1514
Attachments are used by several kinds of `Class.Constraint|Constraints` and
1615
are also valid alternatives to `Class.BasePart` as a parent for objects such
@@ -303,8 +302,8 @@ properties:
303302
- Deprecated
304303
deprecation_message: |
305304
This item has been superseded by
306-
`Class.Attachment.WorldOrientation|WorldOrientation` which
307-
should be used in new work.
305+
`Class.Attachment.WorldOrientation|WorldOrientation` which should be used
306+
in new work.
308307
security:
309308
read: None
310309
write: None

0 commit comments

Comments
 (0)