Skip to content

Commit a4f43c3

Browse files
update Open Source Docs from Roblox internal teams
1 parent e7f6461 commit a4f43c3

File tree

11 files changed

+111
-58
lines changed

11 files changed

+111
-58
lines changed

content/en-us/art/modeling/assign-textures.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To assign Roblox-supported textures to your 3D model in Blender:
4141
3. Connect NormalMap's `Normal` to PrincipledBSDF's `Normal` socket.
4242

4343
<Alert severity ='success'>
44-
After replacing your PBR textures, [export the entire head](../../art/modeling/export-requirements.md#blender) and follow instructions to [import into Studio](./3d-importer.md).
44+
After replacing your PBR textures, [export the entire model](../../art/modeling/export-requirements.md#blender) and follow instructions to [import into Studio](./3d-importer.md).
4545
</Alert>
4646

4747
## Maya
@@ -66,5 +66,5 @@ To assign Roblox-supported textures to your 3D model in Maya:
6666
<img src="../../assets/modeling/textures-decals/Maya-Assign-Material.png" width="65%" />
6767

6868
<Alert severity ='success'>
69-
After replacing your PBR textures, [export the entire head](../../art/modeling/export-requirements.md#maya) and follow instructions to [import into Studio](./3d-importer.md).
69+
After replacing your PBR textures, [export the model](../../art/modeling/export-requirements.md#maya) and follow instructions to [import into Studio](./3d-importer.md).
7070
</Alert>

content/en-us/ip-licensing/creators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ To apply to use an IP license in your experience:
2828
2. Select an IP from the available licenses.
2929
3. Click **Request license**.
3030
4. Select the experience you want to apply to the license with and click **Next**.
31-
5. (Optional) Under **Intent**, enter more details about your experience in the form of a pitch. This can help the IP holder make a decision about your application. For more information about writing a pitch, see [Pitch details](#pitch-details).
31+
5. Under **Intent**, enter more details about your experience in the form of a pitch. This can help the IP holder make a decision about your application. For more information about writing a pitch, see [Pitch details](#pitch-details).
3232
6. Under **Experience readiness**, select one of the following:
3333
- **Yes, my experience is ready to use this intellectual property** if you're done incorporating the IP into your experience. Revenue share will start as soon as the license agreement becomes active.
3434
- **No, I need time to incorporate this intellectual property into my experience** if you're not done incorporating the IP into your experience. Revenue share won't start immediately, but the IP holder can still turn on monetization at any time.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,8 @@ methods:
183183
HTTP request parameters as method parameters instead of a single
184184
dictionary and returns only the body of the HTTP response. Generally, this
185185
method is useful only as a shorthand and
186-
`Class.HttpService:RequestAsync()|RequestAsync()` should to be used in
187-
most cases.
186+
`Class.HttpService:RequestAsync()|RequestAsync()` should be used in most
187+
cases.
188188
189189
When `true`, the `nocache` parameter prevents this method from caching
190190
results from previous calls with the same `url`.
@@ -333,8 +333,8 @@ methods:
333333
HTTP request parameters as method parameters instead of a single
334334
dictionary and returns only the body of the HTTP response. Generally, this
335335
method is useful only as a shorthand and
336-
`Class.HttpService:RequestAsync()|RequestAsync()` should to be used in
337-
most cases.
336+
`Class.HttpService:RequestAsync()|RequestAsync()` should be used in most
337+
cases.
338338
339339
When `true`, the `compress` parameter controls whether large request
340340
bodies will be compressed using **gzip**.

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

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1272,21 +1272,29 @@ methods:
12721272
capabilities: []
12731273
- name: Instance:IsPropertyModified
12741274
summary: |
1275-
Returns `true` if the value stored in the specified property is equal to
1276-
the code-instantiated default.
1275+
Returns `true` if the value stored in the specified property is not equal
1276+
to the code-instantiated default.
12771277
description: |
1278-
Returns `true` if the value stored in the specified property is equal to
1279-
the code‑instantiated default. For example, if outputting the
1280-
`Class.TextLabel.TextSize|TextSize` property of a `Class.TextLabel`
1281-
indicates `8`, then calling `IsPropertyModified("TextSize")` on the label
1282-
will return `false` because `8` is the default value for
1283-
`Class.TextLabel.TextSize` when the label is created via
1284-
`Instance.new("TextLabel")` rather than inserted through the Studio
1285-
insertion workflows.
1278+
This method indicates whether a specific property has been modified from
1279+
the code‑instantiated default. If called on an instance newly created via
1280+
code (`Datatype.Instance.new()`), this method will return `false`. If
1281+
called on an object newly created by Studio workflows such as
1282+
[Explorer](../../../studio/explorer.md) window insertion, the result may
1283+
differ.
1284+
1285+
For example, querying the
1286+
`Class.TextLabel.BackgroundColor3|BackgroundColor3` property of a
1287+
`Class.TextLabel` inserted via the [Explorer](../../../studio/explorer.md)
1288+
will return `true`, but querying the same property of a `Class.TextLabel`
1289+
created through `Datatype.Instance.new()` will return `false`, assuming no
1290+
other changes were made to its
1291+
`Class.TextLabel.BackgroundColor3|BackgroundColor3`.
12861292
12871293
Note that if this method returns `true`, styling will **not** affect the
12881294
property because explicitly modifying a property takes precedence over
1289-
styling it.
1295+
styling it. To reset a property to its code‑instantiated default and allow
1296+
styling on it, use
1297+
`Class.Instance:ResetPropertyToDefault()|ResetPropertyToDefault()`.
12901298
code_samples: []
12911299
parameters:
12921300
- name: property
@@ -1297,7 +1305,8 @@ methods:
12971305
returns:
12981306
- type: boolean
12991307
summary: |
1300-
Boolean indicating whether the property is modified.
1308+
Boolean indicating whether the property is modified from its
1309+
code‑instantiated default.
13011310
tags: []
13021311
deprecation_message: ''
13031312
security: None

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ properties:
6969
"imposter" mesh (colored, coarse mesh that wraps around all child parts of
7070
the model) renders outside the streaming radius.
7171
72+
When set to `Enum.ModelLevelOfDetail|SLIM`, a Scalable Lightweight
73+
Interactive Model, or SLIM, model (a composite of all child parts of the
74+
model) renders at progressively lower resolutions at distances based on
75+
the streaming radius. This greatly improves visual quality over
76+
`StreamingMesh`.
77+
7278
When set to `Enum.ModelLevelOfDetail|Disabled` or
7379
`Enum.ModelLevelOfDetail|Automatic`, lower resolution meshes will not be
7480
displayed.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@ events:
5757
type: int
5858
default:
5959
summary: ''
60+
- name: reason
61+
type: string
62+
default:
63+
summary: ''
6064
tags: []
6165
deprecation_message: ''
6266
security: None

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -666,8 +666,8 @@ properties:
666666
thread_safety: ReadSafe
667667
category: Behavior
668668
serialization:
669-
can_load: true
670-
can_save: true
669+
can_load: false
670+
can_save: false
671671
capabilities:
672672
- Players
673673
- name: Player.HasVerifiedBadge
@@ -1276,7 +1276,7 @@ methods:
12761276
<tr>
12771277
<th><code>LaunchData</code></th>
12781278
<td>string</td>
1279-
<td>A plain or JSON encoded string that contains launch data specified in a <a href="../../../production/promotion/deeplinks.md">deep link</a> URL or
1279+
<td>A plain or JSON encoded string that contains launch data specified in a <a href="../../../production/promotion/share-links.md">share link</a> or
12801280
<code>Class.ExperienceInviteOptions.LaunchData</code>.</td>
12811281
</tr>
12821282
<tr>

content/en-us/reference/engine/datatypes/Vector3.yaml

Lines changed: 33 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ tags: []
3838
deprecation_message: ''
3939
constructors:
4040
- name: Vector3.new
41-
summary: Returns a new `Datatype.Vector3` from the given x, y, and z components.
42-
description: Returns a new `Datatype.Vector3` using the given x, y, and z components.
41+
summary: Returns a new `Datatype.Vector3` from the given `x`, `y`, and `z` components.
42+
description: Returns a new `Datatype.Vector3` using the given `x`, `y`, and `z` components.
4343
parameters:
4444
- name: x
4545
type: number
@@ -81,9 +81,9 @@ constructors:
8181
constants:
8282
- name: Vector3.zero
8383
type: Vector3
84-
summary: A `Datatype.Vector3` with a magnitude of zero.
84+
summary: A `Datatype.Vector3` with a magnitude of `0`.
8585
description: |-
86-
A `Datatype.Vector3` with a magnitude of zero.
86+
A `Datatype.Vector3` with a magnitude of `0`.
8787
8888
This API member is a **constant**, and must be accessed through the
8989
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3` object.
@@ -96,9 +96,9 @@ constants:
9696
deprecation_message: ''
9797
- name: Vector3.one
9898
type: Vector3
99-
summary: A `Datatype.Vector3` with a value of 1 on every axis.
99+
summary: A `Datatype.Vector3` with a value of `1` on every axis.
100100
description: |-
101-
A `Datatype.Vector3` with a value of 1 on every axis.
101+
A `Datatype.Vector3` with a value of `1` on every axis.
102102
103103
This API member is a **constant**, and must be accessed through the
104104
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3` object.
@@ -111,9 +111,9 @@ constants:
111111
deprecation_message: ''
112112
- name: Vector3.xAxis
113113
type: Vector3
114-
summary: A `Datatype.Vector3` with a value of 1 on the X axis.
114+
summary: A `Datatype.Vector3` with a value of `1` on the **X** axis.
115115
description: |-
116-
A `Datatype.Vector3` with a value of 1 on the X axis.
116+
A `Datatype.Vector3` with a value of `1` on the **X** axis.
117117
118118
This API member is a **constant**, and must be accessed through the
119119
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3` object.
@@ -126,9 +126,9 @@ constants:
126126
deprecation_message: ''
127127
- name: Vector3.yAxis
128128
type: Vector3
129-
summary: A `Datatype.Vector3` with a value of 1 on the Y axis.
129+
summary: A `Datatype.Vector3` with a value of `1` on the **Y** axis.
130130
description: |-
131-
A `Datatype.Vector3` with a value of 1 on the Y axis.
131+
A `Datatype.Vector3` with a value of `1` on the **Y** axis.
132132
133133
This API member is a **constant**, and must be accessed through the
134134
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3` object.
@@ -141,9 +141,9 @@ constants:
141141
deprecation_message: ''
142142
- name: Vector3.zAxis
143143
type: Vector3
144-
summary: A `Datatype.Vector3` with a value of 1 on the Z axis.
144+
summary: A `Datatype.Vector3` with a value of `1` on the **Z** axis.
145145
description: |-
146-
A `Datatype.Vector3` with a value of 1 on the Z axis.
146+
A `Datatype.Vector3` with a value of `1` on the **Z** axis.
147147
148148
This API member is a **constant**, and must be accessed through the
149149
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3` object.
@@ -158,9 +158,9 @@ properties:
158158
- name: Vector3.zero
159159
type: Vector3
160160
summary: |
161-
A `Datatype.Vector3` with a magnitude of zero.
161+
A `Datatype.Vector3` with a magnitude of `0`.
162162
description: |
163-
A `Datatype.Vector3` with a magnitude of zero.
163+
A `Datatype.Vector3` with a magnitude of `0`.
164164
165165
This API member is a **constant**, and must be accessed through the
166166
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3`
@@ -176,9 +176,9 @@ properties:
176176
- name: Vector3.one
177177
type: Vector3
178178
summary: |
179-
A `Datatype.Vector3` with a value of 1 on every axis.
179+
A `Datatype.Vector3` with a value of `1` on every axis.
180180
description: |
181-
A `Datatype.Vector3` with a value of 1 on every axis.
181+
A `Datatype.Vector3` with a value of `1` on every axis.
182182
183183
This API member is a **constant**, and must be accessed through the
184184
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3`
@@ -194,9 +194,9 @@ properties:
194194
- name: Vector3.xAxis
195195
type: Vector3
196196
summary: |
197-
A `Datatype.Vector3` with a value of 1 on the X axis.
197+
A `Datatype.Vector3` with a value of `1` on the **X** axis.
198198
description: |
199-
A `Datatype.Vector3` with a value of 1 on the X axis.
199+
A `Datatype.Vector3` with a value of `1` on the **X** axis.
200200
201201
This API member is a **constant**, and must be accessed through the
202202
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3`
@@ -212,9 +212,9 @@ properties:
212212
- name: Vector3.yAxis
213213
type: Vector3
214214
summary: |
215-
A `Datatype.Vector3` with a value of 1 on the Y axis.
215+
A `Datatype.Vector3` with a value of `1 `on the **Y** axis.
216216
description: |
217-
A `Datatype.Vector3` with a value of 1 on the Y axis.
217+
A `Datatype.Vector3` with a value of `1` on the **Y** axis.
218218
219219
This API member is a **constant**, and must be accessed through the
220220
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3`
@@ -230,9 +230,9 @@ properties:
230230
- name: Vector3.zAxis
231231
type: Vector3
232232
summary: |
233-
A `Datatype.Vector3` with a value of 1 on the Z axis.
233+
A `Datatype.Vector3` with a value of `1` on the **Z** axis.
234234
description: |
235-
A `Datatype.Vector3` with a value of 1 on the Z axis.
235+
A `Datatype.Vector3` with a value of `1` on the **Z** axis.
236236
237237
This API member is a **constant**, and must be accessed through the
238238
`Datatype.Vector3` global as opposed to an individual `Datatype.Vector3`
@@ -248,39 +248,39 @@ properties:
248248
- name: Vector3.X
249249
type: number
250250
summary: |
251-
The x-coordinate of the Vector3.
251+
The **X** coordinate of the `Datatype.Vector3`.
252252
description: |
253-
The x-coordinate of the Vector3.
253+
The **X** coordinate of the `Datatype.Vector3`.
254254
default:
255255
code_samples: []
256256
tags: []
257257
deprecation_message: ''
258258
- name: Vector3.Y
259259
type: number
260260
summary: |
261-
The y-coordinate of the Vector3.
261+
The **Y** coordinate of the `Datatype.Vector3`.
262262
description: |
263-
The y-coordinate of the Vector3.
263+
The **Y** coordinate of the `Datatype.Vector3`.
264264
default:
265265
code_samples: []
266266
tags: []
267267
deprecation_message: ''
268268
- name: Vector3.Z
269269
type: number
270270
summary: |
271-
The z-coordinate of the Vector3.
271+
The **Z** coordinate of the `Datatype.Vector3`.
272272
description: |
273-
The z-coordinate of the Vector3.
273+
The **Z** coordinate of the `Datatype.Vector3`.
274274
default:
275275
code_samples: []
276276
tags: []
277277
deprecation_message: ''
278278
- name: Vector3.Magnitude
279279
type: number
280280
summary: |
281-
The length of the Vector3.
281+
The length of the `Datatype.Vector3`.
282282
description: |
283-
The length of the Vector3.
283+
The length of the `Datatype.Vector3`.
284284
default:
285285
code_samples: []
286286
tags: []
@@ -289,10 +289,10 @@ properties:
289289
type: Vector3
290290
summary: |
291291
A normalized copy of the `Datatype.Vector3` - one that has the same
292-
direction as the original but a magnitude of 1.
292+
direction as the original but a magnitude of `1`.
293293
description: |
294294
A normalized copy of the `Datatype.Vector3` - one that has the same
295-
direction as the original but a magnitude of 1.
295+
direction as the original but a magnitude of `1`.
296296
default:
297297
code_samples: []
298298
tags: []
@@ -439,9 +439,7 @@ methods:
439439
description: |
440440
Returns a `Datatype.Vector3` linearly interpolated between this
441441
`Datatype.Vector3` and the given `goal` `Datatype.Vector3` by the fraction
442-
`alpha`.
443-
444-
Note: the `alpha` value is **not** limited to the range [0, 1].
442+
`alpha`. Note that `alpha` is **not** limited to the range `[0, 1]`.
445443
parameters:
446444
- name: goal
447445
type: Vector3

content/en-us/reference/engine/enums/Material.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ items:
125125
deprecation_message: ''
126126
- name: CorrodedMetal
127127
summary: |
128-
Applies to `Class.BasePart` and `Class.Terrain`.
128+
Applies to `Class.BasePart` only.
129129
value: 1040
130130
tags: []
131131
deprecation_message: ''

content/en-us/reference/engine/enums/ModelLevelOfDetail.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ items:
2727
value: 1
2828
tags: []
2929
deprecation_message: ''
30+
- name: SLIM
31+
summary: |
32+
A Scalable Lightweight Interactive Model, or SLIM, model (a composite of
33+
all child parts of the model) renders at progressively lower resolutions
34+
at distances based on the streaming radius. Greatly improves visual
35+
quality over `StreamingMesh`.
36+
value: 2
37+
tags: []
38+
deprecation_message: ''
3039
- name: Disabled
3140
summary: |
3241
A lower resolution mesh will not be displayed.

0 commit comments

Comments
 (0)