Skip to content

Commit cd8fd83

Browse files
update Open Source Docs from Roblox internal teams
1 parent 20c1df8 commit cd8fd83

19 files changed

+330
-38
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -943,6 +943,11 @@ navigation:
943943
type: engineapi
944944
source: /reference/engine/classes/FaceInstance.yaml
945945
ignoreTranslation: true
946+
- title: FacialAgeEstimationService
947+
path: /reference/engine/classes/FacialAgeEstimationService
948+
type: engineapi
949+
source: /reference/engine/classes/FacialAgeEstimationService.yaml
950+
ignoreTranslation: true
946951
- title: Feature
947952
path: /reference/engine/classes/Feature
948953
type: engineapi
@@ -2543,6 +2548,11 @@ navigation:
25432548
type: engineapi
25442549
source: /reference/engine/classes/SyncScriptBuilder.yaml
25452550
ignoreTranslation: true
2551+
- title: SystemThemeService
2552+
path: /reference/engine/classes/SystemThemeService
2553+
type: engineapi
2554+
source: /reference/engine/classes/SystemThemeService.yaml
2555+
ignoreTranslation: true
25462556
- title: TaskScheduler
25472557
path: /reference/engine/classes/TaskScheduler
25482558
type: engineapi
@@ -3431,10 +3441,10 @@ navigation:
34313441
type: engineapi
34323442
source: /reference/engine/enums/AnnotationEditingMode.yaml
34333443
ignoreTranslation: true
3434-
- title: AnnotationRequestResult
3435-
path: /reference/engine/enums/AnnotationRequestResult
3444+
- title: AnnotationRequestStatus
3445+
path: /reference/engine/enums/AnnotationRequestStatus
34363446
type: engineapi
3437-
source: /reference/engine/enums/AnnotationRequestResult.yaml
3447+
source: /reference/engine/enums/AnnotationRequestStatus.yaml
34383448
ignoreTranslation: true
34393449
- title: AnnotationRequestType
34403450
path: /reference/engine/enums/AnnotationRequestType
@@ -4021,6 +4031,11 @@ navigation:
40214031
type: engineapi
40224032
source: /reference/engine/enums/ExplosionType.yaml
40234033
ignoreTranslation: true
4034+
- title: FacialAgeEstimationResultType
4035+
path: /reference/engine/enums/FacialAgeEstimationResultType
4036+
type: engineapi
4037+
source: /reference/engine/enums/FacialAgeEstimationResultType.yaml
4038+
ignoreTranslation: true
40244039
- title: FacialAnimationStreamingState
40254040
path: /reference/engine/enums/FacialAnimationStreamingState
40264041
type: engineapi
@@ -5161,6 +5176,11 @@ navigation:
51615176
type: engineapi
51625177
source: /reference/engine/enums/SwipeDirection.yaml
51635178
ignoreTranslation: true
5179+
- title: SystemThemeValue
5180+
path: /reference/engine/enums/SystemThemeValue
5181+
type: engineapi
5182+
source: /reference/engine/enums/SystemThemeValue.yaml
5183+
ignoreTranslation: true
51645184
- title: TableMajorAxis
51655185
path: /reference/engine/enums/TableMajorAxis
51665186
type: engineapi

content/en-us/avatar-setup/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,5 +98,5 @@ When selecting the Publish option, you can upload the asset to the Marketplace,
9898
For additional resources on the publishing process and Marketplace, see the following:
9999

