Skip to content

Commit 95cc061

Browse files
update Open Source Docs from Roblox internal teams
1 parent df0ee9e commit 95cc061

File tree

76 files changed

+1174
-2348
lines changed

Some content is hidden

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

76 files changed

+1174
-2348
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2003,6 +2003,16 @@ navigation:
20032003
type: engineapi
20042004
source: /reference/engine/classes/RayValue.yaml
20052005
ignoreTranslation: true
2006+
- title: RecommendationPages
2007+
path: /reference/engine/classes/RecommendationPages
2008+
type: engineapi
2009+
source: /reference/engine/classes/RecommendationPages.yaml
2010+
ignoreTranslation: true
2011+
- title: RecommendationService
2012+
path: /reference/engine/classes/RecommendationService
2013+
type: engineapi
2014+
source: /reference/engine/classes/RecommendationService.yaml
2015+
ignoreTranslation: true
20062016
- title: ReflectionMetadata
20072017
path: /reference/engine/classes/ReflectionMetadata
20082018
type: engineapi
@@ -3586,6 +3596,11 @@ navigation:
35863596
type: engineapi
35873597
source: /reference/engine/enums/AudioWindowSize.yaml
35883598
ignoreTranslation: true
3599+
- title: AuthorityMode
3600+
path: /reference/engine/enums/AuthorityMode
3601+
type: engineapi
3602+
source: /reference/engine/enums/AuthorityMode.yaml
3603+
ignoreTranslation: true
35893604
- title: AutoIndentRule
35903605
path: /reference/engine/enums/AutoIndentRule
35913606
type: engineapi
@@ -4186,11 +4201,6 @@ navigation:
41864201
type: engineapi
41874202
source: /reference/engine/enums/FACSDataLod.yaml
41884203
ignoreTranslation: true
4189-
- title: FeedRankingScoreType
4190-
path: /reference/engine/enums/FeedRankingScoreType
4191-
type: engineapi
4192-
source: /reference/engine/enums/FeedRankingScoreType.yaml
4193-
ignoreTranslation: true
41944204
- title: FieldOfViewMode
41954205
path: /reference/engine/enums/FieldOfViewMode
41964206
type: engineapi
@@ -4576,6 +4586,11 @@ navigation:
45764586
type: engineapi
45774587
source: /reference/engine/enums/LocationType.yaml
45784588
ignoreTranslation: true
4589+
- title: LuauTypeCheckMode
4590+
path: /reference/engine/enums/LuauTypeCheckMode
4591+
type: engineapi
4592+
source: /reference/engine/enums/LuauTypeCheckMode.yaml
4593+
ignoreTranslation: true
45794594
- title: MarketplaceBulkPurchasePromptStatus
45804595
path: /reference/engine/enums/MarketplaceBulkPurchasePromptStatus
45814596
type: engineapi
@@ -4966,6 +4981,21 @@ navigation:
49664981
type: engineapi
49674982
source: /reference/engine/enums/RaycastFilterType.yaml
49684983
ignoreTranslation: true
4984+
- title: RecommendationActionType
4985+
path: /reference/engine/enums/RecommendationActionType
4986+
type: engineapi
4987+
source: /reference/engine/enums/RecommendationActionType.yaml
4988+
ignoreTranslation: true
4989+
- title: RecommendationImpressionType
4990+
path: /reference/engine/enums/RecommendationImpressionType
4991+
type: engineapi
4992+
source: /reference/engine/enums/RecommendationImpressionType.yaml
4993+
ignoreTranslation: true
4994+
- title: RecommendationItemVisibility
4995+
path: /reference/engine/enums/RecommendationItemVisibility
4996+
type: engineapi
4997+
source: /reference/engine/enums/RecommendationItemVisibility.yaml
4998+
ignoreTranslation: true
49694999
- title: RejectCharacterDeletions
49705000
path: /reference/engine/enums/RejectCharacterDeletions
49715001
type: engineapi

