Skip to content

Commit 97bfc9b

Browse files
rbx-open-source-docs[bot]rbx-open-source-docs[bot]
committed
update Open Source Docs from Roblox internal teams
1 parent 152cb54 commit 97bfc9b

31 files changed

+396
-269
lines changed

‎content/common/navigation/engine/reference.yaml‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -930,6 +930,11 @@ navigation:
930930
type: engineapi
931931
source: /reference/engine/classes/Feature.yaml
932932
ignoreTranslation: true
933+
- title: FeatureRestrictionManager
934+
path: /reference/engine/classes/FeatureRestrictionManager
935+
type: engineapi
936+
source: /reference/engine/classes/FeatureRestrictionManager.yaml
937+
ignoreTranslation: true
933938
- title: File
934939
path: /reference/engine/classes/File
935940
type: engineapi
@@ -1995,6 +2000,11 @@ navigation:
19952000
type: engineapi
19962001
source: /reference/engine/classes/ReflectionMetadataYieldFunctions.yaml
19972002
ignoreTranslation: true
2003+
- title: RelativeGui
2004+
path: /reference/engine/classes/RelativeGui
2005+
type: engineapi
2006+
source: /reference/engine/classes/RelativeGui.yaml
2007+
ignoreTranslation: true
19982008
- title: RemoteDebuggerServer
19992009
path: /reference/engine/classes/RemoteDebuggerServer
20002010
type: engineapi
@@ -3778,11 +3788,6 @@ navigation:
37783788
type: engineapi
37793789
source: /reference/engine/enums/CreatorTypeFilter.yaml
37803790
ignoreTranslation: true
3781-
- title: CSGAsyncDynamicCollision
3782-
path: /reference/engine/enums/CSGAsyncDynamicCollision
3783-
type: engineapi
3784-
source: /reference/engine/enums/CSGAsyncDynamicCollision.yaml
3785-
ignoreTranslation: true
37863791
- title: CurrencyType
37873792
path: /reference/engine/enums/CurrencyType
37883793
type: engineapi

‎content/en-us/reference/engine/classes/AdService.yaml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ memory_category: Instances
55
summary: |
66
A class that allows the display of mobile video ads.
77
description: |
8-
This `Class.AdService` was a service for displaying mobile video ads as a form of
9-
monetization. It has been superseded by [Immersive Ads](../../../production/monetization/immersive-ads.md)
10-
which should be used instead to serve ad units to visitors of your experience.
8+
This `Class.AdService` was a service for displaying mobile video ads as a form
9+
of monetization. It has been superseded by
10+
[Immersive Ads](../../../production/monetization/immersive-ads.md) which
11+
should be used instead to serve ad units to visitors of your experience.
1112
code_samples:
1213
inherits:
1314
- Instance

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

