Skip to content

Commit 1c905b6

Browse files
update Open Source Docs from Roblox internal teams
1 parent 5fab99b commit 1c905b6

27 files changed

+549
-140
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 90 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -278,11 +278,6 @@ navigation:
278278
type: engineapi
279279
source: /reference/engine/classes/AudioTextToSpeech.yaml
280280
ignoreTranslation: true
281-
- title: AuroraScriptObject
282-
path: /reference/engine/classes/AuroraScriptObject
283-
type: engineapi
284-
source: /reference/engine/classes/AuroraScriptObject.yaml
285-
ignoreTranslation: true
286281
- title: AvatarCreationService
287282
path: /reference/engine/classes/AvatarCreationService
288283
type: engineapi
@@ -968,11 +963,6 @@ navigation:
968963
type: engineapi
969964
source: /reference/engine/classes/FeatureRestrictionManager.yaml
970965
ignoreTranslation: true
971-
- title: FeedPages
972-
path: /reference/engine/classes/FeedPages
973-
type: engineapi
974-
source: /reference/engine/classes/FeedPages.yaml
975-
ignoreTranslation: true
976966
- title: File
977967
path: /reference/engine/classes/File
978968
type: engineapi
@@ -2058,6 +2048,11 @@ navigation:
20582048
type: engineapi
20592049
source: /reference/engine/classes/ReflectionMetadataYieldFunctions.yaml
20602050
ignoreTranslation: true
2051+
- title: ReflectionService
2052+
path: /reference/engine/classes/ReflectionService
2053+
type: engineapi
2054+
source: /reference/engine/classes/ReflectionService.yaml
2055+
ignoreTranslation: true
20612056
- title: RemoteDebuggerServer
20622057
path: /reference/engine/classes/RemoteDebuggerServer
20632058
type: engineapi
@@ -3511,6 +3506,11 @@ navigation:
35113506
type: engineapi
35123507
source: /reference/engine/enums/AudioApiRollout.yaml
35133508
ignoreTranslation: true
3509+
- title: AudioCaptureMode
3510+
path: /reference/engine/enums/AudioCaptureMode
3511+
type: engineapi
3512+
source: /reference/engine/enums/AudioCaptureMode.yaml
3513+
ignoreTranslation: true
35143514
- title: AudioChannelLayout
35153515
path: /reference/engine/enums/AudioChannelLayout
35163516
type: engineapi
@@ -3571,6 +3571,81 @@ navigation:
35713571
type: engineapi
35723572
source: /reference/engine/enums/AvatarPromptResult.yaml
35733573
ignoreTranslation: true
3574+
- title: AvatarSettingsAccessoryLimitMethod
3575+
path: /reference/engine/enums/AvatarSettingsAccessoryLimitMethod
3576+
type: engineapi
3577+
source: /reference/engine/enums/AvatarSettingsAccessoryLimitMethod.yaml
3578+
ignoreTranslation: true
3579+
- title: AvatarSettingsAccessoryMode
3580+
path: /reference/engine/enums/AvatarSettingsAccessoryMode
3581+
type: engineapi
3582+
source: /reference/engine/enums/AvatarSettingsAccessoryMode.yaml
3583+
ignoreTranslation: true
3584+
- title: AvatarSettingsAnimationClipsMode
3585+
path: /reference/engine/enums/AvatarSettingsAnimationClipsMode
3586+
type: engineapi
3587+
source: /reference/engine/enums/AvatarSettingsAnimationClipsMode.yaml
3588+
ignoreTranslation: true
3589+
- title: AvatarSettingsAnimationPacksMode
3590+
path: /reference/engine/enums/AvatarSettingsAnimationPacksMode
3591+
type: engineapi
3592+
source: /reference/engine/enums/AvatarSettingsAnimationPacksMode.yaml
3593+
ignoreTranslation: true
3594+
- title: AvatarSettingsAppearanceMode
3595+
path: /reference/engine/enums/AvatarSettingsAppearanceMode
3596+
type: engineapi
3597+
source: /reference/engine/enums/AvatarSettingsAppearanceMode.yaml
3598+
ignoreTranslation: true
3599+
- title: AvatarSettingsBuildMode
3600+
path: /reference/engine/enums/AvatarSettingsBuildMode
3601+
type: engineapi
3602+
source: /reference/engine/enums/AvatarSettingsBuildMode.yaml
3603+
ignoreTranslation: true
3604+
- title: AvatarSettingsClothingMode
3605+
path: /reference/engine/enums/AvatarSettingsClothingMode
3606+
type: engineapi
3607+
source: /reference/engine/enums/AvatarSettingsClothingMode.yaml
3608+
ignoreTranslation: true
3609+
- title: AvatarSettingsCollisionMode
3610+
path: /reference/engine/enums/AvatarSettingsCollisionMode
3611+
type: engineapi
3612+
source: /reference/engine/enums/AvatarSettingsCollisionMode.yaml
3613+
ignoreTranslation: true
3614+
- title: AvatarSettingsCustomAccessoryMode
3615+
path: /reference/engine/enums/AvatarSettingsCustomAccessoryMode
3616+
type: engineapi
3617+
source: /reference/engine/enums/AvatarSettingsCustomAccessoryMode.yaml
3618+
ignoreTranslation: true
3619+
- title: AvatarSettingsCustomBodyType
3620+
path: /reference/engine/enums/AvatarSettingsCustomBodyType
3621+
type: engineapi
3622+
source: /reference/engine/enums/AvatarSettingsCustomBodyType.yaml
3623+
ignoreTranslation: true
3624+
- title: AvatarSettingsCustomClothingMode
3625+
path: /reference/engine/enums/AvatarSettingsCustomClothingMode
3626+
type: engineapi
3627+
source: /reference/engine/enums/AvatarSettingsCustomClothingMode.yaml
3628+
ignoreTranslation: true
3629+
- title: AvatarSettingsHitAndTouchDetectionMode
3630+
path: /reference/engine/enums/AvatarSettingsHitAndTouchDetectionMode
3631+
type: engineapi
3632+
source: /reference/engine/enums/AvatarSettingsHitAndTouchDetectionMode.yaml
3633+
ignoreTranslation: true
3634+
- title: AvatarSettingsJumpMode
3635+
path: /reference/engine/enums/AvatarSettingsJumpMode
3636+
type: engineapi
3637+
source: /reference/engine/enums/AvatarSettingsJumpMode.yaml
3638+
ignoreTranslation: true
3639+
- title: AvatarSettingsLegacyCollisionMode
3640+
path: /reference/engine/enums/AvatarSettingsLegacyCollisionMode
3641+
type: engineapi
3642+
source: /reference/engine/enums/AvatarSettingsLegacyCollisionMode.yaml
3643+
ignoreTranslation: true
3644+
- title: AvatarSettingsScaleMode
3645+
path: /reference/engine/enums/AvatarSettingsScaleMode
3646+
type: engineapi
3647+
source: /reference/engine/enums/AvatarSettingsScaleMode.yaml
3648+
ignoreTranslation: true
35743649
- title: AvatarThumbnailCustomizationType
35753650
path: /reference/engine/enums/AvatarThumbnailCustomizationType
35763651
type: engineapi
@@ -5476,6 +5551,11 @@ navigation:
54765551
type: engineapi
54775552
source: /reference/engine/enums/VibrationMotor.yaml
54785553
ignoreTranslation: true
5554+
- title: VideoCaptureResult
5555+
path: /reference/engine/enums/VideoCaptureResult
5556+
type: engineapi
5557+
source: /reference/engine/enums/VideoCaptureResult.yaml
5558+
ignoreTranslation: true
54795559
- title: VideoDeviceCaptureQuality
54805560
path: /reference/engine/enums/VideoDeviceCaptureQuality
54815561
type: engineapi

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

