Skip to content

Commit 24833d1

Browse files
update Open Source Docs from Roblox internal teams
1 parent 5d3c17b commit 24833d1

File tree

12 files changed

+324
-110
lines changed

12 files changed

+324
-110
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,11 @@ navigation:
9090
type: engineapi
9191
source: /reference/engine/classes/AnimationClipProvider.yaml
9292
ignoreTranslation: true
93+
- title: AnimationConstraint
94+
path: /reference/engine/classes/AnimationConstraint
95+
type: engineapi
96+
source: /reference/engine/classes/AnimationConstraint.yaml
97+
ignoreTranslation: true
9398
- title: AnimationController
9499
path: /reference/engine/classes/AnimationController
95100
type: engineapi

content/en-us/cloud/legacy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ This page summarizes the available operations and authentication types, but you
4646
| GetMembersInTeamCreateSessionByPlace | `GET v1/places/{placeId}/teamcreate/active_session/members` | `legacy-team-collaboration:manage` |
4747
| CloseTeamTestGame | `DELETE v2/teamtest/{placeId}` | `legacy-team-collaboration:manage` |
4848
| GetGroupsWithEditGroupGamePermission | `GET v1/user/groups/canmanage` | `legacy-group:manage` |
49+
| ActivateUniverse | `POST v1/universes/{universeId}/activate` | `legacy-universe:manage` |
50+
| DeactivateUniverse | `POST v1/universes/{universeId}/deactivate` | `legacy-universe:manage` |
4951