Lines changed: 100 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,85 @@ tags:
1717
deprecation_message: ''
1818
properties: []
1919
methods:
20+
- name: AssetService:CreateEditableImage
21+
summary: |
22+
Creates a new `Class.EditableImage`.
23+
description: |
24+
Creates a new `Class.EditableImage`. By default, the resolution is set at
25+
512×512, but you can specify a different size using the method's
26+
option table.
27+
28+
If the device‑specific editable memory budget is exhausted, creation fails
29+
and this method returns `nil`.
30+
code_samples: []
31+
parameters:
32+
- name: editableImageOptions
33+
type: Dictionary?
34+
default:
35+
summary: |
36+
Options table containing controls for the method:
37+
38+
- `Size` – A `Datatype.Vector2` that specifies the image's desired
39+
width and height.
40+
returns:
41+
- type: Object
42+
summary: ''
43+
tags: []
44+
deprecation_message: ''
45+
security: None
46+
thread_safety: Unsafe
47+
capabilities: []
48+
writeCapabilities: []
49+
- name: AssetService:CreateEditableMesh
50+
summary: |
51+
Creates a new, empty `Class.EditableMesh`.
52+
description: |
53+
Creates a new, empty `Class.EditableMesh`. Vertices, triangles and their
54+
attributes can be added dynamically to it. If the device‑specific editable
55+
memory budget is exhausted, creation will fail and this method will return
56+
`nil`.
57+
code_samples: []
58+
parameters:
59+
- name: editableMeshOptions
60+
type: Dictionary?
61+
default:
62+
summary: ''
63+
returns:
64+
- type: Object
65+
summary: ''
66+
tags: []
67+
deprecation_message: ''
68+
security: None
69+
thread_safety: Unsafe
70+
capabilities: []
71+
writeCapabilities: []
72+
- name: AssetService:CheckTextureAlphaAsync
73+
summary: ''
74+
description: ''
75+
code_samples: []
76+
parameters:
77+
- name: textureId
78+
type: ContentId
79+
default:
80+
summary: ''
81+
returns:
82+
- type: bool
83+
summary: ''
84+
tags:
85+
- Yields
86+
deprecation_message: ''
87+
security: RobloxScriptSecurity
88+
thread_safety: Unsafe
89+
capabilities: []
90+
writeCapabilities: []
2091
- name: AssetService:CreateAssetAsync
2192
summary: |
2293
Creates a new asset from the given object.
2394
description: |
24-
Creates a new asset from the given object in Plugin or Open Cloud Luau Execution context.
95+
Creates a new asset from the given object in Plugin or Open Cloud Luau
96+
Execution context.
2597
code_samples:
26-
- AssetService-CreateAssetAsync
98+
- AssetService-CreateAssetAsync
2799
parameters:
28100
- name: object
29101
type: Object
@@ -35,17 +107,19 @@ methods:
35107
default:
36108
summary: |
37109
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?
110+
- `Enum.AssetType.Model` – with `object` as any valid `Class.Instance`
111+
root.
112+
- `Enum.AssetType.Plugin` – with `object` as any valid
113+
`Class.Instance` root.
114+
- `Enum.AssetType.Mesh` – with `object` as any valid
115+
`Class.EditableMesh` root.
116+
- `Enum.AssetType.Image` – with `object` as any valid
117+
`Class.EditableImage` root.
118+
- name: requestParameters
119+
type: Dictionary
45120
default:
46121
summary: |
47122
Options table containing asset metadata:
48-
49123
- `Name` – Name of the asset as a string. Defaults to `[object.Name]`.
50124
- `Description` – Description of the asset as a string. Defaults to `"Created with AssetService:CreateAssetAsync"`.
51125
- `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.
@@ -68,9 +142,10 @@ methods:
68142
summary: |
69143
Creates a new version for an existing asset from the given object.
70144
description: |
71-
Creates a new version for an existing asset from the given object in Plugin or Open Cloud Luau Execution context.
145+
Creates a new version for an existing asset from the given object in
146+
Plugin or Open Cloud Luau Execution context.
72147
code_samples:
73-
- AssetService-CreateAssetVersionAsync
148+
- AssetService-CreateAssetVersionAsync
74149
parameters:
75150
- name: object
76151
type: Object
@@ -82,22 +157,24 @@ methods:
82157
default:
83158
summary: |
84159
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
160+
- `Enum.AssetType.Model` – with `object` as any valid `Class.Instance`
161+
root.
162+
- `Enum.AssetType.Plugin` – with `object` as any valid
163+
`Class.Instance` root.
164+
- `Enum.AssetType.Mesh` – with `object` as any valid
165+
`Class.EditableMesh` root.
166+
- `Enum.AssetType.Image` – with `object` as any valid
167+
`Class.EditableImage` root.
168+
- name: assetId
91169
type: int64
92170
default:
93171
summary: |
94172
The ID of the asset for the new version.
95-
- name: options
96-
type: Dictionary?
173+
- name: requestParameters
174+
type: Dictionary
97175
default:
98176
summary: |
99177
Options table containing asset metadata:
100-
101178
- `Name` – A `string`. Name of the asset. Default: object.Name.
102179
- `Description` – A `string`. Description of the asset. Default: "Created with AssetService:CreateAssetAsync".
103180
- `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.
@@ -106,7 +183,8 @@ methods:
106183
returns:
107184
- type: Tuple
108185
summary: |
109-
The `Enum.CreateAssetResult` and asset version number pair if successful.
186+
The `Enum.CreateAssetResult` and asset version number pair if
187+
successful.
110188
tags:
111189
- Yields
112190
deprecation_message: ''
@@ -116,77 +194,6 @@ methods:
116194
- PluginOrOpenCloud
117195
writeCapabilities:
118196
- PluginOrOpenCloud
119-
- name: AssetService:CreateEditableImage
120-
summary: |
121-
Creates a new `Class.EditableImage`.
122-
description: |
123-
Creates a new `Class.EditableImage`. By default, the resolution is set at
124-
512×512, but you can specify a different size using the method's
125-
option table.
126-
127-
If the device‑specific editable memory budget is exhausted, creation fails
128-
and this method returns `nil`.
129-
code_samples: []
130-
parameters:
131-
- name: editableImageOptions
132-
type: Dictionary?
133-
default:
134-
summary: |
135-
Options table containing controls for the method:
136-
137-
- `Size` – A `Datatype.Vector2` that specifies the image's desired
138-
width and height.
139-
returns:
140-
- type: Object
141-
summary: ''
142-
tags: []
143-
deprecation_message: ''
144-
security: None
145-
thread_safety: Unsafe
146-
capabilities: []
147-
writeCapabilities: []
148-
- name: AssetService:CreateEditableMesh
149-
summary: |
150-
Creates a new, empty `Class.EditableMesh`.
151-
description: |
152-
Creates a new, empty `Class.EditableMesh`. Vertices, triangles and their
153-
attributes can be added dynamically to it. If the device‑specific editable
154-
memory budget is exhausted, creation will fail and this method will return
155-
`nil`.
156-
code_samples: []
157-
parameters:
158-
- name: editableMeshOptions
159-
type: Dictionary?
160-
default:
161-
summary: ''
162-
returns:
163-
- type: Object
164-
summary: ''
165-
tags: []
166-
deprecation_message: ''
167-
security: None
168-
thread_safety: Unsafe
169-
capabilities: []
170-
writeCapabilities: []
171-
- name: AssetService:CheckTextureAlphaAsync
172-
summary: ''
173-
description: ''
174-
code_samples: []
175-
parameters:
176-
- name: textureId
177-
type: ContentId
178-
default:
179-
summary: ''
180-
returns:
181-
- type: bool
182-
summary: ''
183-
tags:
184-
- Yields
185-
deprecation_message: ''
186-
security: RobloxScriptSecurity
187-
thread_safety: Unsafe
188-
capabilities: []
189-
writeCapabilities: []
190197
- name: AssetService:CreateEditableImageAsync
191198
summary: |
192199
Creates a new `Class.EditableImage` object populated with the given image.