content/en-us/production/publishing/vr-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,5 @@ The following best practices may help you reach 72 frames per second with a high
5454
- Minimize the number of semi-transparent objects and textures with partial transparency such as `Class.Decal|Decals` or the `Enum.Material|Glass` material.
5555
- Use **Voxel** or **ShadowMap** lighting `Class.Lighting.Technology|Technology`, as **Future** lighting can be costly to generate and may produce inconsistent results on VR when the automatic quality drops.
5656
- Numerous and complex `Class.SurfaceGui|SurfaceGuis` can be costly, both on the rendering and CPU side.
57-
- Avoid writing platform-dependent code such as actions that rely on keyboard presses. Instead, use `Class.ContextActionService` methods that allow input from either touch, gamepad, keyboard, or mouse.
57+
- Avoid writing platform-dependent code such as actions that rely on keyboard presses. Instead, use objects like `Class.InputAction` which supports input bindings from multiple sources.
5858
- Test and iterate often to make sure you're getting the anticipated performance and visual quality. If possible, invest in a Quest 2 headset.

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ methods:
6262
deprecation_message: ''
6363
security: None
6464
thread_safety: Safe
65-
capabilities: []
65+
capabilities:
66+
- Basic
6667
writeCapabilities: []
6768
- name: Actor:BindToMessageParallel
6869
summary: |
@@ -108,7 +109,8 @@ methods:
108109
deprecation_message: ''
109110
security: None
110111
thread_safety: Safe
111-
capabilities: []
112+
capabilities:
113+
- Basic
112114
writeCapabilities: []
113115
- name: Actor:SendMessage
114116
summary: |
@@ -147,7 +149,8 @@ methods:
147149
deprecation_message: ''
148150
security: None
149151
thread_safety: Safe
150-
capabilities: []
152+
capabilities:
153+
- Basic
151154
writeCapabilities: []
152155
events: []
153156
callbacks: []

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

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ properties:
3232
serialization:
3333
can_load: true
3434
can_save: true
35-
capabilities: []
35+
capabilities:
36+
- Basic
3637
writeCapabilities: []
3738
- name: AirController.BalanceSpeed
3839
summary: |
@@ -53,7 +54,8 @@ properties:
5354
serialization:
5455
can_load: true
5556
can_save: true
56-
capabilities: []
57+
capabilities:
58+
- Basic
5759
writeCapabilities: []
5860
- name: AirController.LinearImpulse
5961
summary: ''
@@ -72,7 +74,8 @@ properties:
7274
serialization:
7375
can_load: false
7476
can_save: false
75-
capabilities: []
77+
capabilities:
78+
- Basic
7679
writeCapabilities: []
7780
- name: AirController.MaintainAngularMomentum
7881
summary: |
@@ -94,7 +97,8 @@ properties:
9497
serialization:
9598
can_load: true
9699
can_save: true
97-
capabilities: []
100+
capabilities:
101+
- Basic
98102
writeCapabilities: []
99103
- name: AirController.MaintainLinearMomentum
100104
summary: |
@@ -116,7 +120,8 @@ properties:
116120
serialization:
117121
can_load: true
118122
can_save: true
119-
capabilities: []
123+
capabilities:
124+
- Basic
120125
writeCapabilities: []
121126
- name: AirController.MoveMaxForce
122127
summary: |
@@ -143,7 +148,8 @@ properties:
143148
serialization:
144149
can_load: true
145150
can_save: true
146-
capabilities: []
151+
capabilities:
152+
- Basic
147153
writeCapabilities: []
148154
- name: AirController.TurnMaxTorque
149155
summary: |
@@ -170,7 +176,8 @@ properties:
170176
serialization:
171177
can_load: true
172178
can_save: true
173-
capabilities: []
179+
capabilities:
180+
- Basic
174181
writeCapabilities: []
175182
- name: AirController.TurnSpeedFactor
176183
summary: |
@@ -192,7 +199,8 @@ properties:
192199
serialization:
193200
can_load: true
194201
can_save: true
195-
capabilities: []
202+
capabilities:
203+
- Basic
196204
writeCapabilities: []
197205
methods: []
198206
events: []

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@ properties:
3535
can_load: true
3636
can_save: true
3737
capabilities:
38+
- Basic
3839
- UI
40+
- Input
3941
writeCapabilities: []
4042
methods: []
4143
events:
@@ -54,7 +56,9 @@ events:
5456
deprecation_message: ''
5557
security: None
5658
capabilities:
59+
- Basic
5760
- UI
61+
- Input
5862
writeCapabilities: []
5963
- name: ArcHandles.MouseButton1Up
6064
summary: |
@@ -71,7 +75,9 @@ events:
7175
deprecation_message: ''
7276
security: None
7377
capabilities:
78+
- Basic
7479
- UI
80+
- Input
7581
writeCapabilities: []
7682
- name: ArcHandles.MouseDrag
7783
summary: |
@@ -98,7 +104,9 @@ events:
98104
deprecation_message: ''
99105
security: None
100106
capabilities:
107+
- Basic
101108
- UI
109+
- Input
102110
writeCapabilities: []
103111
- name: ArcHandles.MouseEnter
104112
summary: |
@@ -115,7 +123,9 @@ events:
115123
deprecation_message: ''
116124
security: None
117125
capabilities:
126+
- Basic
118127
- UI
128+
- Input
119129
writeCapabilities: []
120130
- name: ArcHandles.MouseLeave
121131
summary: |
@@ -132,6 +142,8 @@ events:
132142
deprecation_message: ''
133143
security: None
134144
capabilities:
145+
- Basic
135146
- UI
147+
- Input
136148
writeCapabilities: []
137149
callbacks: []

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

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

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ properties:
3636
serialization:
3737
can_load: false
3838
can_save: true
39-
capabilities: []
39+
capabilities:
40+
- Basic
4041
writeCapabilities: []
4142
- name: AtmosphereSensor.RelativeWindVelocity
4243
summary: |
@@ -57,7 +58,8 @@ properties:
5758
serialization:
5859
can_load: false
5960
can_save: true
60-
capabilities: []
61+
capabilities:
62+
- Basic
6163
writeCapabilities: []
6264
methods: []
6365
events: []

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

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ properties:
4646
serialization:
4747
can_load: true
4848
can_save: true
49-
capabilities: []
49+
capabilities:
50+
- Physics
5051
writeCapabilities: []
5152
- name: BodyAngularVelocity.MaxTorque
5253
summary: |
@@ -69,7 +70,8 @@ properties:
6970
serialization:
7071
can_load: true
7172
can_save: true
72-
capabilities: []
73+
capabilities:
74+
- Physics
7375
writeCapabilities: []
7476
- name: BodyAngularVelocity.P
7577
summary: |
@@ -92,7 +94,8 @@ properties:
9294
serialization:
9395
can_load: true
9496
can_save: true
95-
capabilities: []
97+
capabilities:
98+
- Physics
9699
writeCapabilities: []
97100
- name: BodyAngularVelocity.angularvelocity
98101
summary: ''
@@ -113,7 +116,8 @@ properties:
113116
serialization:
114117
can_load: true
115118
can_save: false
116-
capabilities: []
119+
capabilities:
120+
- Physics
117121
writeCapabilities: []
118122
- name: BodyAngularVelocity.maxTorque
119123
summary: |
@@ -138,7 +142,8 @@ properties:
138142
serialization:
139143
can_load: true
140144
can_save: false
141-
capabilities: []
145+
capabilities:
146+
- Physics
142147
writeCapabilities: []
143148
methods: []
144149
events: []

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ properties:
4141
serialization:
4242
can_load: true
4343
can_save: true
44-
capabilities: []
44+
capabilities:
45+
- Physics
4546
writeCapabilities: []
4647
- name: BodyForce.force
4748
summary: |
@@ -65,7 +66,8 @@ properties:
6566
serialization:
6667
can_load: true
6768
can_save: false
68-
capabilities: []
69+
capabilities:
70+
- Physics
6971
writeCapabilities: []
7072
methods: []
7173
events: []

0 commit comments

Comments
 (0)