Skip to content

Commit 26ad2d4

Browse files
update Open Source Docs from Roblox internal teams
1 parent b17dff6 commit 26ad2d4

File tree

21 files changed

+1187
-864
lines changed

21 files changed

+1187
-864
lines changed

content/en-us/production/localization/automatic-translations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Automatic Text Capture (ATC) captures text strings from UI elements in your expe
1919

2020
ATC evaluates over time which strings should be added to your translation table, so it may take up to a few days for new strings to appear in Translator Portal after users encounter them. If you require strings to be captured immediately, you can use the [Studio text capture process](#text-capture-in-studio).
2121

22+
ATC only captures text objects that have `Class.GuiBase2d.AutoLocalize|AutoLocalize` enabled. If you do not want ATC to collect a certain text string, such as a name or unique text entry, disable this property. Note that for `Class.TextBox` objects, only `Class.TextBox.PlaceholderText|PlaceholderText` is captured; the assumption is that strings in `Class.TextBox.Text|Text` were provided by the player.
23+
2224
To enable Automatic Text Capture:
2325

2426
1. In localization settings, navigate to **Settings**.
@@ -27,8 +29,6 @@ To enable Automatic Text Capture:
2729
<img src="../../assets/localization/Portal-Enable-ATC.png"
2830
width="800" alt="The Localization Settings section highlighting the toggle for Capture text from Experience UI while users play."/>
2931

30-
ATC adds text strings to the localization table within 1–2 minutes of encountering the text in the experience. If you do not want ATC to collect a certain text string, such as a name or unique text entry, disable the `Class.GuiBase2d.AutoLocalize|AutoLocalize` property of the text object.
31-
3232
<Alert severity="info">
3333
ATC can not capture some experience objects. These objects may require special handling with <a href="./localize-with-scripting.md">localization scripts</a>. The current exemptions are:
3434
<ul>

content/en-us/production/promotion/ads-manager.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,12 @@ You can use existing thumbnail images you have previously uploaded to the Creato
8080

8181
### Define the campaign
8282

83+
<Alert severity="warning">
84+
Campaigns for experiences that are not unique can result in **no ad spend** and **no conversions**.
85+
86+
Experiences with metadata and place files that closely resemble existing experiences on Roblox are not prioritized for recommendations and might rank lower in search results. Campaigns for these experiences might not be effective.
87+
</Alert>
88+
8389
To create an ad campaign with the new Ads Manager:
8490

8591
1. Go to **Manage Ads** and click **Create Campaign**.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
0.689.0.6890885
2-
version-35c93a9f28424904
1+
0.690.0.6900721
2+
version-ffd2994ae3bd41ab

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

Lines changed: 66 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,19 @@
55
name: Attachment
66
type: class
77
memory_category: Instances
8-
summary: |-
8+
summary: |
99
Defines a point and orientation relative to an ancestor `Class.PVInstance`,
1010
`Class.Bone`, or another `Class.Attachment`.
11-
description: |-
12-
An `Attachment` defines a point and orientation relative to an ancestor `Class.PVInstance`, `Class.Bone`, or another `Attachment`. The offset is stored in the `Class.Attachment.CFrame|CFrame` property. The offset can also be set through other properties, such as `Class.Attachment.WorldCFrame|WorldCFrame`.
11+
description: |
12+
An `Attachment` defines a point and orientation relative to an ancestor
13+
`Class.PVInstance`, `Class.Bone`, or another `Attachment`. The offset is
14+
stored in the `Class.Attachment.CFrame|CFrame` property. The offset can also
15+
be set through other properties, such as
16+
`Class.Attachment.WorldCFrame|WorldCFrame`.
1317
14-
If no ancestral `Class.PVInstance` or `Class.Attachment` exists, then `Class.Attachment.CFrame|CFrame` and `Class.Attachment.WorldCFrame|WorldCFrame` are the same.
18+
If no ancestral `Class.PVInstance` or `Class.Attachment` exists, then
19+
`Class.Attachment.CFrame|CFrame` and
20+
`Class.Attachment.WorldCFrame|WorldCFrame` are the same.
1521
1622
Attachments are used by several kinds of `Class.Constraint|Constraints` and
1723
are also valid alternatives to `Class.BasePart` as a parent for objects such
@@ -34,10 +40,10 @@ tags: []
3440
deprecation_message: ''
3541
properties:
3642
- name: Attachment.Axis
37-
summary: |-
43+
summary: |
3844
Direction of the **X** axis of the attachment, represented as a unit
3945
`Datatype.Vector3`.
40-
description: |-
46+
description: |
4147
Direction of the **X** axis of the attachment, represented as a unit
4248
`Datatype.Vector3`.
4349
code_samples: []
@@ -56,8 +62,9 @@ properties:
5662
capabilities:
5763
- Basic
5864
- name: Attachment.CFrame
59-
summary: '`Datatype.CFrame` offset of the attachment.'
60-
description: |-
65+
summary: |
66+
`Datatype.CFrame` offset of the attachment.
67+
description: |
6168
The `Datatype.CFrame` offset of the attachment. Changes to this property
6269
will reflect onto the `Class.Attachment.Position|Position` and
6370
`Class.Attachment.Rotation|Rotation` properties of this object. Similarly,
@@ -77,8 +84,9 @@ properties:
7784
capabilities:
7885
- Basic
7986
- name: Attachment.Orientation
80-
summary: Orientation of the attachment relative to the orientation of its parent.
81-
description: |-
87+
summary: |
88+
Orientation of the attachment relative to the orientation of its parent.
89+
description: |
8290
Orientation of the attachment relative to the orientation of its parent.
8391
Rotations are in **Z**,&nbsp;**X**,&nbsp;**Y** order.
8492
code_samples: []
@@ -98,10 +106,10 @@ properties:
98106
capabilities:
99107
- Basic
100108
- name: Attachment.Position
101-
summary: |-
109+
summary: |
102110
Positional offset of the attachment, relative to the position and
103111
orientation of its parent.
104-
description: |-
112+
description: |
105113
Positional offset of the attachment, relative to the position and
106114
orientation of its parent.
107115
code_samples: []
@@ -121,8 +129,9 @@ properties:
121129
capabilities:
122130
- Basic
123131
- name: Attachment.Rotation
124-
summary: Rotation of the attachment relative to the rotation of its parent.
125-
description: |-
132+
summary: |
133+
Rotation of the attachment relative to the rotation of its parent.
134+
description: |
126135
Rotation of the attachment relative to the rotation of its parent.
127136
Rotations are in **Z**,&nbsp;**Y**,&nbsp;**X** order.
128137
code_samples: []
@@ -131,7 +140,7 @@ properties:
131140
- Hidden
132141
- NotReplicated
133142
- Deprecated
134-
deprecation_message: |-
143+
deprecation_message: |
135144
This property is deprecated and should not be used in new work. See
136145
`Class.Attachment.Orientation|Orientation` instead.
137146
security:
@@ -145,10 +154,10 @@ properties:
145154
capabilities:
146155
- Basic
147156
- name: Attachment.SecondaryAxis
148-
summary: |-
157+
summary: |
149158
Direction of the **Y** axis of the attachment, represented as a unit
150159
`Datatype.Vector3`.
151-
description: |-
160+
description: |
152161
Direction of the **Y** axis of the attachment, represented as a unit
153162
`Datatype.Vector3`.
154163
code_samples: []
@@ -167,8 +176,10 @@ properties:
167176
capabilities:
168177
- Basic
169178
- name: Attachment.Visible
170-
summary: Toggles the in-experience visibility of the attachment.
171-
description: Toggles the in-experience visibility of the attachment.
179+
summary: |
180+
Toggles the in-experience visibility of the attachment.
181+
description: |
182+
Toggles the in-experience visibility of the attachment.
172183
code_samples: []
173184
type: boolean
174185
tags: []
@@ -184,10 +195,10 @@ properties:
184195
capabilities:
185196
- Basic
186197
- name: Attachment.WorldAxis
187-
summary: |-
198+
summary: |
188199
Direction of the **X** axis of the attachment relative to the world,
189200
represented as a unit `Datatype.Vector3` with a length of 1.
190-
description: |-
201+
description: |
191202
Direction of the **X** axis of the attachment relative to the world,
192203
represented as a unit `Datatype.Vector3` with a length of 1.
193204
code_samples: []
@@ -206,8 +217,9 @@ properties:
206217
capabilities:
207218
- Basic
208219
- name: Attachment.WorldCFrame
209-
summary: The exact `Datatype.CFrame` of the attachment in world space coordinates.
210-
description: |-
220+
summary: |
221+
The exact `Datatype.CFrame` of the attachment in world space coordinates.
222+
description: |
211223
The exact `Datatype.CFrame` of the attachment in world space coordinates,
212224
independent of its parent. The value of this property is equivalent to
213225
multiplying the `Datatype.CFrame` of the attachment's parent by its own
@@ -228,10 +240,10 @@ properties:
228240
capabilities:
229241
- Basic
230242
- name: Attachment.WorldOrientation
231-
summary: |-
243+
summary: |
232244
Orientation of the attachment relative to the world rather than its own
233245
parent.
234-
description: |-
246+
description: |
235247
Orientation of the attachment relative to the world rather than its own
236248
parent. Rotations are in **Z**,&nbsp;**X**,&nbsp;**Y** order.
237249
code_samples: []
@@ -251,10 +263,10 @@ properties:
251263
capabilities:
252264
- Basic
253265
- name: Attachment.WorldPosition
254-
summary: |-
266+
summary: |
255267
Position of the attachment relative to the world rather than its own
256268
parent.
257-
description: |-
269+
description: |
258270
Position of the attachment relative to the world rather than its own
259271
parent.
260272
code_samples: []
@@ -274,10 +286,10 @@ properties:
274286
capabilities:
275287
- Basic
276288
- name: Attachment.WorldRotation
277-
summary: |-
289+
summary: |
278290
Rotation of the attachment relative to the world rather than its own
279291
parent.
280-
description: |-
292+
description: |
281293
Rotation of the attachment relative to the world rather than its own
282294
parent.
283295
code_samples: []
@@ -287,7 +299,7 @@ properties:
287299
- ReadOnly
288300
- NotReplicated
289301
- Deprecated
290-
deprecation_message: |-
302+
deprecation_message: |
291303
This item has been superseded by
292304
`Class.Attachment.WorldOrientation|WorldOrientation` which should be used
293305
in new work.
@@ -302,10 +314,10 @@ properties:
302314
capabilities:
303315
- Basic
304316
- name: Attachment.WorldSecondaryAxis
305-
summary: |-
317+
summary: |
306318
Direction of the **Y** axis of the attachment relative to the world,
307319
represented as a unit `Datatype.Vector3` with a length of 1.
308-
description: |-
320+
description: |
309321
Direction of the **Y** axis of the attachment relative to the world,
310322
represented as a unit `Datatype.Vector3` with a length of 1.
311323
code_samples: []
@@ -325,25 +337,28 @@ properties:
325337
- Basic
326338
methods:
327339
- name: Attachment:GetAxis
328-
summary: Returns the value of the attachment's `Class.Attachment.Axis|Axis`.
329-
description: Returns the value of the attachment's `Class.Attachment.Axis|Axis`.
340+
summary: |
341+
Returns the value of the attachment's `Class.Attachment.Axis|Axis`.
342+
description: |
343+
Returns the value of the attachment's `Class.Attachment.Axis|Axis`.
330344
code_samples: []
331345
parameters: []
332346
returns:
333347
- type: Vector3
334348
summary: ''
335349
tags:
336350
- Deprecated
337-
deprecation_message: This method is deprecated and should not be used in new work.
351+
deprecation_message: |
352+
This method is deprecated and should not be used in new work.
338353
security: None
339354
thread_safety: Unsafe
340355
capabilities:
341356
- Basic
342357
- name: Attachment:GetConstraints
343-
summary: |-
358+
summary: |
344359
Returns a list of `Class.Constraint|Constraints` connected to the
345360
attachment.
346-
description: |-
361+
description: |
347362
Returns a list of `Class.Constraint|Constraints` connected to the
348363
attachment.
349364
code_samples: []
@@ -358,10 +373,10 @@ methods:
358373
capabilities:
359374
- Basic
360375
- name: Attachment:GetSecondaryAxis
361-
summary: |-
376+
summary: |
362377
Returns the value of the attachment's
363378
`Class.Attachment.SecondaryAxis|SecondaryAxis`.
364-
description: |-
379+
description: |
365380
Returns the value of the attachment's
366381
`Class.Attachment.SecondaryAxis|SecondaryAxis`.
367382
code_samples: []
@@ -371,14 +386,17 @@ methods:
371386
summary: ''
372387
tags:
373388
- Deprecated
374-
deprecation_message: This method is deprecated and should not be used in new work.
389+
deprecation_message: |
390+
This method is deprecated and should not be used in new work.
375391
security: None
376392
thread_safety: Unsafe
377393
capabilities:
378394
- Basic
379395
- name: Attachment:SetAxis
380-
summary: Sets the value of the attachment's `Class.Attachment.Axis|Axis`.
381-
description: Sets the value of the attachment's `Class.Attachment.Axis|Axis`.
396+
summary: |
397+
Sets the value of the attachment's `Class.Attachment.Axis|Axis`.
398+
description: |
399+
Sets the value of the attachment's `Class.Attachment.Axis|Axis`.
382400
code_samples: []
383401
parameters:
384402
- name: axis
@@ -390,16 +408,17 @@ methods:
390408
summary: ''
391409
tags:
392410
- Deprecated
393-
deprecation_message: This method is deprecated and should not be used in new work.
411+
deprecation_message: |
412+
This method is deprecated and should not be used in new work.
394413
security: None
395414
thread_safety: Unsafe
396415
capabilities:
397416
- Basic
398417
- name: Attachment:SetSecondaryAxis
399-
summary: |-
418+
summary: |
400419
Sets the value of the attachment's
401420
`Class.Attachment.SecondaryAxis|SecondaryAxis`.
402-
description: |-
421+
description: |
403422
Sets the value of the attachment's
404423
`Class.Attachment.SecondaryAxis|SecondaryAxis`.
405424
code_samples: []
@@ -413,7 +432,8 @@ methods:
413432
summary: ''
414433
tags:
415434
- Deprecated
416-
deprecation_message: This method is deprecated and should not be used in new work.
435+
deprecation_message: |
436+
This method is deprecated and should not be used in new work.
417437
security: None
418438
thread_safety: Unsafe
419439
capabilities:

0 commit comments

Comments
 (0)