Skip to content

Commit eaf181a

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

File tree

6 files changed

+74
-35
lines changed

6 files changed

+74
-35
lines changed

content/en-us/luau/tables.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -292,17 +292,17 @@ To copy a more complex table with nested tables inside it, you'll need to use a
292292

293293
```lua
294294
-- The function used for deep copying a table
295-
local function deepCopy(original)
295+
local function deepCopy(original)
296296
-- Define the new table for the copy
297297
local copy = {}
298-
298+
299299
-- Loop through the original table to clone
300300
for key, value in original do
301301
-- If the type of the value is a table, deep copy it to the key (index)
302302
-- Else (or) the type isn't a table, assign the default value to the index instead
303303
copy[key] = type(value) == "table" and deepCopy(value) or value
304304
end
305-
305+
306306
-- Return the finalized copy of the deep cloned table
307307
return copy
308308
end
@@ -329,7 +329,7 @@ local clone = deepCopy(original)
329329

330330
## Freezing Tables
331331

332-
Freezing a table makes it read-only. This means that its keys can't be written to, but can be read. New keys can't be created after a table is frozen. You can check if a table is frozen by using the `Library.table.isfrozen()` method. This feature is used to create constant values which you don't want to change.
332+
Freezing a table makes it read-only, which is useful for creating constant values that you don't want to change. Freezing is permanent; there's no "unfreeze" or "thaw" method. To check if a table is frozen, use `Library.table.isfrozen()`.
333333

334334
### Shallow Freezes
335335

@@ -348,7 +348,7 @@ target.playerID = 1 --> attempt to modify a readonly table
348348

349349
### Deep Freezes
350350

351-
To freeze a more complex table with nested tables inside it, you'll need to use a recursive function similar to the following:
351+
To freeze a more complex table with nested tables inside it, use a recursive function similar to the following:
352352

353353
```lua
354354
local function deepFreeze(target)

content/en-us/production/promotion/referral-system.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ description: Use referral links to track and reward players that have successful
77
This feature is still in beta. If you'd like to provide Roblox with feedback about this feature, join the [User Acquisition Referrals](https://www.guilded.gg/i/EwKQPZWE) Guilded group.
88
</Alert>
99

10+
<iframe width="880" height="495" src="https://www.youtube-nocookie.com/embed/qfWKYgO63OI" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
11+
12+
<br> </br>
13+
1014
The friend referral system encourages existing players to bring new players into your experience, increasing player retention and overall engagement. Players can access and share referral links from [player invite prompts](./invite-prompts.md) or directly from the default in-experience invite menu.
1115

1216
As a developer, you can use these shareable referral links to:

content/en-us/production/publishing/thumbnails.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -285,11 +285,3 @@ You can express your experience's theme through overall theme and colors to help
285285
<figcaption>Dark and stormy theme for a horror experience</figcaption>
286286
</figure>
287287
</GridContainer>
288-
289-
### Keep Multiple Thumbnails Active
290-
291-
To get the most out of your personalized thumbnails, always keep multiple thumbnails active instead of choosing one winner. This allows personalization to adapt to changing user trends.
292-
293-
### Avoid Clickbait
294-
295-
To avoid clickbait, make sure your thumbnail content reflects what users can expect from your experience.

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