Lines changed: 0 additions & 50 deletions
This file was deleted.

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

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -169,29 +169,6 @@ methods:
169169
thread_safety: Unsafe
170170
capabilities: []
171171
writeCapabilities: []
172-
- name: AvatarCreationService:AutoSetupAvatarAsync
173-
summary: ''
174-
description: ''
175-
code_samples: []
176-
parameters:
177-
- name: player
178-
type: Player
179-
default: ''
180-
summary: ''
181-
- name: model
182-
type: Model
183-
default: ''
184-
summary: ''
185-
returns:
186-
- type: string
187-
summary: ''
188-
tags:
189-
- Yields
190-
deprecation_message: ''
191-
security: RobloxScriptSecurity
192-
thread_safety: Unsafe
193-
capabilities: []
194-
writeCapabilities: []
195172
- name: AvatarCreationService:GenerateAvatar2DPreviewAsync
196173
summary: ''
197174
description: ''

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

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ description: |
3434
3535
For security purposes, using `EditableMesh` fails by default for published
3636
experiences. To enable usage, you must be 13+ age verified and ID verified.
37-
After you are verified, open Studio's [Game
38-
Settings](../../../studio/game-settings.md), select **Security**, and enable
39-
the **Allow Mesh / Image APIs** toggle.
37+
After you are verified, open Studio's
38+
[Game Settings](../../../studio/game-settings.md), select **Security**, and
39+
enable the **Allow Mesh / Image APIs** toggle.
4040
4141
##### Permissions
4242
@@ -204,7 +204,8 @@ properties:
204204
description: ''
205205
code_samples: []
206206
type: boolean
207-
tags: []
207+
tags:
208+
- Deprecated
208209
deprecation_message: ''
209210
security:
210211
read: None
@@ -812,31 +813,6 @@ methods:
812813
thread_safety: Unsafe
813814
capabilities: []
814815
writeCapabilities: []
815-
- name: EditableMesh:GetVertexBoneWeights
816-
summary: |
817-
Returns skinning blend weights for each bone that is associated with the
818-
vertex.
819-
description: |
820-
Returns skinning blend weights for each bone that is associated with the
821-
vertex.
822-
code_samples: []
823-
parameters:
824-
- name: vertexId
825-
type: int64
826-
default: ''
827-
summary: |
828-
Vertex ID for which to get the associated bone weights.
829-
returns:
830-
- type: Array
831-
summary: |
832-
Skinning blend weights for each bone that is associated with the
833-
vertex.
834-
tags: []
835-
deprecation_message: ''
836-
security: None
837-
thread_safety: Unsafe
838-
capabilities: []
839-
writeCapabilities: []
840816
- name: EditableMesh:GetVertices
841817
summary: |
842818
Returns all vertices as a list of stable vertex IDs.

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

