Skip to content

Commit b6926da

Browse files
update Open Source Docs from Roblox internal teams
1 parent eaf181a commit b6926da

24 files changed

+718
-127
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2505,6 +2505,11 @@ navigation:
25052505
type: engineapi
25062506
source: /reference/engine/classes/Teams.yaml
25072507
ignoreTranslation: true
2508+
- title: TelemetryService
2509+
path: /reference/engine/classes/TelemetryService
2510+
type: engineapi
2511+
source: /reference/engine/classes/TelemetryService.yaml
2512+
ignoreTranslation: true
25082513
- title: TeleportAsyncResult
25092514
path: /reference/engine/classes/TeleportAsyncResult
25102515
type: engineapi
@@ -3348,6 +3353,16 @@ navigation:
33483353
type: engineapi
33493354
source: /reference/engine/enums/AnnotationEditingMode.yaml
33503355
ignoreTranslation: true
3356+
- title: AnnotationRequestResult
3357+
path: /reference/engine/enums/AnnotationRequestResult
3358+
type: engineapi
3359+
source: /reference/engine/enums/AnnotationRequestResult.yaml
3360+
ignoreTranslation: true
3361+
- title: AnnotationRequestType
3362+
path: /reference/engine/enums/AnnotationRequestType
3363+
type: engineapi
3364+
source: /reference/engine/enums/AnnotationRequestType.yaml
3365+
ignoreTranslation: true
33513366
- title: AppLifecycleManagerState
33523367
path: /reference/engine/enums/AppLifecycleManagerState
33533368
type: engineapi
@@ -3878,11 +3893,6 @@ navigation:
38783893
type: engineapi
38793894
source: /reference/engine/enums/EasingStyle.yaml
38803895
ignoreTranslation: true
3881-
- title: EditableStatus
3882-
path: /reference/engine/enums/EditableStatus
3883-
type: engineapi
3884-
source: /reference/engine/enums/EditableStatus.yaml
3885-
ignoreTranslation: true
38863896
- title: ElasticBehavior
38873897
path: /reference/engine/enums/ElasticBehavior
38883898
type: engineapi

content/en-us/art/modeling/avatar-setup.md

Lines changed: 108 additions & 64 deletions
Large diffs are not rendered by default.
Lines changed: 3 additions & 0 deletions
Loading