‎content/en-us/reference/engine/classes/AudioAnalyzer.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,8 @@ events:
156156
type: Wire
157157
default:
158158
summary: |
159-
The `Class.Wire` between the `Class.AudioAnalyzer` and the other instance.
159+
The `Class.Wire` between the `Class.AudioAnalyzer` and the other
160+
instance.
160161
- name: instance
161162
type: Instance
162163
default:

‎content/en-us/reference/engine/classes/AudioChorus.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,8 @@ events:
153153
type: Wire
154154
default:
155155
summary: |
156-
The `Class.Wire` between the `Class.AudioChorus` and the other instance.
156+
The `Class.Wire` between the `Class.AudioChorus` and the other
157+
instance.
157158
- name: instance
158159
type: Instance
159160
default:

‎content/en-us/reference/engine/classes/AudioCompressor.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,8 @@ events:
211211
type: Wire
212212
default:
213213
summary: |
214-
The `Class.Wire` between the `Class.AudioCompressor` and the other instance.
214+
The `Class.Wire` between the `Class.AudioCompressor` and the other
215+
instance.
215216
- name: instance
216217
type: Instance
217218
default:

‎content/en-us/reference/engine/classes/AudioDeviceInput.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,8 @@ events:
273273
type: Wire
274274
default:
275275
summary: |
276-
The `Class.Wire` between the `Class.AudioDeviceInput` and the other instance.
276+
The `Class.Wire` between the `Class.AudioDeviceInput` and the other
277+
instance.
277278
- name: instance
278279
type: Instance
279280
default:

‎content/en-us/reference/engine/classes/AudioDeviceOutput.yaml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,14 @@ events:
8282
type: string
8383
default:
8484
summary: |
85-
The pin on the `Class.AudioDeviceOutput` that the `Class.Wire` targets.
85+
The pin on the `Class.AudioDeviceOutput` that the `Class.Wire`
86+
targets.
8687
- name: wire
8788
type: Wire
8889
default:
8990
summary: |
90-
The `Class.Wire` between the `Class.AudioDeviceOutput` and the other instance.
91+
The `Class.Wire` between the `Class.AudioDeviceOutput` and the other
92+
instance.
9193
- name: instance
9294
type: Instance
9395
default:

‎content/en-us/reference/engine/classes/AudioDistortion.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,8 @@ events:
102102
type: Wire
103103
default:
104104
summary: |
105-
The `Class.Wire` between the `Class.AudioDistortion` and the other instance.
105+
The `Class.Wire` between the `Class.AudioDistortion` and the other
106+
instance.
106107
- name: instance
107108
type: Instance
108109
default:

‎content/en-us/reference/engine/classes/AudioEmitter.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,8 @@ events:
320320
type: Wire
321321
default:
322322
summary: |
323-
The `Class.Wire` between the `Class.AudioEmitter` and the other instance.
323+
The `Class.Wire` between the `Class.AudioEmitter` and the other
324+
instance.
324325
- name: instance
325326
type: Instance
326327
default:

0 commit comments

Comments
 (0)