Lines changed: 0 additions & 16 deletions
This file was deleted.
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: ReflectionService
2+
type: class
3+
memory_category: Instances
4+
summary: ''
5+
description: ''
6+
code_samples: []
7+
inherits:
8+
- Instance
9+
tags:
10+
- NotCreatable
11+
- Service
12+
- NotReplicated
13+
deprecation_message: ''
14+
properties: []
15+
methods:
16+
- name: ReflectionService:GetClass
17+
summary: ''
18+
description: ''
19+
code_samples: []
20+
parameters:
21+
- name: className
22+
type: string
23+
default: ''
24+
summary: ''
25+
- name: filter
26+
type: Dictionary
27+
default: nil
28+
summary: ''
29+
returns:
30+
- type: Dictionary?
31+
summary: ''
32+
tags: []
33+
deprecation_message: ''
34+
security: None
35+
thread_safety: Unsafe
36+
capabilities: []
37+
writeCapabilities: []
38+
- name: ReflectionService:GetClasses
39+
summary: ''
40+
description: ''
41+
code_samples: []
42+
parameters:
43+
- name: filter
44+
type: Dictionary
45+
default: nil
46+
summary: ''
47+
returns:
48+
- type: Array
49+
summary: ''
50+
tags: []
51+
deprecation_message: ''
52+
security: None
53+
thread_safety: Unsafe
54+
capabilities: []
55+
writeCapabilities: []
56+
- name: ReflectionService:GetPropertiesOfClass
57+
summary: ''
58+
description: ''
59+
code_samples: []
60+
parameters:
61+
- name: className
62+
type: string
63+
default: ''
64+
summary: ''
65+
- name: filter
66+
type: Dictionary
67+
default: nil
68+
summary: ''
69+
returns:
70+
- type: Array
71+
summary: ''
72+
tags: []
73+
deprecation_message: ''
74+
security: None
75+
thread_safety: Unsafe
76+
capabilities: []
77+
writeCapabilities: []
78+
events: []
79+
callbacks: []

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,23 @@ inherits:
99
tags: []
1010
deprecation_message: ''
1111
properties:
12+
- name: StyleDerive.Priority
13+
summary: ''
14+
description: ''
15+
code_samples: []
16+
type: int
17+
tags: []
18+
deprecation_message: ''
19+
security:
20+
read: None
21+
write: None
22+
thread_safety: ReadSafe
23+
category: Data
24+
serialization:
25+
can_load: true
26+
can_save: true
27+
capabilities: []
28+
writeCapabilities: []
1229
- name: StyleDerive.StyleSheet
1330
summary: ''
1431
description: ''

0 commit comments

Comments
 (0)