Skip to content

Commit 2f7dcb5

Browse files
rbx-open-source-docs[bot]rbx-open-source-docs[bot]
committed
update Open Source Docs from Roblox internal teams
1 parent 887bcee commit 2f7dcb5

File tree

3 files changed

+237
-45
lines changed

3 files changed

+237
-45
lines changed

‎content/common/navigation/engine/studio.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ navigation:
8383
path: /studio/properties
8484
- title: Game Settings
8585
path: /studio/game-settings
86+
- title: Avatar Settings
87+
path: /studio/avatar-settings
8688
- title: Shortcuts
8789
path: /studio/shortcuts
8890
- heading: Plugins

‎content/en-us/studio/avatar-settings.md‎

Lines changed: 234 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,234 @@
1+
---
2+
title: Avatar Settings
3+
description: The Avatar Settings window contains all Studio-level settings and customization options for an experience.
4+
---
5+
6+
The **Avatar Settings** window allows you to control the look and behavior of user avatars across your entire experience.
7+
8+
Most experiences will find that the default avatar settings work perfectly right out of the box, offering a seamless player experience. The extensive controls in Avatar Settings are primarily for advanced creators looking to finely tune avatar appearance and behavior for specific gameplay needs.
9+
10+
<Alert severity="warning">
11+
Avatar Settings modifies underlying experience defaults that are not visible outside of the settings interface or accessible with scripts. This can lead to difficult-to-debug behaviors, especially when working across teams or on a universe with multiple place files.
12+
13+
Test your changes by using the Avatar Settings preview and by playtesting in Studio so that you fully understand the impact on player avatars before publishing changes to your live experience.
14+
</Alert>
15+
16+
## Top bar
17+
18+
The top bar of the Avatar Settings window provides easy access to quickly set the Avatar Type, assign a preset, and enable preview.
19+
20+
<table>
21+
<thead>
22+
<tr>
23+
<th>Setting</th>
24+
<th>Description</th>
25+
</tr>
26+
</thead>
27+
<tbody>
28+
<tr>
29+
<td>**Preset**</td>
30+
<td>Displays which Settings preset is enabled and allows you to toggle between them (for descriptions of each setting, see [General](#general)). <br /><br />If the preset displays `--`, this indicates that the current settings are customized and do not match a preset.<br /> </td>
31+
</tr>
32+
<tr>
33+
<td>**Preview**</td>
34+
<td>Toggles a preview lineup of avatars based off the avatar settings applied. <br/><br/>This creates an `AvatarPreview` folder under **Workspace** > **Camera** with four representative avatar types. You can add or remove avatars to the lineup by dragging them into or out of the folder. <br/> <br/>This folder is removed during Studio runtime playtesting and it is not saved to your place file.</td>
35+
</tr>
36+
<tr>
37+
<td>**. . .**</td>
38+
<td>Avatar Type: sets the default avatar type to either **R6**, **R15**, or **R15 & R6**.</td>
39+
</tr>
40+
41+
</tbody>
42+
</table>
43+
44+
## General
45+
46+
The **General** tab offers simple presets tailored to the needs of most experiences. In many cases, one of these presets will fit your experience's avatar use-cases and additional configuration is not necessary. However, advanced developers can further customize avatar behavior using the more detailed settings available in the other tabs.
47+
48+
<table>
49+
<thead>
50+
<tr>
51+
<th>Setting</th>
52+
<th>Description</th>
53+
</tr>
54+
</thead>
55+
<tbody>
56+
<tr>
57+
<td>****Player Choice****</td>
58+
<td>Loads player avatars without any modifications.</td>
59+
</tr>
60+
<tr>
61+
<td>**Consistent Gameplay**</td>
62+
<td>Sets all avatars to the same height with the same box collider for consistent collision behavior.</td>
63+
</tr>
64+
</tbody>
65+
</table>
66+
67+
## Body
68+
69+
The **Body** tab contains settings for body proportions, parts, scale.
70+
71+
<table>
72+
<thead>
73+
<tr>
74+
<th>Setting</th>
75+
<th>Description</th>
76+
</tr>
77+
</thead>
78+
<tbody>
79+
<tr>
80+
<td>**Scale**</td>
81+
<td>
82+
<ul>
83+
<li>**Player Choice** (default): Does not modify avatar character scale.</li>
84+
<li>**Custom Scale**: Allows you to scale avatars to an absolute height in studs, but maintain their proportions. You can set a **Minimum** and **Maximum** range. </li>
85+
</ul>
86+
<br />
87+
<Typography variant='body1'>For reference, classic style avatars are around 5 studs tall. More humanoid style proportions are around 6 - 6.5 studs.</Typography>
88+
</td>
89+
</tr>
90+
<tr>
91+
<td>**Appearance**</td>
92+
<td>
93+
<ul>
94+
<li>**Player Choice** (default): Does not modify avatar character appearance.</li>
95+
<li>**Custom Parts**: Lets you override a user's default body part to a custom ID.</li>
96+
</ul>
97+
</td>
98+
</tr>
99+
<tr>
100+
<td>**Build**</td>
101+
<td>
102+
<ul>
103+
<li>**Player Choice** (default): Does not modify avatar character proportions.</li>
104+
<li>**Custom Build**: Provides customization options that limits the user's avatar body type, height, width, head size, and proportions. </li>
105+
</ul>
106+
</td>
107+
</tr>
108+
</tbody>
109+
</table>
110+
111+
## Clothing
112+
113+
The **Clothing** tab contains controls for layered and classic clothing.
114+
115+
<table>
116+
<thead>
117+
<tr>
118+
<th>Setting</th>
119+
<th>Description</th>
120+
</tr>
121+
</thead>
122+
<tbody>
123+
<tr>
124+
<td>Clothing Scale</td>
125+
<td>
126+
<ul>
127+
<li>**Player Choice** (default): Keep user's avatar clothing.</li>
128+
<li>**Custom Limit**: Remove any clothing that exceeds the limit bounds of the avatar.</li>
129+
<ul>
130+
<li>**Limit Bounds**: The amount of length, width, and depth padding beyond the avatar body’s bounding box, expressed as a percentage. <br /> <br />0% means no padding and items must be strictly within the bounding box of the body and 100% adds padding equal to the avatar's bounding box on all sides, allowing items to occupy up to three times the body size. <br /> <br />This limit is shown as a blue box around each avatar in the preview lineup.</li>
131+
</ul>
132+
</ul>
133+
</td>
134+
</tr>
135+
<tr>
136+
<td>Custom Clothing</td>
137+
<td>
138+
<ul>
139+
<li>**Player Choice** (default): Keep user's avatar clothing.</li>
140+
<li>**Custom Clothing**: Lets you override a user's layered clothing equip slot or classic clothing type to a custom ID. If you check the box to override, but leave the Asset ID field blank, it will remove all player clothing in that equip slot.</li>
141+
</ul>
142+
</td>
143+
</tr>
144+
</tbody>
145+
</table>
146+
147+
## Accessories
148+
149+
The **Accessories** tab contains settings related to accessories in your experience.
150+
151+
<table>
152+
<thead>
153+
<tr>
154+
<th>Setting</th>
155+
<th>Description</th>
156+
</tr>
157+
</thead>
158+
<tbody>
159+
<tr>
160+
<td>**Accessory Scale**</td>
161+
<td>
162+
<ul>
163+
<li>**Player Choice** (default): Does not change the scale of user's equipped accessories.</li>
164+
<li>**Custom Limit**: Allows you to **Scale** accessories, or **Remove** accessories that exceed limit bounds.</li>
165+
<ul>
166+
<li>**Limit Method**: Allows you to **Scale** accessories to fit within limit bounds, or **Remove** accessories that exceed limit bounds.</li>
167+
<li>**Limit Bounds**: The amount of length, width, and depth padding beyond the avatar body's bounding box, expressed as a percentage. <br /> <br />0% means no padding and items must be strictly within the bounding box of the body and 100% means pad by 100% of the bounding box on each side, so items can occupy an area three times the size of the body. <br /> <br />The limit bounds are visualized as a blue box around each avatar in the preview lineup.</li>
168+
</ul>
169+
</ul>
170+
</td>
171+
</tr>
172+
<tr>
173+
<td>**Custom Accessories**</td>
174+
<td>
175+
<ul>
176+
<li>**Player Choice** (default): Keep user's avatar accessories.</li>
177+
<li>**Custom Accessories**: Lets you override a user's accessory types to a custom ID. If you check the box to override, but leave the Asset ID field blank, it will remove all player accessories of that category.</li>
178+
</ul>
179+
</td>
180+
</tr>
181+
<tr>
182+
<td>**Accessory Behaviors**</td>
183+
<td>Controls to enable/disable accessory behaviors like VFX and Sound.</td>
184+
</tr>
185+
</tbody>
186+
</table>
187+
188+
## Movement
189+
190+
The **Movement** tab contains collision and animation settings.
191+
192+
<table>
193+
<thead>
194+
<tr>
195+
<th>Setting</th>
196+
<th>Description</th>
197+
</tr>
198+
</thead>
199+
<tbody>
200+
<tr>
201+
<td>**Collision**</td>
202+
<td>
203+
<ul>
204+
<li>**Default**: Use Outer Box method for collisions. This method calculates collisions based off the bounding boxes of avatar parts. </li>
205+
<li>**Single Collider**: Use a single consistently sized box for collisions.</li>
206+
<ul>
207+
<li>**Size**: Set the length, width, and depth of the collider box.</li>
208+
<li>**Hit & Touch Detection**: Set hit and touch events to use avatar **parts** or **colliders**.</li>
209+
</ul>
210+
<li>**Legacy**: Use Inner Box Collision method (for backwards compatibility only).</li>
211+
</ul>
212+
</td>
213+
</tr>
214+
<tr>
215+
<td>**Animation Packs**</td>
216+
<td>
217+
<ul>
218+
<li>**Player Choice** (default): Keep user's platform animation style, including style packs</li>
219+
<li>**Standard R15**: All avatars will use the Standard R15 platform animations.</li>
220+
<li>**Standard R6**: All avatars will use the Standard R6 platform animations.</li>
221+
</ul>
222+
</td>
223+
</tr>
224+
<tr>
225+
<td>**Animation Clips**</td>
226+
<td>
227+
<ul>
228+
<li>**Player Choice** (default): Keep user's platform animations.</li>
229+
<li>**Custom Clips**: Lets you override and preview any default animation type with a custom ID. These overrides are applied **on top of your selection of Animation Pack**.</li>
230+
</ul>
231+
</td>
232+
</tr>
233+
</tbody>
234+
</table>

‎content/en-us/studio/game-settings.md‎

Lines changed: 1 addition & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ customization options for Roblox experiences, including settings for
88
[permissions](#permissions), [monetization](#monetization), [security](#security), and [localization](#localization). You can access it from the Studio application's **File** menu.
99

1010
<Alert severity="warning">
11-
The **Game Settings** window is only available for experiences saved or [published](../production/publishing/publish-experiences-and-places.md) to Roblox.
11+
Many settings in this window modify underlying properties in your place file that aren’t visible in Studio or accessible with scripts. This can lead to unexpected or difficult-to-debug behavior, especially when working across teams or reverting changes. Make sure you fully understand the impact of each setting before applying changes.
1212
</Alert>
1313

1414
## Basic Info
@@ -218,50 +218,6 @@ The **Localization** tab contains language settings related to [localization](..
218218
</tbody>
219219
</table>
220220

221-
## Avatar
222-
223-
The **Avatar** tab includes global settings for all users'
224-
[avatars](../characters/index.md) while they are in the experience.
225-
226-
<table>
227-
<thead>
228-
<tr>
229-
<th>Setting</th>
230-
<th>Description</th>
231-
</tr>
232-
</thead>
233-
<tbody>
234-
<tr>
235-
<td>**Presets**</td>
236-
<td>Sets the options lower in the tab to presets for **Default**, **Classic&nbsp;Scale**, **Full&nbsp;Classic**, **Rthro**, or **Player&nbsp;Choice**.</td>
237-
</tr>
238-
<tr>
239-
<td>**Avatar&nbsp;Type**</td>
240-
<td>Sets the default [avatar type](../characters/appearance.md#avatar-types) to either **R6**, **R15**, or **Player&nbsp;Choice**.</td>
241-
</tr>
242-
<tr>
243-
<td>**Animation**</td>
244-
<td>Sets the default animation to either **Standard** or **Player&nbsp;Choice**.</td>
245-
</tr>
246-
<tr>
247-
<td>**Collision**</td>
248-
<td>Sets the collision type to either the **Outer&nbsp;Box** or **Inner&nbsp;Box**.</td>
249-
</tr>
250-
<tr>
251-
<td>**Scale**</td>
252-
<td>For **R15** avatars, options to customize body type, height, width, head size, and proportions.</td>
253-
</tr>
254-
<tr>
255-
<td>**Body&nbsp;Parts**</td>
256-
<td>Lets you override a user's default body part type to a custom ID.</td>
257-
</tr>
258-
<tr>
259-
<td>**Clothing**</td>
260-
<td>Lets you override a user's default classic clothing ID to a custom ID.</td>
261-
</tr>
262-
</tbody>
263-
</table>
264-
265221
## World
266222

267223
The **World** tab includes global settings for the experience, such as

0 commit comments

Comments
 (0)