content/en-us/avatar/resources.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ The following assets are designed for the specific [auto-setup requirements](../
204204
<Card style={{height: '100%'}}>
205205
<CardContent>
206206

207-
<center>Nature Girl - AutoSetup</center>
207+
<center>Nature Girl - Auto-Setup</center>
208208
<figure>
209209
<center> <img src="../assets/art/resources/Archer-Girl-Preview.png" width="100%" /> </center>
210210
</figure>
@@ -225,7 +225,7 @@ This Auto-Setup template is not compatible with the traditional avatar creation
225225
<Card style={{height: '100%'}}>
226226
<CardContent>
227227

228-
<center>Stylish Male - AutoSetup</center>
228+
<center>Stylish Male - Auto-Setup</center>
229229
<figure>
230230
<center> <img src="../assets/art/resources/StylizedMale-Preview.png" width="100%" /> </center>
231231
</figure>

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

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@ type: class
33
category:
44
memory_category: PhysicsParts
55
summary: |
6-
Aligns two `Class.BasePart|BaseParts` with an animate-able kinematic or force-based joint.
6+
Aligns two `Class.BasePart|BaseParts` with an animate-able kinematic or
7+
force-based joint.
78
description: |
89
An **AnimationConstraint** constrains its `Class.Attachment|Attachments` so
9-
that they're offset by the `Class.AnimationConstraint.Transform|Transform` `CFrame`.
10-
The `Class.AnimationConstraint.Transform|Transform` can be set manually
11-
during `Class.RunService.PreSimulation` or by an `Class.Animator`.
10+
that they're offset by the `Class.AnimationConstraint.Transform|Transform`
11+
`CFrame`. The `Class.AnimationConstraint.Transform|Transform` can be set
12+
manually during `Class.RunService.PreSimulation` or by an `Class.Animator`.
1213
code_samples: []
1314
inherits:
1415
- Constraint
@@ -19,7 +20,9 @@ properties:
1920
- name: AnimationConstraint.C0
2021
summary: ''
2122
description: |
22-
The `Class.AnimationConstraint.Attachment0|Attachment0` `Class.Attachment.CFrame|CFrame` for backwards compatibility with `Class.Motor6D.C0`.
23+
The `Class.AnimationConstraint.Attachment0|Attachment0`
24+
`Class.Attachment.CFrame|CFrame` for backwards compatibility with
25+
`Class.Motor6D.C0`.
2326
code_samples: []
2427
type: CFrame
2528
tags:
@@ -43,7 +46,9 @@ properties:
4346
- name: AnimationConstraint.C1
4447
summary: ''
4548
description: |
46-
The `Class.AnimationConstraint.Attachment1|Attachment1` `Class.Attachment.CFrame|CFrame` for backwards compatibility with `Class.Motor6D.C1`.
49+
The `Class.AnimationConstraint.Attachment1|Attachment1`
50+
`Class.Attachment.CFrame|CFrame` for backwards compatibility with
51+
`Class.Motor6D.C1`.
4752
code_samples: []
4853
type: CFrame
4954
tags:
@@ -66,10 +71,15 @@ properties:
6671
writeCapabilities: []
6772
- name: AnimationConstraint.IsKinematic
6873
summary: |
69-
Toggles whether the `Class.AnimationConstraint` is kinematic or physically simulated.
74+
Toggles whether the `Class.AnimationConstraint` is kinematic or physically
75+
simulated.
7076
description: |
71-
When true, the connected parts follow the `Class.AnimationConstraint.Transform|Transform` perfectly without participating in physics simulation.
72-
When false, the connected parts follow the trajectory using forces and torques limited by `Class.AnimationConstraint.MaxForce` and `Class.AnimationConstraint.MaxTorque`.
77+
When true, the connected parts follow the
78+
`Class.AnimationConstraint.Transform|Transform` perfectly without
79+
participating in physics simulation. When false, the connected parts
80+
follow the trajectory using forces and torques limited by
81+
`Class.AnimationConstraint.MaxForce` and
82+
`Class.AnimationConstraint.MaxTorque`.
7383
code_samples: []
7484
type: bool
7585
tags: []
@@ -133,7 +143,9 @@ properties:
133143
- name: AnimationConstraint.Part0
134144
summary: ''
135145
description: |
136-
The `Class.AnimationConstraint.Attachment0|Attachment0` `Class.Instance.Parent|Parent` for backwards compatibility with `Class.Motor6D.Part0`.
146+
The `Class.AnimationConstraint.Attachment0|Attachment0`
147+
`Class.Instance.Parent|Parent` for backwards compatibility with
148+
`Class.Motor6D.Part0`.
137149
code_samples: []
138150
type: BasePart
139151
tags:
@@ -157,7 +169,9 @@ properties:
157169
- name: AnimationConstraint.Part1
158170
summary: ''
159171
description: |
160-
The `Class.AnimationConstraint.Attachment1|Attachment1` `Class.Instance.Parent|Parent` for backwards compatibility with `Class.Motor6D.Part1`.
172+
The `Class.AnimationConstraint.Attachment1|Attachment1`
173+
`Class.Instance.Parent|Parent` for backwards compatibility with
174+
`Class.Motor6D.Part1`.
161175
code_samples: []
162176
type: BasePart
163177
tags:
@@ -180,17 +194,18 @@ properties:
180194
writeCapabilities: []
181195
- name: AnimationConstraint.Transform
182196
summary: |
183-
Describes the current animation offset of the `Class.AnimationConstraint` joint.
197+
Describes the current animation offset of the `Class.AnimationConstraint`
198+
joint.
184199
description: |
185-
The internal `Datatype.CFrame` that is manipulated when a `Class.AnimationConstraint`
186-
is being animated.
200+
The internal `Datatype.CFrame` that is manipulated when a
201+
`Class.AnimationConstraint` is being animated.
187202
188203
##### Timing
189204
190-
`Class.AnimationConstraint` transforms are not applied immediately, but rather as
191-
a batch in a parallel job after `Class.RunService.PreSimulation`,
192-
immediately before physics steps. The deferred batch update is much more
193-
efficient than many immediate updates.
205+
`Class.AnimationConstraint` transforms are not applied immediately, but
206+
rather as a batch in a parallel job after
207+
`Class.RunService.PreSimulation`, immediately before physics steps. The
208+
deferred batch update is much more efficient than many immediate updates.
194209
195210
If the `Class.AnimationConstraint` is part of an animated model with an
196211
`Class.Animator`, then `Class.AnimationConstraint.Transform` is usually

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

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,62 @@ inherits:
1010
tags: []
1111
deprecation_message: ''
1212
properties: []
13-
methods: []
14-
events: []
13+
methods:
14+
- name: Annotation:GetRequests
15+
summary: ''
16+
description: ''
17+
code_samples: []
18+
parameters: []
19+
returns:
20+
- type: Dictionary
21+
summary: ''
22+
tags: []
23+
deprecation_message: ''
24+
security: RobloxScriptSecurity
25+
thread_safety: Unsafe
26+
capabilities: []
27+
writeCapabilities: []
28+
events:
29+
- name: Annotation.RequestCompleted
30+
summary: ''
31+
description: ''
32+
code_samples: []
33+
parameters:
34+
- name: requestId
35+
type: string
36+
default:
37+
summary: ''
38+
- name: requestType
39+
type: AnnotationRequestType
40+
default:
41+
summary: ''
42+
- name: result
43+
type: AnnotationRequestResult
44+
default:
45+
summary: ''
46+
tags: []
47+
deprecation_message: ''
48+
security: RobloxScriptSecurity
49+
thread_safety: Unsafe
50+
capabilities: []
51+
writeCapabilities: []
52+
- name: Annotation.RequestInitiated
53+
summary: ''
54+
description: ''
55+
code_samples: []
56+
parameters:
57+
- name: requestId
58+
type: string
59+
default:
60+
summary: ''
61+
- name: requestType
62+
type: AnnotationRequestType
63+
default:
64+
summary: ''
65+
tags: []
66+
deprecation_message: ''
67+
security: RobloxScriptSecurity
68+
thread_safety: Unsafe
69+
capabilities: []
70+
writeCapabilities: []
1571
callbacks: []

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,9 @@ methods:
116116
description: |
117117
Returns the frequency spectrum of the last audio buffer, as an array of
118118
numbers. The elements of the array are root-mean-square volume levels,
119-
evenly spaced from 0 hertz to 24,000 hertz.
120-
If any of the analyzer's inputs come from an `Class.AudioDeviceInput`, this method returns an empty array.
119+
evenly spaced from 0 hertz to 24,000 hertz. If any of the analyzer's
120+
inputs come from an `Class.AudioDeviceInput`, this method returns an empty
121+
array.
121122
code_samples: []
122123
parameters: []
123124
returns:

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ description: |
88
Configures properties of the optional channel tabs in the default chat window.
99
It is parented to `Class.TextChatService`.
1010
11-
To learn more, see [Customizing Text Chat](../../../chat/customizing-in-experience-text-chat.md).
11+
To learn more, see
12+
[Customizing Text Chat](../../../chat/customizing-in-experience-text-chat.md).
1213
code_samples: []
1314
inherits:
1415
- TextChatConfigurations

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,7 @@ methods:
229229
default:
230230
summary: |
231231
Optional dictionary for additional configuration:
232+
232233
- `CombineType`: Specifies how the pixels of the source image blend
233234
with those of the destination. Default is
234235
`Enum.ImageCombineType.AlphaBlend`.

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -565,6 +565,20 @@ methods:
565565
thread_safety: Unsafe
566566
capabilities: []
567567
writeCapabilities: []
568+
- name: GuiService:GetRawScreenScale
569+
summary: ''
570+
description: ''
571+
code_samples: []
572+
parameters: []
573+
returns:
574+
- type: float
575+
summary: ''
576+
tags: []
577+
deprecation_message: ''
578+
security: RobloxScriptSecurity
579+
thread_safety: Unsafe
580+
capabilities: []
581+
writeCapabilities: []
568582
- name: GuiService:InspectPlayerFromHumanoidDescription
569583
summary: |
570584
Allows a developer to bring up the Inspect menu showing the assets listed

0 commit comments

Comments
 (0)