5052
## Followings API
5153

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
name: AnimationConstraint
2+
type: class
3+
category:
4+
memory_category: PhysicsParts
5+
summary: ''
6+
description: ''
7+
code_samples: []
8+
inherits:
9+
- Constraint
10+
tags:
11+
- NotBrowsable
12+
deprecation_message: ''
13+
properties:
14+
- name: AnimationConstraint.C0
15+
summary: ''
16+
description: ''
17+
code_samples: []
18+
type: CFrame
19+
tags:
20+
- Hidden
21+
- ReadOnly
22+
- NotReplicated
23+
- Deprecated
24+
deprecation_message: ''
25+
security:
26+
read: None
27+
write: None
28+
thread_safety: ReadSafe
29+
category: Data
30+
serialization:
31+
can_load: false
32+
can_save: false
33+
capabilities:
34+
- Physics
35+
- Animation
36+
writeCapabilities: []
37+
- name: AnimationConstraint.C1
38+
summary: ''
39+
description: ''
40+
code_samples: []
41+
type: CFrame
42+
tags:
43+
- Hidden
44+
- ReadOnly
45+
- NotReplicated
46+
- Deprecated
47+
deprecation_message: ''
48+
security:
49+
read: None
50+
write: None
51+
thread_safety: ReadSafe
52+
category: Data
53+
serialization:
54+
can_load: false
55+
can_save: false
56+
capabilities:
57+
- Physics
58+
- Animation
59+
writeCapabilities: []
60+
- name: AnimationConstraint.IsKinematic
61+
summary: ''
62+
description: ''
63+
code_samples: []
64+
type: bool
65+
tags: []
66+
deprecation_message: ''
67+
security:
68+
read: None
69+
write: None
70+
thread_safety: ReadSafe
71+
category: Data
72+
serialization:
73+
can_load: true
74+
can_save: true
75+
capabilities:
76+
- Physics
77+
- Animation
78+
writeCapabilities: []
79+
- name: AnimationConstraint.MaxForce
80+
summary: ''
81+
description: ''
82+
code_samples: []
83+
type: float
84+
tags: []
85+
deprecation_message: ''
86+
security:
87+
read: None
88+
write: None
89+
thread_safety: ReadSafe
90+
category: Compliance
91+
serialization:
92+
can_load: true
93+
can_save: true
94+
capabilities:
95+
- Physics
96+
- Animation
97+
writeCapabilities: []
98+
- name: AnimationConstraint.MaxTorque
99+
summary: ''
100+
description: ''
101+
code_samples: []
102+
type: float
103+
tags: []
104+
deprecation_message: ''
105+
security:
106+
read: None
107+
write: None
108+
thread_safety: ReadSafe
109+
category: Compliance
110+
serialization:
111+
can_load: true
112+
can_save: true
113+
capabilities:
114+
- Physics
115+
- Animation
116+
writeCapabilities: []
117+
- name: AnimationConstraint.Part0
118+
summary: ''
119+
description: ''
120+
code_samples: []
121+
type: BasePart
122+
tags:
123+
- Hidden
124+
- ReadOnly
125+
- NotReplicated
126+
- Deprecated
127+
deprecation_message: ''
128+
security:
129+
read: None
130+
write: None
131+
thread_safety: ReadSafe
132+
category: Data
133+
serialization:
134+
can_load: false
135+
can_save: false
136+
capabilities:
137+
- Physics
138+
- Animation
139+
writeCapabilities: []
140+
- name: AnimationConstraint.Part1
141+
summary: ''
142+
description: ''
143+
code_samples: []
144+
type: BasePart
145+
tags:
146+
- Hidden
147+
- ReadOnly
148+
- NotReplicated
149+
- Deprecated
150+
deprecation_message: ''
151+
security:
152+
read: None
153+
write: None
154+
thread_safety: ReadSafe
155+
category: Data
156+
serialization:
157+
can_load: false
158+
can_save: false
159+
capabilities:
160+
- Physics
161+
- Animation
162+
writeCapabilities: []
163+
- name: AnimationConstraint.Transform
164+
summary: ''
165+
description: ''
166+
code_samples: []
167+
type: CFrame
168+
tags: []
169+
deprecation_message: ''
170+
security:
171+
read: None
172+
write: None
173+
thread_safety: ReadSafe
174+
category: Data
175+
serialization:
176+
can_load: true
177+
can_save: true
178+
capabilities:
179+
- Physics
180+
- Animation
181+
writeCapabilities: []
182+
methods: []
183+
events: []
184+
callbacks: []

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

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,21 @@ methods:
2222
Creates a new `Class.EditableImage`.
2323
description: |
2424
Creates a new `Class.EditableImage`. By default, the resolution is set at
25-
512×512 but it can be specified via the returned object's
26-
`Class.EditableImage.Size` parameter. If the device‑specific editable
27-
memory budget is exhausted, creation will fail and this method will return
28-
`nil`.
25+
512×512, but you can specify a different size using the method's
26+
option table.
27+
28+
If the device‑specific editable memory budget is exhausted, creation fails
29+
and this method returns `nil`.
2930
code_samples: []
3031
parameters:
3132
- name: editableImageOptions
3233
type: Dictionary?
3334
default:
34-
summary: ''
35+
summary: |
36+
Options table containing controls for the method:
37+
38+
- `Size` – A `Datatype.Vector2` that specifies the image's desired
39+
width and height.
3540
returns:
3641
- type: Object
3742
summary: ''
@@ -137,7 +142,13 @@ methods:
137142
- name: editableMeshOptions
138143
type: Dictionary?
139144
default:
140-
summary: ''
145+
summary: |
146+
Options table containing controls for the method:
147+
148+
- `FixedSize` – A `bool`. Default value is `true`, and the returned
149+
`Class.EditableMesh` will not allow you to add or remove vertices,
150+
only modify their values. Set to `false` if the ability to change the
151+
mesh topology is required, at the expense of using more memory.
141152
returns:
142153
- type: Object
143154
summary: |
@@ -152,10 +163,10 @@ methods:
152163
- name: AssetService:CreateEditableMeshFromPartAsync
153164
summary: |
154165
Returns a new `Class.EditableMesh` instance created from an existing
155-
`Class.MeshPart`.
166+
`Class.MeshPart`.
156167
description: |
157168
Returns a new `Class.EditableMesh` instance created from the
158-
`Class.MeshPart.MeshId|MeshId` of an existing `Class.MeshPart`.
169+
`Class.MeshPart.MeshId|MeshId` of an existing `Class.MeshPart`.
159170
code_samples: []
160171
parameters:
161172
- name: meshPart
@@ -172,7 +183,9 @@ methods:
172183
tags:
173184
- Yields
174185
- Deprecated
175-
deprecation_message: 'This function has been deprecated - use `Class.AssetService:CreateEditableMeshAsync()`.'
186+
deprecation_message: |
187+
This function has been deprecated - use
188+
`Class.AssetService:CreateEditableMeshAsync()`.
176189
security: None
177190
thread_safety: Unsafe
178191
capabilities: []

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

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -395,14 +395,16 @@ events:
395395
summary: |
396396
Fires when the `Class.AudioPlayer` has completed playback and stopped.
397397
description: |
398-
Fires after the `Class.AudioPlayer` has completed playback and stopped. Note this
399-
event will **not** fire for audio with `Class.AudioPlayer.Looped|Looped` set to `true`
400-
since it continues playing upon reaching its end. This event will also **not** fire when
401-
the audio is stopped before playback has completed; for this, use
398+
Fires after the `Class.AudioPlayer` has completed playback and stopped.
399+
Note this event will **not** fire for audio with
400+
`Class.AudioPlayer.Looped|Looped` set to `true` since it continues playing
401+
upon reaching its end. This event will also **not** fire when the audio is
402+
stopped before playback has completed; for this, use
402403
`Class.AudioPlayer:GetPropertyChangedSignal()` on the
403404
`Class.AudioPlayer.IsPlaying|IsPlaying` property.
404405
405-
This event is often used to destroy an `Class.AudioPlayer` when it has completed playback.
406+
This event is often used to destroy an `Class.AudioPlayer` when it has
407+
completed playback.
406408
code_samples: []
407409
parameters: []
408410
tags: []
@@ -415,13 +417,13 @@ events:
415417
summary: |
416418
Fires when the `Class.AudioPlayer` loops.
417419
description: |
418-
Event that fires after the `Class.AudioPlayer` loops. This happens when the
419-
audio reaches the end of its content (or the end of the
420-
`Class.AudioPlayer.LoopRegion|LoopRegion` if it is active)
421-
and `Class.AudioPlayer.Looping|Looping` is `true`.
420+
Event that fires after the `Class.AudioPlayer` loops. This happens when
421+
the audio reaches the end of its content (or the end of the
422+
`Class.AudioPlayer.LoopRegion|LoopRegion` if it is active) and
423+
`Class.AudioPlayer.Looping|Looping` is `true`.
422424
423-
This event does **not** fire if the audio is looped manually by changing its
424-
`Class.AudioPlayer.TimePosition|TimePosition`.
425+
This event does **not** fire if the audio is looped manually by changing
426+
its `Class.AudioPlayer.TimePosition|TimePosition`.
425427
code_samples: []
426428
parameters: []
427429
tags: []

0 commit comments

Comments
 (0)