100100
- [Publish to the Marketplace](../marketplace/publish-to-marketplace.md)
101-
- [Marketplace fees and commissions](../marketplace/marketplace-fees-and-commissions.md
101+
- [Marketplace fees and commissions](../marketplace/marketplace-fees-and-commissions.md)
102102
- [Marketplace policy](../marketplace/marketplace-policy.md)

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,24 @@ methods:
7373
thread_safety: Unsafe
7474
capabilities: []
7575
writeCapabilities: []
76+
- name: AssetService:CreateSurfaceAppearance
77+
summary: ''
78+
description: ''
79+
code_samples: []
80+
parameters:
81+
- name: content
82+
type: Dictionary
83+
default:
84+
summary: ''
85+
returns:
86+
- type: SurfaceAppearance
87+
summary: ''
88+
tags: []
89+
deprecation_message: ''
90+
security: None
91+
thread_safety: Unsafe
92+
capabilities: []
93+
writeCapabilities: []
7694
- name: AssetService:CreateAssetAsync
7795
summary: |
7896
Uploads a new asset to Roblox from the given object.

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ description: |
3232
See [Customizing the Camera](../../../workspace/camera.md) for more
3333
information on how to adjust and customize the camera's behavior.
3434
35-
3635
#### Storing Multiple Cameras
37-
38-
Note that when changing `Class.Workspace.CurrentCamera` to a new `Class.Camera`,
39-
all other `Class.Camera|Cameras` directly descending from `Class.Workspace` will be
40-
destroyed. If you need to store multiple cameras and swap between them on demand,
41-
it's recommended that you store them in a `Class.Folder` or `Class.Model` under
42-
`Class.Workspace`, inside which they will remain even when
43-
`Class.Workspace.CurrentCamera|CurrentCamera` is changed.
36+
37+
Note that when changing `Class.Workspace.CurrentCamera` to a new
38+
`Class.Camera`, all other `Class.Camera|Cameras` directly descending from
39+
`Class.Workspace` will be destroyed. If you need to store multiple cameras and
40+
swap between them on demand, it's recommended that you store them in a
41+
`Class.Folder` or `Class.Model` under `Class.Workspace`, inside which they
42+
will remain even when `Class.Workspace.CurrentCamera|CurrentCamera` is
43+
changed.
4444
code_samples:
4545
inherits:
4646
- PVInstance

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ methods:
328328
329329
If any of the assets fail to load, an error message appears in the output.
330330
The method itself will not error and it will continue executing until it
331-
has processed each requested instance or asset ID.
331+
has processed each requested instance.
332332
333333
##### Limitations
334334

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,25 @@ properties:
7575
can_save: false
7676
capabilities: []
7777
writeCapabilities: []
78+
- name: DataModel.Environment
79+
summary: ''
80+
description: ''
81+
code_samples: []
82+
type: string
83+
tags:
84+
- ReadOnly
85+
- NotReplicated
86+
deprecation_message: ''
87+
security:
88+
read: RobloxScriptSecurity
89+
write: RobloxScriptSecurity
90+
thread_safety: ReadSafe
91+
category: State
92+
serialization:
93+
can_load: false
94+
can_save: false
95+
capabilities: []
96+
writeCapabilities: []
7897
- name: DataModel.GameId
7998
summary: |
8099
Describes the ID of the experience that the place running on the server
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: FacialAgeEstimationService
2+
type: class
3+
category:
4+
memory_category: Instances
5+
summary: ''
6+
description: ''
7+
code_samples: []
8+
inherits:
9+
- Instance
10+
tags:
11+
- NotCreatable
12+
- Service
13+
- NotReplicated
14+
deprecation_message: ''
15+
properties: []
16+
methods:
17+
- name: FacialAgeEstimationService:IsAvailable
18+
summary: ''
19+
description: ''
20+
code_samples: []
21+
parameters: []
22+
returns:
23+
- type: boolean
24+
summary: ''
25+
tags: []
26+
deprecation_message: ''
27+
security: RobloxScriptSecurity
28+
thread_safety: Unsafe
29+
capabilities: []
30+
writeCapabilities: []
31+
- name: FacialAgeEstimationService:InquiryAsync
32+
summary: ''
33+
description: ''
34+
code_samples: []
35+
parameters:
36+
- name: inquiryId
37+
type: string
38+
default:
39+
summary: ''
40+
returns:
41+
- type: Dictionary
42+
summary: ''
43+
tags:
44+
- Yields
45+
deprecation_message: ''
46+
security: RobloxScriptSecurity
47+
thread_safety: Unsafe
48+
capabilities: []
49+
writeCapabilities: []
50+
events: []
51+
callbacks: []

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,11 @@ properties:
6666
writeCapabilities: []
6767
- name: GuiButton.HoverHapticEffect
6868
summary: |
69-
A `Class.HapticEffect` instance that will play when the `Class.GuiButton` is being hovered.
69+
A `Class.HapticEffect` instance that will play when the `Class.GuiButton`
70+
is being hovered.
7071
description: |
71-
A `Class.HapticEffect` instance that will play when the `Class.GuiButton` is being hovered.
72+
A `Class.HapticEffect` instance that will play when the `Class.GuiButton`
73+
is being hovered.
7274
code_samples: []
7375
type: HapticEffect
7476
tags: []
@@ -108,9 +110,11 @@ properties:
108110
writeCapabilities: []
109111
- name: GuiButton.PressHapticEffect
110112
summary: |
111-
A `Class.HapticEffect` instance that will play when the `Class.GuiButton` is being pressed.
113+
A `Class.HapticEffect` instance that will play when the `Class.GuiButton`
114+
is being pressed.
112115
description: |
113-
A `Class.HapticEffect` instance that will play when the `Class.GuiButton` is being pressed.
116+
A `Class.HapticEffect` instance that will play when the `Class.GuiButton`
117+
is being pressed.
114118
code_samples: []
115119
type: HapticEffect
116120
tags: []

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ summary: |
88
description: |
99
The `Handles` object places 3D handles around any object that its
1010
`Class.Handles.Adornee|Adornee` is set to; this property must be set to a 3D
11-
object for the handles to appear. The color can be changed and the shape
12-
of the handles can be set to either arrows or spheres.
11+
object for the handles to appear. The color can be changed and the shape of
12+
the handles can be set to either arrows or spheres.
1313
1414
For handles to be interactive, they must be parented to a player's
1515
`Class.PlayerGui` or the `Class.CoreGui`.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ properties:
3030
3131
```
3232
local Workspace = game:GetService("Workspace")
33-
33+
3434
local effect = Instance.new("HapticEffect")
3535
effect.Type = Enum.HapticEffectType.GameplayExplosion
3636
effect.Looped = true
@@ -72,7 +72,7 @@ properties:
7272
7373
```
7474
local Workspace = game:GetService("Workspace")
75-
75+
7676
local effect = Instance.new("HapticEffect")
7777
7878
-- Set the position and radius of impact
@@ -112,7 +112,7 @@ properties:
112112
113113
```
114114
local Workspace = game:GetService("Workspace")
115-
115+
116116
local effect = Instance.new("HapticEffect")
117117
118118
-- Set the position and radius of impact
@@ -186,7 +186,7 @@ methods:
186186
187187
```
188188
local Workspace = game:GetService("Workspace")
189-
189+
190190
local effect = Instance.new("HapticEffect")
191191
effect.Type = Enum.HapticEffectType.GameplayExplosion
192192
effect.Parent = Workspace
@@ -215,7 +215,7 @@ methods:
215215
216216
```
217217
local Workspace = game:GetService("Workspace")
218-
218+
219219
local effect = Instance.new("HapticEffect")
220220
221221
-- Set effect type to custom in order to define a waveform
@@ -256,7 +256,7 @@ methods:
256256
257257
```
258258
local Workspace = game:GetService("Workspace")
259-
259+
260260
local effect = Instance.new("HapticEffect")
261261
effect.Type = Enum.HapticEffectType.GameplayExplosion
262262
effect.Looped = true

0 commit comments

Comments
 (0)