Lines changed: 48 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@ name: AnimationConstraint
22
type: class
33
category:
44
memory_category: PhysicsParts
5-
summary: ''
6-
description: ''
5+
summary: |
6+
Aligns two `Class.BasePart|BaseParts` with an animate-able kinematic or force-based joint.
7+
description: |
8+
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`.
712
code_samples: []
813
inherits:
914
- Constraint
@@ -13,7 +18,8 @@ deprecation_message: ''
1318
properties:
1419
- name: AnimationConstraint.C0
1520
summary: ''
16-
description: ''
21+
description: |
22+
The `Class.AnimationConstraint.Attachment0|Attachment0` `Class.Attachment.CFrame|CFrame` for backwards compatibility with `Class.Motor6D.C0`.
1723
code_samples: []
1824
type: CFrame
1925
tags:
@@ -36,7 +42,8 @@ properties:
3642
writeCapabilities: []
3743
- name: AnimationConstraint.C1
3844
summary: ''
39-
description: ''
45+
description: |
46+
The `Class.AnimationConstraint.Attachment1|Attachment1` `Class.Attachment.CFrame|CFrame` for backwards compatibility with `Class.Motor6D.C1`.
4047
code_samples: []
4148
type: CFrame
4249
tags:
@@ -58,8 +65,11 @@ properties:
5865
- Animation
5966
writeCapabilities: []
6067
- name: AnimationConstraint.IsKinematic
61-
summary: ''
62-
description: ''
68+
summary: |
69+
Toggles whether the `Class.AnimationConstraint` is kinematic or physically simulated.
70+
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`.
6373
code_samples: []
6474
type: bool
6575
tags: []
@@ -77,8 +87,11 @@ properties:
7787
- Animation
7888
writeCapabilities: []
7989
- name: AnimationConstraint.MaxForce
80-
summary: ''
81-
description: ''
90+
summary: |
91+
Maximum force magnitude the constraint can apply to achieve its goal.
92+
description: |
93+
Maximum force magnitude the constraint can apply to achieve its goal. Only
94+
used if `Class.AnimationConstraint.IsKinematic|IsKinematic` is false.
8295
code_samples: []
8396
type: float
8497
tags: []
@@ -96,8 +109,11 @@ properties:
96109
- Animation
97110
writeCapabilities: []
98111
- name: AnimationConstraint.MaxTorque
99-
summary: ''
100-
description: ''
112+
summary: |
113+
Maximum torque the constraint can apply to reach its goal.
114+
description: |
115+
Maximum torque the constraint can use to reach its goal. Only used if
116+
`Class.AnimationConstraint.IsKinematic|IsKinematic` is false.
101117
code_samples: []
102118
type: float
103119
tags: []
@@ -116,7 +132,8 @@ properties:
116132
writeCapabilities: []
117133
- name: AnimationConstraint.Part0
118134
summary: ''
119-
description: ''
135+
description: |
136+
The `Class.AnimationConstraint.Attachment0|Attachment0` `Class.Instance.Parent|Parent` for backwards compatibility with `Class.Motor6D.Part0`.
120137
code_samples: []
121138
type: BasePart
122139
tags:
@@ -139,7 +156,8 @@ properties:
139156
writeCapabilities: []
140157
- name: AnimationConstraint.Part1
141158
summary: ''
142-
description: ''
159+
description: |
160+
The `Class.AnimationConstraint.Attachment1|Attachment1` `Class.Instance.Parent|Parent` for backwards compatibility with `Class.Motor6D.Part1`.
143161
code_samples: []
144162
type: BasePart
145163
tags:
@@ -161,8 +179,24 @@ properties:
161179
- Animation
162180
writeCapabilities: []
163181
- name: AnimationConstraint.Transform
164-
summary: ''
165-
description: ''
182+
summary: |
183+
Describes the current animation offset of the `Class.AnimationConstraint` joint.
184+
description: |
185+
The internal `Datatype.CFrame` that is manipulated when a `Class.AnimationConstraint`
186+
is being animated.
187+
188+
##### Timing
189+
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.
194+
195+
If the `Class.AnimationConstraint` is part of an animated model with an
196+
`Class.Animator`, then `Class.AnimationConstraint.Transform` is usually
197+
overwritten every frame by the `Class.Animator` after
198+
`Class.RunService.PreAnimation` and before
199+
`Class.RunService.PreSimulation`.
166200
code_samples: []
167201
type: CFrame
168202
tags: []

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

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,8 @@ methods:
234234
ID of the third vertex of the triangle.
235235
returns:
236236
- type: int64
237-
summary: ''
237+
summary: |
238+
Stable face ID of the new face.
238239
tags: []
239240
deprecation_message: ''
240241
security: None
@@ -392,7 +393,8 @@ methods:
392393
summary: ''
393394
returns:
394395
- type: Array
395-
summary: ''
396+
summary: |
397+
List of face IDs adjacent to the given face.
396398
tags: []
397399
deprecation_message: ''
398400
security: None
@@ -430,7 +432,8 @@ methods:
430432
parameters: []
431433
returns:
432434
- type: Vector3
433-
summary: ''
435+
summary: |
436+
Center of the bounding box of the `EditableMesh`.
434437
tags: []
435438
deprecation_message: ''
436439
security: None
@@ -569,8 +572,10 @@ methods:
569572
capabilities: []
570573
writeCapabilities: []
571574
- name: EditableMesh:GetFaceVertices
572-
summary: ''
573-
description: ''
575+
summary: |
576+
Returns the face's vertex IDs.
577+
description: |
578+
Returns the face's vertex IDs.
574579
code_samples: []
575580
parameters:
576581
- name: faceId
@@ -579,7 +584,8 @@ methods:
579584
summary: ''
580585
returns:
581586
- type: Array
582-
summary: ''
587+
summary: |
588+
List of vertex IDs around the given face.
583589
tags:
584590
- CustomLuaState
585591
deprecation_message: ''
@@ -596,7 +602,8 @@ methods:
596602
parameters: []
597603
returns:
598604
- type: Array
599-
summary: ''
605+
summary: |
606+
List of stable face IDs.
600607
tags:
601608
- CustomLuaState
602609
deprecation_message: ''
@@ -696,7 +703,8 @@ methods:
696703
parameters: []
697704
returns:
698705
- type: Vector3
699-
summary: ''
706+
summary: |
707+
Size of the `EditableMesh`.
700708
tags: []
701709
deprecation_message: ''
702710
security: None

tools/checks/utils/allowedHttpLinks.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -575,3 +575,4 @@ https://impactacademies.cz/
575575
https://impactacademies.de/
576576
https://impactacademies.me/
577577
https://www.youtube-nocookie.com/embed/5NvGzKVyKxg
578+
https://www.youtube-nocookie.com/embed/qfWKYgO63OI

0 commit comments

Comments
 (0)