-After you finish your recording, you can [fine-tune](../animation/editor.md#keyframes) the keyframes, [save](../animation/editor.md#save-an-animation) your animation, then [export](../animation/editor.md#export-an-animation) it to use across all of your experiences.
+After you finish your recording, you can [fine-tune](../animation/editor.md#keyframes) the keyframes, [save](../animation/editor.md#saving-an-animation) your animation, then [export](../animation/editor.md#exporting-an-animation) it to use across all of your experiences.
## Body
@@ -80,7 +80,7 @@ The **Animation Capture - Body** allows you to quickly generate high-quality, re
-### Media and playback controls
+### Media and Playback Controls
-### Access local data
+### Accessing Local Data
Roblox saves animation data locally to `Class.ServerStorage` to preserve your animation work. In most cases, your experience shouldn't directly access this local data and instead should reference a published animation.
@@ -551,9 +551,9 @@ local myAnim = ServerStorage.RBX_ANIMSAVES.myRig.myAnimation
Since local data is stored in `Class.ServerStorage`, it doesn't replicate and isn't available from clients. If your clients need access to that data, you must move the `Class.KeyframeSequence` or `Class.CurveAnimation` objects and their descendants to `Class.ReplicatedStorage`.
-### Migrate legacy data
+### Migrating Legacy Data
-The Animation Editor previously stored animation objects directly within a rig, not within `Class.ServerStorage`. If your experience references legacy animation objects in a rig, you can migrate this data to `Class.ServerStorage` using the animation migration tool, allowing you to [access local animation data](#access-local-data) in the same way.
+The Animation Editor previously stored animation objects directly within a rig, not within `Class.ServerStorage`. If your experience references legacy animation objects in a rig, you can migrate this data to `Class.ServerStorage` using the animation migration tool, allowing you to [access local animation data](#accessing-local-data) in the same way.
To migrate your legacy animation data:
@@ -565,11 +565,11 @@ To migrate your legacy animation data:
- **Delete**: Delete animations that are already published or no longer being used.
- **Migrate**: Migrate animations that are still in progress or that haven't yet been published.
- - **Ignore**: Ignore animations if you have yet to update your experience's code to [access local data](#access-local-data) from `Class.ServerStorage`. Once updated, migrate these animations.
+ - **Ignore**: Ignore animations if you have yet to update your experience's code to [access local data](#accessing-local-data) from `Class.ServerStorage`. Once updated, migrate these animations.
3. Press **OK** when complete.
-## Export an animation
+## Exporting an Animation
When you export an animation to Studio, it becomes available for use in
all experiences. This means that you only need to create an animation
@@ -581,7 +581,7 @@ once, then you can reuse it as many times as you want.
To export an animation:
-1. **(Important)** If the animation will be used to [replace a default character animation](../animation/using.md#replace-default-animations) like running or jumping, rename the final keyframe **End** as follows:
+1. **(Important)** If the animation will be used to [replace a default character animation](../animation/using.md#replacing-default-animations) like running or jumping, rename the final keyframe **End** as follows:
1. Right-click the final white keyframe symbol in the upper bar region and choose **Rename Key Keyframe** from the
contextual menu.
@@ -603,8 +603,8 @@ To export an animation:
6. Click the **Submit** button.
Once the upload is complete, you can copy the animation's asset ID
-from the [Toolbox](../projects/assets/toolbox.md) for scripting custom animations or to replace default character animations, as outlined in [Use animations](../animation/using.md).
+from the [Toolbox](../projects/assets/toolbox.md) for scripting custom animations or to replace default character animations, as outlined in [Using Animations](../animation/using.md).
1. Click the **Creations** tab and select **Animations** from the dropdown menu.
2. Right-click the desired animation and select **Copy Asset ID** from the contextual menu.
-3. See [Use animations](../animation/using.md) for instructions on how to play the animation from a script or use the animation as a default character animation.
+3. See [Using Animations](../animation/using.md) for instructions on how to play the animation from a script or use the animation as a default character animation.
diff --git a/content/en-us/animation/events.md b/content/en-us/animation/events.md
index db03eda12..d75b0979b 100644
--- a/content/en-us/animation/events.md
+++ b/content/en-us/animation/events.md
@@ -1,5 +1,5 @@
---
-title: Animation events
+title: Animation Events
description: Animation Events are markers across the timeline span in the Animation Editor.
---
@@ -7,7 +7,7 @@ You can define animation **event markers** across the timeline span and use
`Class.AnimationTrack:GetMarkerReachedSignal()|GetMarkerReachedSignal()`
to detect those markers as the animation runs.
-## Show events
+## Showing Events
By default, the event track isn't visible. To show the event track:
@@ -25,10 +25,10 @@ By default, the event track isn't visible. To show the event track:
src="../assets/animation/animation-editor/Animation-Events-Bar.png"
width="600" />
-You can now [create](#create-events), [detect](#detect-events), and
-[duplicate](#duplicate-events) events.
+You can now [create](#creating-events), [detect](#detecting-events), and
+[duplicate](#duplicating-events) events.
-## Create events
+## Creating Events
Event markers are visual indicators of where an animation event begins. After you create an event
marker, you can move it to any frame position on the timeline.
@@ -59,7 +59,7 @@ To create a new event marker:
src="../assets/animation/animation-editor/Animation-Events-Marker-In-Timeline.png"
width="700" />
-## Detect events
+## Detecting Events
To detect animation events in a `Class.LocalScript`,
connect a function to the `Class.AnimationTrack:GetMarkerReachedSignal()|GetMarkerReachedSignal()` function of `Class.AnimationTrack`. For example:
@@ -94,7 +94,7 @@ marker within the Animation Editor. This lets you pass a custom string
(single value, comma-separated string, etc.) to the `Class.AnimationTrack:GetMarkerReachedSignal()|GetMarkerReachedSignal()` function, as illustrated by the paramString argument in the code example above. This string can then be parsed or converted, if necessary, and used for whatever action you wish to perform in the event.
-## Duplicate events
+## Duplicating Events
As you create events, they become available for usage throughout the whole
animation, not only at the frame position where you originally created them. For
@@ -131,5 +131,5 @@ steps:
| Character action | -Animate script reference | +Character Action | +Animate Script Reference |
|---|---|---|---|
| **Run** | @@ -235,9 +235,9 @@ The following table contains all of the default character animations that you ca
| Shape | -Pixel size (width x height) | -Clothing parts | +Pixel Size (width x height) | +Clothing Parts |
|---|---|---|---|---|
| Tutorials | -[Rigid accessory creation](../../art/accessories/creating-rigid/index.md) [Basic clothing creation](../../art/accessories/creating/index.md) |
+ [Rigid Accessory Creation](../../art/accessories/creating-rigid/index.md) [Basic Clothing Creation](../../art/accessories/creating/index.md) |
||
| Reference files | -[Accessory and clothing reference files](../../art/modeling/project-files.md) | +Reference Files | +[Accessory and Clothing Reference Files](../../art/modeling/project-files.md) | |
| Technical specs | -[.FBX export settings](../../art/modeling/export-requirements.md) [General mesh specifications](../../art/modeling/specifications.md) [Accessory specifications](../../art/accessories/specifications.md) [Marketplace policy](../../marketplace/marketplace-policy.md) |
+ Technical Specs | +[.FBX Export Settings](../../art/modeling/export-requirements.md) [General Mesh Specifications](../../art/modeling/specifications.md) [Accessory Specifications](../../art/accessories/specifications.md) [Marketplace Policy](../../marketplace/marketplace-policy.md) |
|
| Cosmetic creation | -[Accessories overview](../../art/accessories/specifications.md) [Layered clothing overview](../../art/accessories/layered-clothing.md) [Accessory Fitting Tool](../../art/accessories/accessory-fitting-tool.md) [Accessory specifications](../../art/accessories/specifications.md) [Marketplace requirements](../../marketplace/marketplace-policy.md) |
+ Cosmetic Creation | +[Accessories Overview](../../art/accessories/specifications.md) [Layered Clothing Overview](../../art/accessories/layered-clothing.md) [Accessory Fitting Tool](../../art/accessories/accessory-fitting-tool.md) [Accessory Specifications](../../art/accessories/specifications.md) [Marketplace Requirements](../../marketplace/marketplace-policy.md) |
|
| Texturing | -[Texturing requirements](../../art/modeling/texture-specifications.md) [PBR textures](../../art/modeling/surface-appearance.md) |
+ [Texturing Requirements](../../art/modeling/texture-specifications.md) [PBR Textures](../../art/modeling/surface-appearance.md) |
||
| Rigging and skinning | -[Rigging and skinning overview](../../art/modeling/rigging.md) [Humanoid rig requirements](../../art/characters/specifications.md#rigging) [Rig facial bones](../../art/characters/facial-animation/create-basic-heads.md#rigging) [Automatic Skin Transfer](../../art/accessories/automatic-skinning-transfer.md) [Skin facial bones](../../art/characters/facial-animation/create-basic-heads.md#skin-face-bones) |
+ Rigging and Skinning | +[Rigging and Skinning Overview](../../art/modeling/rigging.md) [Humanoid Rig Requirements](../../art/characters/specifications.md#rigging) [Rigging Facial Bones](../../art/characters/facial-animation/creating-basic-heads.md#rigging) [Auto Skin Transfer](../../art/accessories/automatic-skinning-transfer.md) [Skinning Facial Bones](../../art/characters/facial-animation/creating-basic-heads.md#skinning-face-bones) |
|
| Publishing and Marketplace | -[Uploading to Marketplace](../../marketplace/publish-to-marketplace.md) [Marketplace Policy](../../marketplace/marketplace-policy.md) [Fees and commissions](../../marketplace/marketplace-fees-and-commissions.md) |
+ [Uploading to Marketplace](../../marketplace/publishing-to-marketplace.md) [Marketplace Policy](../../marketplace/marketplace-policy.md) [Fees and Commissions](../../marketplace/marketplace-fees-and-commissions.md) |
-Skinning is still an important concept for character creation, and if you're creating custom characters, you may want to apply skinning data to the model to create a character with more natural looking poses and animations. For information on how to skin a mesh, see [Skin a humanoid model](../../art/modeling/skin-a-humanoid-model.md).
+Skinning is still an important concept for character creation, and if you're creating custom characters, you may want to apply skinning data to the model to create a character with more natural looking poses and animations. For information on how to skin a mesh, see [Skinning a Humanoid Model](../../art/modeling/skinning-a-humanoid-model.md).
@@ -45,7 +45,7 @@ To prevent a layered accessory from using skinning data from an undesired area o
-It's important to note that you could also solve the previous example's deformation issue by using a different cage altogether. For example, if you use a more humanoid cage with more space between the chest and the chin, the beard is closest to the head instead of being near the chest or neck area, so the Automatic Skinning Transfer wouldn't transfer skinning data from those regions.
+It's important to note that you could also solve the previous example's deformation issue by using a different cage altogether. For example, if you use a more humanoid cage with more space between the chest and the chin, the beard is closest to the head instead of being near the chest or neck area, so the automatic skinning transfer wouldn't transfer skinning data from those regions.
@@ -57,10 +57,10 @@ By modifying different regions of the character's cage, you can ensure that your
- 
- 
diff --git a/content/en-us/art/accessories/creating-rigid/exporting.md b/content/en-us/art/accessories/creating-rigid/exporting.md
index 12812cf0b..029491836 100644
--- a/content/en-us/art/accessories/creating-rigid/exporting.md
+++ b/content/en-us/art/accessories/creating-rigid/exporting.md
@@ -1,5 +1,5 @@
---
-title: Export from Blender
+title: Exporting
description: Use Blender's .fbx exporter with the correct settings to create a Studio-ready asset.
prev: /art/accessories/creating-rigid/texturing
next: /art/accessories/creating-rigid/importing
@@ -7,7 +7,7 @@ next: /art/accessories/creating-rigid/importing
-After modeling and texturing your asset, you can begin the process of **exporting** your Blender project as a `.fbx` or `.gltf`. For up-to-date settings, see [Export settings](../../modeling/export-requirements.md).
+After modeling and texturing your asset, you can begin the process of **exporting** your Blender project as a `.fbx` or `.gltf`. For up-to-date settings, see [Export Settings](../../modeling/export-requirements.md).
-## Export
+## Exporting
After modeling and texturing your asset, you can begin the process of **exporting** your Blender project as a `.fbx`. The start of this process includes cleaning up your project, which can involve deleting or removing any extra objects, such as lights, cameras, or mannequins, to ensure you only export the accessory mesh, and applying any modifiers to your mesh object.
@@ -190,7 +190,7 @@ To export your model as a `.fbx`:
You've completed the exporting section of this tutorial. If desired, download a [reference sample](../../assets/art/accessories/creating-rigid/Rigid_Mask_Export.fbx) of this exported file for comparison. You can use this reference in the next importing step.
-## Import
+## Importing
Studio's 3D Importer provides a quick and easy way to import third-party 3D assets into your projects. The importer provides object previews and error-checking to ensure that your asset meets Studio's general 3D requirements.
@@ -231,7 +231,7 @@ To import your asset:
After successful import, your model object should populate in your project as a `Class.Model` with the appropriate textures applied. See [3D Importer](../../art/modeling/3d-importer.md) for additional information on import settings and troubleshooting.
-## Convert
+## Converting
After importing your asset into Studio, you can begin **fitting** your imported object to a mannequin and **converting** the `Class.Model` object into a `Class.Accessory`. When fitting and converting your accessory it's important to use the **Accessory Fitting Tool (AFT)** to correctly preview the placement and apply the correct configurations to your accessory.
@@ -274,7 +274,7 @@ To fit and generate your accessory:
4. After you select the **Asset Category**, Studio begins validating the asset to ensure that it matches Roblox's accessory technical requirements.
1. If set up correctly, the window displays a green Validation Successful confirmation.
- 2. If you see an error `Could not find a Part called Handle...`, you may have published your accessory as a MeshPart instead of a legacy accessory. See [Use the Accessory Fitting tool](#convert) step 6 for more information.
+ 2. If you see an error `Could not find a Part called Handle...`, you may have published your accessory as a MeshPart instead of a legacy accessory. See [Using the Accessory Fitting Tool](#converting) step 6 for more information.
3. If other errors appear, see the error messages for specific details. Some errors may require going back to the modeling software and adjusting the asset.
-5. If the validation is successful, you can submit the asset to the upload and moderation queue for a fee. See [Fees and commissions](../../marketplace/marketplace-fees-and-commissions.md) for current fee information.
+5. If the validation is successful, you can submit the asset to the upload and moderation queue for a fee. See [Fees and Commissions](../../marketplace/marketplace-fees-and-commissions.md) for current fee information.
-## Publish
+## Publishing
After uploading your asset for moderation, you can check your asset's current moderation status on your [Creator Dashboard > Avatar Items](https://create.roblox.com/dashboard/creations). Moderation can take up to 24 hours during which a placeholder icon is used on the creation page.
@@ -329,8 +329,8 @@ You now have your accessory added to the Marketplace catalog! Use the item's Mar
See the following resources for additional Marketplace policy and related information:
- [Marketplace policy](../../marketplace/marketplace-policy.md)
-- [Fees and commissions](../../marketplace/marketplace-fees-and-commissions.md)
-- [Intellectual property](../../marketplace/intellectual-property.md)
+- [Fees and Commissions](../../marketplace/marketplace-fees-and-commissions.md)
+- [Intellectual Property](../../marketplace/intellectual-property.md)
- [Moderation](../../marketplace/moderation.md)
[Basic clothing creation](../../art/accessories/creating/index.md)
[Basic Clothing Creation](../../art/accessories/creating/index.md)
[General mesh specifications](../../art/modeling/specifications.md)
[Accessory specifications](../../art/accessories/specifications.md)
[Marketplace policy](../../marketplace/marketplace-policy.md)
[General Mesh Specifications](../../art/modeling/specifications.md)
[Accessory Specifications](../../art/accessories/specifications.md)
[Marketplace Policy](../../marketplace/marketplace-policy.md)
[Layered clothing overview](../../art/accessories/index.md)
[Create face accessories](../../art/characters/facial-animation/create-face-accessories.md)
[Accessory fitting tool](../../art/accessories/accessory-fitting-tool.md)
[Accessory specifications](../../art/accessories/specifications.md)
[Marketplace requirements](../../marketplace/marketplace-policy.md)
[Layered Clothing Overview](../../art/accessories/index.md)
[Creating Face Accessories](../../art/characters/facial-animation/creating-face-accessories.md)
[Accessory Fitting Tool](../../art/accessories/accessory-fitting-tool.md)
[Accessory Specifications](../../art/accessories/specifications.md)
[Marketplace Requirements](../../marketplace/marketplace-policy.md)
[PBR textures](../../art/modeling/surface-appearance.md)
[PBR Textures](../../art/modeling/surface-appearance.md)
[Humanoid rigging requirements](../../art/characters/specifications.md#rigging)
[Rigging facial bones](../../art/characters/facial-animation/create-basic-heads.md#rigging)
[Auto skin transfer](../../art/accessories/automatic-skinning-transfer.md)
[Skin facial bones](../../art/characters/facial-animation/create-basic-heads.md#skin-face-bones)
[Humanoid Rig Requirements](../../art/characters/specifications.md#rigging)
[Rigging Facial Bones](../../art/characters/facial-animation/creating-basic-heads.md#rigging)
[Auto Skin Transfer](../../art/accessories/automatic-skinning-transfer.md)
[Skinning Facial Bones](../../art/characters/facial-animation/creating-basic-heads.md#skinning-face-bones)
[Clothing validation tool](../../art/accessories/validation-tool.md)
[Clothing Validation Tool](../../art/accessories/validation-tool.md)
[Marketplace policy](../../marketplace/marketplace-policy.md)
[Fees and commissions](../../marketplace/marketplace-fees-and-commissions.md)
[Marketplace Policy](../../marketplace/marketplace-policy.md)
[Fees and Commissions](../../marketplace/marketplace-fees-and-commissions.md)
diff --git a/content/en-us/art/accessories/project-files.md b/content/en-us/art/accessories/project-files.md
index c907a9f26..680e76420 100644
--- a/content/en-us/art/accessories/project-files.md
+++ b/content/en-us/art/accessories/project-files.md
@@ -1,5 +1,5 @@
---
-title: Accessory project files and references
+title: Accessory Project Files and References
description: Download various accessory-related project files and reference files.
---
@@ -10,7 +10,7 @@ See [Resources](../../avatar/resources.md) for a complete list of avatar-related
The following `.fbx`, `.blend`, and `.ma` project files are available to use as templates or as reference:
| Accessory type | -Attachment name | +Accessory Type | +Attachment Name |
|---|
-## Validate assets
+## Validating Assets
With the plugin active and a layered asset in your workspace, you can begin validating content. After the check, results with issues change to **red** (Blender) or **yellow** (Maya). You can resolve some failed checks by clicking the check button. See [Checks and Troubleshooting Steps](#checks-and-troubleshooting-steps) for details on each validation check.
@@ -129,7 +129,7 @@ To use the Validation Tool on your asset:
This Validation Tool only checks for common clothing creation issues. Ensure your layered clothing model meets both the [general mesh specifications](../../art/modeling/specifications.md) and Roblox-specific [layered clothing specifications](../../art/accessories/specifications.md#layered-requirements) before uploading to Studio.
-## Checks and troubleshooting steps
+## Checks and Troubleshooting Steps
Refer to the table below for details on the specific checks and troubleshooting steps:
diff --git a/content/en-us/art/characters/creating/blender-configurations.md b/content/en-us/art/characters/creating/blender-configurations.md
index 93359d630..6534c09fe 100644
--- a/content/en-us/art/characters/creating/blender-configurations.md
+++ b/content/en-us/art/characters/creating/blender-configurations.md
@@ -1,5 +1,5 @@
---
-title: Blender configuration
+title: Blender Configuration
description: Roblox avatar template projects have several helper configurations and settings to help expedite the character creation process.
next: /art/characters/creating/modeling-best-practices
prev: /art/characters/creating/head-objects
@@ -28,7 +28,7 @@ The following is a breakdown of what is included in each Blender template file:
width="800" />
. Since attachment objects are often not modified until the end of the character creation process, these objects have **Disable In Viewport** 
enabled to make the organization of your project more efficient, especially when bulk toggling object visibility.
@@ -45,7 +45,7 @@ If you need access to disabled objects, use the following instructions to access
3. The **Disable In Viewport** icon 
-### Custom skin tones
+### Custom Skin Tones
The Blender project files include a shader configuration that allows you to preview custom skin tones, similar to how they display in Roblox if users customize their skin tones.
@@ -57,7 +57,7 @@ Textures with full or partial transparency allow the underlying `Class.Part.Colo
-### Animation range
+### Animation Range
-### Unpack image files
+### Unpacking Image Files
As an alternative to embedding textures, you can export your texture files as separate `.png` image files, which allows you to quickly access and swap image texture maps.
diff --git a/content/en-us/art/characters/creating/final-checks.md b/content/en-us/art/characters/creating/final-checks.md
index a720a239f..80464dcfb 100644
--- a/content/en-us/art/characters/creating/final-checks.md
+++ b/content/en-us/art/characters/creating/final-checks.md
@@ -1,8 +1,8 @@
---
-title: Final checks
+title: Final Checks
description: Before exporting, verify that your model meets Studio's requirements.
-next: /art/characters/creating/export-textures
-prev: /art/characters/creating/verify-attachments
+next: /art/characters/creating/exporting-textures
+prev: /art/characters/creating/verifying-attachments
---
Depending on the types of customizations you made to your template project or model, the following are additional tasks to look out for when cleaning up your project:
diff --git a/content/en-us/art/characters/creating/head-objects.md b/content/en-us/art/characters/creating/head-objects.md
index 1fd199543..dcc2806dc 100644
--- a/content/en-us/art/characters/creating/head-objects.md
+++ b/content/en-us/art/characters/creating/head-objects.md
@@ -1,5 +1,5 @@
---
-title: Template head structure
+title: Template Head Structure
description: Each Roblox avatar template contains modular separate pieces that must later be combined or removed.
next: /art/characters/creating/blender-configurations
prev: /art/characters/creating/template-files
@@ -7,7 +7,7 @@ prev: /art/characters/creating/template-files
In each template file, each avatar body includes extra head mesh objects and face armature bones. Separating these objects within the templates allow you to make easier changes to each of these separate objects, as demonstrated during the texturing step.
-To avoid validation errors, you must [join](../../../art/characters/creating/combine-head-geometry.md) and [remove](../../../art/characters/creating/remove-extra-bones.md) these extra objects during the cleanup process prior to exporting.
+To avoid validation errors, you must [join](../../../art/characters/creating/combining-head-geometry.md) and [remove](../../../art/characters/creating/removing-extra-bones.md) these extra objects during the cleanup process prior to exporting.
The extra head mesh objects are the following:
| Round head region | -Edge flow notes | +Round Head Region | +Edge Flow Notes |
|---|
| Template prototype | +Template Prototype | - | Sample customizations | +Sample Customizations | |||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-  |
@@ -28,7 +28,7 @@ Each template comes pre-baked with the [necessary components of an avatar charac | ||||||||||||||||||||||||||||||||||||||||
-  |
diff --git a/content/en-us/art/characters/creating/texturing-eyes.md b/content/en-us/art/characters/creating/texturing-eyes.md index 20677092c..1efaa0c48 100644 --- a/content/en-us/art/characters/creating/texturing-eyes.md +++ b/content/en-us/art/characters/creating/texturing-eyes.md @@ -1,5 +1,5 @@ --- -title: Texturing eyes +title: Texturing Eyes description: Use Blender's texture painting tools to apply a custom surface appearance on your character's eyes. next: /art/characters/creating/texturing-face prev: /art/characters/creating/texturing-setup diff --git a/content/en-us/art/characters/creating/texturing-face.md b/content/en-us/art/characters/creating/texturing-face.md index c478a4ea6..1b9704d99 100644 --- a/content/en-us/art/characters/creating/texturing-face.md +++ b/content/en-us/art/characters/creating/texturing-face.md @@ -1,5 +1,5 @@ --- -title: Texturing face +title: Texturing Face description: Use Blender to apply a custom surface appearance on your character's face. next: /art/characters/creating/texturing-pbr prev: /art/characters/creating/texturing-eyes diff --git a/content/en-us/art/characters/creating/texturing-pbr.md b/content/en-us/art/characters/creating/texturing-pbr.md index 41e07c4d3..48b7dd818 100644 --- a/content/en-us/art/characters/creating/texturing-pbr.md +++ b/content/en-us/art/characters/creating/texturing-pbr.md @@ -1,5 +1,5 @@ --- -title: PBR textures (optional) +title: PBR Textures (Optional) description: PBR textures are high-definition texture maps that can elevate your custom characters. next: /art/characters/creating/caging prev: /art/characters/creating/texturing-face @@ -13,4 +13,4 @@ Physically-based rendering (PBR) textures use multiple texture maps to define ho |
-10. After exporting, use Studio's [3D importer](../../art/modeling/3d-importer.md) to import your model. See [Test characters in Studio](../../art/characters/testing/studio.md) for additional importing and testing information.
+10. After exporting, use Studio's [3D Importer](../../art/modeling/3d-importer.md) to import your model. See [Testing Characters in Studio](../../art/characters/testing/studio.md) for additional importing and testing information
-## Create animations
+## Creating Animations
-After you have [opened](../../../animation/editor.md#open-the-animation-editor) the Animation Editor and selected the character model with a head you want to create an animation for, you can either create a head animation by using animation tracks or the Face Animation Editor.
+After you have [opened](../../../animation/editor.md#opening-the-animation-editor) the Animation Editor and selected the character model with a head you want to create an animation for, you can either create a head animation by using animation tracks or the Face Animation Editor.
For details on using Animation Capture to track facial movement as keyframes, see [Animation Capture - Face](../../../animation/capture.md#face).
-### Use animation tracks
+### Using Animation Tracks
-Similar to inserting other objects like `Class.MeshPart|MeshParts` or `Class.Bone|Bones` as animation tracks, you can manually add one FACS value at a time to the track list to manipulate a single body part, such as the character's eyes, jaw, or tongue. The [Animation Editor](../../../animation/editor.md) represents FACS values as a percentage between 0 and 1, and these values map directly to `Class.FaceControls` values. While this process provides precise control over individual values, the [Face Animation Editor](#use-the-face-animation-editor) enhances this workflow and lets you quickly change values to multiple facial features at once on the animation timeline.
+Similar to inserting other objects like `Class.MeshPart|MeshParts` or `Class.Bone|Bones` as animation tracks, you can manually add one FACS value at a time to the track list to manipulate a single body part, such as the character's eyes, jaw, or tongue. The [Animation Editor](../../../animation/editor.md) represents FACS values as a percentage between 0 and 1, and these values map directly to `Class.FaceControls` values. While this process provides precise control over individual values, the [Face Animation Editor](#using-the-face-animation-editor) enhances this workflow and lets you quickly change values to multiple facial features at once on the animation timeline.
To create an animation by inserting individual FACS values:
@@ -37,7 +37,7 @@ To create an animation by inserting individual FACS values:
-### Use the Face Animation Editor
+### Using the Face Animation Editor
The Face Animation Editor is an intuitive, visual way to automatically create keyframes as you adjust **sliders** to achieve your desired facial expression. For example, when you drag the thumb of the `LeftEyeClosed` slider all the way down, the character's left eye closes and a new animation track for `LeftEyeClosed` displays with a value of `1` within the track list.
@@ -91,14 +91,14 @@ To create an animation for your head using the Face Animation Editor:
4. When you are finished creating your animation, navigate to the **Media and Playback Controls** and click the **…** button. A pop-up menu displays.
5. Select **Save** or **Save As** to save the animation. The animation displays in the **Explorer** window as a child of the **AnimSaves** object (itself a child of the rig).
-## Export animations
+## Exporting Animations
-When you export a head that supports animation to Studio, it becomes available for use in all of your experiences. This means that you only need to create a head animation once, then you can reuse it as many times for as many characters as you want as long as the character has an [animatable head](../../../art/characters/facial-animation/use-heads-in-studio.md).
+When you export a head that supports animation to Studio, it becomes available for use in all of your experiences. This means that you only need to create a head animation once, then you can reuse it as many times for as many characters as you want as long as the character has an [animatable head](../../../art/characters/facial-animation/using-heads-in-studio.md).
-You can export head animations using the same workflow as [exporting other animations](../../../animation/editor.md#export-an-animation). Once the upload is complete, copy the animation's asset ID by clicking the copy button. **This ID is required for scripting animations**.
+You can export head animations using the same workflow as [exporting other animations](../../../animation/editor.md#exporting-an-animation). Once the upload is complete, copy the animation's asset ID by clicking the copy button. **This ID is required for scripting animations**.
-## Script animations
+## Scripting Animations
-Once you have created an animation, you need to use a script to play it in your experience. Like generic animations, you can either play animations for heads manually from your scripts or automatically by replacing default animations for player characters. For more information, see [Use animations](../../../animation/using.md).
+Once you have created an animation, you need to use a script to play it in your experience. Like generic animations, you can either play animations for heads manually from your scripts or automatically by replacing default animations for player characters. For more information, see [Using Animations](../../../animation/using.md).
diff --git a/content/en-us/art/characters/facial-animation/create-basic-heads.md b/content/en-us/art/characters/facial-animation/creating-basic-heads.md
similarity index 93%
rename from content/en-us/art/characters/facial-animation/create-basic-heads.md
rename to content/en-us/art/characters/facial-animation/creating-basic-heads.md
index 4897f2b82..b5e9e244a 100644
--- a/content/en-us/art/characters/facial-animation/create-basic-heads.md
+++ b/content/en-us/art/characters/facial-animation/creating-basic-heads.md
@@ -1,5 +1,5 @@
---
-title: Create basic heads
+title: Creating Basic Heads
description: The process of creating a basic animatable head in Blender.
---
@@ -10,8 +10,8 @@ description: The process of creating a basic animatable head in Blender.
You can create or modify an existing model to support animated heads in a third-party modeling software, such as [Blender](https://www.blender.org) or [Maya](https://www.autodesk.com/products/maya/overview). When creating a head, your character model must meet the following requirements:
- The model follows standard [modeling requirements](#modeling-requirements), and includes head geometry, such as eyes, a mouth, and teeth.
-- The model's head must include a [rig](#rigging), or internal bone structure. These bones drive the various deformation of vertices to create facial expressions. You can create a [control system](#add-controls) to simplify the posing process.
-- The model has facial poses [saved to the animation timeline](#pose) and [mapped to the head mesh](#map). Typical animatable heads include [50 standard base poses](../../../art/characters/facial-animation/facs-poses-reference.md) that allow for a diverse range of expressions.
+- The model's head must include a [rig](#rigging), or internal bone structure. These bones drive the various deformation of vertices to create facial expressions. You can create a [control system](#adding-controls) to simplify the posing process.
+- The model has facial poses [saved to the animation timeline](#posing) and [mapped to the head mesh](#mapping). Typical animatable heads include [50 standard base poses](../../../art/characters/facial-animation/facs-poses-reference.md) that allow for a diverse range of expressions.
To meet these requirements, you can apply the steps in this guide when designing and posing your own head. This guide covers the basic processes of adding facial bones, posing, and mapping 5 basic FACS poses in Blender on a simplified reference character (Cubie), then exporting the model.
@@ -19,7 +19,7 @@ To meet these requirements, you can apply the steps in this guide when designing
For reference, this guide uses | Reference files | +Reference Files | Description |
|---|
-#### Skin face bones
+#### Skinning Face Bones
You can apply [skinning](../../../art/modeling/rigging.md) to a character rig using several methods. The following example uses Blender's **Weight Paint** mode to paint which vertices a single bone can control. Skinning is typically a time consuming step for complex characters and a background in skinning and facial posing is recommended.
-When applying detailed or shared influences for complex models, it's recommended to enable [Auto Normalize](../../../art/modeling/skin-a-simple-mesh.md#auto-normalize) to prevent influence conflicts between bones.
+When applying detailed or shared influences for complex models, it's recommended to enable [Auto Normalize](../../../art/modeling/skinning-a-simple-mesh.md#auto-normalize) to prevent influence conflicts between bones.
-### Combination poses
+### Combination Poses
You can combine 2-3 base FACS poses in a single animation frame to display complex facial expressions. However, when you combine FACS poses that control the **same** facial regions, the facial features might either collide or disfigure the character.
@@ -385,7 +385,7 @@ A **combination pose**, or **corrective**, is the combination of 2-3 FACS poses
On import, Studio calculates and stores the corrective difference for combination poses in the head's `Class.FaceControls` instance, and the `Class.FaceControls` instance corrects the base poses values as they combine in the Animation Editor.
-## Map
+## Mapping
After you finish posing each FACS pose that your character needs, you must map, or link, **each animation frame that you pose** to its corresponding FACS base or combination pose name. Mapping stores the bone positions and translations within the head `Class.MeshPart`, and when you begin to animate your head within the [Animation Editor](../../../animation/editor.md), the `Class.FaceControls` instance uses this stored data to transform your character's facial features to the applicable FACS pose.
@@ -402,7 +402,7 @@ Aside from mapping each pose to its proper pose name, you also need to map the [
-## Export
+## Exporting
After you finish posing and mapping your head for your character, you can export the character model as a `.fbx` to import into Studio, allowing you to access the 4 eye poses using the `Class.FaceControls` instance in Studio. You can also reference the fully configured Cubie head `.fbx` to access all 50+ base poses.
@@ -456,7 +456,7 @@ The export settings for animatable heads differ slightly from [standard third-pa
7. Expand **Bake Animation** and uncheck **NLA Strips**, **All Actions**, and **Force Start/End Keyframes**.
8. Click the **Export FBX** button. Save the FBX to the directory of your choice.
-At this point, you can now import the `.fbx` into Studio as a character with a supported animatable head. For model import and usage instructions, see [Use heads in Studio](../../../art/characters/facial-animation/use-heads-in-studio.md).
+At this point, you can now import the `.fbx` into Studio as a character with a supported animatable head. For model import and usage instructions, see [Using Heads in Studio](../../../art/characters/facial-animation/using-heads-in-studio.md).
-### Parent armature
+### Parenting Armature
Connect the mesh object to the character's armature by parenting the armature to the mesh object. To parent the armature:
@@ -127,11 +127,11 @@ Connect the mesh object to the character's armature by parenting the armature to
Parenting with Automatic Weights automatically applies some influences to your model which can save some time during the [optional skinning](#optional-skinning) step. You can alternatively **Parent** with **Empty Weights** to not apply any skinning influence to your accessory mesh. See Blender's documentation on [Automatic Weights](https://docs.blender.org/manual/en/latest/animation/armatures/skinning/parenting.html#with-automatic-weights) for more information.
-### Optional skinning
+### Optional Skinning
-In many cases, you can skip the [skinning](../../../art/modeling/rigging.md) process for your accessory and use Roblox's [Automatic Skinning Transfer transfer](../../../art/accessories/automatic-skinning-transfer.md) instead. You can still apply manual skinning through a modeling software and opt to use Automatic Skinning Transfer transfer later.
+In many cases, you can skip the [skinning](../../../art/modeling/rigging.md) process for your accessory and use Roblox's [automatic skinning transfer](../../../art/accessories/automatic-skinning-transfer.md) instead. You can still apply manual skinning through a modeling software and opt to use automatic skinning transfer later.
-If you do not intend to apply skinning manually, continue directly to [caging](#caging).
+If you do not intend to apply skinning manually, continue directly to [Caging](#caging).
-## Set moods
+## Setting Moods
Every character with an animatable head has a child **Animate** `Class.LocalScript` with a child **mood** `Class.StringValue` that contains the mood animation that plays on the character's head. The mood animation's default `Class.Animation.AnimationID` plays a smiling animation, but you can change the character's mood to something else by either directly editing the `Class.Animation.AnimationID` within the mood `Class.StringValue`, or using the `Class.HumanoidDescription` system.
@@ -79,7 +79,7 @@ Every character with an animatable head has a child **Animate** `Class.LocalScri
The code for playing moods doesn't occur in the **Animate** `Class.LocalScript`, but in a hidden, internal Roblox script. While you can't edit this internal script, the **mood** `Class.StringValue` allows you to interact with it in order to customize moods within your experiences.
-### Edit AnimationIds
+### Editing AnimationIds
You can set a specific mood for each character within your experience by editing their mood's `Class.Animation.AnimationID` whenever a user triggers an event. For example, the following `Class.Script` edits any previously set mood to an animation that [opens the character's mouth](https://www.roblox.com/library/7715145252/moods-11-FaceAnimation) as soon as the user enters the experience:
@@ -99,7 +99,7 @@ end
Players.PlayerAdded:Connect(onPlayerAdded)
```
-### Use the HumanoidDescription
+### Using the HumanoidDescription
You can also use the `Class.HumanoidDescription` system to find user characters and edit their `Class.Animation.AnimationID|AnimationIDs` for any default animation. For example, the following `Class.Script` edits any previously set mood to an animation that gives the character a [half-smile](https://www.roblox.com/catalog/10725833199/Chiseled-Good-Looks-Mood) on the left-side of their face whenever their character is idling:
@@ -113,7 +113,7 @@ if humanoid then
end
```
-## Disable moods
+## Disabling Moods
To disable moods from your experience, you can delete the mood object underneath the **Animate** `Class.LocalScript`. For example, the following `Class.Script` removes every character's **mood** `Class.StringValue` as soon as they join the experience:
diff --git a/content/en-us/art/characters/facial-animation/use-heads-in-studio.md b/content/en-us/art/characters/facial-animation/using-heads-in-studio.md
similarity index 89%
rename from content/en-us/art/characters/facial-animation/use-heads-in-studio.md
rename to content/en-us/art/characters/facial-animation/using-heads-in-studio.md
index 67944790e..8355be9ec 100644
--- a/content/en-us/art/characters/facial-animation/use-heads-in-studio.md
+++ b/content/en-us/art/characters/facial-animation/using-heads-in-studio.md
@@ -1,5 +1,5 @@
---
-title: Use heads in Studio
+title: Using Heads in Studio
description: If you have a model with a live head, you can import the model into Studio, equip face accessories, and create and save animations.
---
@@ -7,16 +7,16 @@ You can import character models with animatable heads into Studio and use the au
To set up heads with facial animation in your experience:
-1. [Import a model with an animatable head](../../../art/characters/testing/studio.md#import). You can either create your own or use one of the provided reference model files.
-2. (Optional) [Import face accessories](#import-face-accessories) you want to deform with the facial expressions of your head. You can either create your own or use one of the provided reference accessory files.
-3. [Animate the head](#animate-heads) in the Animation Editor by either adding in individual animation tracks, or by using the Face Animation Editor.
+1. [Import a model with an animatable head](../../../art/characters/testing/studio.md#importing). You can either create your own or use one of the provided reference model files.
+2. (Optional) [Import face accessories](#importing-face-accessories) you want to deform with the facial expressions of your head. You can either create your own or use one of the provided reference accessory files.
+3. [Animate the head](#animating-heads) in the Animation Editor by either adding in individual animation tracks, or by using the Face Animation Editor.
-If you want to experiment with pre-made heads before [making your own](../../../art/characters/facial-animation/create-basic-heads.md), Roblox has a reference experience you can access to see how heads interact with Studio's interface, as well as two reference models and accessories you can import directly into your own experience:
+If you want to experiment with pre-made heads before [making your own](../../../art/characters/facial-animation/creating-basic-heads.md), Roblox has a reference experience you can access to see how heads interact with Studio's interface, as well as two reference models and accessories you can import directly into your own experience:
| Reference files | +Reference Files | Description |
|---|
-2. Using the [Accessory Fitting tool](../../../art/accessories/accessory-fitting-tool.md), convert the `Class.MeshPart` into an `Class.Accessory` instance.
+2. Using the [Accessory Fitting Tool](../../../art/accessories/accessory-fitting-tool.md), convert the `Class.MeshPart` into an `Class.Accessory` instance.
1. In the **Avatar** tab, click on the **Accessory Fitting Tool**. The **Accessory Fitting Tool** window displays.
2. In the **Explorer** window, select the **MeshPart** you imported as a face accessory. Its name displays in the **Part** field.
@@ -78,9 +78,9 @@ You can preview the accessory on your imported model by making the `Class.Access
-You can also save the `Class.Accessory` instance to your toolbox and use the asset ID at any time in your experiences. For information on equipping accessories by applying a `Class.HumanoidDescription`, see [Customize characters with humanoid description](../../../characters/appearance.md#set-multiple-accessories).
+You can also save the `Class.Accessory` instance to your toolbox and use the asset ID at any time in your experiences. For information on equipping accessories by applying a `Class.HumanoidDescription`, see [Customizing Characters with Humanoid Description](../../../characters/appearance.md#setting-multiple-accessories).
-### AutoSkin property
+### Accessory Skinning
You can enable the `Class.WrapLayer.AutoSkin` property in the accessory's `Class.WrapLayer` instance to apply the skinning of the head to the face accessory. This allows a face accessory to fit and follow a character's expressions without having to apply any skinning influences to it during the 3D modeling process.
@@ -90,7 +90,7 @@ The following options are available for the `Class.WrapLayer.AutoSkin` property:
- **EnabledOverride**: Enables the Auto-Skin Transfer process and allows Studio to override any existing skinning information found on the accessory. Choose this setting when you want to set or replace the existing skinning of an accessory using the Auto-Skin Transfer version.
- **EnabledPreserve**: Enables the Automatic Skinning Transfer process but **doesn't** allow it to override any existing skinning information found on the accessory. Choose this setting when you want to preserve and maintain any existing skinning of an accessory. If there isn't any skinning to maintain, the Auto-Skin Transfer creates new skinning automatically.
-## Animate heads
+## Animating Heads
Animatable head `Class.MeshPart|MeshParts` include a `Class.FaceControls` instance which allows you to access your facial pose properties.
@@ -105,20 +105,20 @@ Animatable head `Class.MeshPart|MeshParts` include a `Class.FaceControls` instan
-You can adjust these properties in the Animation Editor to animate your head. For more information, see [Animate heads](../../../art/characters/facial-animation/animate-heads.md).
+You can adjust these properties in the Animation Editor to animate your head. For more information, see [Animating Heads](../../../art/characters/facial-animation/animating-heads.md).
## Troubleshooting
-When importing custom head models, the [Output Window](../../../studio/output.md) displays an error or warning message if there were any issues during the configuration process.
+When importing custom head models, the [Output window](../../../studio/output.md) displays an error or warning message if there were any issues during the configuration process.
-### Error messages
+### Error Messages
Error messages indicate a failure to properly import a model with a head. Reference the following table for a summary of all head error messages and troubleshooting tips:
| Error message | +Error Message | Troubleshooting |
|---|
| Error message | +Error Message | Troubleshooting | |
|---|---|---|---|
| Tutorials | -[Basic character creation tutorial](../accessories/creating/index.md) | +[Basic Character Creation Tutorial](../accessories/creating/index.md) | |
| Reference files | -[Avatar references and project files](../characters/project-files.md) [Example mesh/model objects](../modeling/project-files.md) |
+ Reference Files | +[Avatar references and project files](../characters/project-files.md) [Example Mesh/Model Objects](../modeling/project-files.md) |
| Technical specs | -[.FBX export settings](../characters/export-settings.md) [Avatar specifications](../characters/specifications.md) [General mesh specifications](../modeling/specifications.md) [Accessory specifications](../accessories/specifications.md) [Marketplace policy](../marketplace/marketplace-policy.md) |
+ Technical Specs | +[.FBX Export Settings](../characters/export-settings.md) [Avatar Specifications](../characters/specifications.md) [General Mesh Specifications](../modeling/specifications.md) [Accessory Specifications](../accessories/specifications.md) [Marketplace Policy](../marketplace/marketplace-policy.md) |
| Cosmetic creation | -[Accessories overview](../accessories/index.md) [Creating face accessories](../characters/facial-animation/create-face-accessories.md) [Accessory Fitting Tool](../accessories/accessory-fitting-tool.md) [Accessory specifications](../accessories/specifications.md) [Marketplace requirements](../../marketplace/marketplace-policy.md) |
+ Cosmetic Creation | +[Accessories Overview](../accessories/specifications.md) [Creating Face Accessories](../characters/facial-animation/creating-face-accessories.md) [Accessory Fitting Tool](../accessories/accessory-fitting-tool.md) [Accessory Specifications](../accessories/specifications.md) [Marketplace Requirements](../marketplace/marketplace-policy.md) |
| Texturing | -[Texturing requirements](../modeling/texture-specifications.md) [PBR textures](../modeling/surface-appearance.md) |
+ [Texturing Requirements](../modeling/texture-specifications.md) [PBR Textures](../modeling/surface-appearance.md) |
|
| Rigging and skinning | -[Rigging and skinning overview](../modeling/rigging.md) [Humanoid rig requirements](../characters/specifications.md#rig) [Rigging facial bones](../characters/facial-animation/create-basic-heads.md#rig) [Automatic Skinning Transfer](../accessories/automatic-skinning-transfer.md) [Skinning facial bones](../characters/facial-animation/create-basic-heads.md#skin-face-bones) |
+ Rigging and Skinning | +[Rigging and Skinning Overview](../modeling/rigging.md) [Humanoid Rig Requirements](../characters/specifications.md#rigging) [Rigging Facial Bones](../characters/facial-animation/creating-basic-heads.md#rigging) [Auto Skin Transfer](../accessories/automatic-skinning-transfer.md) [Skinning Facial Bones](../characters/facial-animation/creating-basic-heads.md#skinning-face-bones) |
| Facial animation and live heads | -[Basic head creation](../characters/facial-animation/create-basic-heads.md) [Face accessory creation](../characters/facial-animation/create-face-accessories.md) [FACS pose references](../characters/facial-animation/facs-poses-reference.md) |
+ Facial Animation and Live Heads | +[Basic Head Creation](../characters/facial-animation/creating-basic-heads.md) [Creating Face Accessories](../characters/facial-animation/creating-face-accessories.md) [FACS Pose References](../characters/facial-animation/facs-poses-reference.md) |
| Testing and validation | +Testing and Validation | [Calisthenics Tool](../modeling/calisthenics-tool.md) [Clothing Validation Tool](../accessories/validation-tool.md) |
|
| Publishing and Marketplace | -[Uploading to Marketplace](../../marketplace/publish-to-marketplace) [Marketplace policy](../../marketplace/marketplace-policy) [Fees and commissions](../../marketplace/marketplace-fees-and-commissions) |
+ [Uploading to Marketplace](../marketplace/publishing-to-marketplace.md) [Marketplace Policy](../marketplace/marketplace-policy.md) [Fees and Commissions](../marketplace/marketplace-fees-and-commissions.md) |
- If textures don't load for your asset, you can manually import your textures later.
- - See [3D importer](../../art/modeling/3d-importer.md) for additional information on import settings and troubleshooting.
+ - See [3D Importer](../../art/modeling/3d-importer.md) for additional information on import settings and troubleshooting.
3. To begin body validation after import, enable **Validate UGC Body**. This can save you time if you intend on uploading your body to the Marketplace.
4. Set the **Rig Scale** to the appropriate [Body Scale](../characters/specifications.md#body-scale) of your character.
@@ -30,7 +30,7 @@ To import your asset:
5. Select **Import**. The asset populates in your workspace as a `Class.Model` with the appropriate textures applied as a `Class.SurfaceAppearance` or `Class.MeshPart.TextureID`.
-
-
- When creating a generic mesh, your model must meet [general mesh specifications](../modeling/specifications.md).
- When creating a rigid accessory model, see the [accessory specifications](../../art/accessories/specifications.md).
- When creating a clothing accessory model, see the [clothing specifications](../../art/accessories/clothing-specifications.md). +
- When creating a generic mesh, your model must meet [General Mesh Specifications](../modeling/specifications.md).
- When creating a rigid accessory model, see [Accessory Specifications](../../art/accessories/specifications.md).
- When creating a clothing accessory model, see [Clothing Specifications](../../art/accessories/clothing-specifications.md).
-
-
+
+
@@ -162,7 +162,7 @@ A Rthro Slender (Narrow) body scale [downloadable mannequin](../../avatar/resour -In the [3D importer](../../art/modeling/3d-importer.md#avatar-general), use **Rig Type** > **Rthro Narrow** to import your model as a Slender body scale. +In the [3D Importer](../../art/modeling/3d-importer.md#avatar-general), use **Rig Type** > **Rthro Narrow** to import your model as a Slender body scale.
@@ -367,18 +367,18 @@ In the [3D Importer](../../art/modeling/3d-importer.md#avatar-general), use **Ri -### Triangle budgets +### Triangle Budgets -Although model geometries are typically created using quads, the Roblox Engine converts imported assets into tris. Each asset of your character model must not exceed our maximum tri budget. To quickly get the number of expected tris in your third-party modeling application, you can double the number of quads in your model. +Although model geometries are typically created using quads, the Roblox engine converts imported assets into tris. Each asset of your character model must not exceed our maximum tri budget. To quickly get the number of expected tris in your third-party modeling application, you can double the number of quads in your model.
| Asset type | -Included mesh objects | -Maximum triangles | +Asset Type | +Included Mesh Objects | +Maximum Triangles |
|---|
-### Face accessories
+### Face Accessories
-Face accessories, such as hair, eyebrows, and eyelashes are unique accessories that you can bundle with an avatar body upload. At this time, eyebrows and eyelashes can not be uploaded as standalone accessories and must be bundled with an avatar body. See [Accessory specifications](../accessories/specifications.md#face-accessories) for additional information on face accessories.
+Face accessories, such as hair, eyebrows, and eyelashes are unique accessories that you can bundle with an avatar body upload. At this time, eyebrows and eyelashes can not be uploaded as standalone accessories and must be bundled with an avatar body. See [Accessory Specifications](../accessories/specifications.md#face-accessories) for additional information on face accessories.
### Visibility
@@ -491,8 +491,8 @@ Attachments must follow a specific naming convention and positional consistency:
-### Import
+### Importing
After you open the test experience in Studio, import your custom character model.
@@ -56,10 +56,10 @@ After you open the test experience in Studio, import your custom character model
4. Click **Import**. The character's model populates into the workspace.
-### Set model as StarterPlayer
+### Setting Model as StarterPlayer
In order to play as the character during a playtest, rename and move the model instance:
@@ -95,7 +95,7 @@ In order to play as the character during a playtest, rename and move the model i
After you rename and add your model, navigate to the **Test** > **Play** button to start a test session of the experience as the custom model.
-## Use test experience
+## Using Test Experience
The Avatar Test experience includes several features in the interface and environment to quickly perform comprehensive tests of your avatar characters. You can use the [test checklist](#checklist) to ensure you are reviewing all the important aspects of your avatar character.
@@ -146,7 +146,7 @@ When playtesting the experience, use the following UI buttons on the right side
Use the following checklists to ensure that you are comprehensively testing each component of your avatar. Use the Avatar menu to switch between your custom avatar and a control avatar to verify expected behavior.
-#### Movement and animation
+#### Movement and Animation
- 
- 
- 
- 
-
-
-
-
+
-2. Select the `.fbx`, `.gltf` or `.obj` you intend to import. The Importer window displays.
+2. Select the `.fbx`, `.gltf` or `.obj` you intend to import. The importer window displays.
3. Verify the object preview and check that the [import settings](#import-settings) are correct for your object.
4. Verify any [warning or error messages](#warnings-and-errors).
5. Click **Import**.
-### Import settings
+### Import Settings
Depending on the object selected in the hierarchy panel, the inspector panel displays the following groups of settings:
@@ -59,7 +59,7 @@ Depending on the object selected in the hierarchy panel, the inspector panel dis
- **Object General**: Affects the selected child object.
- **Object Geometry**: Affects the geometry of the selected child object.
-#### File general
+#### File General
The 3D Importer provides the following settings for all meshes:
@@ -101,12 +101,12 @@ The 3D Importer provides the following settings for all meshes:
- **R15**
- **Custom**
- **No Rig**
By default, the 3D importer attempts to select the most appropriate setting based on the detected rigging and skinning data of the mesh.
- **R15**
- **Custom**
- **No Rig**
By default, the 3D Importer attempts to select the most appropriate setting based on the detected rigging and skinning data of the mesh.
diff --git a/content/en-us/art/modeling/avatar-setup.md b/content/en-us/art/modeling/avatar-setup.md index c31d39aea..ca1c77f4c 100644 --- a/content/en-us/art/modeling/avatar-setup.md +++ b/content/en-us/art/modeling/avatar-setup.md @@ -1,6 +1,6 @@ --- title: Avatar Setup -description: The Avatar setup tool previews animations, clothing, accessories, and body constructs on avatar rigs, directly in Studio. +description: The Avatar Setup tool previews animations, clothing, accessories, and body constructs on avatar rigs, directly in Studio. --- The **Avatar Setup** tool allows you to auto-setup avatar meshes, preview animations, clothing, skin tones, and test avatar character bodies directly in Studio. Marketplace creators can also begin the uploading and validation process from this tool to quickly publish their assets. @@ -14,11 +14,11 @@ The **Avatar Setup** tool allows you to auto-setup avatar meshes, preview animat
- 
4. Once complete, a `Class.Model` of your avatar populates in your workspace.
@@ -283,30 +283,30 @@ When your project has the appropriate `Class.Model` in your workspace, you can b
- 2. Use the various [Avatar setup tools](#test-interface) to verify the components of your avatar before saving the `Class.Model` to your Toolbox or uploading to the Marketplace.
+ 2. Use the various [Avatar Setup tools](#testing-interface) to verify the components of your avatar before saving the `Class.Model` to your Toolbox or uploading to the Marketplace.
-## Test interface
+## Testing Interface
After auto-setup, or when using the tool with an avatar-ready character model, the character populates in the preview window. It's important to test that your avatar components have correctly generated by testing out different clothing, rigid accessories, and animations. If you discover any issues, you may need to update your base input model in your third-party modeling software and/or retry the auto-setup process.
-#### Equip items
+#### Equipping Items
Selected items are equipped on the avatar and are added to the currently equipped column on the right side. Selected animations begin playing as a preview of how they'll look in a running experience.
To unequip an item, click it again in the selection column, press the **X** button at the top right of the equipped item, or right-click the asset in the Equipped column and select **Unequip**. You can also drag and order the various equipped accessories to set the worn order.
-#### Add items
+#### Adding Items
The add item button allows you to add custom assets to the tool's palette for testing.
@@ -319,7 +319,7 @@ To add an item to the palette:
3. The item appears in the appropriate section and subsection of the Check Body interface, such as **Accessories** → **Hair**.
-### Check face
+### Check Face
The **Check Face** interface zooms into the face and allows you test various facial poses.
@@ -334,9 +334,9 @@ The **Check Face** interface zooms into the face and allows you test various fac
-### Test in experience
+### Test in Experience
-The **Test in Experience** button starts playtesting the experience with the previewed avatar. Any changes made in the Avatar setup preview tools, such as equipped clothing or accessories, or modifications, such as skin tone or body part swaps, do not transfer over to the playable character model in this mode.
+The **Test in Experience** button starts playtesting the experience with the previewed avatar. Any changes made in the Avatar Setup preview tools, such as equipped clothing or accessories, or modifications, such as skin tone or body part swaps, do not transfer over to the playable character model in this mode.
### Publish
@@ -348,6 +348,6 @@ The upload option opens the following prompt which goes through additional valid
For additional resources on the publishing process and Marketplace, see the following:
-- [Publish to the Marketplace](../../marketplace/publish-to-marketplace.md)
-- [Marketplace fees and commissions](../../marketplace/marketplace-fees-and-commissions.md)
-- [Marketplace policy](../../marketplace/marketplace-policy.md)
+- [Publishing to the Marketplace](../../marketplace/publishing-to-marketplace.md)
+- [Marketplace Fees and Commissions](../../marketplace/marketplace-fees-and-commissions.md)
+- [Marketplace Policy](../../marketplace/marketplace-policy.md)
diff --git a/content/en-us/art/modeling/calisthenics-tool.md b/content/en-us/art/modeling/calisthenics-tool.md
index 7c4bdf388..fff8f609d 100644
--- a/content/en-us/art/modeling/calisthenics-tool.md
+++ b/content/en-us/art/modeling/calisthenics-tool.md
@@ -3,9 +3,9 @@ title: Calisthenics Tool
description: Calisthenics Tool is a Blender plugin that you can use to verify skinning quality of an asset.
---
-The **Calisthenics tool** is a supplemental [Blender](https://www.blender.org/) add-on that allows you to quickly test your asset through a set of animation cycles to verify your skinning data. At any point during the animation testing, you can pause and use Blender's skinning tools, such as [Weight Painting brushes](https://docs.blender.org/manual/en/latest/sculpt_paint/weight_paint/introduction.html), to resolve any skinning imperfections.
+The **Calisthenics Tool** is a supplemental [Blender](https://www.blender.org/) add-on that allows you to quickly test your asset through a set of animation cycles to verify your skinning data. At any point during the animation testing, you can pause and use Blender's skinning tools, such as [Weight Painting brushes](https://docs.blender.org/manual/en/latest/sculpt_paint/weight_paint/introduction.html), to resolve any skinning imperfections.
-Skinning your clothing and characters is a critical and often time-intensive process to create high quality assets that move and fit with different character bodies. Similar to the [Layered Clothing Validation Tool](../../art/accessories/validation-tool.md), the Calisthenics Tool can save you time when testing your character models after rigging and skinning.
+Skinning your clothing and characters is a critical and often time-intensive process to create high quality assets that move and fit with different character bodies. Similar to the [Layered Clothing Validation tool](../../art/accessories/validation-tool.md), the Calisthenics Tool can save you time when testing your character models after rigging and skinning.
-## Common materials
+## Common Materials
You can use the following material reference values as a baseline for creating your own custom surfaces:
@@ -115,16 +115,16 @@ You can use the following material reference values as a baseline for creating y
-## Clothing examples
+## Clothing Examples
Layered clothing can take advantage of PBR textures to achieve realistic and visually popping cosmetics for avatar characters. Use the following reference examples to compare how various material values are used to achieve a certain cosmetic effect and its comparable real-time rendering in Substance Painter and Roblox Studio:
-## Create a bone structure
+## Creating a Bone Structure
Now that your model is within Blender, you must add an **armature** and **bones** to your mesh object. An **armature** is a skeleton-like rigging object that acts as a container for bones, while **bones** are objects that control the movement and deformation of the group of vertices, or **vertex group**, that surround the bone.
-### Add an armature
+### Adding an Armature
An armature is a structure required to add bones to your mesh. After you add in an armature, you can create and reposition any number of bones inside of your mesh object.
@@ -70,7 +70,7 @@ To add an armature:
-### Add and position bones
+### Adding and Positioning Bones
When you add an armature to your project, Blender automatically adds one bone to the armature at a default position and scale which will act as the root bone.
@@ -96,7 +96,7 @@ To add and position two additional bones:
-## Parent armature
+## Parenting Armature
After you create and position the bone structure, you need to connect the armature to the mesh object by parenting the armature to the mesh object.
@@ -112,7 +112,7 @@ To parent an armature to a mesh:
-## Assign vertices to bones
+## Assigning Vertices to Bones
With your armature connected to the mesh object, you can now assign the mesh vertices of your limbs to be fully influenced by their corresponding
bones. As a rigid model, each limb will completely bend and articulate when the bones are rotated, which is ideal for a non-organic character like a robot.
@@ -138,7 +138,7 @@ To assign bone influence to the left and right arms:
-## Test
+## Testing
You can test your rig in different poses in Pose mode. It's important to test your rigs after applying or changing influences before exporting.
diff --git a/content/en-us/art/modeling/rigging.md b/content/en-us/art/modeling/rigging.md
index e59f6fd2e..fdf6d1244 100644
--- a/content/en-us/art/modeling/rigging.md
+++ b/content/en-us/art/modeling/rigging.md
@@ -1,5 +1,5 @@
---
-title: Rigging and skinning
+title: Rigging and Skinning
description: Rigging and skinning is a modeling process that connects an armature to a mesh, allowing it to be animated or posed in Studio.
---
@@ -29,16 +29,16 @@ description: Rigging and skinning is a modeling process that connects an armatur
See the following resources to learn the basics and intermediate steps required to skin models in Blender:
-- [Rig a simple mesh](../../art/modeling/rig-a-simple-mesh.md)
-- [Skin a simple mesh](../../art/modeling/skin-a-simple-mesh.md)
-- [Rig a humanoid model](../../art/modeling/rig-a-humanoid-model.md)
-- [Skin a humanoid model](../../art/modeling/skin-a-humanoid-model.md)
+- [Rigging a Simple Mesh](../../art/modeling/rigging-a-simple-mesh.md)
+- [Skinning a Simple Mesh](../../art/modeling/skinning-a-simple-mesh.md)
+- [Rigging a Humanoid Model](../../art/modeling/rigging-a-humanoid-model.md)
+- [Skinning a Humanoid Model](../../art/modeling/skinning-a-humanoid-model.md)
-## Rigs and bones
+## Rigs and Bones
The **rig**, or bone structure, within a rigged mesh creates additional poseable points for the 3D model in Studio. By rotating or moving the bones of a mesh, the parts of the mesh assigned to those bones can move independently from the rest of the mesh. The assignment of influence between meshes and bones, such as a **LowerLeftArm** bone driving the movement of the **LowerLeftArm** geometry, is set in a third-party application like Blender or Maya. When imported into Studio, Roblox saves this influence assignment data to the `Class.MeshPart` asset data.
-Once you successfully [import](../../parts/meshes.md#import-meshes) a rigged mesh model into Studio, Studio represents this rig structure with `Class.Bone` instances that you can then pose and animate. You can view bones in Studio by toggling **Constraint Details** in the Model tab, or when you are using the [Animation Editor](../../animation/editor.md).
+Once you successfully [import](../../parts/meshes.md#importing-meshes) a rigged mesh model into Studio, Studio represents this rig structure with `Class.Bone` instances that you can then pose and animate. You can view bones in Studio by toggling **Constraint Details** in the Model tab, or when you are using the [Animation Editor](../../animation/editor.md).
@@ -57,14 +57,14 @@ When `Class.Bone` objects are used in animation, they affect the appearance of t
-## Types of rigs
+## Types of Rigs
Rigged models use a naming convention starting with "R" and ending with the number of individual meshes that make up the model. This is used to quickly identify the type and number of meshes that a model has. Although R6 and R15 models are common, a model can be of varying subjects, sizes and can have any number of individual meshes, such as a R5, R20, or R200.
- **R1** refers to a single mesh that is rigged, or associated with an internal skeleton structure. Many models, such as a tree or accessory item, are good candidates to be made into an R1 model. Even humanoid characters, such as NPCs, can be created as R1 models but they will not be able to take full advantage of the animation and humanoid options available for R15 characters.
- See [Rig a simple mesh](../../art/modeling/rig-a-simple-mesh.md) for instructions on turning a basic mesh into an R1 model in Blender.
+ See [Rigging a Simple Mesh](../../art/modeling/rigging-a-simple-mesh.md) for instructions on turning a basic mesh into an R1 model in Blender.
- **R15** typically refers to humanoid models used as player or avatar characters. An R15 model is made up of 15 specific meshes that are parented to a single rig. A R15 character model often includes skinning data to allow the model to bend and pose naturally. Roblox uses the R15 standard for all avatars, and requires the [R15 technical specifications](../../art/characters/specifications.md) to ensure universal behavior and quality.
- See [Rig a humanoid model](../../art/modeling/rig-a-humanoid-model.md) for instructions on turning a character model into an R15 humanoid model in Blender.
+ See [Rigging a Humanoid Model](../../art/modeling/rigging-a-humanoid-model.md) for instructions on turning a character model into an R15 humanoid model in Blender.
diff --git a/content/en-us/art/modeling/roblox-blender-plugin.md b/content/en-us/art/modeling/roblox-blender-plugin.md
index 2474ff3a3..2fbf2701d 100644
--- a/content/en-us/art/modeling/roblox-blender-plugin.md
+++ b/content/en-us/art/modeling/roblox-blender-plugin.md
@@ -1,10 +1,10 @@
---
-title: Roblox Blender plugin
+title: Roblox Blender Plugin
description: The Roblox Blender plugin allows you to transfer assets directly from Blender to Studio.
---
-The Roblox Blender plugin is a Blender add-on that allows you to link your Roblox account and quickly transfer 3D modeling objects directly from Blender to your Studio session. This tool helps you save time and reduce errors by skipping the process of exporting and importing third-party modeling files between applications.
+The Roblox Blender Plugin is a Blender add-on that allows you to link your Roblox account and quickly transfer 3D modeling objects directly from Blender to your Studio session. This tool helps you save time and reduce errors by skipping the process of exporting and importing third-party modeling files between applications.
-The Roblox Blender plugin is an open-source implementation of Roblox's [Open Cloud API](../../cloud/open-cloud/index.md) and developers are encouraged to extend and build upon this tool for their own projects. For installation, use, licensing, and contribution details, see the [Roblox Blender plugin GitHub page](https://github.com/Roblox/roblox-blender-plugin).
+The Roblox Blender plugin is an open-source implementation of Roblox's [Open Cloud API](../../cloud/open-cloud/index.md) and developers are encouraged to extend and build upon this tool for their own projects. For installation, use, licensing, and contribution details, see the [Roblox Blender Plugin GitHub page](https://github.com/Roblox/roblox-blender-plugin).
diff --git a/content/en-us/art/modeling/skin-a-humanoid-model.md b/content/en-us/art/modeling/skinning-a-humanoid-model.md
similarity index 90%
rename from content/en-us/art/modeling/skin-a-humanoid-model.md
rename to content/en-us/art/modeling/skinning-a-humanoid-model.md
index 3a7ec112e..b8cda109e 100644
--- a/content/en-us/art/modeling/skin-a-humanoid-model.md
+++ b/content/en-us/art/modeling/skinning-a-humanoid-model.md
@@ -1,33 +1,33 @@
---
-title: Skin a humanoid model
+title: Skinning a Humanoid Model
description: Explains the process for skinning a humanoid R15 model in Blender.
---
A humanoid skinned mesh is a character model that, when posed or animated, bends and stretches naturally at its joints. You can create a skinned mesh using a third party modeling tool such as [Blender](https://www.blender.org) or [Maya](https://www.autodesk.com/products/maya/overview).
-This is an advanced guide on skinning a humanoid model into an R15 model in Blender using the humanoid model completed in [Rig a humanoid model](./rig-a-humanoid-model.md). Before skinning a humanoid model, you should also familiarize yourself with the basic concepts in [Skin a simple mesh](../../art/modeling/skin-a-simple-mesh.md).
+This is an advanced guide on skinning a humanoid model into an R15 model in Blender using the humanoid model completed in [Rigging a Humanoid Model](./rigging-a-humanoid-model.md). Before skinning a humanoid model, you should also familiarize yourself with the basic concepts in [Skinning a Simple Mesh](../../art/modeling/skinning-a-simple-mesh.md).
To skin a humanoid model in Blender, you need to:
-- [Set up Blender](#set-up-blender) with a rigged model to optimize the weight painting process with bone visualization settings and Auto Normalize.
+- [Set up Blender](#setting-up-blender) with a rigged model to optimize the weight painting process with bone visualization settings and Auto Normalize.
- [Weight paint](#weight-painting) vertices of your mesh objects by balancing influence of your vertices between two or more bones of a humanoid rig architecture.
-### Import a model
+### Importing a Model
For this guide, you'll import a [maple tree model](../../assets/modeling/skinned-meshes/MapleLeafTree.fbx) into Blender as your mesh object.
@@ -55,11 +55,11 @@ To import a model into Blender:
-## Create a bone structure
+## Creating a Bone Structure
Now that your model is within Blender, add an armature and **bones** to your mesh object. An **armature** is a skeleton-like rigging object that acts as a container for bones, while **bones** are objects that control the movement and deformation of the group of vertices, or **vertex group**, that surround the bone.
-### Add an armature
+### Adding an Armature
An armature is a structure required to add bones to your mesh. After you add in an armature, you can create and reposition any number of bones inside of your mesh object.
@@ -78,7 +78,7 @@ To add an armature:
-### Position bones
+### Positioning Bones
When you add an armature to your project, Blender also adds one bone to the armature at a default position and scale. You can rotate and scale the bone to more accurately represent the internal structure of your mesh object.
@@ -95,7 +95,7 @@ To reposition the bone:
5. Press and hold your mouse's scroll wheel to move the camera around the mesh object to see different views and angles to ensure that the bone is centered within the mesh object.
-### Add additional bones
+### Adding Additional Bones
In this guide, you need 3 bones within your mesh so the tree can move and rotate at three points.
@@ -121,7 +121,7 @@ To add additional bones into the armature:
-## Parent armature
+## Parenting Armature
After the bone structure is created and positioned, you need to connect the armature to the mesh object by parenting the armature to the mesh object.
@@ -139,7 +139,7 @@ To parent an armature to a mesh:
src="../../assets/modeling/skinned-meshes/Parenting-Armature.mp4"
width="80%">
-## Weight paint
+## Weight Painting
With your armature connected to the mesh object, you can use the process of **weight painting** to change the amount of influence (weight) the bones will have on specific vertices to allow for more natural movement and flexibility.
@@ -149,13 +149,13 @@ You can quickly assign influence with the [Brush tool](https://docs.blender.org/
-To optimize the painting process, [set up visualization and brush settings](#setup) before [painting influences](#paint-influence) to the mesh.
+To optimize the painting process, [set up visualization and brush settings](#setup) before [painting influences](#painting-influence) to the mesh.
### Setup
When assigning influences for complex models, you can configure the following Blender settings to optimize the Weight Painting process.
-#### Bone visualization
+#### Bone Visualization
By default, Blender displays bone objects as octahedral shapes. This original shape is useful when positioning bones within the rig but can get in the way while painting. To help visualize the weight painting process, change your bone visualization to sticks.
@@ -169,7 +169,7 @@ To update the visualization of your bones:
src="../../assets/modeling/skinned-meshes/Stick-Visualization.mp4"
width="80%">
-#### Auto normalize
+#### Auto Normalize
The [**Auto Normalize**](https://docs.blender.org/manual/en/latest/sculpt_paint/weight_paint/tool_settings/options.html) setting forces the influence on your vertices to equal one. This makes weight painting more efficient by ensuring that each vertex in your character is fully influenced by at least one bone. In this guide, Auto Normalize allows you to first apply full influence to the entire mesh quickly and then make minor adjustments with each bone.
@@ -190,7 +190,7 @@ To enable Auto Normalize:
src="../../assets/modeling/skinned-meshes/Enabling-Autonormalize.mp4"
width="80%">
-#### Projected brush
+#### Projected Brush
A projected brush allows you to easily apply influence through a mesh, instead of just the surface. This is useful when painting influences on meshes that may be geometrically layered, such as the foliage of the tree.
@@ -207,11 +207,11 @@ To set up a projected brush:
src="../../assets/modeling/skinned-meshes/Setting-Projected-Brush.mp4"
width="80%">
-### Paint influence
+### Painting Influence
With the [projected brush](#projected-brush) set up, you can now begin applying influence to the tree. Take advantage of the [Auto Normalize](#auto-normalize) setting by painting full red influence to the entire tree to the bottom bone and then assigning a partial influence on the middle and top bones.
-#### Bottom bone
+#### Bottom Bone
The bottom bone should fully influence the movement of the entire tree starting from the trunk.
@@ -236,7 +236,7 @@ To start painting influence to the bottom bone:
src="../../assets/modeling/skinned-meshes/Test-Bottom-Bone.mp4"
width="80%">
-#### Middle bone
+#### Middle Bone
The middle bone represents most of the foliage above the bottom bone. For a more subtle effect, apply a 50% influence (green) from the middle bone upwards.
@@ -253,7 +253,7 @@ To paint influence to the middle bone:
src="../../assets/modeling/skinned-meshes/Paint-Middle-Bone.mp4"
width="80%">
-#### Top bone
+#### Top Bone
The top bone should influence the top leaf area above the middle bone. Paint this top area using 25% influence (teal) for a more natural effect.
@@ -276,7 +276,7 @@ After weight painting each bone, each section of this tree should now be influen
src="../../assets/modeling/skinned-meshes/Test-Bones.mp4"
width="80%">
-### Test
+### Testing
It is important to constantly test the influences of your bone **throughout** the weight painting process.
diff --git a/content/en-us/art/modeling/specifications.md b/content/en-us/art/modeling/specifications.md
index c1cb6d8fe..f76d88564 100644
--- a/content/en-us/art/modeling/specifications.md
+++ b/content/en-us/art/modeling/specifications.md
@@ -1,5 +1,5 @@
---
-title: General specifications
+title: General Specifications
description: Lists the specific technical requirements for custom models created outside of Studio.
---
@@ -7,14 +7,14 @@ Roblox supports a wide variety of mesh configurations created from third-party s
Check that your model meets the following modeling specifications and guidelines before exporting to ensure Studio compatibility. Specific types of assets, like characters and accessories, have additional specifications:
-- If you are creating a rigid accessory model, ensure that your model follows the [accessory specifications](../../art/accessories/specifications.md).
-- If you are creating a clothing accessory model, ensure that your model follows the [clothing specifications](../../art/accessories/clothing-specifications.md).
-- If you are creating an avatar character model, ensure that your model follows the [character specifications](../../art/characters/specifications.md).
+- If you are creating a rigid accessory model, ensure that your model follows [Accessory Specifications](../../art/accessories/specifications.md).
+- If you are creating a clothing accessory model, ensure that your model follows [Clothing Specifications](../../art/accessories/clothing-specifications.md).
+- If you are creating an avatar character model, ensure that your model follows [Character Specifications](../../art/characters/specifications.md).
-When ready to export, see the [export settings](../../art/modeling/export-requirements.md) for mesh export settings for Blender and Maya.
+When ready to export, see [Export Requirements](../../art/modeling/export-requirements.md) for mesh export settings for Blender and Maya.
-- **Outer cage** - Models, such as a playable character, that aren't expected deform but are the target of meshes that will stretch over it, only require an Outer Cage.
-- **Vertices and UV map** - Don't delete vertices or alter the UVs on the Inner or Outer Cages as this can cause errors when importing in Studio or when equipping onto a character.
+- **Outer Cage** - Models, such as a playable character, that aren't expected deform but are the target of meshes that will stretch over it, only require an Outer Cage.
+- **Vertices and UV Map** - Don't delete vertices or alter the UVs on the Inner or Outer Cages as this can cause errors when importing in Studio or when equipping onto a character.
- **Symmetry and consistency** - Keep each face (the space between vertices) consistently sized and retain symmetry wherever possible. Use symmetry tools in your modeling software whenever possible.
diff --git a/content/en-us/art/modeling/surface-appearance.md b/content/en-us/art/modeling/surface-appearance.md
index 41b705ade..48e102a74 100644
--- a/content/en-us/art/modeling/surface-appearance.md
+++ b/content/en-us/art/modeling/surface-appearance.md
@@ -1,9 +1,9 @@
---
-title: PBR textures
+title: PBR Textures
description: PBR textures are advanced textures using multiple texture maps.
---
-**Physically-Based rendering** (PBR) textures allow you to represent realistic shading and lighting by using multiple types of texture images, or **maps**, on a single object. Combining multiple texture maps can more accurately simulate color, roughness, and reflectivity in any lighting environment and can enhance the visual elements of your assets and environment.
+**Physically-Based Rendering** (PBR) textures allow you to represent realistic shading and lighting by using multiple types of texture images, or **maps**, on a single object. Combining multiple texture maps can more accurately simulate color, roughness, and reflectivity in any lighting environment and can enhance the visual elements of your assets and environment.
-## Texture maps
+## Texture Maps
Studio currently supports 4 types of PBR texture maps: **Color**, **Normal**, **Metalness**, **Roughness**. Each of these maps correspond to an important aspect of the object's surface appearance. Texture maps only change visual appearance and don't affect the geometry of the `Class.MeshPart` object.
@@ -51,19 +51,19 @@ See the following examples for an overview of Roblox's supported texture maps an
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-### Generate materials
+### Generate Materials
When given a request to generate a material, Assistant in Studio can quickly style existing parts through a lightweight implementation of the [Material Generator](../studio/material-generator.md).
-## Access Assistant
+## Accessing Assistant
Assistant is available in two locations: Studio and the documentation.
@@ -67,14 +67,14 @@ To access Assistant from Studio:
-2. Type a request into the field near the bottom of the window, using guidance from the [prompt guide](prompt-engineering.md) to generate improved responses.
+2. Type a request into the field near the bottom of the window, using guidance from the [Prompt Guide](prompt-engineering.md) to generate improved responses.
- Click thumbs up or thumbs down to rate the result and improve future results.
- Click the redo icon to process a new result.
-### From the documentation
+### From the Documentation
To access Assistant from the [documentation](/assistant):
@@ -82,7 +82,7 @@ To access Assistant from the [documentation](/assistant):
-1. Select a premade question or type your own. See the [prompt guide](prompt-engineering.md) for guidance on generating improved responses.
+1. Select a premade question or type your own. See the [Prompt Guide](prompt-engineering.md) for guidance on generating improved responses.
diff --git a/content/en-us/assistant/prompt-engineering.md b/content/en-us/assistant/prompt-engineering.md
index 622d2f1cb..fc0536d63 100644
--- a/content/en-us/assistant/prompt-engineering.md
+++ b/content/en-us/assistant/prompt-engineering.md
@@ -1,5 +1,5 @@
---
-title: Assistant prompt guide and examples
+title: Assistant Prompt Guide and Examples
description: Get tips and tricks on how best to prompt Roblox's AI Assistant to get the best results.
---
@@ -9,14 +9,14 @@ description: Get tips and tricks on how best to prompt Roblox's AI Assistant to
This document gives guidance on prompting Assistant and provides examples and inspiration on what Assistant can do.
-## Be specific
+## Be Specific
If Assistant fails, add more details to your prompt and try again. Use instance names exactly as they're spelled, specify which function you want Assistant to use, and tell Assistant which type it's working with, such as a part or a model.
-### Building - Scatter objects with randomization
+### Building - Scattering Objects with Randomization
**Prompt:**
Add 0-5 of the selected instance "Mushroom" around each "RedwoodTree-Var01".
-### Building - Night / day cycle with street lights
+### Building - Night / Day Cycle with Street Lights
**Prompt:**
Add a script that changes the time of day by 1 hour every second. Start at 3pm. At 7pm, turn every spotlight's brightness up to 10. At 8am turn every spotlight's brightness down to 0.
-### Building - Physics-based suspension bridge
+### Building - Physics-based Suspension Bridge
**Prompt:**
Create a rope bridge. Make 10 wood planks that are 5 studs wide and 2 studs long.
@@ -212,35 +212,35 @@ visible, anchor the 1st and 10th part, and add a drag detector on the 1st and 10
-### Building - Add smoke to chimneys
+### Building - Adding Smoke to Chimneys
**Prompt:**
Insert an invisible brick that is non-collidable into every chimney in every house. The brick should have a particle inside it that makes smoke that flows upwards, and the smoke must be white.
-### Building - Rename instances
+### Building - Renaming Instances
**Prompt:**
Rename all the "emptyscripts" objects to "Script+uniqueID".
-### Building - Create terrain
+### Building - Creating Terrain
**Prompt:**
Create a terrain region with rolling hills.
-### Building - Add behavior at scale
+### Building - Adding Behavior at Scale
**Prompt:**
Add a script to make the spotlights in the folder StreetLights flicker on and off randomly.
-### Building - Replace greyboxes with assets
+### Building - Replacing Greyboxes with Assets
**Prompt:**
Replace each of the selected parts with a model of the same name currently in the data model inside the AssetLibrary Folder under workspace. For example, if the part is called "Suburban House", look for a model called "Suburban House" and replace the part with that model.
diff --git a/content/en-us/avatar/index.md b/content/en-us/avatar/index.md
index 61d7a510e..9b02fd126 100644
--- a/content/en-us/avatar/index.md
+++ b/content/en-us/avatar/index.md
@@ -1,5 +1,5 @@
---
-title: Roblox avatars
+title: Roblox Avatars
description: Create and upload avatar characters, clothing, and accessories to the Roblox Marketplace.
hideBreadcrumbs: true
---
@@ -13,15 +13,15 @@ Whether you're creating and selling a basic accessory, clothes, or an avatar cha
-1. **Modeling and creation** — Create the asset in a third-party software such as Blender or Maya.
+1. **Modeling and Creation** — Create the asset in a third-party software such as Blender or Maya.
- Roblox supports many types of third-party models, but assets intended for the Marketplace require their own specifications for [rigid accessories](../art/accessories/specifications.md), [clothing accessories](../art/accessories/clothing-specifications.md), and [bodies](../art/characters/specifications.md).
-2. **Importing and uploading** — Add your creation to the Roblox servers through Studio.
+2. **Importing and Uploading** — Add your creation to the Roblox servers through Studio.
- Initial validation and moderation of the asset occurs during this stage. See each item category section for specific instructions.
-3. **Publishing and selling** — Manage your asset on your [Creator Dashboard](https://create.roblox.com/dashboard/creations) where you can set your item price and other Marketplace configurations before you enable the item for sale.
+3. **Publishing and Selling** — Manage your asset on your [Creator Dashboard](https://create.roblox.com/dashboard/creations) where you can set your item price and other Marketplace configurations before you enable the item for sale.
- See [Marketplace](../marketplace/index.md) for an overview of this process.
@@ -42,7 +42,7 @@ Create avatar items for Roblox, ranging from clothing, accessories, bodies, and
Understand the various components that make up rigid accessories, the most basic form of 3D avatar cosmetics.
-### Health display type
+### Health Display Type
The `Class.Humanoid.HealthDisplayType` property provides further control over the character's health bar visibility. The bar reflects the humanoid's `Class.Humanoid.Health|Health` as a factor of its `Class.Humanoid.MaxHealth|MaxHealth` and it changes color from green to yellow to red as the humanoid's health decreases.
@@ -100,9 +100,9 @@ In the following scenario, both **Watchman** and **Octavia** are sufficiently hi
-## Modify character displays
+## Modifying Character Displays
-### User avatars
+### User Avatars
To modify the name or health display for every incoming avatar in an experience, connect the `Class.Players.PlayerAdded` and `Class.Player.CharacterAdded` events in a `Class.Script` and set [display properties](#display-properties) on the character's `Class.Humanoid`.
@@ -157,7 +157,7 @@ Players.PlayerAdded:Connect(onPlayerAdded)
When a player is assigned to a `Class.Team`, their character's name appears in the same color as the team's `Class.Team.TeamColor|TeamColor`. This helps identify teammates and opposing players in team-based experiences.
-### NPC characters
+### NPC Characters
For NPC characters already placed in the 3D world, you can edit name/health directly on the `Class.Humanoid` object in the [Properties](../studio/properties.md) window.
@@ -166,15 +166,15 @@ For NPC characters already placed in the 3D world, you can edit name/health dire
-## Override display names
+## Overriding Display Names
By default, a humanoid's display name matches the user's Roblox account **Display Name** which is unique and separate from their account **Username**. To show a fully custom name that's unrelated to the user's account, you can override the `Class.Humanoid.DisplayName` property.
-### Set directly
+### Setting Directly
You can set the `Class.Humanoid.DisplayName|DisplayName` property of any `Class.Humanoid` instance which you gain reference to through a `Class.Script`, such as the [team customization](#team-customization-script) example, or directly on an [NPC](#npc-characters) character's **Humanoid** object.
-### Set through user input
+### Setting Through User Input
In some genres like roleplaying or fighting, you may want to provide a method for users to input their own character name, pet character name, etc. that's specific to the experience and isn't tied to their account display name. You can gather this input on the client side through a `Class.TextBox` name entry.
diff --git a/content/en-us/characters/pathfinding.md b/content/en-us/characters/pathfinding.md
index 1cc463c6c..250cf858d 100644
--- a/content/en-us/characters/pathfinding.md
+++ b/content/en-us/characters/pathfinding.md
@@ -1,5 +1,5 @@
---
-title: Character pathfinding
+title: Character Pathfinding
description: Pathfinding is the process of moving a character along a logical path to reach a destination.
---
@@ -7,13 +7,13 @@ description: Pathfinding is the process of moving a character along a logical pa
-## Navigation visualization
+## Navigation Visualization
To assist with pathfinding layout and debugging, Studio can render a navigation mesh and [modifier](#pathfinding-modifiers) labels. To enable them, toggle on **Navigation mesh** and **Pathfinding modifiers** from the [Visualization Options](../studio/ui-overview.md#visualization-options) widget in the upper‑right corner of the 3D viewport.
-With **Navigation mesh** enabled, colored areas show where a character might walk or swim, while non-colored areas are blocked. The small arrows indicate areas that a character will attempt to reach by jumping, assuming you set `AgentCanJump` to `true` when [creating the path](#create-paths).
+With **Navigation mesh** enabled, colored areas show where a character might walk or swim, while non-colored areas are blocked. The small arrows indicate areas that a character will attempt to reach by jumping, assuming you set `AgentCanJump` to `true` when [creating the path](#creating-paths).
@@ -21,11 +21,11 @@ With **Pathfinding modifiers** enabled, text labels indicate specific materials
-## Known limitations
+## Known Limitations
Pathfinding features specific limitations to ensure efficient processing and optimal performance.
-### Vertical placement limit
+### Vertical Placement Limit
Pathfinding calculations consider only parts within certain vertical boundaries:
@@ -33,11 +33,11 @@ Pathfinding calculations consider only parts within certain vertical boundaries:
- Upper Boundary — Parts with a top **Y** coordinate exceeding 65,536 studs are ignored.
- Vertical Span — The vertical distance from the lowest part's bottom **Y** coordinate to the highest part's top **Y** coordinate must not exceed 65,536 studs; otherwise, the pathfinding system will ignore those parts during the pathfinding computation.
-### Search distance limitation
+### Search Distance Limitation
The direct line-of-sight distance for pathfinding from the start to the finish point must not exceed 3,000 studs. Exceeding this distance will result in a `Enum.PathStatus|NoPath` status.
-## Create paths
+## Creating Paths
Pathfinding is initiated through `Class.PathfindingService` and its `Class.PathfindingService:CreatePath()|CreatePath()` function.
@@ -111,7 +111,7 @@ local path = PathfindingService:CreatePath({
})
```
-Note that the agent can climb `Class.TrussPart|TrussParts` during pathfinding assuming you set `AgentCanClimb` to `true` when [creating the path](#create-paths) and nothing blocks the agent from the truss climbing path. A climbable path has the **Climb** label and the [cost](#set-material-costs) for a climbable path is **1** by default.
+Note that the agent can climb `Class.TrussPart|TrussParts` during pathfinding assuming you set `AgentCanClimb` to `true` when [creating the path](#creating-paths) and nothing blocks the agent from the truss climbing path. A climbable path has the **Climb** label and the [cost](#setting-material-costs) for a climbable path is **1** by default.
@@ -126,7 +126,7 @@ local path = PathfindingService:CreatePath({
})
```
-## Move along paths
+## Moving Along Paths
This section uses the following pathfinding script for the player's character. To test while reading:
@@ -198,7 +198,7 @@ end
followPath(TEST_DESTINATION)
```
-### Compute the path
+### Computing the Path
After you've created a valid path with `Class.PathfindingService:CreatePath()|CreatePath()`, it must be **computed** by calling `Class.Path:ComputeAsync()` with a `Datatype.Vector3` for both the starting point and destination.
@@ -230,7 +230,7 @@ end
-### Get waypoints
+### Getting Waypoints
Once the `Class.Path` is computed, it will contain a series of **waypoints** that trace the path from start to end. These points can be gathered with the `Class.Path:GetWaypoints()` function.
@@ -271,7 +271,7 @@ end
-To optimize pathfinding even further, you can implement **pathfinding modifiers** to compute smarter paths across various [materials](#set-material-costs), around defined [regions](#work-with-regions), or through [obstacles](#ignore-obstacles).
+To optimize pathfinding even further, you can implement **pathfinding modifiers** to compute smarter paths across various [materials](#setting-material-costs), around defined [regions](#working-with-regions), or through [obstacles](#ignoring-obstacles).
-### Set material costs
+### Setting Material Costs
When working with `Class.Terrain` and `Class.BasePart` materials, you can include a `Costs` table within `Class.PathfindingService:CreatePath()|CreatePath()` to make certain materials more traversable than others. All materials have a default cost of **1** and any material can be defined as non-traversable by setting its value to `Library.math.huge`.
@@ -423,9 +423,9 @@ local path = PathfindingService:CreatePath({
-### Work with regions
+### Working With Regions
-In some cases, [material preference](#set-material-costs) is not enough. For example, you might want characters to avoid a **defined region**, regardless of the materials underfoot. This can be achieved by adding a `Class.PathfindingModifier` object to a part.
+In some cases, [material preference](#setting-material-costs) is not enough. For example, you might want characters to avoid a **defined region**, regardless of the materials underfoot. This can be achieved by adding a `Class.PathfindingModifier` object to a part.
1. Create an `Class.BasePart.Anchored|Anchored` part around the dangerous region and set its `Class.BasePart.CanCollide|CanCollide` property to **false**.
@@ -451,7 +451,7 @@ In some cases, [material preference](#set-material-costs) is not enough. For exa
-### Ignore obstacles
+### Ignoring Obstacles
In some cases, it's useful to pathfind through solid obstacles as if they didn't exist. This lets you compute a path through specific physical blockers, versus the computation failing outright.
@@ -467,7 +467,7 @@ In some cases, it's useful to pathfind through solid obstacles as if they didn't
-## Pathfinding links
+## Pathfinding Links
Sometimes it's necessary to find a path across a space that cannot be normally traversed, such as across a chasm, and perform a custom action to reach the next waypoint. This can be achieved through the `Class.PathfindingLink` object.
@@ -611,14 +611,14 @@ To create a `Class.PathfindingLink` using this example:
-## Streaming compatibility
+## Streaming Compatibility
In-experience [instance streaming](../workspace/streaming.md) is a powerful feature that dynamically loads and unloads 3D content as a player's character moves around the world. As they explore the 3D space, new subsets of the space stream to their device and some of the existing subsets might stream out.
Consider the following best practices for using `Class.PathfindingService` in streaming-enabled experiences:
-- Streaming can block or unblock a given path as a character moves along it. For example, while a character runs through a forest, a tree might stream in somewhere ahead of them and obstruct the path. To make pathfinding work seamlessly with streaming, it's highly recommended that you use the [handling blocked paths](#handle-blocked-paths) technique and re-compute the path when necessary.
+- Streaming can block or unblock a given path as a character moves along it. For example, while a character runs through a forest, a tree might stream in somewhere ahead of them and obstruct the path. To make pathfinding work seamlessly with streaming, it's highly recommended that you use the [Handling Blocked Paths](#handling-blocked-paths) technique and re-compute the path when necessary.
-- A common approach in pathfinding is to use the coordinates of existing objects for [computation](#compute-the-path), such as setting a path destination to the position of an existing **TreasureChest** model in the world. This approach is fully compatible with server-side `Class.Script|Scripts` since the server has full view of the world at all times, but `Class.LocalScript|LocalScripts` and `Class.ModuleScript|ModuleScripts` that run on the client may fail if they attempt to compute a path to an object that's not streamed in.
+- A common approach in pathfinding is to use the coordinates of existing objects for [computation](#computing-the-path), such as setting a path destination to the position of an existing **TreasureChest** model in the world. This approach is fully compatible with server-side `Class.Script|Scripts` since the server has full view of the world at all times, but `Class.LocalScript|LocalScripts` and `Class.ModuleScript|ModuleScripts` that run on the client may fail if they attempt to compute a path to an object that's not streamed in.
To address this issue, consider setting the destination to the position of a `Class.BasePart` within a [persistent](../workspace/streaming.md#model-streaming-controls) model. Persistent models load soon after the player joins and they never stream out, so a client-side script can connect to the `Class.Workspace.PersistentLoaded|PersistentLoaded` event and safely access the model for creating waypoints after the event fires.
diff --git a/content/en-us/characters/r6-to-r15-adapter.md b/content/en-us/characters/r6-to-r15-adapter.md
index bd9b27503..162c741ad 100644
--- a/content/en-us/characters/r6-to-r15-adapter.md
+++ b/content/en-us/characters/r6-to-r15-adapter.md
@@ -1,5 +1,5 @@
---
-title: R6 to R15 Adapter
+title: R6 To R15 Adapter
description: The R6 to R15 adapter enables R15 avatar characters to join your R6 experience.
---
@@ -9,9 +9,9 @@ This feature is only applicable to developers who manage an active experience wi
The **R6 to R15 Adapter** allows R15 avatars to join your R6 experience. All avatars in the experience will still use the R6-like scale and movement systems. The adapter allows your experience to take advantage of modern R15 components, such as layered clothing and animatable heads, with minimal performance or gameplay impact to your experience.
-It's important to understand how the adapter uses [adapter parts](#adapter-parts) and review the feature's [known limitations](#known-limitations) before [enabling](#enable-the-r6-to-r15-adapter) and testing the adapter for your experience.
+It's important to understand how the adapter uses [adapter parts](#adapter-parts) and review the feature's [known limitations](#known-limitations) before [enabling](#enabling-the-r6-to-r15-adapter) and testing the adapter for your experience.
-## Adapter parts
+## Adapter Parts
The R6 to R15 Adapter implements a Lua-script injection when an avatar spawns that creates adapter parts.
@@ -25,7 +25,7 @@ The adapter parts perform the following:
- Acts as a shim between R6 and R15 body parts. Property changes applied to the invisible R6 parts are passed along to their corresponding visible R15 parts.
- For example, a color change in R6 `LeftArm` is passed to the R15 `LeftUpperArm`, `LeftLowerArm` and `LeftHand` parts.
-## Enable the R6 to R15 Adapter
+## Enabling the R6 to R15 Adapter
You can enable the R6 to R15 Adapter by setting the `Class.Workspace.AvatarUnificationMode` property in Workspace. You can only access this property if **Avatar Type** is set to `R6` in your **Game Settings**. At this time, the **Default** setting disables the `Class.Workspace.AvatarUnificationMode|AvatarUnificationMode`.
@@ -34,42 +34,42 @@ To enable the R6 to R15 Adapter:
1. In the Explorer, navigate to **Workspace**.
2. In the Properties window, set **AvatarUnificationMode** to **Enabled**.
-## Known limitations
+## Known Limitations
In a majority of cases, the R6 to R15 Adapter works out-of-the-box with the systems of a R6 experience. In rare cases, there may be conflicts with custom systems that handle game security, or character-related behavior. See the following for a list of potential limitations or conflicts that you may encounter when using the R6 to R15 Adapter.
-### Game security
+### Game Security
Some R6 experiences with active cheat detection can interpret the Lua-script injection as an attempt to circumvent the security.
Since the default behavior of R6 avatars is to spawn with all their parts already in place, many experiences tend to flag changes in body parts as potential exploits. In experiences with the adapter enabled, the R15 avatars spawn with their default bodies before changing body parts based on their saved avatar body parts and accessories.
-### Custom avatar editors
+### Custom Avatar Editors
Experiences with custom avatar editors that allow players to swap body parts might break the connection with the adapter parts.
-### Pre-existing R15 support
+### Pre-existing R15 Support
Experiences that check the avatar rig type and include solutions specific for each R15 and R6 case might not work properly with the adapter. `AvatarUnificationMode` uses code paths corresponding to R15 which may require testing in your experience.
-### Body part rescaling
+### Body Part Rescaling
Games that resize the R6 body parts won't see the scale change propagated to the proxied R15 parts. This is also the case if joint attachments are moved.
-### GetChildren API calls
+### GetChildren API Calls
`Class.Instance:GetChildren()|GetChildren()` calls return both the R6 proxy parts and their corresponding R15 parts. You may need to account for this extra information.
-### FindFirstChild API calls
+### FindFirstChild API Calls
Don't immediately use `Class.Instance:FindFirstChild()|FindFirstChild()`, or "dot indexing," in your scripts to find character parts. Instead, use `Class.Instance:WaitForChild()|WaitForChild()` before you call `Class.Instance:FindFirstChild()|FindFirstChild()`. Replication in `Class.Workspace.AvatarUnificationMode|AvatarUnificationMode` is different, and the experience may fail to find a child that doesn't exist yet.
This has always been a best practice for Roblox scripts, even if some cases work without following this practice.
-### Head.ClassName conditionals
+### Head.ClassName Conditionals
`Class.Workspace.AvatarUnificationMode|AvatarUnificationMode` sets the Head to a `Class.MeshPart`. Any calls that read or write to the `Class.SpecialMesh.MeshId` property will fail.
-### Head collisions
+### Head Collisions
R15 characters joining an R6 experience don't support collisions with their Head part. If your game detects or depends on collisions with a character's Head, you must also update your scripts to check for `CollisionHead` as well.
diff --git a/content/en-us/chat/bubble-chat.md b/content/en-us/chat/bubble-chat.md
index f6cf669f2..564d3068e 100644
--- a/content/en-us/chat/bubble-chat.md
+++ b/content/en-us/chat/bubble-chat.md
@@ -1,13 +1,13 @@
---
-title: Customize bubble chat
+title: Customizing Bubble Chat
description: The text chat system allows users to communicate and socialize with each other.
---
-With [TextChatService](../chat/in-experience-text-chat.md), you can use bubble chat to display customizable speech chat bubbles above user avatars and NPCs. Bubble chat can make your experience more visually immersive and help users easily identify messages and their speakers in a contextually relevant manner. This feature is especially useful for experiences where users need to focus on the content in the meantime communicating with others in a less obtrusive way.
+With [TextChatService](../chat/in-experience-text-chat.md), you can use **bubble chat** to display customizable speech chat bubbles above user avatars and NPCs. Bubble chat can make your experience more visually immersive and help users easily identify messages and their speakers in a contextually relevant manner. This feature is especially useful for experiences where users need to focus on the content in the meantime communicating with others in a less obtrusive way.
-## Enable bubble chat
+## Enabling Bubble Chat
To enable bubble chat in your experience:
@@ -19,7 +19,7 @@ To enable bubble chat in your experience:
-## Bubble customization
+## Bubble Customization
After enabling bubble chat, you can customize the appearance and behavior of your chat bubbles to match your experience theme. Use the [Properties](../studio/properties.md) window of `Class.BubbleChatConfiguration` for [basic](#basic-customization) changes like text color and spacing, or implement [advanced](#advanced-customization) customization for bubble background images and other visual adjustments.
@@ -27,7 +27,7 @@ After enabling bubble chat, you can customize the appearance and behavior of you
Alternatively, add a `Class.LocalScript` in `Class.StarterPlayerScripts` with all your customization settings. This allows the engine to apply your customizations during runtime, overriding the settings in Studio. It's useful for adding special effects to chat bubbles when users trigger certain events or conditions.
-### Basic customization
+### Basic Customization
The following table shows common bubble chat customization properties. For a full list of customization properties, see `Class.BubbleChatConfiguration`.
@@ -125,7 +125,7 @@ The following table shows common bubble chat customization properties. For a ful
-### Advanced customization
+### Advanced Customization
For advanced customization of your bubble, add UI objects representing certain aspects of the bubble appearance as children under `Class.BubbleChatConfiguration`, including:
@@ -321,7 +321,7 @@ The following tables outline the available `Class.GuiObject` and [appearance mod
-## Per-bubble customization
+## Per-Bubble Customization
You can individually style and modify chat bubble behaviors based on specific conditions in order to override your general settings. For example, you can use chat bubbles to differentiate NPCs and users, highlight critical health status, and apply special effects to messages with pre-defined keywords.
@@ -435,13 +435,13 @@ end
-## Manually display bubbles
+## Manually Displaying Bubbles
You might want to display a chat bubble when players haven't sent a message, such as with NPCs. Use the `Class.TextChatService:DisplayBubble` method to manually display a chat bubble.
Customization of these bubbles is the same as the customization of the bubbles that are automatically displayed when Players send messages through TextChannels using the [`Class.TextChatService.OnBubbleAdded` callback](#per-bubble-customization).
-### NPC bubbles
+### NPC Bubbles
Display chat bubbles for non-player characters (NPCs) by calling `Class.TextChatService:DisplayBubble(character, message)`, with the NPC character and the message as parameters. These bubbles are customizable using the `Class.TextChatService.OnBubbleAdded` callback just like any other chat bubble.
diff --git a/content/en-us/chat/chat-window.md b/content/en-us/chat/chat-window.md
index 5014dc31f..d9fdfc895 100644
--- a/content/en-us/chat/chat-window.md
+++ b/content/en-us/chat/chat-window.md
@@ -1,17 +1,13 @@
---
-title: Customize the chat window
+title: Customizing the Chat Window
description: Customize the chat window and message UI of your in-experience text chat.
---
The [in-experience text chat](../chat/in-experience-text-chat.md) system, powered by `Class.TextChatService`, allows players to easily communicate and socialize with each other in live experiences. In addition to supporting the default text chat, you can [customize](#chat-window-configuration) the front‑end user interface.
-## Chat window configuration
+## Chat Window Configuration
-The overall chat window consists of:
-
-- Chat window
-- Input bar
-- Channel tabs (optional)
+The overall chat window consists of the **chat window**, an **input bar**, and optional **channel tabs**.
@@ -50,13 +46,13 @@ end
-When `Class.ChannelTabsConfiguration` is enabled, each default `Class.TextChannel` appears in a tab as outlined in the following table. In addition, each custom `Class.TextChannel` creates a tab corresponding to the channel's `Class.Instance.Name|Name` property.
+When `Class.ChannelTabsConfiguration` is enabled, each **default** `Class.TextChannel` appears in a tab as outlined in the following table. In addition, each **custom** `Class.TextChannel` creates a tab corresponding to the channel's `Class.Instance.Name|Name` property.
@@ -152,9 +148,9 @@ Appearance of the overall chat window is customizable through `Class.ChatWindowC
@@ -220,7 +216,7 @@ Appearance of the chat input bar is customizable through `Class.ChatInputBarConf
@@ -354,9 +350,9 @@ TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
end
```
-### Add chat tags
+### Adding Chat Tags
-If your experience has users with special [attributes](../studio/properties.md#instance-attributes) like VIP status, you can attach chat tags wrapped in brackets to the front of user messages to highlight their messages. The following `Class.LocalScript` in `Class.StarterPlayerScripts` examines all `Class.Player` instances representing users in your experience and appends VIP chat tags to those with the `IsVIP` attribute.
+If your experience has users with special [attributes](../studio/properties.md#instance-attributes) like VIP status, you can attach **chat tags** wrapped in brackets to the front of user messages to highlight their messages. The following `Class.LocalScript` in `Class.StarterPlayerScripts` examines all `Class.Player` instances representing users in your experience and appends VIP chat tags to those with the `IsVIP` attribute.
@@ -383,7 +379,7 @@ TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
end
```
-### Rich text customization
+### Rich Text Customization
Rich text [font color tags](../ui/rich-text.md#supported-tags) can be used to format chat messages, helpful if you want to apply formatting to very specific parts of the message. Note that rich text does not support gradients, but the following code sample shows how you can move the user name (stored in `Class.TextChatMessage.PrefixText`) into the message body and then apply rich text tagging to only the name portion.
@@ -417,7 +413,7 @@ TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
end
```
-## Send messages from non‑player sources
+## Sending Messages from Non‑Player Sources
Sometimes, you might want to show non‑player dialogue in the chat window, such as "speech" from a public address system or a non‑player character.
@@ -442,9 +438,9 @@ generalChannel:DisplaySystemMessage(PREFIX .. player.DisplayName)
For a more detailed guide on how to customize the appearance of system messages, see [Customizing System Messages](./examples/custom-system-messages.md).
-#### Default system messages
+#### Default System Messages
-When `Class.TextChatService.CreateDefaultTextChannels` is true, one of the default text channels is the RBXSystem channel. The default chat scripts automatically display system messages in this channel. You can customize the appearance of these messages using the `Class.TextChannel.OnIncomingMessage` callback.
+When `Class.TextChatService.CreateDefaultTextChannels` is true, one of the default text channels is the **RBXSystem** channel. The default chat scripts automatically display system messages in this channel. You can customize the appearance of these messages using the `Class.TextChannel.OnIncomingMessage` callback.
You might want to customize or alter the system messages that are automatically emitted by the chat system. Since the default system messages are localized for users, you should reference them by `TextChatMessage.Metadata` in your [text chat callbacks](../chat/in-experience-text-chat.md#text-chat-hooks-and-callbacks) if you wish to customize their appearance.
@@ -585,7 +581,7 @@ Below is a reference of the default system messages that are emitted by the chat
-### NPC/object
+### NPC/Object
You can also stylize non-player dialogue and add [chat bubbles](../chat/bubble-chat.md) to make it appear like messages are coming from an NPC or object within the 3D world.
diff --git a/content/en-us/chat/examples/custom-system-messages.md b/content/en-us/chat/examples/custom-system-messages.md
index 01c41deda..87c2583d2 100644
--- a/content/en-us/chat/examples/custom-system-messages.md
+++ b/content/en-us/chat/examples/custom-system-messages.md
@@ -1,5 +1,5 @@
---
-title: Custom text chat system messages
+title: Custom Text Chat System Messages
description: Learn how to display and format system messages in the chat window.
---
@@ -45,7 +45,7 @@ TextChannel.OnIncomingMessage = function(message: TextChatMessage)
end
```
-## Use metadata to categorize messages
+## Using Metadata to Categorize Messages
Use metadata however you see fit to categorize messages and apply different styles to different types of messages.
diff --git a/content/en-us/chat/examples/custom-text-chat-commands.md b/content/en-us/chat/examples/custom-text-chat-commands.md
index 8c06d29aa..e1493de40 100644
--- a/content/en-us/chat/examples/custom-text-chat-commands.md
+++ b/content/en-us/chat/examples/custom-text-chat-commands.md
@@ -1,24 +1,24 @@
---
-title: Custom text chat commands
+title: Custom Text Chat Commands
description: Learn how to create custom chat commands.
---
-`Class.TextChatService` has built-in chat commands for common purposes, such as muting other players and using avatar emotes. You can enable them by setting `Class.TextChatService.CreateDefaultCommands` to true in the Studio properties panel.
+`Class.TextChatService` has built-in chat commands for common purposes, such as muting other players and using avatar emotes. You can enable them by setting `Class.TextChatService.CreateDefaultCommands` to true in the Studio **Properties** panel.
You can also add custom commands using `Class.TextChatCommand`. Users sending a defined command in the chat input bar trigger a callback defined by `Class.TextChatCommand.Triggered` to perform your customized actions.
The following example shows how to create a chat command that allows players to increase or decrease their character's size when they input `/super` or `/mini`.
1. Add a `Class.TextChatCommand` instance inside `Class.TextChatService`.
-2. Rename it SizeCommand.
+1. Rename it **SizeCommand**.
-3. Set its PrimaryAlias property to `/super` and its SecondaryAlias to `/mini`.
+1. Set its **PrimaryAlias** property to `/super` and its **SecondaryAlias** to `/mini`.
-4. Insert the following `Class.Script` inside `Class.ServerScriptService` to define a callback for the chat command that scales the character's size:
+1. Insert the following `Class.Script` inside `Class.ServerScriptService` to define a callback for the chat command that scales the character's size:
```lua title='Script' highlight='4,6'
local TextChatService = game:GetService("TextChatService")
diff --git a/content/en-us/chat/examples/group-chat-tags.md b/content/en-us/chat/examples/group-chat-tags.md
index 11575fcf8..37d0debd6 100644
--- a/content/en-us/chat/examples/group-chat-tags.md
+++ b/content/en-us/chat/examples/group-chat-tags.md
@@ -1,11 +1,11 @@
---
-title: Assign chat tags by group membership
+title: Assigning Chat Tags by Group Membership
description: Example of how to assign chat tags to players based on their membership of a group.
---
This example demonstrates how to assign chat tags to players based on their membership of a group. Chat tags are a way to visually identify a player in the chat window and useful for indicating a player's role, status, or group membership.
-First, create a script in ServerScriptStorage, and add the following code to it:
+First, create a script in **ServerScriptStorage**, and add the following code to it:
```lua title='Server'
local Players = game:GetService("Players")
diff --git a/content/en-us/chat/examples/proximity-chat.md b/content/en-us/chat/examples/proximity-chat.md
index f49559a83..add4a1a6d 100644
--- a/content/en-us/chat/examples/proximity-chat.md
+++ b/content/en-us/chat/examples/proximity-chat.md
@@ -1,9 +1,9 @@
---
-title: Proximity-based chat
+title: Proximity-Based Chat
description: Learn how to implement exclusive chat for users who are close to each other in locations using the TextChatService.
---
-This example shows how to implement an exclusive chat for users who are near each other in the game world. It extends the callback with a function using `Class.TextSource` to identify the locations of a user who might be a potential message receiver. If this function returns false, it means that the user locates further than the preset valid range from the message sender, so the system doesn't deliver the message to that user. Add the following to a `Class.Script` in ServerScriptStorage:
+This example shows how to implement an exclusive chat for users who are near each other in the game world. It extends the callback with a function using `Class.TextSource` to identify the locations of a user who might be a potential message receiver. If this function returns false, it means that the user locates further than the preset valid range from the message sender, so the system doesn't deliver the message to that user. Add the following to a `Class.Script` in **ServerScriptStorage**:
```lua title='Server'
-- Get the text chat and players services
diff --git a/content/en-us/chat/examples/simple-custom-frontend-ui.md b/content/en-us/chat/examples/simple-custom-frontend-ui.md
index 1a128ea47..75e08b343 100644
--- a/content/en-us/chat/examples/simple-custom-frontend-ui.md
+++ b/content/en-us/chat/examples/simple-custom-frontend-ui.md
@@ -1,20 +1,20 @@
---
-title: Custom text chat UI
+title: Custom Text Chat UI
description: Example of how to create a simple frontend UI powered with TextChatService.
---
This example shows how to use the `Class.TextChatService` API to design your own frontend. It reuses the default text channels from `TextChatService.CreateDefaultTextChannels` and is very simple compared to the default UI.
-1. First, disable the default UI that comes with the `TextChatService` by setting the `ChatWindowConfiguration.Enabled` and `ChatInputBarConfiguration.Enabled` properties to `false` in the studio properties window.
+1. First, disable the default UI that comes with the `TextChatService` by setting the `ChatWindowConfiguration.Enabled` and `ChatInputBarConfiguration.Enabled` properties to `false` in the Studio **Properties** window.
-2. Create a replacement for the chat input bar. This is the text box that emits messages when the user presses Enter.
+1. Create a replacement for the chat input bar. This is the text box that emits messages when the user presses Enter.
1. Create a `ScreenGui` and parent it to the `StarterGui`.
- 2. Create a `TextBox` and parent it to the `ScreenGui`. To position the text box at the bottom-center of the screen, set the `TextBox.AnchorPoint` to `Vector2.new(0.5, 1)` and the `TextBox.Position` to `UDim2.new(0.5, 0, 1, 0)`.
- 3. Create a `LocalScript` and parent it to the `TextBox`.
- 4. Add the following code to the `LocalScript`:
+ 1. Create a `TextBox` and parent it to the `ScreenGui`. To position the text box at the bottom-center of the screen, set the `TextBox.AnchorPoint` to `Vector2.new(0.5, 1)` and the `TextBox.Position` to `UDim2.new(0.5, 0, 1, 0)`.
+ 1. Create a `LocalScript` and parent it to the `TextBox`.
+ 1. Add the following code to the `LocalScript`:
```lua title='Client'
--!strict
@@ -41,13 +41,13 @@ This example shows how to use the `Class.TextChatService` API to design your own
end)
```
-3. Create a replacement for the chat window. This is the `ScrollingFrame` that displays messages as they are received from `TextChatService.MessageReceived`. This step also creates a `UIListLayout` to automatically layout the messages.
+1. Create a replacement for the chat window. This is the `ScrollingFrame` that displays messages as they are received from `TextChatService.MessageReceived`. This step also creates a `UIListLayout` to automatically layout the messages.
1. Create a `ScreenGui` and parent it to the `StarterGui`.
- 2. Create a `ScrollingFrame` and parent it to the `ScreenGui`.
- 3. Create a `UIListLayout` and parent it to the `ScrollingFrame`.
- 4. Create a `LocalScript` and parent it to the `ScrollingFrame`.
- 5. Add the following code to the `LocalScript`:
+ 1. Create a `ScrollingFrame` and parent it to the `ScreenGui`.
+ 1. Create a `UIListLayout` and parent it to the `ScrollingFrame`.
+ 1. Create a `LocalScript` and parent it to the `ScrollingFrame`.
+ 1. Add the following code to the `LocalScript`:
```lua title='Client'
--!strict
diff --git a/content/en-us/chat/guidelines.md b/content/en-us/chat/guidelines.md
index a8985b314..15c284f59 100644
--- a/content/en-us/chat/guidelines.md
+++ b/content/en-us/chat/guidelines.md
@@ -1,5 +1,5 @@
---
-title: Usage guidelines
+title: Usage Guidelines
description: Important guidelines for using the in-experience text chat feature.
comments: Eventually fold the key points of this page into other pages and remove.
---
diff --git a/content/en-us/chat/in-experience-text-chat.md b/content/en-us/chat/in-experience-text-chat.md
index 1158ae537..4c3b10ebf 100644
--- a/content/en-us/chat/in-experience-text-chat.md
+++ b/content/en-us/chat/in-experience-text-chat.md
@@ -1,23 +1,23 @@
---
-title: TextChatService overview
+title: TextChatService Overview
description: The TextChatService system allows players to communicate with each other using text-based messages in live sessions.
---
-Roblox offers text-based messaging between players in live sessions through `Class.TextChatService`. This service has its standard functionality, but also provides a set of methods and events for extending and customizing chat, such as delivering messages based on [customized requirements](#conditionally-deliver-messages), adding special permissions or moderation to specific players, and creating [custom commands](./examples/custom-text-chat-commands.md) to execute specific actions.
+Roblox offers text-based messaging between players in live sessions through `Class.TextChatService`. This service has its standard functionality, but also provides a set of methods and events for extending and customizing chat, such as delivering messages based on [customized requirements](#conditionally-delivering-messages), adding special permissions or moderation to specific players, and creating [custom commands](./examples/custom-text-chat-commands.md) to execute specific actions.
-### Basic functionalities
+### Basic Functionalities
Though both systems share the same basic chat functionalities, TextChatService implementations are in general more sustainable and easier to iterate on.
@@ -117,7 +117,7 @@ Though both systems share the same basic chat functionalities, TextChatService i
-## Enable voice chat
+## Enabling Voice Chat
-Before you can enable voice chat in an experience, you must first [publish](../production/publishing/publish-experiences-and-places.md) it to enable the [Game Settings](../studio/game-settings.md) menu within Studio.
+Before you can enable voice chat in an experience, you must first [publish](../production/publishing/publishing-experiences-and-places.md) it to enable the [Game Settings](../studio/game-settings.md) menu within Studio.
1. Open your experience in Studio.
1. Open [Game Settings](../studio/game-settings.md) from the [Home](../studio/home-tab.md) tab.
@@ -25,22 +25,22 @@ Before you can enable voice chat in an experience, you must first [publish](../p
1. Navigate to the **Communication** tab on the left side of the window.
1. Toggle **Enable Microphone** so the selector turns from gray to green.
1. **(Optional)** For greater communication among users within your experience, toggle on **Enable Camera** to allow eligible users to animate their avatar with their movement.
-1. [Publish](../production/publishing/publish-experiences-and-places.md) the place to save the changes.
+1. [Publish](../production/publishing/publishing-experiences-and-places.md) the place to save the changes.
Voice chat will now be available to verified 13+ users who opt‑in to the feature, in every place within the experience that's set to a maximum of 50 users.
-### Set maximum users
+### Setting Maximum Users
If you previously set the maximum number of users in a place to more than 50, you'll need to reduce it to support voice chat.
1. In the left-hand navigation of the [Game Settings](../studio/game-settings.md) dialog, select **Places**. Every place within your experience displays.
1. Click the **⋯** button next to the place with more than 50 players, then select **Configure Place**.
1. In the **Max Players** field, enter any number less than or equal to 50.
-1. Click the **Save** button and then [publish](../production/publishing/publish-experiences-and-places.md) to save the changes.
+1. Click the **Save** button and then [publish](../production/publishing/publishing-experiences-and-places.md) to save the changes.
-When you update the maximum number of users in a place to fewer than 50, there may be servers already configured to a different, higher number. Since those servers won't support voice chat, it's recommended to [restart servers](../production/publishing/publish-experiences-and-places.md#update-experiences).
+When you update the maximum number of users in a place to fewer than 50, there may be servers already configured to a different, higher number. Since those servers won't support voice chat, it's recommended to [restart servers](../production/publishing/publishing-experiences-and-places.md#updating-experiences).
-### Disable per place
+### Disabling Per Place
If you don't want to enable voice chat for every place within your experience, you can disable it within specific places that would otherwise be voice‑eligible through the `Class.VoiceChatService.EnableDefaultVoice|EnableDefaultVoice` property.
@@ -61,9 +61,9 @@ To disable voice chat for a specific place within an experience:
1. In the [Properties](../studio/properties.md) window, disable the **EnableDefaultVoice** property.
-1. Publish the place to save the changes and [restart servers](../production/publishing/publish-experiences-and-places.md#update-experiences) to ensure the change takes effect for all servers currently running your experience.
+1. Publish the place to save the changes and [restart servers](../production/publishing/publishing-experiences-and-places.md#updating-experiences) to ensure the change takes effect for all servers currently running your experience.
-## Check voice chat status
+## Checking Voice Chat Status
You can check if a user has enabled voice chat by calling `Class.VoiceChatService:IsVoiceEnabledForUserIdAsync()|IsVoiceEnabledForUserIdAsync()` in a `Class.LocalScript`, or in a `Class.Script` with `Class.BaseScript.RunContext|RunContext` set to `Enum.RunContext.Client`.
diff --git a/content/en-us/cloud-services/cross-server-messaging.md b/content/en-us/cloud-services/cross-server-messaging.md
index d62436774..a573fb9d4 100644
--- a/content/en-us/cloud-services/cross-server-messaging.md
+++ b/content/en-us/cloud-services/cross-server-messaging.md
@@ -1,5 +1,5 @@
---
-title: Cross-server messaging
+title: Cross-Server Messaging
description: Cross-server messaging enables you to communicate with other servers or client instances of your experience.
---
@@ -10,11 +10,11 @@ Normally, the code within an experience can only affect the server or clients th
You can support cross-server messaging in your experience using `Class.MessagingService`. You can also use the [Teleportation Playground](https://www.roblox.com/games/3112653247/Teleportation-Playground) sample experience to see how cross‑server messaging works before you implement it. Lastly, see [here](../cloud/open-cloud/usage-messaging.md) to explore cross‑server communication using external tools.
-## Cross-server messaging setup
+## Cross-Server Messaging Setup
-To enable cross-server messaging, you must set up a **topic** which is a customized message channel that's accessible from multiple servers. After you create a topic, you can [subscribe users](#subscribe-users-to-receive-messages) to the topic to receive messages and enable [publishing messages](#publish-messages) to the topic.
+To enable cross-server messaging, you must set up a **topic** which is a customized message channel that's accessible from multiple servers. After you create a topic, you can [subscribe users](#subscribing-users-to-receive-messages) to the topic to receive messages and enable [publishing messages](#publishing-messages) to the topic.
-### Subscribe users to receive messages
+### Subscribing Users to Receive Messages
Use `Class.MessagingService:SubscribeAsync()` to subscribe users to a topic and specify a callback function that detects messages publishing to that topic. For example, the following code sample subscribes all users to a **FriendServerEvent** topic that receives messages when any user is teleported to a different server.
@@ -40,7 +40,7 @@ Players.PlayerAdded:Connect(function(player)
end)
```
-### Publish messages
+### Publishing Messages
Use `Class.MessagingService:PublishAsync()` to match a specific topic and publish a message to it. For example, the following code sample uses `Class.MessagingService:PublishAsync()|PublishAsync()` to notify all users when a user joins a new server, including the `Class.Player.Name` representing the user's display name and the `Class.DataModel.JobId|JobId`, a unique identifier for the running experience server instance.
diff --git a/content/en-us/cloud-services/data-stores-vs-memory-stores.md b/content/en-us/cloud-services/data-stores-vs-memory-stores.md
index cfd7e6a8a..49a03b1e2 100644
--- a/content/en-us/cloud-services/data-stores-vs-memory-stores.md
+++ b/content/en-us/cloud-services/data-stores-vs-memory-stores.md
@@ -1,5 +1,5 @@
---
-title: Data stores vs memory stores
+title: Data Stores vs Memory Stores
description: When to use standard data stores, ordered data stores, and memory stores.
---
@@ -7,13 +7,13 @@ To store data, you can use [data stores](./data-stores/index.md) with the `Class
Alternatively, you can also use Lua types and variables to [store data in-memory in Lua](#when-to-use-in-memory-storage-in-lua), without using the data or memory store services.
-## When to use data stores
+## When to Use Data Stores
The `Class.DataStoreService` stores long-term data that needs to last between sessions, such as user progress or inventory items. Data stores are consistent per experience, so every server for every place within an experience can access and change the same data. There are two types of data stores: standard and ordered.
**Standard data stores** can store data like numbers, strings, and tables that don't need to be ranked or sorted. This data is stored as key-value pairs, where each entry is stored under a key that is unique within its data store and that you can retrieve, update, or delete.
-**Ordered data stores** can only store numbers. Each entry is stored under a key that is unique within its data store and that you can retrieve, update, or delete. You can rank and sort this data numerically and retrieve it in ascending or descending order based on stored numerical values. For more information, see [Ordered data stores](./data-stores/index.md#ordered-data-stores).
+**Ordered data stores** can only store numbers. Each entry is stored under a key that is unique within its data store and that you can retrieve, update, or delete. You can rank and sort this data numerically and retrieve it in ascending or descending order based on stored numerical values. For more information, see [Ordered Data Stores](./data-stores/index.md#ordered-data-stores).
@@ -280,7 +280,7 @@ Modules that provide an interface for game code to synchronously read and write
1. Any threads yielded using `waitForDataLoadAsync` for the player are resumed.
-#### Provide an interface for server code
+#### Providing an Interface for Server Code
- `PlayerDataServer` is a singleton that can be required and accessed by any server code running in the same environment.
- Player data is organized into a dictionary of keys and values. You can manipulate these values on the server using the `setValue`, `getValue`, `updateValue` and `removeValue` methods. These methods all operate synchronously without yielding.
@@ -288,14 +288,14 @@ Modules that provide an interface for game code to synchronously read and write
- A `hasErrored` method can query if the player's initial load failed, causing them to use default data. Check this method before allowing the player to make any purchases, as purchases cannot be saved to data without a successful load.
- A `playerDataUpdated` signal fires with the `player`, `key`, and `value` whenever a player's data is changed. Individual systems can subscribe to this.
-#### Replicate changes to the client
+#### Replicating Changes to the Client
- Any change to player data in `PlayerDataServer` is replicated to `PlayerDataClient`, unless that key was marked as private using setValueAsPrivate
- `setValueAsPrivate` is used to denote keys that should not be sent to the client
- `PlayerDataClient` includes a method to get the value of a key (get) and a signal that fires when it is updated (updated). A `hasLoaded` method and a `loaded` signal are also included, so the client can wait for data to load & replicate before starting its systems
- `PlayerDataClient` is a singleton that can be required and accessed by any client code running in the same environment
-#### Replicate errors to the client
+#### Replicating Errors to the Client
- Error statuses encountered when saving or loading player data are replicated to `PlayerDataClient`.
- Access this information with the `getLoadError` and `getSaveError` methods, along with the `loaded` and `saved` signals.
@@ -304,7 +304,7 @@ Modules that provide an interface for game code to synchronously read and write
-#### Save player data
+#### Saving Player Data
diff --git a/content/en-us/cloud-services/memory-stores/best-practices.md b/content/en-us/cloud-services/memory-stores/best-practices.md
index 0717e048b..15ecbdc84 100644
--- a/content/en-us/cloud-services/memory-stores/best-practices.md
+++ b/content/en-us/cloud-services/memory-stores/best-practices.md
@@ -1,5 +1,5 @@
---
-title: Best practices when designing MemoryStore data structures
+title: Best Practices when designing MemoryStore Data Structures
description: Explains how to best design data structures to reduce the chance of experiencing throttling.
---
@@ -7,7 +7,7 @@ Depending on the data structure type, MemoryStoreService enforces [limits](../..
Each Roblox experience has the [Memory Store Observability Dashboard](../../cloud-services/memory-stores/observability.md), which includes a set of charts that you can use to monitor memory store usage.
-## Sorted maps and queues
+## Sorted Maps and Queues
Sorted maps and queues both have limits on the maximum number of items and maximum total memory. Additionally, the items in one of these data structures always reside on a single partition. Every request to one of those data structures is a request to the same partition.
@@ -21,7 +21,7 @@ Sharding is the process of storing a set of related data across multiple data st
The key challenge to sharding is finding a way to spread the data across multiple data structures in a way that maintains the same functionality as the original.
-### Sharding a sorted map
+### Sharding a Sorted Map
To shard a sorted map, consider splitting your data into alphabetic subsections with character ranges. For example, assume that you only have keys with the first letter from A-Z, and you believe four sorted maps is sufficient for your current use case and future growth:
@@ -68,7 +68,7 @@ local playerScore = bucket:GetAsync(player)
print(playerScore)
```
-### Sharding a queue
+### Sharding a Queue
Sharding a queue is tricker than sharding a sorted map. Although you want to spread the request throughput across multiple queues, adds, reads, and removes only ever occur at the front or back of the queue.
@@ -159,7 +159,7 @@ local players, ids = readFromQueue(20, true, -1)
removeFromQueue(ids)
```
-## Hash maps
+## Hash Maps
Hash maps do not have individual memory or item count limits and are automatically sharded, but you can still encounter throttling if you use them poorly.
diff --git a/content/en-us/cloud-services/memory-stores/hash-map.md b/content/en-us/cloud-services/memory-stores/hash-map.md
index 145b162fd..834c31988 100644
--- a/content/en-us/cloud-services/memory-stores/hash-map.md
+++ b/content/en-us/cloud-services/memory-stores/hash-map.md
@@ -1,5 +1,5 @@
---
-title: Memory store hash map
+title: Memory Store Hash Map
description: Explains how to implement the hash map data structure for memory stores.
---
@@ -11,7 +11,7 @@ Hash maps have a key size limit of 128 characters and a value size limit of 32 K
Otherwise, hash maps use the same [API request](../../cloud-services/memory-stores/index.md#api-requests-limits) and [memory quota](../../cloud-services/memory-stores/index.md#memory-size-quota) limits as the other memory store data structures.
-## Get a hash map
+## Getting a Hash Map
To get a hash map, call `Class.MemoryStoreService:GetHashMap()` with a name for the hash map. The name is global within the experience, so you can access the same hash map on any script using this name.
@@ -33,23 +33,23 @@ After you get a hash map, call any of the following functions to read or write d
-For this reason, if you don't need sorting or "first in, first out" functionality, hash maps are usually the best choice for a memory store data structure. For more information, see the [best practices](../../cloud-services/memory-stores/best-practices.md).
+For this reason, if you don't need sorting or "first in, first out" functionality, hash maps are usually the best choice for a memory store data structure. For more information, see [Best Practices](../../cloud-services/memory-stores/best-practices.md).
diff --git a/content/en-us/cloud-services/memory-stores/queue.md b/content/en-us/cloud-services/memory-stores/queue.md
index 78a9588a8..583f749a5 100644
--- a/content/en-us/cloud-services/memory-stores/queue.md
+++ b/content/en-us/cloud-services/memory-stores/queue.md
@@ -1,5 +1,5 @@
---
-title: Memory store queue
+title: Memory Store Queue
description: Explains how to implement the queue data structure for memory stores.
---
@@ -7,7 +7,7 @@ A **queue** is a linear data structure with a collection of items that either fo
Memory store queues are useful for order-based processing and storing user information, such as skill levels, to facilitate matchmaking based on your desired criteria. For example, you can add a lobby place as the start place of your experience, use memory store queues as a centralized user information storage system accessible by multiple servers, manage the placement order of users using the queues, and teleport user who have completed the matchmaking to the main place of your experience.
-## Get a queue
+## Getting a Queue
To get a queue, call `Class.MemoryStoreService:GetQueue()` with a **name**, which is global within the experience for any script to access, and an optional **invisibility timeout** in seconds, which prevents duplicated processing of the same queue item. Invisibility timeout is 30 seconds by default if you leave it empty like the following code sample.
@@ -31,15 +31,15 @@ After you get a queue, call any of the following functions to read or write data
@@ -73,9 +73,9 @@ Example response which returns the notification ID in the `id` field:
}
```
-### Customize notifications using parameters
+### Customizing Notifications Using Parameters
-To customize the notification for each recipient, you can include **parameters** in the [notification string](#create-a-notification-string), then customize the parameters when calling the API. For example, you can define the notification string as:
+To customize the notification for each recipient, you can include **parameters** in the [notification string](#creating-a-notification-string), then customize the parameters when calling the API. For example, you can define the notification string as:
-### Authorization code flow with PKCE
+### Authorization Code Flow with PKCE
The [PKCE extension](https://www.rfc-editor.org/rfc/rfc7636) of the
authorization code flow helps reduce risk of leaking the authorization code and
@@ -136,7 +136,7 @@ process with the following steps:
1. The client retrieves the permitted resources after getting the access token.
-## OpenID Connect support
+## OpenID Connect Support
Roblox uses [OpenID Connect (OIDC)](https://openid.net/connect/) as an
identity layer on top of the OAuth 2.0 protocol for authentication to protect
@@ -145,13 +145,13 @@ of users and obtain their basic public profile information, such as user ID,
usernames, display names, and profile links.
-## Configure a webhook with third-party integration
+## Configuring a Webhook with Third-Party Integration
Before creating a bot, set up a server with webhook integration on the third-party messaging application. Then use the server to configure a webhook on Creator Dashboard.
-### Set up a server
+### Setting Up a Server
The following steps show how to set up the server using Guilded or Discord.
@@ -50,23 +50,23 @@ The following steps show how to set up the server using Guilded or Discord.
-### Configure a webhook on Roblox
+### Configuring a Webhook on Roblox
-After obtaining the third-party server URL, use it to [configure a webhook](../../cloud/webhooks/webhook-notifications.md#configure-webhooks-on-creator-dashboard) on Creator Dashboard. make sure you perform the following settings:
+After obtaining the third-party server URL, use it to [configure a webhook](../../cloud/webhooks/webhook-notifications.md#configuring-webhooks-on-creator-dashboard) on Creator Dashboard. make sure you perform the following settings:
-## Configure a bot
+## Configuring a Bot
After you add the webhook, use it to configure the bot with the following steps:
@@ -106,11 +106,11 @@ After you add the webhook, use it to configure the bot with the following steps:
-## Create an Open Cloud API key
+## Creating an Open Cloud API Key
-To allow your third-party bot to access your data stores for storing PII data of users, [create an Open Cloud API key](https://create.roblox.com/docs/reference/cloud/manage-api-keys) that can access your experiences and add the **Delete Entry** permission of data stores for data deletion. If you use ordered data stores for storing PII, you also need to add the **Write** permission of ordered data stores. After completion, copy and save the API key in a secure location to use it in later steps.
+To allow your third-party bot to access your data stores for storing PII data of users, [create an Open Cloud API key](https://create.roblox.com/docs/reference/cloud/managing-api-keys) that can access your experiences and add the **Delete Entry** permission of data stores for data deletion. If you use ordered data stores for storing PII, you also need to add the **Write** permission of ordered data stores. After completion, copy and save the API key in a secure location to use it in later steps.
-## Obtain identifiers of experiences and places
+## Obtaining Identifiers of Experiences and Places
For the bot to locate the PII data requested by users for deletion, obtain the following identifiers of all experiences that you intend to use the bot for:
@@ -121,7 +121,7 @@ To obtain these identifiers, open the [Creations](https://create.roblox.com/dash
-## Add scripts
+## Adding Scripts
After you finish setting up the webhook, bot, and API key for data stores, add them to the scripts that implement the bot's automation logic. The following example uses Python 3:
@@ -465,7 +465,7 @@ After you finish setting up the webhook, bot, and API key for data stores, add t
To ensure constant and secure execution of the scripts, save and run them locally only. Keep your local device or virtual machine running the scripts turned on at all times. In the event that your device goes offline, you need to manually manage any missed messages during the offline period and handle delivery failures according to the [retry policy](../../cloud/webhooks/webhook-notifications.md#delivery-failure-retry-policy).
-## Test
+## Testing
You can create and run a test message to verify that your custom program can properly handle right to erasure requests and delete PII data:
diff --git a/content/en-us/cloud/webhooks/webhook-notifications.md b/content/en-us/cloud/webhooks/webhook-notifications.md
index cbe816f85..6e7523b10 100644
--- a/content/en-us/cloud/webhooks/webhook-notifications.md
+++ b/content/en-us/cloud/webhooks/webhook-notifications.md
@@ -1,5 +1,5 @@
---
-title: Webhook notifications
+title: Webhook Notifications
description: Explains how to set up webhooks to automate your notification management workflow.
---
@@ -9,13 +9,13 @@ Instead of manually monitoring all events in your experience and requests from u
Currently, Roblox fully supports webhook notifications for Discord, Guilded, and Slack. Using webhooks with other third-party tools carries the risk of not receiving all notifications.
-## Webhook workflow
+## Webhook Workflow
Webhooks send real-time notifications or data between two different applications or services, such as Roblox and a third-party messaging tool. Unlike traditional APIs, which require you to set up a client application to send requests to a server to receive data, webhooks send data to your client endpoint as soon as an event occurs. They're useful for automating workflows between Roblox and third-party applications that you use for collaborating with your team, as they allow for real-time data sharing and processing.
Once you set up a webhook, whenever a target event occurs, Roblox sends a request to the webhook URL you provide. The webhook URL then redirects the request to your receiving application or custom endpoint, which can take action based on the data included in the webhook payload. This could include erasing data for GDPR, sending a confirmation to the user, or triggering another event.
-## Supported triggers
+## Supported Triggers
Roblox currently supports the following event triggers for notifications:
@@ -26,10 +26,9 @@ Roblox currently supports the following event triggers for notifications:
- **Subscription Resubscribed** - When a user resubscribes to a subscription, a message is sent containing the subscription and subscriber.
- ["Right to be forgotten"](https://gdpr.eu/right-to-be-forgotten/) data deletion requests under the General Data Protection Regulation (**GDPR**).
-For more information on subscription events and their fields, see the [Cloud API Subscription](../../cloud/reference)
-(../../cloud/reference/Subscription) reference.
+For more information on subscription events and their fields, see the [Cloud API Subscription](../../cloud/reference/Subscription) reference.
-## Configure webhooks on Creator Dashboard
+## Configuring Webhooks on Creator Dashboard
To receive notifications through webhooks, you need to configure a webhook that subscribes to certain events for triggering notifications. For group-owned experiences, only group owners can configure and receive webhook notifications.
@@ -42,9 +41,9 @@ To set up a webhook:
1. Navigate to the [Webhooks](https://create.roblox.com/settings/webhooks) section of the [Creator Dashboard](https://create.roblox.com/settings/webhooks).
1. Click the **Add Webhook** button.
1. Complete the configuration fields:
- 1. **Webhook URL** — Specify the URL where you want to receive notifications and accept incoming webhook URLs from third-party entities. For more information on the requirements, see [Set up webhook URLs](#set-up-webhook-urls).
+ 1. **Webhook URL** — Specify the URL where you want to receive notifications and accept incoming webhook URLs from third-party entities. For more information on the requirements, see [Setting up Webhook URLs](#setting-up-webhook-urls).
2. **Name** — Use a custom name to differentiate your configuration from others. By default the value is the same as the Webhook URL.
- 3. **Secret** (optional) — Supply a secret if you want to verify that notifications you receive are coming from Roblox. For more information, see [Verify webhook security](#verify-webhook-security).
+ 3. **Secret** (optional) — Supply a secret if you want to verify that notifications you receive are coming from Roblox. For more information, see [Verifying Webhook Security](#verifying-webhook-security).
4. **Triggers** — Choose one or more options from the list of [supported triggers](#supported-triggers) of events for which you want to receive notifications.
1. Click the **Save Changes** button.
@@ -52,7 +51,7 @@ To set up a webhook:
Currently, you can configure up to 5 webhooks in total.
-## Set up webhook URLs
+## Setting up Webhook URLs
You can set up a custom HTTP service endpoint as your webhook URL, provided it fulfills the following requirements:
@@ -68,11 +67,11 @@ When your endpoint receives a POST request, it must be able to:
For more information of the schema of POST requests to handle, see the [Payload Schema](#payload-schema).
-### Delivery failure retry policy
+### Delivery Failure Retry Policy
-When a webhook notification fails to reach your specified URL due to errors such as endpoint unavailability, Roblox retries sending the message to the configured URL 5 times using a fixed window size. If the notification still fails to be delivered after 5 attempts, Roblox stops trying to send the notification and assumes that the URL is no longer valid. In this situation, you need to update your webhook configuration with a new URL that is reachable and able to receive notifications. To troubleshoot and confirm that your webhook URL can successfully receive notifications, see [Test webhooks](#test-webhooks).
+When a webhook notification fails to reach your specified URL due to errors such as endpoint unavailability, Roblox retries sending the message to the configured URL 5 times using a fixed window size. If the notification still fails to be delivered after 5 attempts, Roblox stops trying to send the notification and assumes that the URL is no longer valid. In this situation, you need to update your webhook configuration with a new URL that is reachable and able to receive notifications. To troubleshoot and confirm that your webhook URL can successfully receive notifications, see [Testing Webhooks](#testing-webhooks).
-### Third-party requirements
+### Third-Party Requirements
Third-party tools usually have their own requirements for webhooks that you need to follow when setting up your webhook URL. You can find these requirements by searching for the keyword "webhook" on the support or documentation site of the target tool. For the three supported third-party tools, see the following:
@@ -80,7 +79,7 @@ Third-party tools usually have their own requirements for webhooks that you need
- [Guilded Support](https://support.guilded.gg/hc/en-us)
- [Slack API Reference](https://api.slack.com/)
-## Test webhooks
+## Testing Webhooks
You can test whether the webhook you've configured can successfully receive notifications on the [Creator Dashboard](https://create.roblox.com/dashboard/creations):
@@ -107,7 +106,7 @@ Body: {
If you are integrating your webhook with a third-party service, you can test it using the third-party URL to confirm that the service can successfully receive notifications from your webhook. If you provide a secret when configuring the webhook, it also generates a `roblox-signature` that you can use to test the `roblox-signature` logic.
-## Verify webhook security
+## Verifying Webhook Security
Once you configure your server to receive payloads, it starts to listen for any payload sent to the endpoint. If you set a secret when configuring your webhook, Roblox sends a `roblox-signature` along with every webhook notification to help protect your data security. This way, you can use the it to verify that the notification is from Roblox and limit your server to only receive requests originating from Roblox. The signature is in the payload header for custom endpoints and in the footer for third-party servers.
@@ -128,7 +127,7 @@ If you don't have a secret for your webhook, the signature you receive only cont
To verify a signature:
-## How to apply
+## How to Apply
If you wish to nominate your experience to be featured for Today's Picks, please complete the survey below. Our editorial team reviews nominations on an ongoing basis. Due to the high volume of applicants, only those selected for Today's Picks on Home will be notified. If you haven't heard back, we encourage you to fill out the form each time your experience has a notable update.
diff --git a/content/en-us/creator-programs/todays-picks-marketplace.md b/content/en-us/creator-programs/todays-picks-marketplace.md
index ce072ed47..69b7e16d1 100644
--- a/content/en-us/creator-programs/todays-picks-marketplace.md
+++ b/content/en-us/creator-programs/todays-picks-marketplace.md
@@ -16,14 +16,14 @@ description: Today's Picks on Marketplace is a curated sort with items selected
diff --git a/content/en-us/effects/beams.md b/content/en-us/effects/beams.md
index 020f29aab..6941b27be 100644
--- a/content/en-us/effects/beams.md
+++ b/content/en-us/effects/beams.md
@@ -13,7 +13,7 @@ A `Class.Beam` is an object that renders a `Class.Texture` between two `Class.At
-## Create beams
+## Creating a Beam
Before you begin to create a beam, it's useful to toggle on visibility of attachments so you can see where the beam starts and ends.
@@ -54,7 +54,7 @@ To create a beam:
Beams require attachments to function properly. If you remove either attachment object from step 4, the beam stops rendering its texture.
-## Customize beams
+## Customizing Beams
By experimenting with the following properties, you can customize a beam's visual appearance to make unique gameplay elements like force fields, waterfalls, and pathway obstacles.
@@ -177,7 +177,7 @@ The beam below has a `Class.Beam.Width0|Width0` value of **0.5** and a
-### Texture length/mode
+### Texture Length/Mode
A beam's `Class.Beam.TextureLength|TextureLength` and `Class.Beam.TextureMode|TextureMode` determine how its [texture](#texture) repeats across its length.
diff --git a/content/en-us/effects/highlighting.md b/content/en-us/effects/highlighting.md
index aff48a5e2..6ff62b0d6 100644
--- a/content/en-us/effects/highlighting.md
+++ b/content/en-us/effects/highlighting.md
@@ -1,5 +1,5 @@
---
-title: Highlighting objects
+title: Highlighting Objects
description: Highlighting objects lets you call attention to specific objects within your experience.
---
@@ -27,26 +27,26 @@ Useful applications of the highlight effect include:
- Making distant objects visible through objects that are closer to the user.
- Indicating the current position and status of other characters.
-## Add highlights
+## Adding Highlights
As a performance limit, Studio only displays 31 simultaneous `Class.Highlight` instances on the client-side at a time. If you add more than this limit, the additional `Class.Highlight` instances are silently ignored.
Note also that highlights on low-end devices may be more pixelated but will otherwise look the same as on other devices with any combination of settings.
-### Parent to objects
+### Parenting to Objects
To add a highlight effect to an object, you can parent a new `Class.Highlight` directly to the object.
-1. In the **Explorer** window, hover over either a `Class.Model` or a `Class.BasePart`, then click the ⊕ button. A contextual menu displays.
+1. In the [Explorer](../studio/explorer.md) window, hover over either a `Class.Model` or a `Class.BasePart`, then click the ⊕ button. A contextual menu displays.
2. From the menu, insert a **Highlight**. The highlight displays on the object with its default property values that create a white outline and a red tint overlay.
-### Set the adornee
+### Setting the Adornee
Alternatively, you can place the `Class.Highlight` instance outside of a child/parent relationship either within the workspace, `Class.StarterPlayer`, `Class.StarterGui`, `Class.StarterPack`, or `Class.ReplicatedStorage`, then set its `Class.Highlight.Adornee|Adornee` property to the `Class.Model` or `Class.BasePart` that you want to highlight.
-## Customize highlights
+## Customizing Highlights
You can change the properties of a `Class.Highlight` instance to create interesting visual effects that properly highlight objects in theme with your experience.
@@ -147,7 +147,7 @@ The `Class.Highlight.Enabled|Enabled` property allows you to quickly enable or d
While a disabled `Class.Highlight` doesn't display, it still takes one of the 31 available `Class.Highlight` slots. If you plan to permanently disable a `Class.Highlight` instance, it's best to delete the highlight rather than disable it.
-## Performance tips
+## Performance Tips
While you have a lot of options to customize `Class.Highlight` instances, the following tips are recommended to increase your experience's performance on all devices:
diff --git a/content/en-us/effects/index.md b/content/en-us/effects/index.md
index cb211a57d..26c01c003 100644
--- a/content/en-us/effects/index.md
+++ b/content/en-us/effects/index.md
@@ -6,7 +6,7 @@ description: Learn how to add visual effects to your experiences.
You can create special effects by parenting special effect objects to other
objects or attachments.
-## Light sources
+## Light Sources
Light sources let you attach lighting effects to objects or attachments. There
are three types of light sources:
@@ -24,7 +24,7 @@ are three types of light sources:
- 
@@ -32,11 +32,11 @@ are three types of light sources:
- 
-## Customize particles
+## Customizing Particles
By experimenting with the following properties, you can customize a particle's visual appearance to make unique gameplay elements like bursting volcanos, magical dust, and dust motes.
@@ -53,7 +53,7 @@ If you're creating an image to use as a particle texture, it's best to use `.png
-## Atmosphere properties
+## Atmosphere Properties
Every property of the `Class.Atmosphere` object inside the `Class.Lighting` service works together to support the overall vision, themes, and mood of your experience.
diff --git a/content/en-us/environment/clouds.md b/content/en-us/environment/clouds.md
index b97478a95..008ceca83 100644
--- a/content/en-us/environment/clouds.md
+++ b/content/en-us/environment/clouds.md
@@ -1,5 +1,5 @@
---
-title: Dynamic clouds
+title: Dynamic Clouds
description: Dynamic Clouds render realistic, customizable clouds that drift slowly across the sky.
---
@@ -7,23 +7,22 @@ Roblox's **dynamic clouds** are realistic clouds that drift slowly across the sk
-## Enable clouds
+## Enabling Clouds
You can manage dynamic clouds in an experience through the `Class.Clouds` object. While you can place this object anywhere for organization or replication purposes, clouds only render if you parent the object under the `Class.Terrain` class.
To enable dynamic clouds:
-1. In the **Explorer** window, hover over **Terrain** and click the ⊕ button. A contextual menu displays.
+1. In the [Explorer](../studio/explorer.md) window, hover over **Terrain** and click the ⊕ button. A contextual menu displays.
1. From the menu, insert **Clouds**.
-1. Adjust the appearance of clouds through the new object's properties.
-1. Set the clouds in motion through [global wind](../environment/global-wind.md).
+1. Adjust the appearance of clouds through the new object's [properties](#cloud-properties) and, if desired, set the clouds in motion through [global wind](../environment/global-wind.md).
-## Cloud properties
+## Cloud Properties
-From the `Class.Clouds` object under `Class.Terrain`, you can adjust the appearance of clouds through the Properties window.
+From the `Class.Clouds` object under `Class.Terrain`, you can adjust the appearance of clouds through the [Properties](../studio/properties.md) window.
### Cover
diff --git a/content/en-us/environment/global-wind.md b/content/en-us/environment/global-wind.md
index 6402866fd..b7badb327 100644
--- a/content/en-us/environment/global-wind.md
+++ b/content/en-us/environment/global-wind.md
@@ -1,27 +1,27 @@
---
-title: Global wind
+title: Global Wind
description: The global wind vector sets the direction and strength that wind blows through an experience, affecting terrain grass, dynamic clouds, and particles.
---
-The `Class.Workspace.GlobalWind|GlobalWind` vector sets the direction and strength that wind blows through an experience, affecting terrain grass and dynamic clouds. You can set it as a [constant vector](#global-wind-vector), or adjust it through [scripting](#scripted-effects) to create cyclical gusts of wind. Additionally, you can influence [particles](#particle-influence) to follow the global wind vector.
+The `Class.Workspace.GlobalWind|GlobalWind` vector sets the direction and strength that wind blows through an experience, affecting [terrain grass](../parts/terrain.md#animated-grass) and [dynamic clouds](../environment/clouds.md). You can set it as a [constant vector](#global-wind-vector), or adjust it through [scripting](#scripted-effects) to create cyclical gusts of wind. Additionally, you can influence [particles](#particle-influence) to follow the global wind vector.
-1. In the **Properties** window, locate the **GlobalWind** property and set an **X**, **Y**, and **Z** value for its direction and strength.
+1. In the [Properties](../studio/properties.md) window, locate the **GlobalWind** property and set an **X**, **Y**, and **Z** value for its direction and strength.
@@ -33,7 +33,7 @@ Particles emitted by a `Class.ParticleEmitter` will follow the global wind vecto
-## Wind direction widget
+## Wind Direction Widget
To make it easier to tune global wind, you can use the **Wind Direction** widget, accessible from the [View](../studio/view-tab.md) tab. The widget lets you visualize how wind is blowing using a "wind sock" model, and you can dynamically set the wind's **Speed**, **Yaw**, and **Pitch** by clicking the desired aspect name and sliding the slider along the bottom, or you can adjust yaw or pitch by manipulating the green ring and blue arrow on the animated portion. You can also click and drag the widget to reposition it anywhere in the 3D viewport.
@@ -41,7 +41,7 @@ To make it easier to tune global wind, you can use the **Wind Direction** w
-## Scripted effects
+## Scripted Effects
Scripting of the `Class.Workspace.GlobalWind|GlobalWind` property opens up a whole range of possibilities. For example, you can use the following code sample to cause cyclical gusts of wind that ease in and out using the `Library.math.sin()` function.
diff --git a/content/en-us/environment/index.md b/content/en-us/environment/index.md
index 641d3bea2..413cca603 100644
--- a/content/en-us/environment/index.md
+++ b/content/en-us/environment/index.md
@@ -1,11 +1,11 @@
---
-title: Lighting and effects
+title: Lighting and Effects
description: Create more immersive environments through lighting, atmospheres, and special effects.
---
The `Class.Lighting` container services let you control and customize an experience's environment such as [lighting](#global-lighting), [atmosphere](#atmospheric-effects), and [clouds](#clouds-and-skies). You can also apply [post-processing effects](#post-processing-effects) to adjust how the experience appears on the screen.
-## Global lighting
+## Global Lighting
The `Class.Lighting` service contains properties that you can adjust to update the global lighting in an experience, such as the `Class.Lighting.ClockTime|ClockTime` and `Class.Lighting.Brightness|Brightness`.
@@ -28,7 +28,7 @@ The `Class.Lighting` service contains properties that you can adjust to update t
In addition to global lighting, you can create and attach [light sources](../effects/light-sources.md) to parts or attachments to simulate objects like lamps, torches, spotlights, or TV screens.
-## Atmospheric effects
+## Atmospheric Effects
[Atmospheric effects](../environment/atmosphere.md) simulate realistic environments by scattering sunlight in unique ways. Using the `Class.Atmosphere` object in the `Class.Lighting` service, you can control air particle [density](../environment/atmosphere.md#density), simulate [haze](../environment/atmosphere.md#haze) or [glare](../environment/atmosphere.md#glare), set an atmosphere's [color](../environment/atmosphere.md#color), and more.
@@ -37,7 +37,7 @@ In addition to global lighting, you can create and attach [light sources](../eff
diff --git a/content/en-us/environment/lighting.md b/content/en-us/environment/lighting.md
index 80b271af5..38d388122 100644
--- a/content/en-us/environment/lighting.md
+++ b/content/en-us/environment/lighting.md
@@ -1,5 +1,5 @@
---
-title: Global lighting
+title: Global Lighting
description: Explains how to customize the global lighting with the Lighting service.
---
@@ -7,11 +7,11 @@ The `Class.Lighting` service contains properties that you can adjust to update
and customize the global lighting in an experience. There are five categories of
lighting properties:
-- **Color** — Configures hue within the experience.
-- **Intensity** — Configures the intensity or amount of light hitting the camera.
-- **Shadows** — Configures how a user experiences shadows within the experience.
-- **Environment** — Configures the conditions of the experience's world, such as the time of day and geographic latitude.
-- **Technology** — Configures the lighting technology Studio uses to render lighting and shadows.
+- [Color](#color) — Configures hue within the experience.
+- [Intensity](#intensity) — Configures the intensity or amount of light hitting the camera.
+- [Shadows](#shadows) — Configures how a user experiences shadows within the experience.
+- [Environment](#environment) — Configures the conditions of the experience's world, such as the time of day and geographic latitude.
+- [Technology](#technology) — Configures the lighting technology Studio uses to render lighting and shadows.
## Color
diff --git a/content/en-us/environment/post-processing-effects.md b/content/en-us/environment/post-processing-effects.md
index f23b15480..4eddb2801 100644
--- a/content/en-us/environment/post-processing-effects.md
+++ b/content/en-us/environment/post-processing-effects.md
@@ -1,5 +1,5 @@
---
-title: Post-processing effects
+title: Post-Processing Effects
description: Post-processing effects are customizable filters that quickly enrich the visuals of an experience.
---
@@ -15,7 +15,7 @@ description: Post-processing effects are customizable filters that quickly enric
-## Sun rays
+## Sun Rays
The `Class.SunRaysEffect` effect creates a halo of light with rays around the sun that move based on the `Class.Lighting.ClockTime|ClockTime`
or `Class.Lighting.TimeOfDay|TimeOfDay` property. Objects between the player's camera and the sun shape this effect, allowing for realistic visuals of light and shadow.
-## Color grading
+## Color Grading
The `Class.ColorGradingEffect` effect modifies how color values calculated by the renderer should be converted to the screen's color range, impacting the mood and appearance of your place.
diff --git a/content/en-us/environment/skybox.md b/content/en-us/environment/skybox.md
index 6d292cdeb..99cdd20d2 100644
--- a/content/en-us/environment/skybox.md
+++ b/content/en-us/environment/skybox.md
@@ -3,16 +3,16 @@ title: Skyboxes
description: Skyboxes are cubes made up of six individual images that create an immersive background.
---
-A **skybox** is a cube made up of six individual images that create an immersive sky background in an experience. When the images are designed to be perfectly aligned with each other, the skybox appears to be panoramic without the impression of being inside a cube. This makes experiences feel larger than they really are, and it adds depth to your atmosphere, such as simulating deep space or underwater environments.
+A **skybox** (`Class.Sky`) is a cube made up of six individual images that create an immersive background in an experience. When the images are designed to be perfectly aligned with each other, the skybox appears to be panoramic without the impression of being inside a cube. This makes experiences feel larger than they really are, and it adds depth to your atmosphere, such as simulating deep space or underwater environments.
-Additionally, the `Class.Sky` object includes celestial bodies such as a sun, moon, and stars which dynamically appear, rise, and set based on the
+Additionally, the `Class.Sky` object includes [celestial bodies](#celestial-bodies) such as a sun, moon, and stars which dynamically appear, rise, and set based on the
`Class.Lighting.TimeOfDay|TimeOfDay` or `Class.Lighting.ClockTime|ClockTime`.
Finally, the `Class.Sky` object can be used as a cubemap for reflections in `Class.ViewportFrame|ViewportFrames`. For details, see [Frames](../ui/frames.md#viewportframe).
-## Create skyboxes
+## Creating a Skybox
-If you've created your own skybox images, you must first [import](../projects/assets/manager.md#import-assets) them to Roblox before you can use them in a skybox. Each image must be seamless along **all edges** of neighboring images when "folded" into a cube.
+If you've created your own skybox images, you must first [import](../projects/assets/manager.md#importing-assets) them to Roblox before you can use them in a skybox. Each image must be seamless along **all edges** of neighboring images when "folded" into a cube.
@@ -26,11 +26,12 @@ If you've created your own skybox images, you must first [import](../projects/as
To create a skybox:
-1. In the **Explorer** window, insert a `Class.Sky` object into the `Class.Lighting` service.
+1. In the [Explorer](../studio/explorer.md) window, insert a `Class.Sky` object into the `Class.Lighting` container.
-1. Select the new **Sky** object, then in the **Properties** window, assign a texture to each of the following sky properties:
+1. Select the new **Sky** object.
+1. In the [Properties](../studio/properties.md) window, assign a texture to each of the following sky properties:
- **SkyboxBk** — The **back** square of the skybox.
- **SkyboxDn** — The **down** square of the skybox.
@@ -41,7 +42,7 @@ To create a skybox:
-## Celestial bodies
+## Celestial Bodies
By default, the `Class.Sky` object includes celestial bodies such as a sun, moon, and stars. These bodies dynamically appear, rise, and set based on the
`Class.Lighting.TimeOfDay|TimeOfDay` or `Class.Lighting.ClockTime|ClockTime` property values.
diff --git a/content/en-us/get-started.md b/content/en-us/get-started.md
index 8a944ac8a..11a64c86c 100644
--- a/content/en-us/get-started.md
+++ b/content/en-us/get-started.md
@@ -1,11 +1,11 @@
---
-title: Get started with experiences on Roblox
+title: Get Started with Experiences on Roblox
description: Learn how to create Roblox experiences with guides, tutorials, and code samples.
hideInPageNavigation: true
---
Roblox is a 3D creation platform that provides an all-in-one IDE that includes
-the Roblox Engine, a client emulator, and all the tools and APIs you need to
+the Roblox engine, a client emulator, and all the tools and APIs you need to
start creating Roblox experiences.
- 
- 
- 
- 
-The **Name** column is the key identifier for the notification. By default, the name matches the identifier name you specified when [creating the notification string](#create-a-notification-string), but you can override it through the `category` field in your API calls, in which case `category` overrides the name. Changing the string name in the [Creator Dashboard](https://create.roblox.com/dashboard/creations) or changing the string your message ID references in the API call will generate a new row in the table.
+The **Name** column is the key identifier for the notification. By default, the name matches the identifier name you specified when [creating the notification string](#creating-a-notification-string), but you can override it through the `category` field in your API calls, in which case `category` overrides the name. Changing the string name in the [Creator Dashboard](https://create.roblox.com/dashboard/creations) or changing the string your message ID references in the API call will generate a new row in the table.
If you'd like to A/B test the performance of different strings, it's recommended that you create an entirely new notification string with a similar name, for example:
diff --git a/content/en-us/includes/experience-notifications/analytics-notification-summary.md b/content/en-us/includes/experience-notifications/analytics-notification-summary.md
index 1bb05aefa..48abac875 100644
--- a/content/en-us/includes/experience-notifications/analytics-notification-summary.md
+++ b/content/en-us/includes/experience-notifications/analytics-notification-summary.md
@@ -16,7 +16,7 @@ The summary section serves as a snapshot of the aggregate performance of your no
1. In the center region, click the **Create a Notification String** button.
-1. Fill in an identifier name (only visible to you) and the custom notification string; this is limited to 99 characters and can include unlimited [custom parameters](#customize-notifications-using-parameters). Notifications will automatically use the title of your experience as the notification title, but you can additionally use **\{experienceName\}** to reference your experience in the notification body text.
+1. Fill in an identifier name (only visible to you) and the custom notification string; this is limited to 99 characters and can include unlimited [custom parameters](#customizing-notifications-using-parameters). Notifications will automatically use the title of your experience as the notification title, but you can additionally use **\{experienceName\}** to reference your experience in the notification body text.
Example notification strings:
@@ -29,4 +29,4 @@ As with [Player Invite Prompts](../../production/promotion/invite-prompts.md), y
-4. Use the copied ID for the `messageId` key value in the `payload` table as demonstrated in the [example script](#send-an-experience-notification).
+4. Use the copied ID for the `messageId` key value in the `payload` table as demonstrated in the [example script](#sending-an-experience-notification).
diff --git a/content/en-us/includes/experience-notifications/intro.md b/content/en-us/includes/experience-notifications/intro.md
index a812997fe..eb21e9b0f 100644
--- a/content/en-us/includes/experience-notifications/intro.md
+++ b/content/en-us/includes/experience-notifications/intro.md
@@ -2,7 +2,7 @@
title: include
---
-**Experience notifications** are a way for [opted-in](https://en.help.roblox.com/hc/en-us/articles/24769602332692-Out-of-Experience-Notifications) users age 13+ to keep up with their favorite experiences through timely, personalized notifications. As the developer, you can determine what kinds of in‑experience activities are most important to notify your users about, as well as define the notification content.
+**Experience Notifications** are a way for [opted-in](https://en.help.roblox.com/hc/en-us/articles/24769602332692-Out-of-Experience-Notifications) users age 13+ to keep up with their favorite experiences through timely, personalized notifications. As the developer, you can determine what kinds of in‑experience activities are most important to notify your users about, as well as define the notification content.
diff --git a/content/en-us/includes/studio/testing-modes.md b/content/en-us/includes/studio/testing-modes.md
index 1648f97ba..a4e49e460 100644
--- a/content/en-us/includes/studio/testing-modes.md
+++ b/content/en-us/includes/studio/testing-modes.md
@@ -54,7 +54,7 @@ Once a playtest is running, the following options become available:
-### Size analysis
+### Size Analysis
Every natively-compiled script consumes memory. When the size of compiled code reaches a predefined limit, native compilation stops and the remaining code is run non‑natively. This makes it essential to choose scripts carefully for native compilation.
@@ -119,7 +119,7 @@ In the [Output](../studio/output.md) window, you'll see the total number of scri
For each script, the output displays the number of functions compiled and the native code memory consumption. Each function is then listed in descending order of native code size, with anonymous functions shown as `[anonymous]` and entire scripts shown as `[top level]`. In the final column, the percentage is computed with respect to the native code size limit. Note that native code size of functions is reported precisely but the memory consumption for scripts is rounded up to the nearest page size.
-## Limits and troubleshooting
+## Limits and Troubleshooting
Compiling code into instructions for a particular CPU requires additional storage memory. Additionally, optimizations for complex functions may take too much time to perform. Hitting an internal limit will report an error in Studio's [Output](../studio/output.md) window, including:
diff --git a/content/en-us/luau/numbers.md b/content/en-us/luau/numbers.md
index 65c6af486..9d25ac8bb 100644
--- a/content/en-us/luau/numbers.md
+++ b/content/en-us/luau/numbers.md
@@ -5,7 +5,7 @@ description: A double-precision floating-point number.
The **number** data type, or `double`, represents a [double-precision (64-bit) floating-point](https://wikipedia.org/wiki/Double-precision_floating-point_format) number. Numbers can range from -1.7 \* 10308 to 1.7 \* 10308 (around 15 digits of precision, positive or negative).
-## Signed and unsigned
+## Signed and Unsigned
The sign of the number indicates whether it's positive or negative. For example, `1` is positive and `-1` is negative. In Luau, the number `-0` is equivalent to `0`.
@@ -17,7 +17,7 @@ print(-0 > -1) --> true
print(-0 < -1) --> false
```
-## Number classifications
+## Number Classifications
Luau doesn't distinguish between integers and numbers, but the API reference sometimes distinguishes between them to be more specific about how to use each API.
@@ -50,7 +50,7 @@ To aid in the readability of long numbers, you can include underscores anywhere
You can use logical and relational [operators](./operators.md) to manipulate and compare numbers. You can also use mathematical functions such as `Library.math.sqrt()` and `Library.math.exp()` in the `Library.math` library and bitwise operations in the `Library.bit32` library.
-## Type introspection
+## Type Introspection
You can determine if a value `x` is a number by using `type(x)` or `typeof(x)`. Both return the string `number` if `x` is a number.
@@ -68,7 +68,7 @@ print(typeof(testDecimal)) --> number
print(typeof(testString)) --> string
```
-## Round functions
+## Rounding Functions
You can round numbers using `Library.math.floor()`, `Library.math.ceil()`, or `Library.math.modf()`. These functions return an integer result if Luau can represent it as an integer. If the number is too large, Luau returns it as a float.
diff --git a/content/en-us/luau/operators.md b/content/en-us/luau/operators.md
index 39d47504e..25f2dbef3 100644
--- a/content/en-us/luau/operators.md
+++ b/content/en-us/luau/operators.md
@@ -253,7 +253,7 @@ Lua supports the usual binary operators along with exponentiation, modulus, and
@@ -50,7 +50,7 @@ If your thumbnail does not look correct, **repeat steps 2-5** to overwrite the e
Once you upload an asset, you can't modify or change an asset's thumbnail.
-### Troubleshooting thumbnails
+### Troubleshooting Thumbnails
If your thumbnails don't look the way you expect, you might need to manually resolve these issues or attempt to use the Custom Thumbnail tool again. See the following for common issues and fixes:
diff --git a/content/en-us/marketplace/frequently-asked-questions.md b/content/en-us/marketplace/frequently-asked-questions.md
index 904794111..afe5bc4a4 100644
--- a/content/en-us/marketplace/frequently-asked-questions.md
+++ b/content/en-us/marketplace/frequently-asked-questions.md
@@ -1,5 +1,5 @@
---
-title: Frequently asked questions
+title: Frequently Asked Questions
description: Marketplace FAQ providing answers and resources for common questions.
---
diff --git a/content/en-us/marketplace/homestore.md b/content/en-us/marketplace/homestore.md
index b93d6168c..aea8b1f62 100644
--- a/content/en-us/marketplace/homestore.md
+++ b/content/en-us/marketplace/homestore.md
@@ -15,7 +15,7 @@ The homestore template provides the following features that you can quickly cust
You can find the UGC Homestore Template in Roblox Studio's start screen. To access Studio's provided templates at any time, select **File** > **Open from Roblox** and select **Templates**.
-## Customize Homestore
+## Customizing Homestore
You can modify the features of the homestore to showcase and sell your assets as well as add your own distinct theme and design. If the place is unpublished, the homestore showcases Roblox-created assets on the mannequins and shop as reference.
@@ -57,9 +57,9 @@ By default, the catalog applies the following behavior:
- If the place is unpublished, such as during initial playtesting, the catalog displays Roblox's marketplace items as reference.
- If the place is published, the catalog automatically displays the current experience owner's available marketplace items.
- If the current experience owner doesn't have any available marketplace items, the catalog doesn't display any items.
- - You can [set a different creator's catalog](#specify-another-creators-catalog) as the default by modifying `ReplicatedStorage.Settings`.
+ - You can [set a different creator's catalog](#specifying-another-creators-catalog) as the default by modifying `ReplicatedStorage.Settings`.
-#### Specify another creator's catalog
+#### Specifying Another Creator's Catalog
To set the catalog to use another creator's marketplace items:
@@ -67,7 +67,7 @@ To set the catalog to use another creator's marketplace items:
-2. Ensure that the marketplace items have their sale location set to `Marketplace and All Experiences` or have specified this specific experience as a valid [sale location](../marketplace/publish-to-marketplace.md#sale-location).
+2. Ensure that the marketplace items have their sale location set to `Marketplace and All Experiences` or have specified this specific experience as a valid [sale location](../marketplace/publishing-to-marketplace.md#sale-location).
1. If the experience is added as a unique sale location, the experience owner [must enable the specific asset for sale using the Creator Dashboard](../production/monetization/avatar-items.md#adding-items-to-experience).
@@ -85,9 +85,9 @@ To set the catalog to use another creator's marketplace items:
### Building
-Each building component is designed to be modular and extendible. You can quickly duplicate pieces, rotate, and rearrange them to create larger and more intricate structures. For more information on working with modular environments, see [Assembling Modular Environments](../tutorials/use-case-tutorials/modeling/assemble-modular-environments.md).
+Each building component is designed to be modular and extendible. You can quickly duplicate pieces, rotate, and rearrange them to create larger and more intricate structures. For more information on working with modular environments, see [Assembling Modular Environments](../tutorials/use-case-tutorials/modeling/assembling-modular-environments.md).
-### Advanced customizations
+### Advanced Customizations
For an advanced technical breakdown of the template project, including descriptions of various scripts, components, and behaviors, navigate to `ServerScriptService` and open the `README` ModuleScript. This content is intended for creators who intend to modify the underlying scripts and behaviors of the template project.
diff --git a/content/en-us/marketplace/index.md b/content/en-us/marketplace/index.md
index 232feb36e..c4f662fd9 100644
--- a/content/en-us/marketplace/index.md
+++ b/content/en-us/marketplace/index.md
@@ -1,5 +1,5 @@
---
-title: Marketplace overview
+title: Marketplace Overview
description: Understand how to create and sell items on the Marketplace, including policies, fees and commissions, and managing IP.
---
@@ -13,12 +13,12 @@ Users can access the Marketplace [through the web](https://www.roblox.com/catalo
The Marketplace is not the same as the [Creator Store](../production/creator-store.md). The Creator Store provides assets for creators to use for the development of their experiences, such as models, images, and plugins.
-## Sell on the Marketplace
+## Selling on the Marketplace
Creators can sell 3D accessories, clothing, and character bodies on the Marketplace. To ensure that assets you create meet Roblox's technical and community standards, make sure to review the following important policies and guidelines:
-- [Marketplace policy](../marketplace/marketplace-policy.md) — covers the rules and policies for Marketplace creators and their assets.
-- [Intellectual property](../marketplace/intellectual-property.md) — provides an overview of how intellectual property works on the Marketplace.
+- [Marketplace Policy](../marketplace/marketplace-policy.md) — covers the rules and policies for Marketplace creators and their assets.
+- [Intellectual Property](../marketplace/intellectual-property.md) — provides an overview of how intellectual property works on the Marketplace.
- [Moderation](../marketplace/moderation.md) — describes the process in which assets are moderated, including instructions on filing appeals and submitting DMCA requests.
-If you have an asset ready to sell, and both you and your asset meets Roblox's policies and guidelines, you can begin [uploading and publishing](../marketplace/publish-to-marketplace.md) your assets to the Marketplace. Depending on the type of item sold, various fees and commissions can apply. For more information, see [Fees and Commissions](../marketplace/marketplace-fees-and-commissions.md).
+If you have an asset ready to sell, and both you and your asset meets Roblox's policies and guidelines, you can begin [uploading and publishing](../marketplace/publishing-to-marketplace.md) your assets to the Marketplace. Depending on the type of item sold, various fees and commissions can apply. For more information, [Fees and Commissions](../marketplace/marketplace-fees-and-commissions.md).
diff --git a/content/en-us/marketplace/intellectual-property.md b/content/en-us/marketplace/intellectual-property.md
index de884e32a..4687792d7 100644
--- a/content/en-us/marketplace/intellectual-property.md
+++ b/content/en-us/marketplace/intellectual-property.md
@@ -1,5 +1,5 @@
---
-title: Intellectual property
+title: Intellectual Property
description: Explains protected intellectual property, both for individual and Roblox creations.
---
@@ -32,7 +32,7 @@ Other examples where you may not have IP ownership:
- If you give credit to the copyright owner, you don't automatically have the rights to use their copyrighted work.
- If you want to create a hat on Roblox inspired by a well-known style of hat, such as a top hat, you may not be able to stop other users from uploading similar hats.
-## Protect your own IP
+## Protecting Your Own IP
In order to protect your IP, it's important that your creations are unique. For example, the creation below takes a well-established concept (a Trojan helmet) and adds intricate details that make the design an original expression of the idea, such as the shape and orientation of the gold adornments and the shape of the facial opening.
@@ -81,7 +81,7 @@ To protect the creativity of others, the Roblox [Terms of Use](https://www.roblo
- This means you should not upload content you do not own or did not get the owner's permission to use.
- Infringing on someone's intellectual property is not only a violation of Roblox's Terms of Use, but it's also a violation of the law.
-## Roblox protecting your IP
+## Roblox Protecting Your IP
Roblox complies with the [Digital Millennium Copyright Act (DMCA)](https://www.copyright.gov/dmca/) and has a designated process for receiving and handling copyright takedown reports from the owner of the original work.
diff --git a/content/en-us/marketplace/marketplace-fees-and-commissions.md b/content/en-us/marketplace/marketplace-fees-and-commissions.md
index e7d029f7d..dbbc84bd7 100644
--- a/content/en-us/marketplace/marketplace-fees-and-commissions.md
+++ b/content/en-us/marketplace/marketplace-fees-and-commissions.md
@@ -1,5 +1,5 @@
---
-title: Marketplace fees and commissions
+title: Marketplace Fees and Commissions
description: Explains upload fees and commission from selling accessories and clothes on the Marketplace.
comments: Updates to this page require careful internal review. We generally don't accept pull requests on it.
---
@@ -8,11 +8,11 @@ You can create and sell bodies, heads, accessories, and clothes on the [Marketpl
You receive a commission every time users purchase your item. If users purchase your item within an experience using the [Avatar Inspect Menu](../players/avatar-inspect-menu.md) or the [Avatar Editor Service](../players/avatar-editor.md), the experience owner also receives a commission. For information on viewing your sales data, see [Sales Data analytics](../production/analytics/analytics-dashboard.md#sales-data).
-## Upload fees
+## Upload Fees
When uploading, accessories, clothing, bodies, and heads require an upload fee of **750 Robux** per submission. In general, fees are not refunded if an item is rejected through moderation. If your asset clears the uploading process, your asset is ready to publish to the Marketplace.
-## Publishing advance
+## Publishing Advance
A publishing advance is a refundable upfront fee that you pay at the time of publishing an item. The publishing advance does not apply for **free Limited items** which require a [per-unit fee](#per-unit-fee). Items taken off-sale and put back on-sale do not require another publishing advance.
@@ -21,9 +21,9 @@ This publishing advance is dependent on the type of Marketplace item being sold:
@@ -146,7 +146,7 @@ On the Manage Item page, you can update the following fields:
- **Description** - The description of your asset in the Marketplace.
- **Tags** - You can add up to 5 tags from a preset list to each of your items to aid in discovery. Roblox already includes implicit tags related to the accessory type, such as **Hair**, **Back**, or **Shoulder**.
-### Item attributes
+### Item Attributes
In **Item Attributes** you can set the **Availability** of your asset as a **Non-Limited** or a **Limited** item. Each availability type changes the available item attribute fields you can modify.
@@ -156,8 +156,8 @@ In **Item Attributes** you can set the **Availability** of your asset as a **Non
@@ -258,5 +258,5 @@ You can disable the sale of a published asset by disabling the **On Sale** at th
After enabling an item for sale, you can take the item off-sale by disabling the toggle. A publishing fee is not required to re-enable.
-## Transform parts
+## Transforming Parts
You can move, scale, and rotate selected parts either through modeling tools or by setting a new position, size, or orientation in the [Properties](#part-properties) window.
@@ -124,7 +124,7 @@ the arrow axis indicators change to a part's local orientation, and an **L** ind
-### Move
+### Moving
You can move a selected part to a new position using the **Move** tool (default shortcut 2) or by **cursor dragging**. While moving a part, you can temporarily toggle [snapping](../studio/model-tab.md#transform-snapping) by holding Shift.
@@ -164,7 +164,7 @@ While cursor dragging, T and R can be used to quickly rota
-### Scale
+### Scaling
To scale (resize) a selected part along the **X**, **Y**, or **Z** axis, use the **Scale** tool (default shortcut 3) and click/drag a handle. While dragging, you can temporarily toggle [snapping](../studio/model-tab.md#transform-snapping) by holding Shift.
@@ -172,7 +172,7 @@ To scale (resize) a selected part along the **X**, **Y**, or **Z** axis, use the
-### Rotate
+### Rotating
To rotate a selected part around the **X**, **Y**, or **Z** axis, use the **Rotate** tool (default shortcut 4) and click/drag a rotation ring. While dragging, you can temporarily toggle [snapping](../studio/model-tab.md#transform-snapping) by holding Shift.
@@ -180,11 +180,11 @@ To rotate a selected part around the **X**, **Y**, or **Z** axis, use the **Rota
-## Color parts
+## Coloring Parts
While a part is gray by default, you can change it to any color through the following methods.
-### Hexagon map
+### Hexagon Map
Clicking the small dropdown arrow on the **Color** widget reveals a hexagonal color picker.
@@ -194,22 +194,22 @@ By default, clicking the overall **Color** button applies the chosen color to an
-### Colors popup
+### Colors Popup
The **Colors** popup allows you to set a color through your operating system's color picker widget. To access it, navigate to the [Properties](../studio/properties.md) window and click the small box to the left of the `Class.BasePart.Color|Color` property.
-### RGB value
+### RGB Value
To define a specific RGB color value for a part, enter an RGB value into the
`Class.BasePart.Color|Color` property field.
-## Apply materials
+## Applying Materials
-Similar to [color](#color-parts), you can customize a part's **material** to simulate real-world materials such as wood, glass, or fabric. When selecting a material, consider the following:
+Similar to [color](#coloring-parts), you can customize a part's **material** to simulate real-world materials such as wood, glass, or fabric. When selecting a material, consider the following:
- **Material affects the physical traits of a part, not just its appearance**. For example, the **Concrete** material is heavier than the **Plastic** material, so a concrete brick will have higher density than a plastic brick and sink in water faster.
diff --git a/content/en-us/parts/materials.md b/content/en-us/parts/materials.md
index 01bb57a19..06f7ee486 100644
--- a/content/en-us/parts/materials.md
+++ b/content/en-us/parts/materials.md
@@ -7,15 +7,15 @@ import BetaAlert from '../includes/beta-features/beta-alert.md'
Roblox's materials are unlike materials on other platforms, in that their visual appearance **and** their [physical properties](#physical-properties) reflect those of materials in the real world. For example, concrete is heavier than plastic and sinks faster in water. When you set the material of a part or terrain, Roblox simulates its physical material properties to make this behavior just work.
-The Roblox Engine offers a range of [base materials](#base-materials) suitable to build many experiences, including various categories of metal, rock, and organic materials.
+The Roblox engine offers a range of [base materials](#base-materials) suitable to build many experiences, including various categories of metal, rock, and organic materials.
You can also create your own [custom materials](#custom-materials) and apply them to parts or [terrain](../parts/terrain.md). Custom materials have an additional [adaptive materials](#adaptive-materials) behavior that lets you adapt any model to use your art style and custom materials, even if someone else created the model.
-## Apply materials
+## Applying Materials
You can quickly apply materials to [parts](../parts/index.md) through the [Material](#material-widget) widget. The [Material Manager](#material-manager) offers the same functionality and an additional "paint tool" application mode.
-### Material widget
+### Material Widget
The **Material** widget is accessible from either the [Home](../studio/home-tab.md) or [Model](../studio/model-tab.md) tabs. Clicking the small dropdown arrow reveals a material picker.
@@ -25,7 +25,7 @@ By default, clicking the overall **Material** button applies the chosen material
-### Material manager
+### Material Manager
If you've enabled the [Material Picker](#material-widget) beta, access the **Material Manager** from the picker window. If you have not enabled the beta, locate its dedicated button to the left of the **Color** button in the [Home](../studio/home-tab.md) or [Model](../studio/model-tab.md) tab.
@@ -57,7 +57,7 @@ You can also use a material as a painting tool that applies to parts:
-## Custom materials
+## Custom Materials
The [Material Manager](#material-manager) provides a user interface to interact with various aspects of `Class.MaterialService`, including creating new custom materials and applying them to parts and [terrain](../parts/terrain.md). Custom materials are represented by `Class.MaterialVariant` instances within `Class.MaterialService`.
@@ -69,7 +69,7 @@ You can apply custom materials per-part or globally to both parts and terrain, a
`Class.MaterialVariant` and `Class.SurfaceAppearance` instances both use [PBR](../art/modeling/surface-appearance.md) textures to customize the appearance of objects. The difference is that `Class.MaterialVariant` is for customizing the appearance of reusable tileable material, whereas `Class.SurfaceAppearance` is for customizing the visual appearance of a specific mesh with UV mapping. `Class.MaterialVariant` instances also have [physical properties](#physical-properties) that `Class.SurfaceAppearance` instances don't.
-### Create custom materials
+### Creating Custom Materials
You can edit all properties of a custom material in the [Material Manager](#material-manager) or through the properties of a `Class.MaterialVariant` instance. You can also generate custom materials through the prompt‑based [Material Generator](../studio/material-generator.md).
@@ -95,9 +95,9 @@ To create a custom material in the [Material Manager](#material-manager):
If necessary, you can delete a custom material from the [Material Manager](#material-manager) by selecting it and clicking the **Delete** button below its preview globe. Alternatively, you can delete its associated `Class.MaterialVariant` instance within **MaterialService** of the [Explorer](../studio/explorer.md).
-### Apply custom materials
+### Applying Custom Materials
-For [parts](../parts/index.md), you can use a custom material just like any other material, applying it to selected parts through the [Material](#apply-materials) widget or the [Material Manager](#material-manager).¹
+For [parts](../parts/index.md), you can use a custom material just like any other material, applying it to selected parts through the [Material](#applying-materials) widget or the [Material Manager](#material-manager).¹
You can also apply the new material to a part by setting its **MaterialVariant** property in the [Properties](../studio/properties.md) window. In this case, Studio automatically sets its **Material** property to the base material you chose when creating the material.
@@ -109,7 +109,7 @@ Note that if you rename a custom material **after** applying it to parts, those
-#### Terrain details
+#### Terrain Details
By default, applying a custom material to parts or as an override applies that custom material as tiles across each face. For terrain, you can optionally configure `Class.TerrainDetail` instances to customize the **top**, **side**, and **bottom** of terrain voxels using that custom material.
@@ -149,7 +149,7 @@ To customize the faces of terrain using a custom material:
-#### Disable overrides
+#### Disabling Overrides
You can disable an entire material override and all base materials that it's currently overriding, or you can disable the override for a specific base material.
@@ -168,7 +168,7 @@ You can disable an entire material override and all base materials that it's cur
-## Physical properties
+## Physical Properties
All materials have built-in **physical properties** such as density, elasticity, and friction. Through the application of [custom materials](#custom-materials) with unique physical properties, you can affect global material behavior for all parts and [terrain](../parts/terrain.md) which use the custom material, such as creating an extremely slippery variant of the **Ice** material.
@@ -225,7 +225,7 @@ If you need to override a part's custom material properties and set physical pro
-## Adaptive materials
+## Adaptive Materials
When you apply a custom material to a part, the part's `Class.Part.MaterialVariant` property becomes the name of its `Class.MaterialVariant` rather than its specific instance. This means that when you reuse the part in the same or a different place, as in a model or package, it's easier for you to adapt different custom materials to adjust the part's look. The adaptive behavior of custom materials has the following effects:
@@ -244,9 +244,9 @@ The [Creator Store](../production/creator-store.md) has a category called Materi
To make the most of adaptive materials, use a consistent naming convention for your `Class.MaterialVariant` instances. For example, you can use `PascalCase` with the base material of the custom material as the first word, as in `GrassWet`, `GrassDry`, and `GrassBurned`.
-## Asset and property reference
+## Asset and Property Reference
-### Base materials
+### Base Materials
Shaders generate the look and feel of materials. The base material shaders work differently than the shader which `Class.MaterialVariant` instances use, so you can't create custom materials that look exactly like base materials, but you can still create custom materials that use their textures. The following tables list the asset IDs for material details such as `Class.SurfaceAppearance.ColorMap|ColorMap` and `Class.SurfaceAppearance.RoughnessMap|RoughnessMap`.
@@ -1221,9 +1221,9 @@ Shaders generate the look and feel of materials. The base material shaders work
The base materials were upgraded in 2022 to support custom materials. New places use the upgraded materials by default, but you may need to explicitly enable upgraded materials for older places by selecting **MaterialService** in the [Explorer](../studio/explorer.md) window and then, in the [Properties](../studio/properties.md) window, enabling its **Use2022Materials** property. Note that after upgrading, you might need to adjust terrain colors since terrain made with upgraded materials uses tint instead of hue shift.
-### Default colors
+### Default Colors
-The following table lists the default RGB values for each base material. For information on how to color parts and terrain, see [Parts](../parts/index.md#color-parts) and [Environmental Terrain](../parts/terrain.md#custom-terrain-colors).
+The following table lists the default RGB values for each base material. For information on how to color parts and terrain, see [Parts](../parts/index.md#coloring-parts) and [Environmental Terrain](../parts/terrain.md#custom-terrain-colors).
@@ -31,17 +31,17 @@ When you **group** objects together, they automatically become a `Class.Model` o
To completely ungroup a model back to its original objects, right-click it and select **Ungroup**, or press CtrlU on Windows or ⌘U on Mac.
-### Set a primary part
+### Setting a Primary Part
If you have a model with parts that are joined together through physical joints like `Class.WeldConstraint|WeldConstraints` or `Class.Motor6D|Motor6Ds`, you should specify a `Class.BasePart` within the model to become a `Class.Model.PrimaryPart|PrimaryPart`. A model's `Class.Model.PrimaryPart|PrimaryPart` is the physical reference that specifies which `Class.BasePart` the pivot point and bounding box should move with when the model changes position or orientation.
To set a primary part:
-1. In the **Explorer** window, select a model.
-1. In the **Properties** window, select the **PrimaryPart** property. Your cursor changes.
-1. Back in the **Explorer** window, select the part that you want to become your primary part.
+1. In the [Explorer](../studio/explorer.md) window, select a model.
+1. In the [Properties](../studio/properties.md) window, select the **PrimaryPart** property. Your cursor changes.
+1. Back in the [Explorer](../studio/explorer.md) window, select the `Class.BasePart` that you want to become your primary part.
-## Select models
+## Selecting Models
As you hover over models in the viewport, they are outlined to indicate their potential selection. You can select an outlined model by clicking it, or you can select multiple models by holding Shift, Ctrl, or ⌘ as you hover over and click them.
@@ -54,9 +54,9 @@ As models typically contain multiple child [parts](../parts/index.md) or [meshes
@@ -86,21 +86,21 @@ Additionally, within a `Class.Script` or `Class.LocalScript`, you can move or ro
-### Destroy height
+### Destroy Height
To prevent parts that have fallen off of an experience's map from continuing to fall forever, Studio automatically destroys parts that fall below the `Class.Workspace.FallenPartsDestroyHeight` value. If a part destroyed due to this behavior is the last part in a model, then that model will also be destroyed.
-## Model streaming
+## Model Streaming
Instance [streaming](../workspace/streaming.md) dynamically loads and unloads `Class.Model|Models` on a player's device as their character explores the 3D world. With streaming enabled, you can specify the way each model should be treated under streaming behavior. For example, a model set to [Persistent](../workspace/streaming.md#persistent) will never stream out, or a model set to [Atomic](../workspace/streaming.md#atomic) will stream in and out as a single unit with all of its descendants.
@@ -108,15 +108,15 @@ Because 3D content that exists on the client changes dynamically in a streaming-
See [Model Streaming Controls](../workspace/streaming.md#model-streaming-controls) for more on model-level streaming controls.
-## Upload and distribute models
+## Uploading and Distributing Models
-You can distribute models to the [Creator Store](../production/creator-store.md) for other creators to use within their own experiences. As with any asset, all models must adhere to the [Community Rules](https://en.help.roblox.com/hc/articles/203313410), [Terms of Use](https://en.help.roblox.com/hc/articles/115004647846), the [DMCA Guidelines](../production/publishing/dmca-guidelines.md) regarding copyright and Creator Store [asset moderation](../production/creator-store.md#asset-moderation) rules.
+You can [distribute](../production/creator-store.md) models to the [Creator Store](../production/creator-store.md) for other creators to use within their own experiences. As with any asset, all models must adhere to the [Community Rules](https://en.help.roblox.com/hc/articles/203313410), [Terms of Use](https://en.help.roblox.com/hc/articles/115004647846), the [DMCA Guidelines](../production/publishing/dmca-guidelines.md) regarding copyright and Creator Store [asset moderation](../production/creator-store.md#asset-moderation) rules.
-## Intersect parts
+## Intersecting Parts
The **Intersect** tool intersects overlapping parts into a single solid `Class.IntersectOperation`. By default, the face colors of the resulting intersection are borrowed from the `Class.BasePart.Color|Color` property of the original parts, although you can enable its `Class.PartOperation.UsePartColor|UsePartColor` property to change the entire intersection to a specific color.
@@ -79,14 +79,14 @@ The **Intersect** tool intersects overlapping parts into a single solid `Class.I
To intersect overlapping parts together:
-1. Select all parts that you want to intersect.
+1. Select all parts to intersect.
2. Click the **Intersect** button. All of the parts combine into one solid `Class.IntersectOperation` with the name **Intersection**.
-## Negate parts
+## Negating Parts
-The **Negate** tool negates a part so that when it's [unioned with another part](#union-parts), the shape of the negated part is **subtracted** from the other part.
+The **Negate** tool negates a part so that when it's [unioned with another part](#unioning-parts), the shape of the negated part is **subtracted** from the other part.
@@ -113,26 +113,26 @@ To subtract a part from other overlapping parts:
-## Separate unions or intersections
+## Separating Unions or Intersections
The **Separate** tool separates a `Class.UnionOperation` back into its individual parts, essentially serving as an "undo" tool for unions and intersections.
To separate a union or intersection back into individual parts:
-1. Select the union or intersection.
+1. Select a `Class.UnionOperation`.
1. Click **Separate**. The parts separate back into their original form.
-## Render fidelity
+## Render Fidelity
By default, new solid modeled operations will always be shown in `Enum.RenderFidelity.Automatic|Automatic` render fidelity, meaning the part's detail is based on its distance from the camera as outlined in the following table.
-Using the Terrain Editor, you can easily [generate](#generate-terrain) and edit terrain either at a [voxel](#detailed-editing) or [region](#large-scale-editing) level with the option of importing a [heightmap](#heightmaps-and-colormaps) and [colormap](#heightmaps-and-colormaps). For more precise, dynamic, or procedural terrain editing, you can also [script](#scripting) terrain creation.
+Using the [Terrain Editor](../studio/terrain-editor.md), you can easily [generate](#generating-terrain) and edit terrain either at a [voxel](#detailed-editing) or [region](#large-scale-editing) level with the option of importing a [heightmap](#heightmaps-and-colormaps) and [colormap](#heightmaps-and-colormaps). For more precise, dynamic, or procedural terrain editing, you can also [script](#scripting) terrain creation.
-## Terrain materials
+## Terrain Materials
-The following default materials are available for terrain, and you can also apply [custom materials](../parts/materials.md#custom-materials). Materials affect both the shape and appearance of terrain in the world; for example, [animated grass](#grass-animation) renders only on the **Grass** material and the **Water** material [ripples and shimmers](#water-appearance) with a subtle motion.
+The following default [materials](../parts/materials.md) are available for terrain, and you can also apply [custom materials](../parts/materials.md#custom-materials). Materials affect both the shape and appearance of terrain in the world; for example, [animated grass](#animated-grass) renders only on the **Grass** material and the **Water** material [ripples and shimmers](#water-appearance) with a subtle motion.
-1. In the **Properties** window, customize the appearance of water through the following properties:
+1. Customize the appearance of water through the following properties in the [Properties](../studio/properties.md) window:
-3. Adjust the grass length by entering a value between `0.1` and `1` for the **GrassLength** property.
+3. Adjust the grass length by entering a value between 0.1 and 1 for the **GrassLength** property.
-4. Adjust the direction and strength of its animation through [global wind](../environment/global-wind.md).
+4. If desired, adjust the direction and strength of its animation through [global wind](../environment/global-wind.md).
-### Custom terrain colors
+### Custom Terrain Colors
Each terrain material is assigned a default color, but you can customize any material's color to better fit your experience.
@@ -205,26 +205,26 @@ Each terrain material is assigned a default color, but you can customize any mat
To customize any material color other than water:
-1. In the **Explorer** window, navigate to the **Workspace**, then select the **Terrain** object.
+1. Select the **Terrain** object under **Workspace** in the [Explorer](../studio/explorer.md) window.
-3. For any material, either input a new RGB code or click the color box to open the [colors popup](../parts/index.md#colors-popup).
+3. For any given material, either input a new RGB code or click the color box to open the [colors popup](../parts/index.md#colors-popup).
-## Generate terrain
+## Generating Terrain
Using the following tools and methods, you can generate large
-areas of terrain procedurally with the Generate tool or scripting, or automatically based on a heightmap and colormap.
+areas of terrain procedurally with the [Generate](#generate-tool) tool or [scripting](#scripting), or automatically based on a [heightmap](#heightmaps-and-colormaps) and optional [colormap](#heightmaps-and-colormaps).
-### Generate tool
+### Generate Tool
-The **Generate** tool allows you to procedurally generate terrain in seconds. This is useful if you want to create a large map and fine-tune [terrain details](#detailed-editing).
+The [Generate](../studio/terrain-editor.md#generate) tool allows you to procedurally generate terrain in seconds. This is useful if you want to create a large map and then fine-tune [terrain details](#detailed-editing).
-1. In the **Terrain Editor**, navigate to the **Create** tab and select the **Generate** tool.
+1. Navigate to the [Create](../studio/terrain-editor.md#create-tab) tab of the [Terrain Editor](../studio/terrain-editor.md) and select the [Generate](../studio/terrain-editor.md#generate) tool.
@@ -256,11 +256,12 @@ The **Generate** tool allows you to procedurally generate terrain in seconds. Th
-4. Click the **Generate** button.
+4. Adjust any other desired settings as documented [here](../studio/terrain-editor.md#generate).
+5. Click the **Generate** button.
-### Heightmaps and colormaps
+### Heightmaps and Colormaps
A **heightmap** is a 2D representation of a 3D terrain map, as viewed directly from above. Brighter areas of a heightmap result in higher terrain, like mountains, while darker areas result in lower regions, like valleys.
@@ -285,7 +286,7 @@ An optional **colormap**, along with a heightmap, converts colors to terrain mat
To import a heightmap and optional colormap:
-1. In the **Terrain Editor**, navigate to the **Create** tab and select the **Import** tool.
+1. Navigate to the [Create](../studio/terrain-editor.md#create-tab) tab of the [Terrain Editor](../studio/terrain-editor.md) and select the [Import](../studio/terrain-editor.md#import) tool.
@@ -299,7 +300,7 @@ To import a heightmap and optional colormap:
@@ -490,7 +491,7 @@ Select a region by clicking and dragging in the 3D viewport, reposition it with
@@ -563,13 +564,13 @@ To transform a region:
By default, this tool uses **Live Edit** mode to constantly update terrain as you transform it. To view only a wireframe preview of the terrain as you transform it, disable live edit mode and then, while transforming, press Enter/Return or click the **Apply** button to apply the changes.
@@ -583,13 +584,11 @@ To fill or replace terrain:
@@ -599,9 +598,9 @@ To set the sea level:
-## Detailed editing
+## Detailed Editing
-The Terrain Editor's **Edit** tab also contains tools for precision editing using a "brush" tool to draw, sculpt, smooth, flatten, or paint terrain.
+The terrain editor's [Edit](../studio/terrain-editor.md#edit-tab) tab also contains tools for precision editing using a "brush" tool to [draw](#drawing), [sculpt](#sculpting), [smooth](#smoothing), [flatten](#flattening), or [paint](#painting).
@@ -653,34 +652,34 @@ For tools which use the brush, Studio supports the following keyboard and mouse
- 
@@ -176,7 +176,7 @@ To offset a texture:
2. In the **Properties** window, set **OffsetStudsU** and **OffsetStudsV** to the number of studs you'd like to offset the texture horizontally and vertically.
-### Animate textures
+### Animating Textures
Using `Class.TweenService`, you can tween texture properties like `Class.Texture.OffsetStudsU|OffsetStudsU` and `Class.Texture.StudsPerTileV|StudsPerTileV` to achieve animated surfaces. For example, if you apply two fog textures to one container and animate them with the following script, you can achieve the appearance of a layered moving fog:
diff --git a/content/en-us/performance-optimization/design.md b/content/en-us/performance-optimization/designing.md
similarity index 92%
rename from content/en-us/performance-optimization/design.md
rename to content/en-us/performance-optimization/designing.md
index 3f37684a4..dee22b3b3 100644
--- a/content/en-us/performance-optimization/design.md
+++ b/content/en-us/performance-optimization/designing.md
@@ -1,11 +1,11 @@
---
-title: Design for performance
+title: Designing for Performance
description: Outlines performance best practices to follow as you build a new experience.
---
Designing for performance means following a handful of best practices **as you build** your experience. Compared to finding and fixing performance issues later in the development process, designing for performance early can save you a lot of time and effort.
-## Low-end devices
+## Low-End Devices
Lower-end devices, particularly mobile devices, have severe memory limitations and are succeptible to crashes due to out of memory (OOM) errors:
@@ -25,19 +25,19 @@ More generally, testing on a variety of devices can help you check that the expe
-## Debug visualization
+## Debugging Visualization
During testing, it may be useful to visualize frequencies for simulated parts. To enable this option:
@@ -51,10 +51,10 @@ Once enabled, simulated parts will be outlined by their current simulation rate.
-### Sensor setup
+### Sensor Setup
A `Class.ControllerPartSensor` detects parts with the same code the `Class.Humanoid` uses for detecting floors and ladders.
@@ -29,9 +29,9 @@ A `Class.ControllerPartSensor` detects parts with the same code the `Class.Human
-### Controller setup
+### Controller Setup
-Controller instances like `Class.GroundController` and `Class.ClimbController` tell the managed part how to interact with the world, working alongside the sensors you configured during the [sensor setup](#sensor-setup).
+Controller instances like `Class.GroundController` and `Class.ClimbController` tell the managed part how to interact with the world, working alongside the sensors you configured in [Sensor Setup](#sensor-setup).
1. Insert both a `Class.GroundController` and `Class.ClimbController` as children of the `Class.ControllerManager`.
@@ -41,7 +41,7 @@ Controller instances like `Class.GroundController` and `Class.ClimbController` t
-### Link references
+### Linking References
To complete the core setup, you'll need to link various properties of the `Class.ControllerManager` instance to objects within the main `Class.Model`.
@@ -58,9 +58,9 @@ To complete the core setup, you'll need to link various properties of the `Class
-### Test
+### Testing
-With [sensors](#sensor-setup) and [controllers](#controller-setup) in place, and with [references linked](#link-references), you can test the controller in Studio.
+With [sensors](#sensor-setup) and [controllers](#controller-setup) in place, and with [references linked](#linking-references), you can test the controller in Studio.
1. Start a playtest using the **Run** mode (F8) since you don't need to insert your avatar character in this scenario.
@@ -91,7 +91,7 @@ With [sensors](#sensor-setup) and [controllers](#controller-setup) in place, and
Remember that `Class.GroundController.GroundOffset|GroundOffset` must be **less** than the value of `Class.ControllerPartSensor.SearchDistance|SearchDistance` for the [GroundSensor](#sensor-setup), since that sensor will deactivate if it loses sense of the ground and effectively stop its forces on the part. This will cause a bouncing effect as gravity and the `Class.GroundController` repeatedly swap control of the part.
-## Custom sensors
+## Custom Sensors
The `Class.ControllerPartSensor.SensorMode` options of `Enum.SensorMode|Floor` and `Enum.SensorMode|Ladder` run the exact `Class.Humanoid` sensor code, letting you use them for backwards compatibility. However, you can also customize how and when walkable and climbable parts are detected, ultimately changing when the managed part walks/climbs.
diff --git a/content/en-us/physics/constraints/align-orientation.md b/content/en-us/physics/constraints/align-orientation.md
index 42c678c23..df80c53c4 100644
--- a/content/en-us/physics/constraints/align-orientation.md
+++ b/content/en-us/physics/constraints/align-orientation.md
@@ -1,10 +1,10 @@
---
-title: AlignOrientation
+title: Align Orientation
description: The AlignOrientation constraint applies torque to align two attachments, or to align one attachment with a goal orientation.
---
diff --git a/content/en-us/physics/mover-constraints.md b/content/en-us/physics/mover-constraints.md
index 034db523c..5ca3df10f 100644
--- a/content/en-us/physics/mover-constraints.md
+++ b/content/en-us/physics/mover-constraints.md
@@ -1,5 +1,5 @@
---
-title: Mover constraints
+title: Mover Constraints
description: Mover constraints apply force or torque to move one or more assemblies.
---
@@ -79,7 +79,7 @@ The physics engine includes the following `Class.Constraint|Constraints` that ap
-## Constraint visualization
+## Constraint Visualization
To accurately visualize constraints in Studio, you can use the following options from the [Model](../studio/model-tab.md) tab:
@@ -102,14 +102,14 @@ To accurately visualize constraints in Studio, you can use the following options
In addition to the above visualization, you can view colored outlines around mechanisms (groups of parts that share simulation step and [network ownership](../physics/network-ownership.md)) by toggling on **Mechanisms** from the [Visualization Options](../studio/ui-overview.md#visualization-options) widget in the upper‑right corner of the 3D viewport.
-## Create constraints
+## Creating Constraints
Mover constraints typically connect one or two `Class.Attachment|Attachments` or `Class.Bone|Bones`. When connected to `Class.Bone|Bones`, the constraint will use their animated position and orientation.
To create a mover constraint, you can use either the **Create** tool or the [Explorer](../studio/explorer.md) window.
-### Add menu options
+### Adding Menu Options
Once enabled, experience-specific actions can be added to the ACM. For example, an experience might allow for trade requests, add-to-party options, or other special interactions.
@@ -106,7 +106,7 @@ local options = {"Custom ACM Action", bindableEvent}
StarterGui:SetCore("AddAvatarContextMenuOption", options)
```
-### Remove menu options
+### Removing Menu Options
You can remove custom and the default Add Friend, Chat, View, and Wave options from the ACM by referencing the custom Action name or the default `Enum.AvatarContextMenuOption` enum.
@@ -124,7 +124,7 @@ StarterGui:SetCore("RemoveAvatarContextMenuOption", Enum.AvatarContextMenuOption
You can not make edits to the ACM while it is open. Your code should verify that an action is still relevant in case the action was removed from the menu. For example, if a marketplace area adds an option to send trade requests, you should verify both users are still in the marketplace.
-## Customize menu appearance
+## Customizing Menu Appearance
To change the appearance of the Avatar Context Menu, call `Class.StarterGui:SetCore()` with the option "AvatarContextMenuTheme", providing a table of parameters and values to adjust the menu appearance.
@@ -138,7 +138,7 @@ B. Button Frame: Contains all of the ACM buttons.
C. Buttons: Individual buttons for the default or custom ACM actions.
-### Appearance parameters
+### Appearance Parameters
These are the customization parameters with the ACM:
@@ -173,7 +173,7 @@ These are the customization parameters with the ACM:
-## Set up the leaderboard
+## Setting up the Leaderboard
To set up the leaderboard and add players when they enter the experience:
@@ -47,7 +47,7 @@ To set up the leaderboard and add players when they enter the experience:
It's essential that the folder is named `leaderstats` with all lowercase letters. Roblox doesn't add the player to the leaderboard if you name it any other way.
-## Add stats
+## Adding Stats
Leaderboards use **value type objects** to store and display player stats. This script will show a player's gold using an `Class.IntValue`, a placeholder for an integer.
@@ -89,7 +89,7 @@ These lines accomplish the following:
-## Update stats
+## Updating Stats
To update a player's leaderboard stat, change the `Value` property of that stat within their `leaderstats` folder. For example, you can attach the following `Class.Script` to any pickup object to increase the **Gold** stat of the player collects it.
@@ -116,7 +116,7 @@ end
goldChunk.Touched:Connect(onPartTouch)
```
-## Order stats
+## Ordering Stats
There are three ways to control the order of stats in a leaderboard:
@@ -152,7 +152,7 @@ Players.PlayerAdded:Connect(leaderboardSetup)
`IsPrimary` takes precedence over any `Priority` values. If multiple stats have `IsPrimary` values set to `true`, their `Priority` values determine the leaderboard order.
-## Hide the leaderboard
+## Hiding the Leaderboard
To hide the leaderboard, such as on a menu screen or during a cutscene, place a `Class.LocalScript` within `Class.StarterGui` or `Class.StarterPlayerScripts` containing a call to `Class.StarterGui:SetCoreGuiEnabled()|StarterGui`.
diff --git a/content/en-us/players/load-screens.md b/content/en-us/players/loading-screens.md
similarity index 94%
rename from content/en-us/players/load-screens.md
rename to content/en-us/players/loading-screens.md
index 86f0d8c7e..6b9d1cbbc 100644
--- a/content/en-us/players/load-screens.md
+++ b/content/en-us/players/loading-screens.md
@@ -1,19 +1,19 @@
---
-title: Load screens
+title: Loading Screens
description: Explains the process of customizing the loading screen when users are connecting to your experience.
---
Roblox displays a default loading screen when users are connecting to an experience, but you can personalize your experience with a custom loading screen that contains static or animated content.
-## Add teams
+## Adding Teams
With the `Class.Teams` service present, you can create a new team through the following steps:
@@ -36,7 +36,7 @@ You can now select the new `Class.Team` object and, in the **Properties** window
-## Assign users to teams
+## Assigning Users to Teams
By default, Roblox **auto-assigns** new users joining the experience to the team with the fewest members, and you can still use the following steps to assign users to a specific team:
@@ -48,7 +48,7 @@ By default, Roblox **auto-assigns** new users joining the experience to the team
3. Assign a user to a specific team by changing their `Class.Player.Team` property to the team name in the format of `Teams[name of the team]`, such as `Teams["Blue Team"]`.
-## Spawn teams
+## Spawning Teams
You can use `Class.SpawnLocation` objects to spawn users of different teams at specific locations when they join or respawn. By default, `Class.SpawnLocation|SpawnLocations` are **neutral** and any user can spawn upon them, so you need to lock each one to the team that can occupy it using the following steps:
diff --git a/content/en-us/players/tools.md b/content/en-us/players/tools.md
index 39879fa8f..b181a1447 100644
--- a/content/en-us/players/tools.md
+++ b/content/en-us/players/tools.md
@@ -1,15 +1,15 @@
---
-title: In-experience tools
+title: In-Experience Tools
description: Create in-experience tools for your users.
---
In-experience `Class.Tool|Tools` are interactive tools that users can equip in sessions, such as swords, rocket launchers, and magic wands. You can create customized in-experience tools, put them in your experience hierarchy, and write scripts to implement them for your users.
-## Create an in-Experience Tool
+## Creating an In-Experience Tool
-For the first step of creating any in-experience tool, you need to [create a tool object](#create-the-tool-object) to contain all elements that make up the tool. You can then add other instances to the tool object including [parts and meshes](#add-parts-or-meshes), sound effects, and scripts which provide functionality. You can also set up a [tool handle](#set-the-tool-handle), [adjust the tool grip](#adjust-the-tool-grip-orientation), and [customize your tool icon](#customize-the-tool-icon) to improve the user experience.
+For the first step of creating any in-experience tool, you need to [create a tool object](#creating-the-tool-object) to contain all elements that make up the tool. You can then add other instances to the tool object including [parts and meshes](#adding-parts-or-meshes), sound effects, and scripts which provide functionality. You can also set up a [tool handle](#setting-the-tool-handle), [adjust the tool grip](#adjusting-the-tool-grip-orientation), and [customize your tool icon](#customizing-the-tool-icon) to improve the user experience.
-### Create the tool object
+### Creating the Tool Object
You can create a new tool object with the following steps:
@@ -19,17 +19,17 @@ You can create a new tool object with the following steps:
-### Add parts or meshes
+### Adding Parts or Meshes
-After creating the tool object, you need to add `Class.Part|Parts` or `Class.MeshPart|MeshParts` to the tool model or [create the tool as an inventory item](#create-tools-as-inventory-items) without parts and meshes. Like other models, in-experience tools can consist of multiple `Class.Part|Parts`, so you need to connect all parts of the tool together using the `Class.Weld` constraints.
+After creating the tool object, you need to add `Class.Part|Parts` or `Class.MeshPart|MeshParts` to the tool model or [create the tool as an inventory item](#creating-tools-as-inventory-items) without parts and meshes. Like other models, in-experience tools can consist of multiple `Class.Part|Parts`, so you need to connect all parts of the tool together using the `Class.Weld` constraints.
-## Add tools to your experience
+## Adding Tools to Your Experience
Once you finish setting up your in-experience tool, you need to place it in the proper area of your experience's object hierarchy. Where you place the tool within the experience's object hierarchy depends on it's intended use.
-### Default starting tool
+### Default Starting Tool
If you want all users to start out with a tool in their inventory, put it inside the **StarterPack** folder. When any user spawns, the system copies the tool to their backpack.
-### Collectible tool
+### Collectible Tool
If you want to allow users to collect tools as they move, you can place the tools in the **Workspace** in the **Explorer** hierarchy. For example, you might want to place a super rocket launcher in a hard-to-reach area of your experience world.
-### Earned and purchased tool
+### Earned and Purchased Tool
If you want to set a tool as awards when a user does something special or offer it for sale in an in-experience store, put the tool inside **ServerStorage** in the **Explorer** hierarchy, which can clone the tool to the user's backpack at the proper time.
-## Add tools effects
+## Adding Tools Effects
After adding your tools to your experience, you can add scripts to enable users to use tools to do special effects.
-### Tool-specific events
+### Tool-Specific Events
You can use the following four tool-specific conditions indicating the state of the tool and the user's input with it in your tool script:
@@ -160,7 +160,7 @@ tool.Deactivated:Connect(onDeactivate)
This code sample assumes that the script is a first-level child inside the tool object. If the script is elsewhere, adjust the path on line 1 (the value of `tool`) to point to the core tool object.
-### Add a basic script
+### Adding a Basic Script
The following example shows steps for adding a `Class.Script` on the server that enables users to equip a magic wand that can switch day and night by clicking on the screen:
@@ -189,7 +189,7 @@ The following example shows steps for adding a `Class.Script` on the server that
-### Different types of scripts for tools implementation
+### Different Types of Scripts for Tools Implementation
Some tools only need a `Class.Script` on the server to implement, such as the previous example, but most tools require both a `Class.Script` on the server and a `Class.LocalScript` on the client, where each takes care of certain aspects of the tool's behavior.
@@ -204,8 +204,8 @@ Here are some example tools and their behaviors managed by either a local script
-## Improve acquisition
+## Improving Acquisition
To improve acquisition, you can run an acquisition funnel to identify sources that might drive more traffic or convert better, such as:
- The sources driving **the most number of new users** to your experience.
- The sources with the best **end-to-end conversion rate**.
-### Improve acquisition from Roblox sources
+### Improving Acquisition from Roblox Sources
Among all Roblox sources, **Home** is usually where the vast majority of users find experiences. To improve your experience's discovery on Home:
-1. **Improve engagement and retention.** Get your [session time](../../production/analytics/engagement.md#improve-average-session-time) and [day 1 retention](../../production/analytics/retention.md#improve-day-1-retention) to be comparable or above your similar experience benchmarks. The algorithm cares about these metrics because they signal how engaging and satisfying your experience is for users.
-2. **Optimize monetization.** Get your [payer conversion](../../production/analytics/monetization.md#improve-payer-conversion-rate) rate and [ARPPU](../../production/analytics/monetization.md#improve-average-revenue-per-paying-user-arppu) (average revenue per paying user) to be comparable or above your similar experience benchmarks. The algorithm cares about these metrics because they measure how invested users are in your experience.
+1. **Improve engagement and retention.** Get your [session time](../../production/analytics/engagement.md#improving-average-session-time) and [Day 1 retention](../../production/analytics/retention.md#improving-day-1-retention) to be comparable or above your similar experience benchmarks. The algorithm cares about these metrics because they signal how engaging and satisfying your experience is for users.
+2. **Optimize monetization.** Get your [payer conversion](../../production/analytics/monetization.md#improving-payer-conversion-rate) rate and [ARPPU](../../production/analytics/monetization.md#improving-average-revenue-per-paying-user-arppu) (average revenue per paying user) to be comparable or above your similar experience benchmarks. The algorithm cares about these metrics because they measure how invested users are in your experience.
You can adopt the following strategies to improve the number of users visiting your experience from Roblox sources, including **Home**, **Discover**, and **Search**:
-1. **Improve your retention**: Day 1 retention signals how engaging and satisfying your experience is for users. Experiences with high Day 1 retention are more likely to be featured in **Recommended Experiences**. For more information on improving Day 1 retention, see [Day 1 retention](../../production/analytics/retention.md#improve-day-1-retention).
+1. **Improve your retention**: Day 1 retention signals how engaging and satisfying your experience is for users. Experiences with high Day 1 retention are more likely to be featured in **Recommended Experiences**. For more information on improving Day 1 retention, see [Day 1 Retention](../../production/analytics/retention.md#improving-day-1-retention).
2. **Grow your engagement**. Average session time measures how much time users spend in your experience and signals how much users enjoy your content. Experiences with high average session time are more likely to be featured in **Recommended Experiences**.
For more information on Roblox sources and best practices on improving the discovery of your experience, see [Discovery](../../discovery.md).
-### Improve qualified play through rate from Roblox sources
+### Improving Qualified Play Through Rate from Roblox Sources
You can get more users to convert by making your experience metadata engaging and accurate:
@@ -154,7 +154,7 @@ You can get more users to convert by making your experience metadata engaging an
-## Improve acquisition from external sources
+## Improving Acquisition from External Sources
Here are some tips to get users to visit your experience from external sources:
diff --git a/content/en-us/production/analytics/analytics-dashboard.md b/content/en-us/production/analytics/analytics-dashboard.md
index b78041179..bbe572cdd 100644
--- a/content/en-us/production/analytics/analytics-dashboard.md
+++ b/content/en-us/production/analytics/analytics-dashboard.md
@@ -1,9 +1,9 @@
---
-title: Analytics dashboard
+title: Analytics Dashboard
description: Analytics Dashboard helps you measure and gain insight into your experience's performance.
---
-The **analytics dashboard** helps you measure and gain insight into your experience's performance to adjust content strategies. It visualizes standard key performance indicators (KPIs) of your experience to help you optimize your experience's full lifecycle, including:
+The **Analytics Dashboard** helps you measure and gain insight into your experience's performance to adjust content strategies. It visualizes standard key performance indicators (KPIs) of your experience to help you optimize your experience's full lifecycle, including:
- [Retention](../../production/analytics/retention.md) KPIs that measure how many users return to your experience again after their first visit.
- [Engagement](../../production/analytics/engagement.md) KPIs that reflect how users actively use your experience and represent your core user base.
@@ -12,9 +12,9 @@ The **analytics dashboard** helps you measure and gain insight into your experie
Any experience with more than 10 Daily Active Users (DAU) and 10 play hours for 7 consecutive days is eligible for accessing all KPIs on the dashboard.
-The dashboard also provides [Sales data](#sales-data) that you can download and analyze in custom ways.
+The dashboard also provides [Sales Data](#sales-data) that you can download and analyze in custom ways.
-## Set up analytics dashboard
+## Setting Up Analytics Dashboard
If you are an experience owner or a group owner, and your experience meets the enrollment requirements, you can enroll in the analytics dashboard at any point with the following steps:
@@ -34,17 +34,17 @@ If you don't want to activate the dashboard immediately, or you accidentally dec
For [group](../../projects/groups.md) experiences, only the group owner and members with sufficient permissions can view the analytics dashboard, as some KPIs such as revenue are sensitive information. See [here](../../projects/groups.md#roles-and-permissions) for details on how to create a group role with access to view the dashboard.
-## Dashboard functionalities
+## Dashboard Functionalities
After activating the analytics dashboard, you can view the default charts on the overview and each KPI category. Hover over the **Information Icon** to understand what each chart represents and the **View Icon** to understand how to interpret the summary statistics on the top of each chart.
-There are also functionalities on each dashboard to help you further analyze your experience's performance, such as [filtering by date](#filter-by-date), [exporting charts](#export-a-chart), [benchmarking](#benchmarking), and [viewing KPI Breakdowns](#view-kpi-breakdowns).
+There are also functionalities on each dashboard to help you further analyze your experience's performance, such as [filtering by date](#filtering-by-date), [exporting charts](#exporting-a-chart), [benchmarking](#benchmarking), and [viewing KPI Breakdowns](#viewing-kpi-breakdowns).
-### Filter by date
+### Filtering by Date
You can apply a date filter to view the chart for a date range by separately selecting any specific time frame between the first date that the data was available and the present day as the start and the end date.
-### Filter by metrics
+### Filtering by Metrics
You can apply various filters to better understand your cohorts by clicking the **Filter By** button. Filters apply to all charts across all analytics pages until they are turned off.
@@ -56,13 +56,13 @@ You can filter by the following metrics:
-## Use custom fields
+## Using Custom Fields
Custom events also allow breaking down on custom fields to support easier comparison between segments. For example, you can provide quest names to each event to see which ones users prefer the most, or attach player class to see if a class has a significantly higher kill/death ratio.
@@ -76,9 +76,9 @@ You should use custom fields whenever possible instead of event names, since the
For example, instead of `PlantCabbage`, `PlantTurnip`, `PlantPepper` as three separate events, you could have a single event with the name `PlantSeed` and custom field values `Plant - Cabbage`, `Plant - Turnip`, and `Plant - Pepper`. This way you can visualize both the total number of seeds planted as well as compare each plant in the same visualization. This also reduces your event name cardinality.
-For more information, see [Custom fields](./custom-fields.md).
+For more information, see [custom fields](./custom-fields.md).
-## Use custom events to grow your experience
+## Using Custom Events to Grow Your Experience
Custom events enable you to track metrics that matter most to your game, providing insights into how players interact with specific features and content. Use these events to uncover patterns in player behavior and optimize your core game loop.
@@ -87,5 +87,5 @@ In the reference game [Plant](../../resources/plant-reference-project.md), the c
- Try to improve the diversity of content within your experience and encourage players to explore other options as part of the [core loop](../game-design/core-loops.md) to prevent repetitiveness.
-- Explore why users significantly prefer turnips over other plants, and if there are any imbalances that turnips are causing (such as with [economy events](./economy-events.md)).
+- Explore why users significantly prefer turnips over other plants, and if there are any imbalances that turnips are causing (such as with [Economy Events](./economy-events.md)).
- Add more event tracking within your loop, such as planting seeds, watering plants, and going to the shop, to better track player behavior and other areas of improvement.
diff --git a/content/en-us/production/analytics/custom-fields.md b/content/en-us/production/analytics/custom-fields.md
index b0a35c627..acb924cdc 100644
--- a/content/en-us/production/analytics/custom-fields.md
+++ b/content/en-us/production/analytics/custom-fields.md
@@ -1,9 +1,9 @@
---
-title: Custom fields
+title: Custom Fields
description: Use custom fields as an additional analytics tool to track unique milestones in your experience.
---
-You can use up to 3 **custom fields** to filter your [economy](./economy-events.md), [funnel](./funnel-events.md), and [custom](./custom-events.md) events by unique dimensions specific to your experience. Some examples include:
+You can use up to 3 **custom fields** to filter your [Economy](./economy-events.md), [Funnel](./funnel-events.md), and [Custom](./custom-events.md) events by unique dimensions specific to your experience. Some examples include:
- Levels — 1, 2, 3, . . .
- Player class — Warrior, Mage, Archer
diff --git a/content/en-us/production/analytics/economy-events.md b/content/en-us/production/analytics/economy-events.md
index 6f5917b64..762bd722a 100644
--- a/content/en-us/production/analytics/economy-events.md
+++ b/content/en-us/production/analytics/economy-events.md
@@ -1,5 +1,5 @@
---
-title: Economy events
+title: Economy Events
description: Use economy events to visualize your experience's economy and track user sources, sinks and wallets.
---
@@ -11,7 +11,7 @@ description: Use economy events to visualize your experience's economy and track
Once your experience begins tracking Economy events, you'll unlock the Economy page of the Analytics dashboard on the Creator Hub.
-## Track economy events
+## Tracking Economy Events
To unlock the Economy dashboard, you need to track some economy events in your experience. Start by identifying where users **source** (i.e. gain) and **sink** (i.e. spend) resources in your experience. These are represented in code by `Enum.AnalyticsEconomyFlowType`, which can be either `Source` or `Sink`.
@@ -19,7 +19,7 @@ To unlock the Economy dashboard, you need to track some economy events in your e
Events can only be sent from the server and in published experiences. Events can't be sent from the client or Studio.
-### Transaction types
+### Transaction Types
Each source and sink event requires a transaction type, encoded with `Enum.AnalyticsEconomyTransactionType`. By default, the options are:
@@ -32,7 +32,7 @@ Each source and sink event requires a transaction type, encoded with `Enum.Analy
These types appear on the dashboard. It's a good idea to start with the default categories, but if you need to you can also provide your own transaction type names when logging an event.
-### Track sources
+### Tracking Sources
The following sample uses `Class.AnalyticsService.LogEconomyEvent` to log two different economy events when users complete the first and second levels in the experience and earn some coins.
@@ -76,7 +76,7 @@ AnalyticsService:LogEconomyEvent(
)
```
-### Track sinks
+### Tracking Sinks
The following sample logs an event when users spend coins to buy a `DoubleJumpUpgrade`. Note the `Sink` flow type and the `Shop` transaction type when compared to the source tracking samples.
@@ -97,9 +97,9 @@ AnalyticsService:LogEconomyEvent(
)
```
-For information on `Class.AnalyticsService` limitations, see [Event tracking limitations](./event-types.md#event-tracking-limitations).
+For information on `Class.AnalyticsService` limitations, see [event tracking limitations](./event-types.md#event-tracking-limitations).
-## Use custom fields
+## Using Custom Fields
Economy events also allow breaking down on custom fields to support easier comparison between segments. For example, you can provide quest names to each event to see which ones users are making the most money from, or attach store locations to see if users prefer one location over another.
@@ -107,9 +107,9 @@ You can breakdown by custom fields by using the breakdown selector.
-For more information, see [Custom fields](./custom-fields.md).
+For more information, see [custom fields](./custom-fields.md).
-## Use economy to grow your experience
+## Using Economy to Grow Your Experience
The Economy dashboard includes five charts to help you take action to grow your revenue. You can add up to five currencies of resources, and all charts can be filtered by gender, age group, platform, OS, and up to three custom fields specific to your experience.
@@ -129,4 +129,4 @@ The Economy dashboard includes five charts to help you take action to grow your
-For more tips on how to balance your in-experience economy, see [Balance virtual economies](../game-design/balance-virtual-economies.md).
+For more tips on how to balance your in-experience economy, see [Balancing Virtual Economies](../game-design/balancing-virtual-economies.md).
diff --git a/content/en-us/production/analytics/engagement.md b/content/en-us/production/analytics/engagement.md
index 4e9106250..998ac9b7f 100644
--- a/content/en-us/production/analytics/engagement.md
+++ b/content/en-us/production/analytics/engagement.md
@@ -9,20 +9,20 @@ description: Explains how to improve engagement metrics for your experience.
**Engagement** measures how engaging your experience is for users.
-## View engagement metrics
+## Viewing Engagement Metrics
To view your experience's engagement analytics:
1. Navigate to your [Creations](https://create.roblox.com/dashboard/creations) page on **Creator Dashboard** and select your experience.
1. In the **Analytics** menu on the left, select **Engagement**.
-You can view analytics for individual or group owned experience. To view the latter, you need to have [group permissions for analytics](../../production/analytics/analytics-dashboard.md).
+You can view analytics for individual or group owned experience. To view the latter, you need to have [group permissions for analytics](../../production/analytics/analytics-dashboard.md#granting-group-permission).
-## Improve average session time
+## Improving Average Session Time
Average session time is the total time users spend in your experience divided by the number of sessions. It's a key metric that's closely tied to retention. To ensure that users are having meaningful sessions, you need to focus on the efficiency and effectiveness of engaging your users.
-### Get users into the fun immediately
+### Getting Users Into the Fun Immediately
Usually, the friction of joining and leaving an experience is very low on Roblox, so first impressions are extremely important, and you want to get users into the fun part of your experience as fast as possible with the following strategies:
@@ -34,7 +34,7 @@ Usually, the friction of joining and leaving an experience is very low on Roblox
-### Give users a reason to keep coming back
+### Give Users a Reason to Keep Coming Back
Regardless of what type of experiences you are designing, you want to design for repeat visits. You can adopt the following strategies to motivate your users to continually use your experience:
@@ -42,7 +42,7 @@ Regardless of what type of experiences you are designing, you want to design for
2. **Add a progression system to make content last**: Progression systems give users a clear path toward their goals and can make content last longer, so you have time to make more content before users unlock them.
3. **Balance the progression system to not gate off the fun**: If you add progression, make sure there is still enough content available upfront to ensure new users can still have fun in their first session.
-### Monitor your experience's performance
+### Monitor Your Experience's Performance
Performance is how well your experience runs on different devices and platforms. To improve your experience's performance:
@@ -52,7 +52,7 @@ Performance is how well your experience runs on different devices and platforms.
You can grow your experience faster if it's more engaging to both new and existing users. For more information on retaining your users for engagement, see [Retention](../../production/analytics/retention.md).
-## Improve new user first session retention
+## Improving New User First Session Retention
The New User First Session Retention chart shows how many new users are still playing X minutes after joining your experience for the first time. It compares the current period with the previous period. You can use it to generate insights and catch issues with your experience's onboarding.
diff --git a/content/en-us/production/analytics/error-report.md b/content/en-us/production/analytics/error-report.md
index e42a89438..2f2a183f8 100644
--- a/content/en-us/production/analytics/error-report.md
+++ b/content/en-us/production/analytics/error-report.md
@@ -1,20 +1,20 @@
---
-title: Error report
+title: Error Report
description: Explains how error reports can help you improve your experience.
---
**Error report** lets you view up-to-the-minute Lua system errors and warnings for both server and client. Monitor your error report before and after updating your experience to identify potential issues early.
-## View your error report
+## Viewing Your Error Report
To view your experience's error report:
- Navigate to your [Creations](https://create.roblox.com/dashboard/creations) page in the **Creator Dashboard** and select your experience.
- Select **Error Report**.
-You can view analytics for individual or group owned experience. To view the latter, you need to have [group permissions for analytics](../../production/analytics/analytics-dashboard.md).
+You can view analytics for individual or group owned experience. To view the latter, you need to have [group permissions for analytics](../../production/analytics/analytics-dashboard.md#granting-group-permission).
-## Monitor errors and warnings
+## Monitoring Errors and Warnings
You can apply the following filters and toggles to your error report:
@@ -30,7 +30,7 @@ Below the filters and toggles, a chart displays the numbers of errors and warnin
-## Event types
+## Event Types
Roblox provides three sets of analytic dashboards you can use to track different aspects of your experience:
@@ -35,11 +35,11 @@ Roblox provides three sets of analytic dashboards you can use to track different
- **User Behavior** — What is the most frequently used ability on each map?
- **Core Loop** — How do kill/death ratios compare across different weapons?
-For more information on setting up these dashboards, see [Economy events](./economy-events.md), [Funnel events](./funnel-events.md) and [Custom events](./custom-events.md).
+For more information on setting up these dashboards, see [Economy Events](./economy-events.md), [Funnel Events](./funnel-events.md) and [Custom Events](./custom-events.md).
-## Validate your event tracking
+## Validating Your Event Tracking
-Once you add [economy](./economy-events.md), [funnel](./funnel-events.md), or [custom](./custom-events.md) events to your experience, charts on the respective pages typically take 24 hours to appear. In the meantime, you can check if events are set up correctly using the **View Events** tool:
+Once you add [Economy](./economy-events.md), [Funnel](./funnel-events.md), or [Custom](./custom-events.md) events to your experience, charts on the respective pages typically take 24 hours to appear. In the meantime, you can check if events are set up correctly using the **View Events** tool:
1. Navigate to the **Economy**, **Funnel**, or **Custom** pages of your Analytics dashboard for your experience.
2. Click the **View Events** button at the top of each page. A near real-time list of the most recent events displays.
@@ -49,7 +49,7 @@ Once you add [economy](./economy-events.md), [funnel](./funnel-events.md), or [c
You can also visit your experience's [error report](./error-report.md) to see if there are any errors with your event tracking.
-## Event tracking limitations
+## Event Tracking Limitations
The following limitations apply when tracking your events with `Class.AnalyticsService`:
@@ -65,7 +65,7 @@ For example, instead of tracking `WarriorXP`, `MageXP`, `PaladinXP` as separate
-## Protect your funnels from exploiters
+## Protecting your Funnels From Exploiters
In order to keep your data clean, it is important to add some level of data validation in your server code to prevent exploiters from sending invalid data to your analytics service.
@@ -176,7 +176,7 @@ end
onboardingEvent.OnServerEvent:Connect(onPlayerEventFired)
```
-## Use custom fields
+## Using Custom Fields
Funnel events also allow breaking down on custom fields to support easier comparison between segments. For example, you can track which starter car gives players the best progression, or attach different maps to see if a certain map has a better game loop than others.
@@ -184,7 +184,7 @@ Funnel events also allow breaking down on custom fields to support easier compar
For more information, see [custom fields](./custom-fields.md).
-## Use funnels to grow your experience
+## Using Funnels to Grow Your Experience
One of the most important funnels to track is onboarding because many experiences struggle with new user retention and engagement.
diff --git a/content/en-us/production/analytics/index.md b/content/en-us/production/analytics/index.md
index 87475e70c..e69d04982 100644
--- a/content/en-us/production/analytics/index.md
+++ b/content/en-us/production/analytics/index.md
@@ -5,7 +5,7 @@ description: An overview of analytics features to track an experience's growth,
Roblox offers a variety of analytics features to help you chart your experience's growth, track user behavior and retention, and find opportunities for optimization. You can use analytics to understand what actions you can take to grow your experience.
-## Grow your experience with analytics
+## Growing Your Experience with Analytics
Consider following this 3-step plan to use analytics to grow your experience:
@@ -72,7 +72,7 @@ Your similar experience benchmarks are updated daily. Roblox does not use these
- Monitor the analytics of multiple experiences at once
- Track avatar item sales and revenue
-### Monitor experiences
+### Monitoring Experiences
You can monitor the analytics of up to nine Roblox experiences by putting them into a **watchlist**. If you have analytics permissions for the experience, your watchlist provides the following analytics at a glance:
@@ -97,9 +97,9 @@ Watchlists are applied on the account level, are private, and persist when toggl
-### Achievement panel
+### Achievement Panel
Your achievement panel highlights key metric milestones that you've reached over the past 6 months. This insight is meant to help you celebrate progress when a metric has reached a six month high. Note that if a metric is at a six month high but below benchmark comparisons, you should still continue to improve it.
@@ -130,4 +130,4 @@ Your achievement panel highlights key metric milestones that you've reached over
-For more information on how analytics works, see [Analytics dashboard](../../production/analytics/analytics-dashboard.md). For more information on how to use analytics to optimize your experience's design, see [Analytics essentials](../../production/game-design/analytics-essentials.md).
+For more information on how analytics works, see [Analytics Dashboard](../../production/analytics/analytics-dashboard.md). For more information on how to use analytics to optimize your experience's design, see [Analytics Essentials](../../production/game-design/analytics-essentials.md).
diff --git a/content/en-us/production/analytics/monetization.md b/content/en-us/production/analytics/monetization.md
index 5ed8bab25..ae6436be5 100644
--- a/content/en-us/production/analytics/monetization.md
+++ b/content/en-us/production/analytics/monetization.md
@@ -9,7 +9,7 @@ description: Explains how to improve monetization metrics for your experience.
**Monetization** measures your experience's ability to generate revenue.
-## View monetization metrics
+## Viewing Monetization Metrics
To view your experience's monetization analytics:
@@ -18,7 +18,7 @@ To view your experience's monetization analytics:
2. In the **Monetization** menu, select **Overview**.
-You can view analytics for individual or group owned experience. To view the latter, you need to have [group permissions for analytics](../../production/analytics/analytics-dashboard.md#grant-group-permission).
+You can view analytics for individual or group owned experience. To view the latter, you need to have [group permissions for analytics](../../production/analytics/analytics-dashboard.md#granting-group-permission).
On the monetization page, you can see the following metrics:
@@ -32,14 +32,14 @@ On the monetization page, you can see the following metrics:
From there, you can explore data for each monetization product:
-- [Developer products](../monetization/developer-products.md#developer-product-analytics)
+- [Developer Products](../monetization/developer-products.md#developer-product-analytics)
- [Passes](../monetization/game-passes.md#passes-analytics)
-- [Avatar items](../monetization/avatar-items.md#avatar-items-analytics)
+- [Avatar Items](../monetization/avatar-items.md#avatar-items-analytics)
- [Subscriptions](../monetization/subscriptions.md#subscription-analytics)
-- [Immersive ads](../monetization/immersive-ads.md#view-immersive-ad-metrics)
-- [Engagement payouts](../monetization/engagement-based-payouts.md#access-payout-data)
+- [Immersive Ads](../monetization/immersive-ads.md#viewing-immersive-ad-metrics)
+- [Engagement Payouts](../monetization/engagement-based-payouts.md#accessing-payout-data)
-## Improve revenue
+## Improving Revenue
Here are some high level tips for growing your revenue:
@@ -52,7 +52,7 @@ Devote as much creativity and attention to your storefront as you do to the rest
-## Improve payer conversion rate
+## Improving Payer Conversion Rate
Payer conversion measures the percent of your users who engage with your paid features or content.
@@ -64,7 +64,7 @@ To improve this metric:
-## Improve average revenue per paying user (ARPPU)
+## Improving Average Revenue per Paying User (ARPPU)
ARPPU measures the spending behavior of your repeat purchasers.
@@ -74,7 +74,7 @@ To improve this metric:
2. **Provide a variety of purchasable items**. If you only have a limited number of sales items available, users might not have anything new to purchase even if they're interested in buying something new. You can find your top-selling items and expand those offerings to provide more options for users.
3. **Add seasonal items**. Seasonal items can create a sense of fun and excitement around particular holidays or real-world events.
-## Improve average revenue per daily active users (ARPDAU)
+## Improving Average Revenue per Daily Active Users (ARPDAU)
ARPDAU is a combination of your payer conversion rate and your ARPPU.
diff --git a/content/en-us/production/analytics/performance.md b/content/en-us/production/analytics/performance.md
index 0946be3c5..762ec356a 100644
--- a/content/en-us/production/analytics/performance.md
+++ b/content/en-us/production/analytics/performance.md
@@ -1,5 +1,5 @@
---
-title: Performance dashboard
+title: Performance Dashboard
description: Explains how to improve performance analytics metrics for your experience.
---
@@ -7,16 +7,16 @@ The **Performance** dashboard provides up-to-the-minute client and server metric
-## Access the dashboard
+## Accessing the Dashboard
-To access the Performance page, you must either be the experience owner or have [analytics group permissions](../../production/analytics/analytics-dashboard.md#grant-group-permission).
+To access the Performance page, you must either be the experience owner or have [analytics group permissions](../../production/analytics/analytics-dashboard.md#granting-group-permission).
1. Navigate to the [Creations](https://create.roblox.com/dashboard/creations) page on the **Creator Hub**.
2. Under the **Creator Hub** dropdown, select your account or the group that owns the experience.
3. Select the experience.
4. In the **Monitoring** dropdown, select **Performance**.
-## Use the dashboard
+## Using the Dashboard
The dashboard begins with the current number of users, the number of servers they are spread across, and a device breakdown. For the dashboard to show client and server **charts** like the ones below, your experience must have at least 100 daily active users (DAU).
@@ -38,7 +38,7 @@ When reviewing charts or filtering:
Percentile values are calculated smallest to largest, so for metrics where lower numbers are better (e.g. server CPU time), P10 represents the "best case" and P90 the "worst case" rather than the other way around.
-## Client charts
+## Client Charts
The **Client** tab includes the following charts, all of which are broken down by platform or operating system:
@@ -77,7 +77,7 @@ The **Client** tab includes the following charts, all of which are broken down b
-## Find assets
+## Finding Assets
With millions of assets available, it's helpful to narrow the search results to find exactly what you are looking for. To find a specific asset:
@@ -56,7 +56,7 @@ The Creator Store curates a selection of assets according to your filters.
-### Community ratings
+### Community Ratings
In addition to the Creator Store's filters, you can view an asset's community approval when you hover over its tile. There are four asset community ratings:
@@ -65,14 +65,14 @@ In addition to the Creator Store's filters, you can view an asset's community ap
- **Yellow** - The asset has moderate community confidence.
- **Green** - The asset has high community confidence.
-### Trusted reviews
+### Trusted Reviews
Users can now leave reviews on Creator Store assets in addition to the currently available thumbs up or down ratings. To improve reliability and ensure authentic feedback, only users that acquire the asset are able to submit reviews. After submitting a review:
- Asset creators can respond to reviews, closing the feedback loop.
- The community can mark reviews as helpful for future users.
-## Add assets to experiences
+## Adding Assets to Experiences
To add an asset to your experience from the [Toolbox](../projects/assets/toolbox.md), click it or drag‑and‑drop it into the 3D viewport.
@@ -84,7 +84,7 @@ To add an asset to your experience from the [Toolbox](../projects/assets/toolbox
Some assets include scripts that perform specific actions, such as animating at runtime or triggering a sound. If you want to use an asset without allowing any of its scripts to run, right-click the object in the [Explorer](../studio/explorer.md) window and select **Disable Scripts** from the context menu.
-## Verify your account
+## Verifying Your Account
In addition to being able to distribute more of each asset type, verifying your account ensures that you are eligible to distribute audio assets under 10 seconds, and that your assets are visible to creators, as the default option for discoverability for assets on the Creator Store is reserved for verified accounts. In order to verify your account, you must:
@@ -92,15 +92,15 @@ In addition to being able to distribute more of each asset type, verifying your
- Have a government-issued photo ID with your picture on it, such as a driver's license, passport, or residency permit.
- Have a mobile device with a camera that can take photos of your face and ID.
-For information on how to verify your account either through a government-issued ID or through a phone number, see [Account verification](../production/publishing/account-verification.md).
+For information on how to verify your account either through a government-issued ID or through a phone number, see [Account Verification](../production/publishing/account-verification.md).
2. Right-click the asset you'd like to distribute and select **Edit Asset**.
3. In the **Asset Configuration** window that opens, confirm and/or update asset details such as **Title** and **Description**.
4. Click **Save**. Once the asset has uploaded, click the dashboard link formatted as `https://create.roblox.com/dashboard/creations/store/.../configure`.
-5. In the browser window that opens, follow the instructions [through the Creator Dashboard](#through-creator-dashboard).
+5. In the browser window that opens, follow the instructions above in [Through Creator Dashboard](#through-creator-dashboard).
@@ -49,11 +49,11 @@ After deciding how to communicate your event to players, be intentional with des
> Take the time to design an impactful and memorable start to an event to inspire players and ensure sure they're excited about the event, will want to engage with it, and keep coming back after the event is over.
-## Monitor and analyze
+## Monitor and Analyze
When designing LiveOps for your experience, monitor your experience effectively by accessing comprehensive data, such as the sources of and spending of your experience's currency and other relevant resources. Integrate tracking into your experience's design to understand how players interact with your features.
-For more about monitoring the impact your events have on your economy, see [Balance virtual economies](./balance-virtual-economies.md).
+For more about monitoring the impact your events have on your economy, see [Balancing Virtual Economies](./balancing-virtual-economies.md).
When tracking data, make sure it's:
@@ -67,4 +67,4 @@ Comparing your event's data to the week before the event and the week after help
If the event had a lasting impact, determine whether it was positive or negative, and if your findings impact how you'll design future events to achieve your desired outcome.
-For additional information and best practices on how to design optimal events, see [LiveOps essentials](./liveops-essentials.md).
+For additional information and best practices on how to design optimal events, see [LiveOps Essentials](./liveops-essentials.md).
diff --git a/content/en-us/production/game-design/monetization-foundations.md b/content/en-us/production/game-design/monetization-foundations.md
index 94adaf1ff..bf83fe2f9 100644
--- a/content/en-us/production/game-design/monetization-foundations.md
+++ b/content/en-us/production/game-design/monetization-foundations.md
@@ -1,6 +1,6 @@
---
-title: Monetization foundations
-description: Monetization foundations
+title: Monetization Foundations
+description: Monetization Foundations
---
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
@@ -100,7 +100,7 @@ To learn more about content cadences, see [Content updates](https://create.roblo
Depending on the items you offer, it could be beneficial to mix both durable and consumable items in these packs, but be intentional with the amount of durable items you include. Because durable items don't expire, overrelying on them can force you into a cycle of constantly designing new ones. The key to a successful item pack lies in the perceived value and positive impact on the player's experience. Instead of filling your packs with random items, fill them with intentionally designed items that your players will anticipate and appreciate each month.
-### Membership and VIP benefits
+### Membership and VIP Benefits
**Membership** and **VIP benefit** rewards are another way to merchandise packs of items, currency, and content access. They are conceptually similar to bundles. Subscriptions are the optimal method for providing this reward, as their monthly value is equivalent to a one-time purchase.
@@ -115,7 +115,7 @@ Depending on the items you offer, it could be beneficial to mix both durable and
-## Enable translations
+## Enabling Translations
Once strings are captured to your localization table, follow these steps to enable translated content:
@@ -83,7 +83,7 @@ Once strings are captured to your localization table, follow these steps to enab
-### Automatic translation quotas
+### Automatic Translation Quotas
Roblox has initial and monthly quotas for automatic translation. The initial quota determines how many string entries you can translate when you localize your experience for the first time. After you use up the initial quota, any subsequent translations come from your monthly quota, which resets every month.
@@ -94,7 +94,7 @@ You can track your automatic translation quota usage on your experience's locali
Quotas are calculated on a **per-character** and **per-language basis**. For example, translating the source string "hello" into all 15 automatic translation-supported languages will count as 5×15 (75) characters towards your quota.
-### Automatic translation updates
+### Automatic Translation Updates
As the automatic translation tool improves, more accurate translations may become available for existing strings. When these updates become available, Roblox refreshes any automatic translations. Automatic translation updates will appear in your translation history.
@@ -112,22 +112,22 @@ By locking an entry, you are approving the translation and turning it into a man
By default, manually added strings and strings with manual translations are locked. If you unlock an entry, it will be impacted by both automatic translation updates and ATC if it is enabled. If you want to generate a new automatic translation for a previously changed or cleared translation, unlock the entry.
-## Supported languages
+## Supported Languages
Roblox supports automatic translation between the languages listed below. Currently, Roblox Translate will always assume that source strings are in the [experience source language](./index.md#setting-source-language).
-## Localization settings
+## Localization Settings
Your experience's localization settings is the starting place for enabling
translations and accessing your localization tools. You'll need to set your
-[source](#set-source-language) and [supported](#set-supported-languages)
+[source](#setting-source-language) and [supported](#setting-supported-languages)
languages before starting any localization to a new language.
The localization page also includes tools to start translating your experiences, add translation collaborators and download translation analytics.
@@ -44,7 +44,7 @@ A link to your experience's localization settings is also available in Studio. T
src="../../assets/localization/Game-Settings-Configure-Localization.png"
width="800" />
-### Set source language
+### Setting Source Language
Before you can start any localization, Roblox needs to know which language you
are translating from and which languages you are translating to.
@@ -64,7 +64,7 @@ To set the **source** language:
2. Select a language from the list.
3. Click **Confirm** to add the language.
-### Set supported languages
+### Setting Supported Languages
The **supported languages** are the languages you intend to provide translations
for. You can have multiple supported languages for your experience. See
@@ -85,20 +85,20 @@ To set the **supported** languages:
4. Click **Confirm** to add the language.
-## Automatic translations
+## Automatic Translations
-Roblox's automatic translation tool is available on any experience and allows you to immediately begin localizing the strings in your experience and broadening your potential audience. In many cases, you can start making significant progress on your localization journey using automatic translations before adding [custom translations](#custom-translations) or working with [manual translators](#work-with-translators).
+Roblox's automatic translation tool is available on any experience and allows you to immediately begin localizing the strings in your experience and broadening your potential audience. In many cases, you can start making significant progress on your localization journey using automatic translations before adding [custom translations](#custom-translations) or working with [manual translators](#working-with-translators).
-For more information on enabling automatic translations in your experience, see [Automatic translations](../../production/localization/automatic-translations.md).
+For more information on enabling automatic translations in your experience, see [Automatic Translations](../../production/localization/automatic-translations.md).
-## Custom translations
+## Custom Translations
Apply various customizations to your translations to improve and expand your experience's localization. You, or any assigned translator, can manually add and modify translations to your experience's translation table. You can also access this table programmatically, allowing you to create contextual translations, switch out images or assets based on language, or even manually display translations from a different language.
-For more information on custom translation use-cases, see [Translate in-experience content](../../production/localization/custom-translations.md).
+For more information on custom translation use-cases, see [Translating In-Experience Content](../../production/localization/custom-translations.md).
-## Work with translators
+## Working with Translators
Add Roblox users as translators for your experience to help you review and polish automatic translations or provide and edit manual translations.
-You can download monthly analytics to track your translation coverage and the contribution of your translators. For more information on working with localization contributors, see [Work with translators](../../production/localization/work-with-translators.md).
+You can download monthly analytics to track your translation coverage and the contribution of your translators. For more information on working with localization contributors, see [Working with Translators](../../production/localization/working-with-translators.md).
diff --git a/content/en-us/production/localization/language-codes.md b/content/en-us/production/localization/language-codes.md
index 6dfd85c7c..282f7a239 100644
--- a/content/en-us/production/localization/language-codes.md
+++ b/content/en-us/production/localization/language-codes.md
@@ -1,6 +1,6 @@
---
-title: Language codes
-description: Language codes are languages you can specify by locale ID to support multi-lingual support.
+title: Language Codes
+description: Language Codes are languages you can specify by locale ID to support multi-lingual support.
---
You can specify languages by their language code or locale ID. Refer to the following table for a list of language codes and locale IDs that you can currently support in your localization tables on Roblox:
@@ -9,7 +9,7 @@ You can specify languages by their language code or locale ID. Refer to the foll
-#### Add experience product translations
+#### Adding Experience Product Translations
You can modify experience product details, such as developer [products](../../production/monetization/developer-products.md), [game passes](../../production/monetization/game-passes.md), and [badges](../../production/publishing/badges.md):
@@ -255,7 +255,7 @@ You can modify experience product details, such as developer [products](../../pr
-### With file upload
+### With File Upload
Using Studio or Creator Hub, you can download, modify, and re-upload your localization table as a `.csv` spreadsheet. This is helpful when editing several translations at a time or when collaborating with translators outside of Roblox.
@@ -268,7 +268,7 @@ When modifying or adding translations with file upload, the following behavior a
7. When complete, verify the **Creation Advance** and **Creation Fee** calculations and select **Create Token** to submit your purchase.
-8. You can now access the created token in the experience's **avatar creation tokens** settings. To implement `Class.AvatarCreationService.PromptCreateAvatarAsync|PromptCreateAvatarAsync`, you'll need the token ID which you can access by selecting the three dots on the thumbnail and selecting **Copy Token ID**.
+8. You can now access the created token in the experience's **Avatar Creation Tokens** settings. To implement `Class.AvatarCreationService.PromptCreateAvatarAsync|PromptCreateAvatarAsync`, you'll need the token ID which you can access by selecting the three dots on the thumbnail and selecting **Copy Token ID**.
diff --git a/content/en-us/production/monetization/avatar-items.md b/content/en-us/production/monetization/avatar-items.md
index fbe14aedb..1be9124c5 100644
--- a/content/en-us/production/monetization/avatar-items.md
+++ b/content/en-us/production/monetization/avatar-items.md
@@ -1,5 +1,5 @@
---
-title: Avatar items
+title: Avatar Items
description: Sell community created Avatar items exclusively through your experience.
---
@@ -13,24 +13,24 @@ By selling unique avatar items in your experience, you can create experience-spe
For information on how to create and sell your own avatar items, which requires third-party software such as Blender or Maya, see Roblox's [Avatar](../../avatar/index.md) documentation.
-## Enable in-experience sales
+## Enabling In-Experience Sales
To set an avatar item on sale, the item creator and the experience owner must perform the following:
-1. The **item creator** must [add the experience's Place ID](#add-place-id) to their item's sale location data.
-2. The **experience owner** must [add the avatar item's Asset ID](#add-items-to-experience) and enable the item.
+1. The **item creator** must [add the experience's Place ID](#adding-place-id) to their item's sale location data.
+2. The **experience owner** must [add the avatar item's Asset ID](#adding-items-to-experience) and enable the item.
1. If the experience owner and the item creator are the same person, Roblox automatically adds and enables the asset to the experience after setting the sale location.
-### Add place ID
+### Adding Place ID
Before enabling an avatar item sale in your experience, the creator of the item must add the experience's starting place ID to the avatar item's sales location.
1. Open the [Creations](https://create.roblox.com/dashboard/creations) page on **Creator Dashboard**.
2. Click the **⋯** in the corner of the experience's thumbnail and select **Copy Start Place ID**.
-3. As the item creator, [update your item's marketplace settings](../../marketplace/publish-to-marketplace.md#marketplace-settings) and add the Place ID to the item's Sale Location field.
+3. As the item creator, [update your item's marketplace settings](../../marketplace/publishing-to-marketplace.md#marketplace-settings) and add the Place ID to the item's Sale Location field.
-### Add items to experience
+### Adding Items to Experience
After the item creator adds your experience to the asset's sale location, you can now enable the item for the experience.
@@ -47,7 +47,7 @@ To search and enable an asset for sale:
-## Avatar items analytics
+## Avatar Items Analytics
Avatar Items analytics help you gauge the success of individual Avatar Items, identify trends, and forecast potential future earnings.
diff --git a/content/en-us/production/monetization/business-resources.md b/content/en-us/production/monetization/business-resources.md
index 888682d09..dc5618d77 100644
--- a/content/en-us/production/monetization/business-resources.md
+++ b/content/en-us/production/monetization/business-resources.md
@@ -1,5 +1,5 @@
---
-title: Build your business
+title: Building Your Business
description: Explains the resources that can help you run and build businesses on Roblox.
---
@@ -7,19 +7,19 @@ See the following resources to help you run and build businesses on Roblox.
## Videos
-### Grow bigger developer studios
+### Growing Bigger Developer Studios
Learn how to create partnerships with developers and grow your team.
-### Tips for scaling up a company on Roblox
+### Tips For Scaling Up a Company on Roblox
Get tips and lessons Nathan learned while scaling up a company on Roblox.
-### Protect you and your business
+### Protecting You and Your Business
How to protect yourself, your business, and your intellectual property.
diff --git a/content/en-us/production/monetization/developer-products.md b/content/en-us/production/monetization/developer-products.md
index 22235ccfd..bd77f4f87 100644
--- a/content/en-us/production/monetization/developer-products.md
+++ b/content/en-us/production/monetization/developer-products.md
@@ -1,5 +1,5 @@
---
-title: Developer products
+title: Developer Products
description: Developer products let you charge users a Robux fee for items or abilities that they can access and use inside your experience.
---
@@ -11,10 +11,10 @@ A **developer product** is an item or ability that a user can purchase more than
For items or abilities that a user should only purchase **once**, such as a special weapon or a permanent power-up, see [Passes](../../production/monetization/game-passes.md).
-## Create developer products
+## Creating Developer Products
-## Sell developer products
+## Selling Developer Products
-### Engagement payouts
+### Engagement Payouts
The **Engagement-Based Payouts** charts track payout data based on the following metrics:
@@ -34,7 +34,7 @@ The **Engagement-Based Payouts** charts track payout data based on the following
Note that the dotted "projected earnings" line becomes solid after the payout amount is final, at which point Roblox adds the payout to your **Pending Robux** amount [here](https://www.roblox.com/transactions).
-## Sell passes
+## Selling Passes
- 
-### Developer products
+### Developer Products
-A [developer product](../../production/monetization/developer-products.md) is an item or ability that a user can purchase more than once, such as in-experience currency, ammo, or potions. You can prompt purchases, record them, and get product information through scripting.
+A [Developer Product](../../production/monetization/developer-products.md) is an item or ability that a user can purchase more than once, such as in-experience currency, ammo, or potions. You can prompt purchases, record them, and get product information through scripting.
-### Price optimization
+### Price Optimization
[Price optimization](../../production/monetization/price-optimization.md) lets you find the best price points for your passes and developer products, which can help you earn more money over time while keeping your prices competitive.
-### Engagement-based payouts
+### Engagement-Based Payouts
-[Engagement-based payouts](../../production/monetization/engagement-based-payouts.md) allow you to automatically earn Robux based on the share of time that [Premium](https://www.roblox.com/premium/membership) subscribers engage in your experiences.
+[Engagement-Based Payouts](../../production/monetization/engagement-based-payouts.md) allow you to automatically earn Robux based on the share of time that [Premium](https://www.roblox.com/premium/membership) subscribers engage in your experiences.
-### Paid access in Robux
+### Paid Access in Robux
[Paid access in Robux](../../production/monetization/paid-access-robux.md) allows you to charge users a **one-time Robux fee** to access your experience. Some developers temporarily use this feature to create a closed beta where their most engaged users can have early access to an experience and help with testing and feedback.
-### Paid access in local currency
+### Paid Access in Local Currency
[Paid access in local currency](../../production/monetization/paid-access-local-currency.md) allows you to charge users a **one-time fee in their local currency** to access your experience. If their local currency isn't available, they're charged in USD. Some developers temporarily use this feature to create a closed beta where their most engaged users can have early access to an experience and help with testing and feedback.
-### Private servers
+### Private Servers
A [private server](../../production/monetization/private-servers.md) is a subscription-based feature that allows a user to decide who can play an experience with them. While private servers can be free, you can also use private servers as a method of monetization by charging users who want to access private servers a **monthly Robux fee**. Private servers are often purchased for:
@@ -122,15 +122,15 @@ A [private server](../../production/monetization/private-servers.md) is a subscr
-### Catalog fees and commissions
+### Catalog Fees and Commissions
You can create and sell accessories and clothes on the Marketplace. After you pay the upload fee and submit a new asset for approval, the moderation team reviews your asset and, if approved, adds your asset to the catalog.
-You'll receive a [commission](../../marketplace/marketplace-fees-and-commissions.md) every time users purchase your catalog item. If users purchase your catalog item within an experience using the [avatar inspect menu](../../players/avatar-inspect-menu.md) or the [avatar editor service](../../players/avatar-editor.md), the experience owner also receives a commission.
+You'll receive a [commission](../../marketplace/marketplace-fees-and-commissions.md) every time users purchase your catalog item. If users purchase your catalog item within an experience using the [Avatar Inspect Menu](../../players/avatar-inspect-menu.md) or the [Avatar Editor Service](../../players/avatar-editor.md), the experience owner also receives a commission.
### Plugins
-A [plugin](../../studio/plugins.md) is an extension that adds additional functionality to Studio. You can offer them to other creators on the [Creator Store](../../production/creator-store.md) for free, or you can sell them for **United States Dollars** (the minimum price is $4.99). Roblox offers a market-leading revenue share for these sales, as only taxes and payment processing fees are deducted. For more information on selling plugins, see [Sell on the Creator Store](../sell-on-creator-store.md).
+A [plugin](../../studio/plugins.md) is an extension that adds additional functionality to Studio. You can offer them to other creators on the [Creator Store](../../production/creator-store.md) for free, or you can sell them for **United States Dollars** (the minimum price is $4.99). Roblox offers a market-leading revenue share for these sales, as only taxes and payment processing fees are deducted. For more information on selling plugins, see [Selling on the Creator Store](../selling-on-creator-store.md).
-## Use the dynamic price check tool
+## Using the Dynamic Price Check Tool
Price optimization can't collect data from and make changes to prices you have hard-coded into your experience. To run a price optimization test on products with hard-coded prices, you must first update them to be dynamically scripted.
-Dynamically scripted prices update through `Class.MarketplaceService|MarketplaceService` and use functions like `Class.MarketplaceService:GetProductInfo()|GetProductInfo()` and `Class.MarketplaceService:GetDeveloperProductsAsync()|GetDeveloperProductsAsync()` to retrieve and display product prices you have set through the Creator Hub. For information on how to dynamically script product prices, see [Selling Passes](./game-passes.md#sell-passes) and [Selling Developer Products](./developer-products.md#sell-developer-products).
+Dynamically scripted prices update through `Class.MarketplaceService|MarketplaceService` and use functions like `Class.MarketplaceService:GetProductInfo()|GetProductInfo()` and `Class.MarketplaceService:GetDeveloperProductsAsync()|GetDeveloperProductsAsync()` to retrieve and display product prices you have set through the Creator Hub. For information on how to dynamically script product prices, see [Selling Passes](./game-passes.md#selling-passes) and [Selling Developer Products](./developer-products.md#selling-developer-products).
The dynamic price check tool updates all products for sale with a fake Robux price to identify which of your product prices are hard-coded and which are scripted with `Class.MarketplaceService|MarketplaceService` inside your experience. If a product price updates to the fake Robux price, the price is scripted. If it remains the same, the price is hard-coded.
@@ -49,7 +53,7 @@ To use the dynamic price check tool:
To disable the dynamic price check tool, go to the **Dynamic Price Check** page and click **Disable**.
-## Use price optimization
+## Using Price Optimization
To use price optimization:
@@ -58,7 +62,7 @@ To use price optimization:
3. Select the developer products and passes you want to include in the price test. For best results, include all products.
4. Click **Start Test**. After approximately two weeks, you receive an e-mail notification that the test is complete. The **Price Optimization** page updates with the optimized product prices, the recommended price percentage change, and the approximate long-term revenue impact of applying the new product prices.
5. Click **Review & Apply prices** to apply the results of the price optimization test.
-6. **(Optional)** Click **Start price review** to [run a price review period](#run-a-price-review-period).
+6. **(Optional)** Click **Start price review** to [run a price review period](#running-a-price-review-period).
You can stop the price optimization test any time by clicking **Stop test** in the **Price Optimization** page. If you stop the test, your product prices revert to their original prices.
@@ -66,7 +70,7 @@ You can stop the price optimization test any time by clicking **Stop test** in t
To make sure your product prices stay optimal, run a price optimization test every three months. You should also consider running a new price test whenever you create new products that account for a significant part of your revenue, or when you make substantial changes to your experience mechanics.
-## Run a price review period
+## Running a Price Review Period
After you receive the results from a price test, you can start an optional price review period to track the long-term revenue impact of the price recommendations.
@@ -76,7 +80,7 @@ If the price review period results are favorable, the optimized prices are appli
To run a price review period:
-1. After [running a price optimization test](#use-price-optimization), click **Start price review** in the **Price Optimization** page. After four weeks, you receive an e-mail notification that the review is complete. The **Price Optimization** page updates with the reviewed prices, the overall revenue increase, and the approximate long-term revenue impact of applying the new product prices.
+1. After [running a price optimization test](#using-price-optimization), click **Start price review** in the **Price Optimization** page. After four weeks, you receive an e-mail notification that the review is complete. The **Price Optimization** page updates with the reviewed prices, the overall revenue increase, and the approximate long-term revenue impact of applying the new product prices.
2. Click **Finish** to complete the review.
## Limitations
diff --git a/content/en-us/production/monetization/private-servers.md b/content/en-us/production/monetization/private-servers.md
index 61e21786d..1fee37c2f 100644
--- a/content/en-us/production/monetization/private-servers.md
+++ b/content/en-us/production/monetization/private-servers.md
@@ -1,5 +1,5 @@
---
-title: Private servers
+title: Private Servers
description: Private servers are a subscription-based feature that allows users to decide who can play an experience with them.
---
@@ -22,7 +22,7 @@ You cannot enable [paid access in Robux](../monetization/paid-access-robux.md) o
Players under the age of 13 may not be able to join private servers depending on their privacy and parental control settings.
-## Enable private servers
+## Enabling Private Servers
Before you can enable private servers, your experience must be **public** to all users.
diff --git a/content/en-us/production/monetization/randomized-virtual-items-policy.md b/content/en-us/production/monetization/randomized-virtual-items-policy.md
index a8c2b6738..d69a745f4 100644
--- a/content/en-us/production/monetization/randomized-virtual-items-policy.md
+++ b/content/en-us/production/monetization/randomized-virtual-items-policy.md
@@ -1,5 +1,5 @@
---
-title: Randomized virtual items policy
+title: Randomized Virtual Items Policy
description: Explains Roblox's policy for selling randomized virtual items.
---
diff --git a/content/en-us/production/monetization/subscriptions.md b/content/en-us/production/monetization/subscriptions.md
index 954ac22bd..c104e3a12 100644
--- a/content/en-us/production/monetization/subscriptions.md
+++ b/content/en-us/production/monetization/subscriptions.md
@@ -3,11 +3,11 @@ title: Subscriptions
description: Subscriptions within experiences let you offer users recurring benefits for a monthly fee.
---
-**Subscriptions** within experiences let you offer users recurring benefits for a monthly fee. Similar to [passes](./game-passes.md), the major difference between subscriptions and passes is that the benefits of a pass are granted in perpetuity, while the benefits of a subscription are contingent on the user paying a monthly fee. Subscriptions on Roblox have the following characteristics:
+**Subscriptions** within experiences let you offer users recurring benefits for a monthly fee. Similar to [Passes](./game-passes.md), the major difference between subscriptions and passes is that the benefits of a pass are granted in perpetuity, while the benefits of a subscription are contingent on the user paying a monthly fee. Subscriptions on Roblox have the following characteristics:
- **Auto-renewal:** Subscriptions are auto-renewing, not one-time purchases, and are priced in local currency.
-- **Robux payout:** You receive subscription revenue in Robux. For more details, see [Earn with subscriptions](#earn-with-subscriptions).
-- **Single-tiered:** All subscriptions within an experience can be owned by users simultaneously. Mutually exclusive subscriptions are not supported.
+- **Robux Payout:** You receive subscription revenue in Robux. For more details, see [Earning with Subscriptions](#earning-with-subscriptions).
+- **Single-Tiered:** All subscriptions within an experience can be owned by users simultaneously. Mutually exclusive subscriptions are not supported.
Users can purchase subscriptions on the desktop app or website using Roblox gift card credit or a credit or debit card, and through payment methods on the Apple and Google stores in qualifying regions. Users can view and manage their subscription purchases in the Subscriptions tab in their Roblox account settings.
@@ -19,7 +19,7 @@ Subscriptions will be rolled out to more regions in the future.
To learn how to design subscriptions for your experience, see [Subscription Design](../../production/game-design/subscription-design.md). For a reference on how to implement subscriptions into your experience's monetization strategy, see this [implementation example](https://devforum.roblox.com/t/subscriptions-within-experiences-livetopia-implementation/2710072).
-## Subscription guidelines
+## Subscription Guidelines
Before creating your subscriptions, ensure they align with [Roblox's Terms of Use](https://en.help.roblox.com/hc/articles/19694609252884/) and comply with local laws. Any experience that engages in scams, attempts to mislead users with false offerings, or otherwise violate our [Community Standards](https://en.help.roblox.com/hc/en-us/articles/203313410-Roblox-Community-Standards) will be taken down. In addition, ensure your subscriptions abide by the following guidelines:
@@ -30,7 +30,7 @@ Before creating your subscriptions, ensure they align with [Roblox's Terms of Us
- **Do not direct users to purchase on another platform (e.g. mobile, web, etc.) in-experience:** While you are free to communicate with users off-platform, using the Roblox app to direct users to purchase elsewhere is prohibited.
- **Do not gate subscription benefits by additional requirements once a user has paid:** Requiring a user to perform additional tasks, such as posting to social media, to get access to benefits they have paid for is prohibited. This guideline does not impact battle passes, which you are allowed to both create and market as a subscription purchase.
-## Create subscriptions
+## Creating Subscriptions
Before you can create a subscription, you must be phone or [ID verified](../publishing/account-verification.md). To create a subscription:
@@ -61,25 +61,25 @@ Before you can create a subscription, you must be phone or [ID verified](../publ
After creating your subscription, you can't make changes to anything but the cover image and description.
-### Activate subscriptions
+### Activating Subscriptions
Once a subscription is ready to go on-sale, click **⋯** at the top right corner of the subscription tile and select **Activate**. Activated subscriptions are available for sale in the **Experience Details** page and within the experience itself.
-Before activating your subscription for the first time, you must confirm a shortened version of your experience name. This shortened experience name is displayed to the user when they subscribe, appearing alongside the subscription name you created in [Create subscriptions](#create-subscriptions). It's also visible managing subscriptions in Roblox and App Store Settings.
+Before activating your subscription for the first time, you must confirm a shortened version of your experience name. This shortened experience name is displayed to the user when they subscribe, appearing alongside the subscription name you created in [Creating Subscriptions](#creating-subscriptions). It's also visible managing subscriptions in Roblox and App Store Settings.
-### Through webhooks
+### Through Webhooks
-The Cloud API Webhook feature includes triggers for four subscription events: cancelled, purchased, refunded and renewed. These notifications fire immediately, so you can respond in real-time or create your own custom analytics. For more information on how to set up a webhook, see [Webhook notifications](../../cloud/webhooks/webhook-notifications.md).
+The Cloud API Webhook feature includes triggers for four subscription events: cancelled, purchased, refunded and renewed. These notifications fire immediately, so you can respond in real-time or create your own custom analytics. For more information on how to set up a webhook, see [Webhook Notifications](../../cloud/webhooks/webhook-notifications.md).
diff --git a/content/en-us/production/promotion/ads-manager.md b/content/en-us/production/promotion/ads-manager.md
index 125d8cc12..fcfc058d3 100644
--- a/content/en-us/production/promotion/ads-manager.md
+++ b/content/en-us/production/promotion/ads-manager.md
@@ -9,7 +9,7 @@ This feature is in beta.
**Ads Manager** offers advertisers valuable control over their ad campaigns, empowering them to create, optimize, and measure ads effectively while reaching their campaign objectives. Advertisers can use this tool to manage their ad campaigns, ads reporting, and ads billings in one place. Ads Manager allows you to create campaigns for **immersive ads** for ad units within experiences ([image](#image-ads) ads, [video](#video-ads) ads, [portal](#portal-ads) ads), [**sponsored experiences**](#sponsored-experiences), which appear on the Home page, and [search ads](./search-ads.md) that appear on Search results.
-## Create an ad account
+## Creating an Ad Account
To access the Ads Manager, you need an ad account. Create an ad account with a verified email on a Roblox account registered for users aged 13 years or older.
@@ -23,7 +23,7 @@ To create an ad account:
-## Add a payment method
+## Adding a Payment Method
Before you can create and manage ads on Roblox, you first need to provide a payment method. To add a payment method to your ad account:
@@ -33,9 +33,9 @@ Before you can create and manage ads on Roblox, you first need to provide a paym
2. There are two payment methods available for selection:
1. **Credit or Debit Card:** Credit or debit cards are available for users 18 and above. A temporary $1.00 USD hold will be placed on the card and refunded after verification is complete within 7 business days.
- 2. **Robux Ad Credit:** Converting Robux into ad credits to fund your campaigns is available for all users 13 and up. For more information, see [Convert Robux to ad credits](#convert-robux-to-ad-credits).
+ 2. **Robux Ad Credit:** Converting Robux into ad credits to fund your campaigns is available for all users 13 and up. For more information, see [Converting Robux to Ad Credits](#converting-robux-to-ad-credits).
-### Convert Robux to ad credits
+### Converting Robux to Ad Credits
Any Roblox user aged 13 and above can convert Robux to ad credit and utilize it for running ads. This accessibility ensures that a wide range of creators can participate in the advertising ecosystem.
@@ -52,7 +52,7 @@ This minimum conversation requirement streamlines the conversion process, preven
Converting Robux to ad credit is a permanent and irreversible action. Once you convert Robux to ad credits they can only be spent on campaigns within the Ads Manager.
-## Create ad campaigns
+## Creating Ad Campaigns
An **ad campaign** is a coordinated series of ads designed to achieve a specific goal. To create an ad campaign, you must do the following:
@@ -66,7 +66,7 @@ Before launching your campaign, you'll be able to [review your campaign details]
Advertising paid experiences is prohibited. You will not be able to select paid experiences in the dropdown menu during the ad selection process.
-### Define the campaign
+### Define the Campaign
Campaigns are defined by their **campaign objective** and **budgeting and scheduling** parameters.
@@ -111,7 +111,7 @@ To set up an ad campaign:
6. Name your campaign and click the **NEXT** button.
-### Define ad sets
+### Define Ad Sets
Ad sets are a group of ads within a campaign that share the same targeting and bidding parameters. When defining an ad set, you can customize your ad campaigns according to the following areas:
@@ -140,20 +140,20 @@ By adjusting all three categories, you can control who sees your ad to meet the
The information provided at the [campaign](#define-the-campaign) level includes:
-| Reporting column | Definition |
+| Reporting Column | Definition |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name** | The name of the ad campaign. |
| **Off/On** | A toggle indicating if the ad campaign is active, paused, or disabled. |
-| **Status** | Displays the status of the ad campaign. For a list of all statuses, see [Ad campaign statuses](#ad-campaign-statuses). |
+| **Status** | Displays the status of the ad campaign. For a list of all statuses, see [Ad Campaign Statuses](#ad-campaign-statuses). |
| **Spent** | The total amount of USD or ad credit you have spent on the selected campaign. |
| **Impressions** | An **image impression** is when a user looks at the ad for at least 1 second and the ad occupies 1.5% of the viewport, is viewed at an angle of up to 55 degrees, with at least 50% of the image ad pixels visible. 
The information provided at the [ad set](#define-ad-sets) level includes:
-| Reporting column | Definition |
+| Reporting Column | Definition |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name** | The name of the ad set. |
| **Off/On** | A toggle indicating if the ad campaign is active, paused, or disabled. |
-| **Status** | Displays the status of the ad set. For a list of all statuses, see [Ad set statuses](#ad-set-statuses). |
+| **Status** | Displays the status of the ad set. For a list of all statuses, see [Ad Set Statuses](#ad-set-statuses). |
| **Campaign** | Shows to which campaign an ad set belongs. |
| **Max Bid** | The maximum bid amount set for ad auction, shown in either USD or ad credit. |
| **Spent** | The total amount of USD or ad credit you have spent. |
@@ -615,17 +615,17 @@ The information provided at the [ad set](#define-ad-sets) level includes:
| **Play Rate** | Percentage calculated by dividing the number of plays by the number of impressions. |
| **Cost Per Play (CPP)** | The average cost incurred for each play, calculated by dividing the total campaign cost by the number of plays. |
-### Ad reports
+### Ad Reports
The information provided at the [individual ad](#create-ads) level includes:
-| Reporting column | Definition |
+| Reporting Column | Definition |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name** | The name of the ad. |
| **Off/On** | A toggle indicating if the ad campaign is active, paused, or disabled. |
-| **Status** | Displays the status of the individual ad. For a list of all statuses, see [Ad statuses](#ad-statuses). |
+| **Status** | Displays the status of the individual ad. For a list of all statuses, see [Ad Statuses](#ad-statuses). |
| **Ad Set** | Displays the ad set the corresponding individual ad belongs to. |
| **Ad Format** | Displays if the Ad is an Image or Portal Ad. |
| **Spent** | The total amount of USD or ad credit you have spent. |
@@ -636,19 +636,19 @@ The information provided at the [individual ad](#create-ads) level includes:
| **Play Rate** | Percentage calculated by dividing the number of plays by the number of impressions. |
| **Cost Per Play (CPP)** | The average cost incurred for each play, calculated by dividing the total campaign cost by the number of plays. |
-### Delivery columns
+### Delivery Columns
The delivery column of the Ads Manager defines the **status** of your campaign, ad set, or ad.
-- [Ad campaign statuses](#ad-campaign-statuses) offer a valuable overview of the campaign's overall progress, helping advertisers identify and optimize active, underperforming, or completed campaigns for better results.
-- [Ad set statuses](#ad-set-statuses) highlight the performance of each ad set in terms of targeting and budget allocation, enabling advertisers to fine-tune their strategies for improved audience engagement and to reach their campaign objectives.
-- [Ad statuses](#ad-statuses) provide insights into the delivery status of each individual ad, allowing advertisers to monitor their effectiveness and note any dependencies on their parent ad sets or Campaigns.
+- [Ad Campaign Statuses](#ad-campaign-statuses) offer a valuable overview of the campaign's overall progress, helping advertisers identify and optimize active, underperforming, or completed campaigns for better results.
+- [Ad Set Statuses](#ad-set-statuses) highlight the performance of each ad set in terms of targeting and budget allocation, enabling advertisers to fine-tune their strategies for improved audience engagement and to reach their campaign objectives.
+- [Ad Statuses](#ad-statuses) provide insights into the delivery status of each individual ad, allowing advertisers to monitor their effectiveness and note any dependencies on their parent ad sets or Campaigns.
You can use the following status tables to understand what each status means.
-#### Ad campaign statuses
+#### Ad Campaign Statuses
-| Delivery status | Definition |
+| Delivery Status | Definition |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Active** | Your campaign contains at least one ad running normally. |
| **Paused** | The campaign is not delivering because it is toggled off (paused by user). |
@@ -657,9 +657,9 @@ You can use the following status tables to understand what each status means.
| **Error** | Technical error. Please contact [support](https://www.roblox.com/support). |
| **Completed** | The campaign, ad set or ad is no longer running because the scheduled end date has passed. |
-#### Ad set statuses
+#### Ad Set Statuses
-| Delivery status | Definition |
+| Delivery Status | Definition |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Active** | The ad is running normally, or your campaign or ad sets contains at least one ad running normally. |
| **Paused** | The ad set is not delivering because it is toggled off. |
@@ -668,9 +668,9 @@ You can use the following status tables to understand what each status means.
| **Completed** | The campaign, ad set or ad is no longer running because the scheduled end date has passed. |
| **Error** | Technical error. Please contact [support](https://www.roblox.com/support). |
-#### Ad statuses
+#### Ad Statuses
-| Delivery status | Definition |
+| Delivery Status | Definition |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Active** | The ad is running normally, or your campaign or ad sets contains at least one ad running normally. |
| **Rejected** | The ad can't run because it doesn't comply with Roblox advertising policy. |
@@ -681,13 +681,13 @@ You can use the following status tables to understand what each status means.
| **Paused** | Ad is toggled on but parent ad set is off so ad is not active. |
| **Error** | Technical error. Please contact [support](https://www.roblox.com/support). |
-## Ads billing
+## Ads Billing
**Ads billing** charges advertisers for ad placements on Roblox using the [payment method on file](#adding-a-payment-method). Billing information can be found under **Payment Activity**.
-### Credit and debit cards
+### Credit and Debit Cards
-### Ad credits
+### Ad Credits
Campaigns using ad credit are settled at the end of the campaign at the end date. Any unused ad credits will be refunded to their ad credit balance within 24-48 hours after the campaign ends. Ad credits will never be refunded to Robux. There is no daily spend limit when using ad credits.
@@ -725,7 +725,7 @@ Ad credit-related activities are categorized as follows:
@@ -45,24 +45,24 @@ To generate content maturity information:
Please review your experience and confirm that your answers accurately reflect the content of your experience. If you intentionally misrepresent your experience, you may be subject to [moderation consequences](#content-maturity-moderation).
-1. If you need to modify a previous answer, click the **Edit** button, otherwise click the **Submit** button to immediately publish the content maturity information to the experience's main page. If your experience receives a Restricted maturity label, servers running the experience restart to remove all players except those age-verified as 17+, and Studio removes all creators from any active [collaboration](../../projects/collaboration.md) session except those age-verified as 17+.
+1. If you need to modify a previous answer, click the **Edit** button, otherwise click the **Submit** button to immediately publish the Content Maturity information to the experience's main page. If your experience receives a Restricted maturity label, servers running the experience restart to remove all players except those age-verified as 17+, and Studio removes all creators from any active [collaboration](../../projects/collaboration.md) session except those age-verified as 17+.
-As long as your experience doesn't have a Restricted maturity label, if you believe that your content maturity information doesn't match your intended audience, you can update the content in your experience so that your experience is appropriate for your target audience, then resubmit the questionnaire. To learn how you can dynamically adjust the content of your experience for different audiences, see the `Class.PolicyService` API reference.
+As long as your experience doesn't have a Restricted maturity label, if you believe that your Content Maturity information doesn't match your intended audience, you can update the content in your experience so that your experience is appropriate for your target audience, then resubmit the questionnaire. To learn how you can dynamically adjust the content of your experience for different audiences, see the `Class.PolicyService` API reference.
-In addition to events, the integrated [update announcements](#announce-experience-updates) system lets you announce experience updates for which opted‑in players receive a notification in their Roblox notifications stream, along with a link to join the experience directly from the notification.
+In addition to events, the integrated [update announcements](#announcing-experience-updates) system lets you announce experience updates for which opted‑in players receive a notification in their Roblox notifications stream, along with a link to join the experience directly from the notification.
-## Create events
+## Creating Events
To create an event, you must have the [Edit all group experiences](../../projects/groups.md#roles-and-permissions) permission in a [group‑owned](../../projects/groups.md) experience, or be the sole owner of a user‑owned experience. Currently, you can publish a maximum of 10 ongoing or upcoming events.
@@ -29,7 +29,7 @@ To create an event, you must have the [Edit all group experiences](../../project
5. Select an event **category** that most accurately describes your event. The category may be shown alongside your event thumbnail in certain places on Roblox.
-6. Enter the event title, subtitle, and description. The description is optional but it can help provide additional information about the details of your event. If you supply a description, it should follow general [best practices](../../production/publishing/publish-experiences-and-places.md#metadata-best-practices) and accurately portray the event, including:
+6. Enter the event title, subtitle, and description. The description is optional but it can help provide additional information about the details of your event. If you supply a description, it should follow general [best practices](../../production/publishing/publishing-experiences-and-places.md#metadata-best-practices) and accurately portray the event, including:
- A summary of the event and how it relates to the overall experience. If you're using the event to promote a major experience update, summarize the key updates.
@@ -50,11 +50,11 @@ To create an event, you must have the [Edit all group experiences](../../project
Assets which are pending review or are moderated will display a placeholder.
-## Event discovery
+## Event Discovery
The following sections detail how you can promote events and how events are discoverable by players on the Roblox platform.
-### Event details page
+### Event Details Page
All published events feature an event details page which you can share with players on and off platform. To access a **shareable link**, you can use either the event details page itself or the **Events** page.
@@ -70,16 +70,16 @@ From the experience's **Events** page, hover over the event thumbnail, click the
-### Group page
+### Group Page
If you create events as an admin for a [group](../../projects/groups.md), the group's events will appear under the **Events** tab on the group page.
@@ -96,7 +96,7 @@ In addition, you can feature an event in the group's **About** section for extra
-### Stream/push notifications
+### Stream/Push Notifications
Players who click **Notify Me** for an upcoming event will receive stream notifications in their Roblox inbox when the event starts. In addition, they can opt into **push notifications** to receive a notification on their device that will take them into the experience. Stream notifications remain accessible in the player's Roblox inbox for the duration of the event, making it easy for them to hop back in at any time.
@@ -111,7 +111,7 @@ Players who click **Notify Me** for an upcoming event will receive stream notifi
-## Delete events
+## Deleting Events
To delete an event and remove its [detail page](#event-details-page):
@@ -123,7 +123,7 @@ To delete an event and remove its [detail page](#event-details-page):
-## Use event attribution
+## Using Event Attribution
When a player joins an experience through an event entry point, such as by clicking on an event [notification](#streampush-notifications) or through the join button on the [event details page](#event-details-page), the event ID is added to the player's `GameJoinContext`. You can use this information in your experience to identify players who have come to participate in the event and show them custom prompts or otherwise personalize their experience.
@@ -146,7 +146,7 @@ end
Players.PlayerAdded:Connect(onPlayerAdded)
```
-## Announce experience updates
+## Announcing Experience Updates
@@ -18,7 +18,7 @@ Roblox treats experiences without guidelines the same as experiences with an age
Experience guidelines only apply to the content you create for your experience. They do **not** apply to user-generated content that players bring with them into your experience, such as avatar clothing and accessories.
-### Send an experience notification
+### Sending an Experience Notification
-Once you've [created a notification string](#create-a-notification-string) and included the [package](#include-the-package) in your project, you can send notifications from server‑side scripts. Notifications will be delivered to [opted-in](https://en.help.roblox.com/hc/en-us/articles/24769602332692-Out-of-Experience-Notifications) users age 13+ through their Roblox notification stream, at which point they can join the experience directly via the **Join** button on the notification and spawn according to your [launch data](#include-launch-and-analytics-data).
+Once you've [created a notification string](#creating-a-notification-string) and included the [package](#including-the-package) in your project, you can send notifications from server‑side scripts. Notifications will be delivered to [opted-in](https://en.help.roblox.com/hc/en-us/articles/24769602332692-Out-of-Experience-Notifications) users age 13+ through their Roblox notification stream, at which point they can join the experience directly via the **Join** button on the notification and spawn according to your [launch data](#including-launch-and-analytics-data).
diff --git a/content/en-us/production/promotion/invite-prompts.md b/content/en-us/production/promotion/invite-prompts.md
index d6ea36c44..83dbcd758 100644
--- a/content/en-us/production/promotion/invite-prompts.md
+++ b/content/en-us/production/promotion/invite-prompts.md
@@ -1,6 +1,6 @@
---
-title: Player invite prompts
-description: Invite prompts are prompts sent to the player of an experience to invite their friends to join them.
+title: Player Invite Prompts
+description: Invite Prompts are prompts sent to the player of an experience to invite their friends to join them.
---
In addition to common [promotion](../../production/promotion/index.md) methods for increasing your player base, you can implement **invite prompts** directly inside your experience, encouraging players to invite their friends and increase co-experience gameplay.
@@ -8,13 +8,13 @@ In addition to common [promotion](../../production/promotion/index.md) methods f
The invite prompt system features the following:
- **Dynamic Invitees** — Prompt players to invite multiple friends from a selection list, or invite one specific friend.
-- **Launch Data** — Include optional [launch data](#include-launch-data) that can be read through `Class.Player:GetJoinData()` when the invited friend joins. Example use cases include routing invited friends to a coordinate location or personalizing the joining experience for the invitee.
-- **Customizable Text** — Customize the [invite prompt](#prompt-an-invite) message and the [notification](#set-notification-options) message. For example, an invite prompt for the player may read "Ask your friends to join the adventure!" and the notification message for the invited friend(s) may read "\{displayName\} wants you to join their adventure in \{experienceName\}!".
+- **Launch Data** — Include optional [launch data](#including-launch-data) that can be read through `Class.Player:GetJoinData()` when the invited friend joins. Example use cases include routing invited friends to a coordinate location or personalizing the joining experience for the invitee.
+- **Customizable Text** — Customize the [invite prompt](#prompting-an-invite) message and the [notification](#setting-notification-options) message. For example, an invite prompt for the player may read "Ask your friends to join the adventure!" and the notification message for the invited friend(s) may read "\{displayName\} wants you to join their adventure in \{experienceName\}!".
You can also track and reward inviters and invitees using the [Friend Invite Reward System](./referral-system.md).
@@ -38,7 +38,7 @@ You can also track and reward inviters and invitees using the [Friend Invite Rew
@@ -81,9 +81,9 @@ To create search ads:
6. In the Review Campaign page, review the final details of your advertisement and click **SUBMIT** to launch your campaign.
-After launching your campaign, you can monitor the campaign's performance with [ads reporting](#reporting) and [billing](./ads-manager.md#ads-billing).
+After launching your campaign, you can monitor the campaign's performance with [Ads Reporting](#reporting) and [Billing](./ads-manager.md#ads-billing).
-## Bidding and auction
+## Bidding and Auction
Ads on Roblox work in a bidding system, where advertisers bid to have their ads shown to users through the available ad units placed in an experience. Search ads differ from other ads in that they also calculate the relevance of the experience to the user's query. **This means that experiences that are more relevant to a search query have a greater chance of displaying as ads**.
@@ -113,6 +113,6 @@ The following is the [same bidding and auction information](./ads-manager.md#bid
## Reporting
-You can review your ad campaign's performance using the Ad Manager's [ads reporting tool](./ads-manager.md#ads-reporting). At this time, you can't filter reports by keywords, but you can create ad sets with a single keyword to compare how an individual keyword performs for your campaign.
+You can review your ad campaign's performance using the Ad Manager's [Ads Reporting tool](./ads-manager.md#ads-reporting). At this time, you can't filter reports by keywords, but you can create ad sets with a single keyword to compare how an individual keyword performs for your campaign.
Search ad metrics also populate in the [Analytics Dashboard](../analytics/acquisition.md#acquisition-sources) acquisition metrics. At this time, search ad and sponsored ad results are combined as a single Sponsored Ad metric on acquisition reports.
diff --git a/content/en-us/production/promotion/social-media-links.md b/content/en-us/production/promotion/social-media-links.md
index 1b9ca01e7..8585dadf3 100644
--- a/content/en-us/production/promotion/social-media-links.md
+++ b/content/en-us/production/promotion/social-media-links.md
@@ -1,5 +1,5 @@
---
-title: Social media links
+title: Social Media Links
description: Explains how to engage with your audience by promoting your experience on social media.
---
diff --git a/content/en-us/production/promotion/sponsor-items.md b/content/en-us/production/promotion/sponsoring-items.md
similarity index 95%
rename from content/en-us/production/promotion/sponsor-items.md
rename to content/en-us/production/promotion/sponsoring-items.md
index 5b0554bf4..a3df43f46 100644
--- a/content/en-us/production/promotion/sponsor-items.md
+++ b/content/en-us/production/promotion/sponsoring-items.md
@@ -1,5 +1,5 @@
---
-title: Sponsor items
+title: Sponsoring Items
comment: Changes to this article require additional review
description: Sponsoring items allows you to increase the discoverability of 3D user-generated content within the Avatar Marketplace.
---
@@ -8,7 +8,7 @@ Sponsoring items allows you to increase the discoverability of your 3D user-gene
-## Bidding system
+## Bidding System
Advertisement space works on a bidding system where the higher you set your **Daily Budget** amount in relation to other creators' bids, the more likely your sponsored item will display within the **Sponsored** category on any item's details page on the Roblox website or in the Roblox app. The location of each sponsored item within the category is random.
@@ -18,7 +18,7 @@ For example, if there are three sponsored items in the bidding system, advertisi
-### Award badges
+### Awarding Badges
You can award badges to players throughout your experience by calling the `Class.BadgeService:AwardBadge()` method in a server-side `Class.Script`. `Class.BadgeService:GetBadgeInfoAsync()` returns properties of the badge, including `IsEnabled` which confirms whether or not the badge can be awarded to a player. You can enable or disable a badge from the **Configure Badge** form on the [Creator Dashboard](https://create.roblox.com/dashboard/creations).
@@ -97,9 +97,9 @@ local function awardBadge(player, badgeId)
end
```
-### Check earned badges
+### Checking Earned Badges
-The following script checks when any player enters the experience, then uses the `Class.BadgeService:UserHasBadgeAsync()` method to verify if that player owns the badge with the [matching ID](#locate-badge-ids) set in the variable `BADGE_ID`. You can also verify badge ownership in batches using the `Class.BadgeService:CheckUserBadgesAsync()` method.
+The following script checks when any player enters the experience, then uses the `Class.BadgeService:UserHasBadgeAsync()` method to verify if that player owns the badge with the [matching ID](#locating-badge-ids) set in the variable `BADGE_ID`. You can also verify badge ownership in batches using the `Class.BadgeService:CheckUserBadgesAsync()` method.
```lua
local BadgeService = game:GetService("BadgeService")
@@ -126,10 +126,10 @@ end
Players.PlayerAdded:Connect(onPlayerAdded)
```
-### Get badge info
+### Getting Badge Info
To get information about a badge, such as its description or icon asset
-ID, call the `Class.BadgeService:GetBadgeInfoAsync()` method with a [badge ID](#locate-badge-ids). For example:
+ID, call the `Class.BadgeService:GetBadgeInfoAsync()` method with a [badge ID](#locating-badge-ids). For example:
```lua
local BadgeService = game:GetService("BadgeService")
diff --git a/content/en-us/production/publishing/console-guidelines.md b/content/en-us/production/publishing/console-guidelines.md
index 6a3c90a00..41f037e41 100644
--- a/content/en-us/production/publishing/console-guidelines.md
+++ b/content/en-us/production/publishing/console-guidelines.md
@@ -1,5 +1,5 @@
---
-title: Console development guidelines
+title: Console Development Guidelines
description: Explains design requirements to follow for publishing an experience to consoles.
---
@@ -9,11 +9,11 @@ With 200M+ Xbox and PlayStation players, consoles present a major opportunity fo
Experiences designed for consoles always need to provide [Content Maturity information](../../production/promotion/content-maturity.md) to ensure smooth releases and minimize the risk of being removed from consoles.
-## Design for controllers
+## Designing for Controllers
Console experiences receive commands from users through input controllers, which require special designs for smooth interactions.
-### Simplify the UI
+### Simplifying UI
@@ -31,11 +31,11 @@ Apply the following to simplify the UI design for consoles:
As controllers aren't just for consoles and VR but also are available on devices such as desktop and mobile, minimizing the number of moves needed can enhance the UI for all devices and input types in addition to PlayStation and Xbox.
-### Add supplemental control
+### Adding Supplemental Control
Unlike mobiles and desktops, navigation is always sequential on consoles, so users can't jump between far away elements as quickly as on other devices. To enhance the speed of navigation, consider adding additional buttons and shortcuts for essential in-experience actions.
-### Accommodate dynamic button icons
+### Accommodating Dynamic Button Icons
@@ -70,7 +70,7 @@ As your experience expands to more platforms, be sure to show button icons that
imageLabel.Image = mappedIcon
```
-## Provide haptic feedback
+## Providing Haptic Feedback
@@ -82,13 +82,13 @@ One unique advantage of controllers is the capability of providing haptic feedba
`Class.HapticService` also allows you to control the individual motors in a controller to set the intensity and duration of vibrations individually, so you can set different vibrations for different purposes and maintain the consistency with which actions trigger feedback. Design haptics carefully and avoid overuse, as users might find constant vibrations unpleasant and annoying.
-## Build for the 10ft experience
+## Building for the 10ft Experience
When on consoles, users are typically sitting 10 feet away from the screen. A scale factor of 1.5x ensures that the UI is comfortable, easy to navigate, and with legible fonts.
-### Consider TV safe-area
+### Considering TV Safe-Area
@@ -97,7 +97,7 @@ When on consoles, users are typically sitting 10 feet away from the screen. A sc
Since not all TVs show content fully to the edges of the screen due to historical and technical limitations, put UI elements in TV-safe areas to ensure important experience elements are visible on various TVs.
-### Implement dynamically-sized UI
+### Implementing Dynamically-Sized UI
Implement your UI using relative sizes and relative positions to measure everything as percentages of a frame. Incorporate a scale factor to all UI sizes by:
@@ -109,12 +109,12 @@ Implement your UI using relative sizes and relative positions to measure everyth
- Implementing `Class.ScrollingFrame` to reduce clutter on screen as the UI scales up.
-## Adapt progressive disclosure
+## Adapting Progressive Disclosure
Progressive disclosure defers advanced or rarely used features to a secondary screen. It's one of the best ways to declutter your UI and make it easy to use. For the console UX, it's common and faster to have the user go in and out of screens rather than fitting everything onto one screen like designing for desktops.
-## Provide sound feedback
+## Providing Sound Feedback
Unlike desktop or mobile interfaces, on which interactions are typically silent or rely on subtle haptic feedback, you can add sound effects to improve console interactions. When users navigate through the UI using a controller, consider incorporating sound effects to confirm selections or signal menu traversal, which can elevate the overall experience.
diff --git a/content/en-us/production/publishing/dmca-guidelines.md b/content/en-us/production/publishing/dmca-guidelines.md
index 9f49c60a0..a8bcfb553 100644
--- a/content/en-us/production/publishing/dmca-guidelines.md
+++ b/content/en-us/production/publishing/dmca-guidelines.md
@@ -1,5 +1,5 @@
---
-title: DMCA guidelines
+title: DMCA Guidelines
description: Explains copyright law and the details of DMCA claims.
---
@@ -7,7 +7,7 @@ description: Explains copyright law and the details of DMCA claims.
The information below is provided for general informational purposes only and is not legal advice. If you have any questions about this information or your specific situation or rights, please contact an attorney.
-## Frequently asked questions
+## Frequently Asked Questions
-## Update genres
+## Updating Genres
You can update your experience's genre and optional subgenre in the Creator Dashboard.
@@ -27,7 +27,7 @@ To update your genre:
When you update your genre, the genre immediately updates on your experience's main page, but it may take a few days to reflect in other Discovery systems like genre-specific sorts in Charts.
-## Genre accuracy
+## Genre Accuracy
To ensure genres are accurate and relevant for users, Roblox regularly reviews experiences and may update any genre selections that appear inaccurate. If Roblox updates your experience's genre, you will be notified by email and the change will appear on the experience's Settings page.
@@ -49,7 +49,7 @@ Roblox will review your appeal and notify you of the outcome, usually within a f
If your appeal has not yet been reviewed and you update your genre through the regular selection flow, your original appeal will not be reviewed.
-## Best practices
+## Best Practices
Selecting a genre helps users discover and understand what to expect from your experience. Consider the following best practices to select the most relevant genre for your experience.
@@ -57,7 +57,7 @@ Selecting a genre helps users discover and understand what to expect from your e
- **Selecting a subgenre** — While genres give users a broad sense of what kind of gameplay to expect, subgenres help describe the core mechanics of your experience in more detail. It's recommended to select a subgenre if one applies. However, if there isn't a subgenre that fits your experience, you can still select a genre without a subgenre.
- **Genre and subgenre descriptions** — Refer to the [genre and subgenre descriptions](#genre-and-subgenre-descriptions) to compare genres and help you make the best choice for your experience.
-## Genre and subgenre descriptions
+## Genre and Subgenre Descriptions
Use the following genre descriptions and additional subgenres to best represent your experience's content. Some genres do not include subgenres.
@@ -97,7 +97,7 @@ Experiences meant to entertain through consumption or creation of content, inclu
- **Showcase & Hub** — Experiences that act as a demo, show off an immersive environment, or highlight and portal to other experiences.
- **Video** — Experiences for watching or creating video content.
-### Obby & platformer
+### Obby & Platformer
Experiences where players navigate surfaces and obstacles to progress. Player actions often involve jumping, climbing, or changing directions.
@@ -108,7 +108,7 @@ Experiences where players navigate surfaces and obstacles to progress. Player ac
- **Runner** — Experiences where players automatically move and must avoid obstacles to continue.
- **Tower Obby** — Experiences where players climb upwards through a series of platforms and obstacles.
-### Party & casual
+### Party & Casual
Experiences focused on casual social play with other players.
@@ -130,7 +130,7 @@ Experiences focused on problem-solving challenges to progress.
-## Publish experiences
+## Publishing Experiences
By default, publishing a new place creates a new experience. New experiences begin as **private** and are only accessible to you and members of your [group](../../projects/groups.md) with the correct permissions.
When you're ready to release an experience to a wider audience, you
-can [release it to the public](#release-to-the-public), although beta testing should still be an essential part of your development cycle. Because you're not able to determine which countries have access to an experience, which limits the ability to run beta tests in smaller markets, consider these strategies:
+can [release it to the public](#releasing-to-the-public), although beta testing should still be an essential part of your development cycle. Because you're not able to determine which countries have access to an experience, which limits the ability to run beta tests in smaller markets, consider these strategies:
-1. **(Optional)** If the experience is live, it's recommended that you restart its servers as outlined in [update experiences](#update-experiences).
+1. **(Optional)** If the experience is live, it's recommended that you restart its servers as outlined in [Updating Experiences](#updating-experiences).
-## Configure experiences
+## Configuring Experiences
You can customize your experience's settings from the [Creator Dashboard][creatordashboard] or within Studio's [Game Settings](../../studio/game-settings.md). Some settings are only configurable within Studio while others are only configurable on the dashboard.
@@ -119,13 +119,13 @@ Regardless of whether or not you activate the toggle, players do not face modera
In-experience assets and experience metadata cannot contain strong language, even if the toggle is on and your experience is rated 17+. If you include strong language in your assets or experience page, your experience will be moderated.
-### Game settings
+### Game Settings
Once an experience is published, the [Game Settings](../../studio/game-settings.md) window contains many Studio-level settings and customization options. To open it, click the **Game Settings** button in the [Home](../../studio/home-tab.md) tab of the ribbon menu.
-## Release to the public
+## Releasing to the Public
New experiences begin as **private** and are only accessible to you and members of your group with the correct [permissions](../../projects/groups.md#roles-and-permissions). When appropriate, you can release an experience to the public as follows:
@@ -136,9 +136,9 @@ New experiences begin as **private** and are only accessible to you and members
1. **(Recommended)** Explore how to provide [Content Maturity labels and content descriptors](#content-maturity) for the experience.
-### Link to experiences
+### Linking to Experiences
-Once an experience is [public](#release-to-the-public), you can copy its link from the [Creator Dashboard][creatordashboard] or the Roblox app and share it with others via social media or similar.
+Once an experience is [public](#releasing-to-the-public), you can copy its link from the [Creator Dashboard][creatordashboard] or the Roblox app and share it with others via social media or similar.
-## Update experiences
+## Updating Experiences
After you publish an updated version of an experience to Roblox, players aren't immediately removed from the old version of the experience. Instead, you have a few options for how quickly you transition players to the new version, each with advantages and disadvantages depending on the situation.
-### Keep multiple thumbnails active
+### Keeping Multiple Thumbnails Active
-## Manage collaborators
+## Managing Collaborators
Collaborators you add to an experience have permission settings that correspond to their level of access to the experience. As follows are the different user permission settings:
@@ -42,12 +42,12 @@ Collaborators you add to an experience have permission settings that correspond
There are some small differences when managing collaborators in [group‑owned experiences](#group-owned-experiences) vs. [user‑owned experiences](#user-owned-experiences).
-### Group-owned experiences
+### Group-Owned Experiences
For [group](../projects/groups.md) experiences, only the group owner or members with sufficient permissions can manage the group's roles, either across **all group experiences** or on a **per‑experience** basis. Such users can also add individual collaborators to group‑owned experiences in the same workflow as [user‑owned](#user-owned-experiences) experiences, but only for **Play** access.
-### View collaborators
+### Viewing Collaborators
While working in a collaborative session, you can see the current collaborators in the upper-right corner of Studio, each with a unique assigned color that's consistent across all collaborators' devices.
@@ -135,7 +135,7 @@ To view more details on the current collaborators, click on any of the icons to
-### Selection visualization
+### Selection Visualization
By default, selected code in the [Script Editor](../studio/script-editor.md) and selected objects in the 3D viewport are highlighted with the unique color assigned to each collaborator. Additionally, the [Explorer](../studio/explorer.md) window marks selected objects with dots in these assigned colors to indicate selection by other collaborators.
@@ -148,17 +148,17 @@ By default, selected code in the [Script Editor](../studio/script-editor.md) and
-To make all collaborators' selections invisible to only you while still seeing their work, uncheck **Show collaborator selections** at the bottom of the [Live Collaborators](#view-collaborators) window.
+To make all collaborators' selections invisible to only you while still seeing their work, uncheck **Show collaborator selections** at the bottom of the [Live Collaborators](#viewing-collaborators) window.
-### Join collaborators
+### Joining Collaborators
-To quickly jump to a location in the workspace or to the exact line in a script that a collaborator is editing, hover over their name in the [Live Collaborators](#view-collaborators) window and click **Join**.
+To quickly jump to a location in the workspace or to the exact line in a script that a collaborator is editing, hover over their name in the [Live Collaborators](#viewing-collaborators) window and click **Join**.
-### Chat with collaborators
+### Chatting with Collaborators
To chat with collaborators during a session:
@@ -168,13 +168,13 @@ To chat with collaborators during a session:
1. Click in the input text field, type your message, and press Enter to send it.
-## Collaborative scripting
+## Collaborative Scripting
In a collaborative session, you can code together in real-time through [live scripting](#live-scripting), or you can [draft](#drafts-mode) scripts in a more focused environment before committing them to a collaborator‑shared repository.
-### Live scripting
+### Live Scripting
-**Live Scripting** lets collaborators code together in real time. In the [Script Editor](../studio/script-editor.md), each collaborator's cursor color matches their assigned color in the [Live Collaborators](#view-collaborators) window.
+**Live Scripting** lets collaborators code together in real time. In the [Script Editor](../studio/script-editor.md), each collaborator's cursor color matches their assigned color in the [Live Collaborators](#viewing-collaborators) window.
-#### Compare and merge changes
+#### Comparing and Merging Changes
If another collaborator commits changes to the same script that you're editing, an icon with a green **⊕** symbol appears in the **Drafts** window. To view their changes, right‑click the script and select **Compare With Server**.
@@ -237,13 +237,13 @@ To merge their changes into your script:
1. Once you've previewed the merge resolution, click **Merge All** to update your local script.
-#### Restore deleted scripts
+#### Restoring Deleted Scripts
If a collaborator deletes a script that you're editing, an icon with a red **⊘** symbol appears in the **Drafts** window. To restore the script, right‑click it and select **Restore Script**. Scripts are restored to the place's **Workspace** tree, so you may need to manually re‑parent them back to their original location.
-### View script history
+### Viewing Script History
All script changes, whether saved by a collaborator, auto-saved, or committed by a collaborator through [Drafts](#drafts-mode) mode, are logged in the **Version History** window. To access it:
@@ -264,25 +264,25 @@ All script changes, whether saved by a collaborator, auto-saved, or committed by
-## Save and publish
+## Saving and Publishing
During a collaborative session, Studio automatically saves the project to the cloud every four minutes.
-## Revert to previous versions
+## Reverting to Previous Versions
-The owner of an experience can revert changes made by other editors. See [here](../production/publishing/publish-experiences-and-places.md#revert-to-previous-versions) for instructions.
+The owner of an experience can revert changes made by other editors. See [here](../production/publishing/publishing-experiences-and-places.md#reverting-to-previous-versions) for instructions.
diff --git a/content/en-us/projects/data-model.md b/content/en-us/projects/data-model.md
index e5732a6f1..23c56a83c 100644
--- a/content/en-us/projects/data-model.md
+++ b/content/en-us/projects/data-model.md
@@ -1,5 +1,5 @@
---
-title: Data model
+title: Data Model
description: Explains the hierarchy of objects that describe everything about a place.
---
@@ -10,9 +10,9 @@ also contains objects that can control runtime behavior, such as scripts that
modify properties, call methods and functions, and respond to events that enable
dynamic behavior and interactivity.
-The Roblox Engine uses the data model as a source of truth for a place's state,
+The Roblox engine uses the data model as a source of truth for a place's state,
so it can simulate and render it on client devices. For more information on how
-the Roblox Engine interprets the data model, see [Client-Server
+the Roblox engine interprets the data model, see [Client-Server
Runtime](/projects/client-server).
## Objects
@@ -25,10 +25,10 @@ provides. There are many categories of objects with a wide variety of uses, but
you'll frequently work with `Class.BasePart` and `Class.LuaSourceContainer`
objects, commonly referred to as parts and scripts.
-For a comprehensive list of all the features of the Roblox Engine, see the
+For a comprehensive list of all the features of the Roblox engine, see the
[reference documentation](/reference/engine).
-### 3D building blocks
+### 3D Building Blocks
`Class.BasePart` is the core class for physically-simulated 3D building blocks in the world. It defines the properties and methods common to all physical objects with properties like position, size, and orientation.
@@ -77,10 +77,10 @@ client, or have them communicate across the network boundary.
For scripts to behave properly, you must place them in the correct containers in
the data model. For more information, see the [Server](#server) and [Client](#client) sections.
-## Object organization
+## Object Organization
While you have a lot of flexibility in how you organize your data model, the
-Roblox Engine expects certain objects to be in certain **container services**
+Roblox engine expects certain objects to be in certain **container services**
which are objects that have specific behaviors and can affect the behaviors of
the objects they contain. The main categories of container services include:
@@ -99,8 +99,8 @@ the objects they contain. The main categories of container services include:
`Class.VoiceChatService` and `Class.TextChatService`.
-### Assign roles
+### Assigning Roles
To assign one or more roles to a member, hover over their name, click the **⋮** button, and then click the **⊕** button for the desired role.
@@ -208,13 +208,13 @@ To quickly un-assign a role from the members overview, hover over it and click t
Currently, roles configured through the legacy [Groups](https://www.roblox.com/groups) pages appear for each member, and new members are assigned the legacy **Member** role. If permissions were granted to a role through the legacy system, **the member will continue to have those permissions**, so it's recommended that you revoke permissions/roles in the legacy system and then migrate members to the new system.
-### Remove members
+### Removing Members
To remove a member entirely, hover over their name and click the "trash" button. A dialog will appear for you to confirm their removal.
-## Manage payouts
+## Managing Payouts
If you're the owner of a selected group, you'll find a **Payouts** page under **Finances**. Here, you can send one‑time payouts, as well as define percentage splits with other members.
@@ -228,13 +228,13 @@ Some groups may not have this page unlocked initially for various reasons, such
Group owners can't share payouts across group members for experiences that charge for [paid access in local currency](../production/monetization/paid-access-local-currency.md).
-### One-time payouts
+### One-Time Payouts
Group owners can make one-time payouts to members in a batch, selecting a set amount for each. Safety features include 2FA challenges, confirmation dialogues, and checks around the eligibility of members being paid.
-### Recurring payouts
+### Recurring Payouts
Group owners can also define recurring payouts across the entire group **and** per‑experience, assigning a percentage payout to each member before the remainder enters the group's overall balance.
@@ -268,10 +268,10 @@ Consider the following scenario where a group experience "Laser Maze" is sp
Note that revenue from [private server](../production/monetization/private-servers.md) subscriptions does not change if you adjust split percentages at a later time, meaning that if a player buys a private server subscription, the split percentages at time of purchase will apply to that particular subscription forever (until it is canceled). This policy may be changed in the future.
-## Intellectual property protection in groups
+## Intellectual Property Protection in Groups
-Group members with permission to edit all group experiences can enable the [Place Copying](../production/publishing/publish-experiences-and-places.md#allow-copying) setting for a creation, potentially allowing the entire Roblox community to copy it and use assets within it. To help protect intellectual property in a group, the owner or members with sufficient permissions should:
+Group members with permission to edit all group experiences can enable the [Place Copying](../production/publishing/publishing-experiences-and-places.md#allowing-copying) setting for a creation, potentially allowing the entire Roblox community to copy it and use assets within it. To help protect intellectual property in a group, the owner or members with sufficient permissions should:
-- Confirm that each member is [assigned the appropriate role](#assign-roles).
+- Confirm that each member is [assigned the appropriate role](#assigning-roles).
- Check that each group role has the correct [permissions](#roles-and-permissions).
-- Confirm that the [Place Copying](../production/publishing/publish-experiences-and-places.md#allow-copying) setting is disabled before private assets are added.
+- Confirm that [Place Copying](../production/publishing/publishing-experiences-and-places.md#allowing-copying) is disabled before private assets are added.
diff --git a/content/en-us/projects/index.md b/content/en-us/projects/index.md
index a02a05084..397da0ee1 100644
--- a/content/en-us/projects/index.md
+++ b/content/en-us/projects/index.md
@@ -7,18 +7,18 @@ A Roblox project is a collection of [places](#places), [assets](#assets), [setti
## Places
-Experiences on Roblox are made up of individual **places**, comparable to scenes in Unity or maps in Unreal Engine. Each place contains all components for that portion of the experience, including its specific environment, parts, meshes, scripts, and user interface. See [Experiences and places](../production/publishing/publish-experiences-and-places.md) for details on creating and managing experiences.
+Experiences on Roblox are made up of individual **places**, comparable to scenes in Unity or maps in Unreal Engine. Each place contains all components for that portion of the experience, including its specific environment, parts, meshes, scripts, and user interface. See [Experiences and Places](../production/publishing/publishing-experiences-and-places.md) for details on creating and managing experiences.
-### Gloves and boots
+### Gloves and Boots
As you'll notice from the base body, we decided to include gloves and boots. You might want to do this temporarily as well, for the following reasons:
@@ -209,7 +209,7 @@ As you'll notice from the base body, we decided to include gloves and boots. You
src="../../assets/resources/beyond-the-dark/layered-clothing/Caging-With-Gloves.png"
width="80%" />
-## Build the suit
+## Building the Suit
Early on in the process, we decided that the suit should fit onto multiple characters, and that we wanted to release the assets to the Marketplace so others could enjoy the clothing. In addition to Layered Clothing, our character needed "hardpoint" items like a helmet and backpack as finishing touches. The following image shows how the space suit looks on a variety of characters.
@@ -262,7 +262,7 @@ With those guidelines in mind, here are the steps we followed to build the space
src="../../assets/resources/beyond-the-dark/layered-clothing/Clothing-Posing.png"
width="80%" />
-### Texture
+### Texturing
After we skinned the clothing, and it moved the way we intended, we moved to texturing.
@@ -293,7 +293,7 @@ When texturing your clothing, keep the following points in mind:
- Without metalness, the surface appearance defaults to 0 metalness, or a plastic surface.
- Without roughness, the surface appearance defaults to 0 roughness, or a smooth surface.
-### Skin
+### Skinning
Skinning clothing is required to have it bend properly with the base body. By skinning it, you're also telling the animations how the clothing should bend, including which parts are rigid or move with the character.
@@ -320,7 +320,7 @@ Since the gloves were going to be rigid, and the suit top stopped well above the
Once skinning on the suit top was done, we simply repeated the same procedure on the pants to get them ready for Studio and bringing into the engine!
-### Import to Studio
+### Importing to Studio
When the clothing looked good in our DCC application and in Studio, we were ready to import it into Studio and use the Accessory Tool, an upcoming release which will help you refine the clothing's cages to get the best fit possible. The tool can also export clothing as an accessory, which lets you add your clothing to a character.
@@ -331,7 +331,7 @@ In Studio, we named our Layered Clothing items with an LC\_ prefix, so we could
src="../../assets/resources/beyond-the-dark/layered-clothing/Accessories-In-Explorer.png"
width="320" />
-## Build the helmet
+## Building the Helmet
The helmet is an important element of the suit. We wanted users to see the character's face and also capture the sheen of the helmet's glass surface.
@@ -342,7 +342,7 @@ The helmet is an important element of the suit. We wanted users to see the chara
Accessories where we don't want deformation to fit the head, like this helmet, are best built as "hardpoint" accessories, which are the types of accessories that you currently find in the Marketplace. The main difference with the helmet and what you find in the Marketplace is that it uses `Class.SurfaceAppearance`, which creates convincing plastic and metal looks and gives the helmet visor some transparency.
-### Make the model
+### Making the Model
To build a helmet model:
@@ -367,7 +367,7 @@ To build a helmet model:
-### Import to Studio
+### Importing to Studio
When we had the helmet roughly fitted and placed in our DCC application, we could then import it into Studio with all the effects we wanted.
@@ -398,7 +398,7 @@ When we had the helmet roughly fitted and placed in our DCC application, we coul
src="../../assets/resources/beyond-the-dark/layered-clothing/Helmet-Attachments.jpeg"
width="80%" />
-### Introduce the accessory tool
+### Introducing the Accessory Tool
+
+## Features
+
+At a high level, City People Cars contains the following:
+
+- 12,000×12,000 stud map with a large coastal city and outer rural areas.
+- [NPCs](../resources/npc-kit.md) that walk around or drive vehicles through the city.
+- Traffic system — pedestrians and vehicles obey traffic laws.
+- Behavior trees used to drive a variety of NPC behaviors.
+- Basic [weapon system](../resources/weapons-kit.md).
+- Customizable number of NPCs and vehicles/drivers that appear in the city.
+- Support for all platforms, controller types, and screen sizes.
diff --git a/content/en-us/resources/feature-packages/bundles.md b/content/en-us/resources/feature-packages/bundles.md
index d84a07684..262e1c731 100644
--- a/content/en-us/resources/feature-packages/bundles.md
+++ b/content/en-us/resources/feature-packages/bundles.md
@@ -1,5 +1,5 @@
---
-title: Bundles package
+title: Bundles Package
description: Learn about the bundles feature package.
---
@@ -13,7 +13,7 @@ Using the package's customization options, you can tailor your bundles to meet t
For information on how to strategically provide purchase opportunities to meet player needs at key stages of your experience, see [Contextual Purchases](../../production/game-design/contextual-purchases.md). For industry best practices on how implement starter pack bundles, see [Starter Pack Design](../../production/game-design/starter-pack-design.md).
-## Get package
+## Get Package
The **Creator Store** is a tab of the Toolbox that you can use to find all assets that are made by Roblox and the Roblox community for use within your projects, including model, image, mesh, audio, plugin, video, and font assets. You can use the Creator Store to add one or more assets directly into an open experience, including feature packages!
@@ -57,7 +57,7 @@ To get the packages from your inventory into your experience:
1. Navigate to the **Security** tab, then enable **Enable Studio Access to API Services**.
-## Define currencies
+## Defining Currencies
-## Module usage
+## Module Usage
### Installation
@@ -47,17 +47,17 @@ To use the **EventSequencer** framework in an experience:
-### Framework modes
+### Framework Modes
-#### Replace mode
+#### Replace Mode
-The default framework mode is **replace mode** in which you design unique [scenes](#create-scenes) by placing [3D objects](../../parts/index.md), [terrain](../../parts/terrain.md), [lighting properties](../../environment/lighting.md), [environmental effects](../../environment/index.md#environment), and user interface objects into that scene's **Environment** folder. When a scene loads, those objects and properties get distributed into `Class.Workspace`, `Class.Terrain`, and `Class.Lighting`, **replacing** existing objects/properties to form a cloned space.
+The default framework mode is **replace mode** in which you design unique [scenes](#creating-scenes) by placing [3D objects](../../parts/index.md), [terrain](../../parts/terrain.md), [lighting properties](../../environment/lighting.md), [environmental effects](../../environment/index.md#environment), and user interface objects into that scene's **Environment** folder. When a scene loads, those objects and properties get distributed into `Class.Workspace`, `Class.Terrain`, and `Class.Lighting`, **replacing** existing objects/properties to form a cloned space.
-### Create scenes
+### Creating Scenes
A **scene** is essentially part of an overall event or a cutscene wrapped up in a series of folders. Each scene contains scripting logic that defines its flow/events, and a scene can store its own [3D objects](../../parts/index.md), [terrain](../../parts/terrain.md), [lighting properties](../../environment/lighting.md), [environmental effects](../../environment/index.md#environment), and user interface objects.
@@ -93,7 +93,7 @@ To get started quickly, you can find an empty scene inside the module's main fol
While developing an event, you can alternatively place scenes elsewhere in the [Explorer](../../studio/explorer.md) hierarchy and tag them with **SequencerScene** using the [Tags](../../studio/properties.md#instance-tags) section of their properties, or Studio's [Tag Editor](../../studio/view-tab.md#windows-and-tools) (**BlankScene** is already tagged as such). However, you'll need to move all event-ready scenes to **ReplicatedStorage** in order for them to work within the overall event flow.
-#### Time length
+#### Time Length
Each scene should have a **time length**, in seconds, defining its duration — just like a movie or concert has a set duration. Time length is defined as a numeric [attribute](../../studio/properties.md#instance-attributes) on the scene's folder named **TimeLength** which you can set directly in Studio or programmatically through `Class.Instance:SetAttribute()`.
@@ -159,11 +159,11 @@ This script executes [schema](#scene-schemas) logic on the client.
This script executes [schema](#scene-schemas) logic on the server.
-### Scene schemas
+### Scene Schemas
A scene's **schema** defines what happens at what point in the scene's timeline. You should define a scene's schema in both its [Client](#client) and [Server](#server) modules and include **lifecycle hooks** to manage when **configurations** occur.
-#### Lifecycle hooks
+#### Lifecycle Hooks
Schema [lifecycle hooks](#schema-lifecycle-hooks) let you manage when scene operations occur. A scene in production will typically run in the most simple flow:
@@ -185,7 +185,7 @@ Schema [configurations](#schema-configurations) define the core operations of a
You can use configurations in both the [Client](#client) and [Server](#server) module schemas, but it's recommended that you perform operations like [audio](#audio) and [animations](#animate) on the client side, just like in a typical experience.
-### Seek scenes
+### Seeking Scenes
A unique feature of **EventSequencer** is the ability to "seek" around scenes as you might seek through a video. In [Replace Mode](#replace-mode), you can also switch between scenes to preview an entire multi-scene event before deploying it to production.
@@ -229,9 +229,9 @@ A unique feature of **EventSequencer** is the ability to "seek" around scenes as
-## Scene manager plugin
+## Scene Manager Plugin
-The [Scene Manager](https://www.roblox.com/library/9995053698/Scene-Manager) plugin is a useful tool for loading and unloading scenes, [lighting](#save-and-load-lighting), and [terrain](#save-and-load-terrain). Unless you're using [Inline Mode](#inline-mode), it's highly recommended that you use this plugin instead of manually placing/editing scene objects and properties.
+The [Scene Manager](https://www.roblox.com/library/9995053698/Scene-Manager) plugin is a useful tool for loading and unloading scenes, [lighting](#saving-and-loading-lighting), and [terrain](#saving-and-loading-terrain). Unless you're using [Inline Mode](#inline-mode), it's highly recommended that you use this plugin instead of manually placing/editing scene objects and properties.
-### Test in Studio
+### Testing in Studio
To test the module in Studio, the **FriendsLocator** module must be run in a multi-client simulation, since no friends will be present in a solo playtest.
@@ -69,14 +69,14 @@ To test the module in Studio, the **FriendsLocator** module must be run in a mul
-### Add items
+### Adding Items
What's a merch booth without merch? The following sections outline how to add [avatar assets](#avatar-assets), [passes](#passes), and [developer products](#developer-products) to your merch booth.
-#### Avatar assets
+#### Avatar Assets
Items such as [clothing and accessories](../../art/accessories/index.md) must be added through their **asset ID** located on the item's detail page in the [Avatar Shop](https://www.roblox.com/catalog).
@@ -183,7 +183,7 @@ Adding [passes](../../production/monetization/game-passes.md) requires pass IDs
end
```
-#### Developer products
+#### Developer Products
Adding [developer products](../../production/monetization/developer-products.md) requires product IDs which can be located in the [Creator Dashboard](https://create.roblox.com/dashboard/creations).
@@ -239,7 +239,7 @@ Adding [developer products](../../production/monetization/developer-products.md)
end
```
-### Custom catalog button
+### Custom Catalog Button
By default, a right-side **catalog button** lets players open the booth at any time.
@@ -268,7 +268,7 @@ In some cases, it may be useful to [remove](#togglecatalogbutton) this button an
end)
```
-### Shoppable regions
+### Shoppable Regions
A helpful way to drive purchases in your experience is to automatically show the merch booth when a player enters an area.
@@ -334,7 +334,7 @@ To create a shoppable region:
CollectionService:GetInstanceAddedSignal("ShopRegion"):Connect(setupRegion)
```
-### Proximity prompts
+### Proximity Prompts
As an alternative to the 2D catalog view, you can add **proximity prompts** over in-experience objects. This encourages players to discover items in the 3D environment, preview them on their own avatar, purchase them, and instantly equip them. See [addProximityButton](#addproximitybutton) for details.
@@ -344,7 +344,7 @@ As an alternative to the 2D catalog view, you can add **proximity prompts** over
If a player has opened an item view through a proximity prompt, it automatically closes when the player moves further away from the prompt object than its activation distance. If you want to keep the booth open regardless of the player's distance from the prompt, set `closeWhenFarFromPrompt` to `false` in a [configure](#configure) call.
-### Change the equip effect
+### Changing the Equip Effect
By default, the merch booth shows a generic sparkle effect when a player equips an item from it. To change the effect, set `particleEmitterTemplate` to your own instance of a `Class.ParticleEmitter` in a [configure](#configure) call.
@@ -365,7 +365,7 @@ MerchBooth.configure({
})
```
-### GUI visibility
+### GUI Visibility
By default, the merch booth hides all `Class.ScreenGui|ScreenGuis` and `Class.CoreGui|CoreGuis` when its UI appears, including the chat, leaderboard, and others included by Roblox. If you want to disable this behavior, set `hideOtherUis` to `false` in a [configure](#configure) call.
@@ -379,7 +379,7 @@ MerchBooth.configure({
})
```
-### Character movement
+### Character Movement
It can be advantageous to prevent a character from moving while they are in the merch booth. This can be done by setting `disableCharacterMovement` to `true` in a [configure](#configure) call.
@@ -393,7 +393,7 @@ MerchBooth.configure({
})
```
-## API reference
+## API Reference
### Types
diff --git a/content/en-us/resources/modules/photo-booth.md b/content/en-us/resources/modules/photo-booth.md
index 3c310a379..8ce4f46ff 100644
--- a/content/en-us/resources/modules/photo-booth.md
+++ b/content/en-us/resources/modules/photo-booth.md
@@ -7,7 +7,7 @@ Taking a photo is a perfect way to commemorate a great experience. The **PhotoBo
-## Module usage
+## Module Usage
### Installation
@@ -35,7 +35,7 @@ To use the **PhotoBooth** module in an experience:
-### Position the booth
+### Positioning the Booth
The module comes with one **PhotoBooth** model that you can position in the 3D world. This model is what players will interact with to set up a photo.
@@ -73,7 +73,7 @@ The module is preconfigured to work for most use cases, but it can be easily cus
-### Connect to events
+### Connecting to Events
Every time the photo booth displays a new screen to a local client, a corresponding event is fired. These events can be connected in a `Class.LocalScript` so that you can respond with your own custom logic.
@@ -95,7 +95,7 @@ PhotoBooth.promptShown:Connect(function()
end)
```
-### GUI visibility
+### GUI Visibility
By default, the photo booth hides all `Class.ScreenGui|ScreenGuis` and `Class.CoreGui|CoreGuis` when a photo is staged. If you want to override this auto-hiding behavior and programmatically decide which GUIs should remain visible, include the [hideOtherGuis](#hideotherguis) and [showOtherGuis](#showotherguis) callbacks and respond with your own custom logic.
@@ -149,7 +149,7 @@ PhotoBooth.showOtherGuis(function()
end)
```
-## API reference
+## API Reference
### Functions
diff --git a/content/en-us/resources/modules/profile-card.md b/content/en-us/resources/modules/profile-card.md
index 3a193f903..a82c4132d 100644
--- a/content/en-us/resources/modules/profile-card.md
+++ b/content/en-us/resources/modules/profile-card.md
@@ -7,7 +7,7 @@ It can be interesting to learn about other players. The **ProfileCard** [develop
-## Module usage
+## Module Usage
### Installation
@@ -88,7 +88,7 @@ Note that players under the age of 13 will only see the status message if it's a
-### Use tokens
+### Using Tokens
The scavenger hunt module uses **tokens** as the items which players search for and collect. The module comes with one token model that you can position in the 3D world.
@@ -79,7 +79,7 @@ Remember that each token must have a unique name as a means of tracking player p
The module will automatically disable the `Class.BasePart.CanCollide|CanCollide` property of tokens at runtime so that players do not physically collide with them. As such, all tokens should be **anchored** so they do not fall through the world geometry.
-### Use regions
+### Using Regions
Regions differ slightly from tokens, as large areas that are marked as "collected" once the player enters them. Additionally, when a player leaves the region, the flavor text modal automatically dismisses and the region itself is removed from the workspace.
@@ -113,7 +113,7 @@ The module is preconfigured to work for most use cases, but it can be easily cus
})
```
-### Collection events
+### Collection Events
Every time a player collects a token or enters a region, the [collected](#collected) event fires. You can listen to this event from a server-side `Class.Script` and respond accordingly. The connected function receives the `Class.Player` that collided with the token or entered the region and that token or region's name.
@@ -162,7 +162,7 @@ end)
When using custom modals, be sure to provide a way for players to close/hide them, or an automatic dismissal after a delay.
-### GUI visibility
+### GUI Visibility
By default, the scavenger hunt hides all `Class.ScreenGui|ScreenGuis` and `Class.CoreGui|CoreGuis` (except for the player list) when the info modal or completion modal appears. If you want to override this auto-hiding behavior and programmatically decide which GUIs should remain visible, include the [hideOtherGuis](#hideotherguis) and [showOtherGuis](#showotherguis) callbacks and respond with your own custom logic.
@@ -214,7 +214,7 @@ ScavengerHunt.showOtherGuis(function()
end)
```
-## API reference
+## API Reference
### Functions
diff --git a/content/en-us/resources/npc-kit.md b/content/en-us/resources/npc-kit.md
index 5c830b5f7..781d74fd9 100644
--- a/content/en-us/resources/npc-kit.md
+++ b/content/en-us/resources/npc-kit.md
@@ -1,5 +1,5 @@
---
-title: NPC kit
+title: NPC Kit
description: The NPC Kit provides several pre-built, customizable NPCs for use an any experience.
---
@@ -41,14 +41,14 @@ To use an NPC in your game:
5. Locate the NPC and click it to add it into the place.
-## Character structure
+## Character Structure
Each NPC model typically contains the following objects:
-### Layer and components
+### Layer and Components
In [Plant][planturl], all UI structures are either a `Layer` or a `Component`.
- `Layer` is defined as a top level grouping singleton that wraps prefabricated UI structures in `Class.ReplicatedStorage`. A layer may contain a number of components, or it may encapsulate its own logic entirely. Examples of layers are the inventory menu or the number of coins indicator in the heads up display.
- `Component` is a reusable UI element. When a new component object is instantiated, it clones a prefabricated template from `Class.ReplicatedStorage`. Components may in themselves contain other components. Examples of components are a generic button class or the concept of a list of items.
-### View handling
+### View Handling
A common UI management problem is view handling. This project has a range of menus and HUD items, some of which listen to user input, and careful management of when they are visible or enabled is required.
@@ -648,7 +648,7 @@ This approach is intuitive because it allows menus to be navigated with history.
UI layer singletons register themselves with the **UIHandler** and are provided with a signal that fires when its visibility should change.
-## Further reading
+## Further Reading
From this thorough overview of the [Plant][planturl] project, you may want to
explore the following guides which go further in depth on related concepts and
diff --git a/content/en-us/resources/roblox-connect.md b/content/en-us/resources/roblox-connect.md
index c697a6202..6619ba585 100644
--- a/content/en-us/resources/roblox-connect.md
+++ b/content/en-us/resources/roblox-connect.md
@@ -1,5 +1,5 @@
---
-title: Roblox Connect project
+title: Roblox Connect Project
description: Explore Roblox Connect, an experience where you can call a friend and have a conversation as your avatars, together in a shared immersive space.
---
@@ -9,11 +9,11 @@ description: Explore Roblox Connect, an experience where you can call a friend a
To run [Roblox Connect][robloxconnecturl], you and your friends need to be on client version 602 or higher. Additionally, to implement the current [methods and events](#api-implementation) in one of your own experiences, it must have been published to Roblox for at least one week.
-## Project overview
+## Project Overview
Developers can introduce synchronous avatar communication into any experience on Roblox utilizing current methods and events. Some of the noteworthy [Roblox Connect][robloxconnecturl] feature highlights and call privacy details are shared below.
-### Environment switcher
+### Environment Switcher
To provide a better immersive communicative experience, the project includes an **environment switcher** that allows players to move from environment to environment. When moving among environments in the same place, player characters are repositioned via `Class.PVInstance:PivotTo()|PivotTo()`. When moving to an environment in a different place, players are teleported via `Class.TeleportService` to their desired location.
@@ -23,13 +23,13 @@ In regards to the call, teleport is to a reserved server and all call participan
-### Camera modes
+### Camera Modes
[Roblox Connect][robloxconnecturl] introduces two unique camera modes in addition to the default camera mode, both of which you can utilize to enhance your own experiences. Furthermore, when switching between various camera modes, a camera transitioner makes switching between modes feel seamless.
-#### Picture-in-picture
+#### Picture-in-Picture
In **picture-in-picture** mode, camera focus is on your call partner and a small view of your character floats on the screen. This mode also includes head tracking, and the local player's movement is restricted.
@@ -45,7 +45,7 @@ The **cinematic** mode attempts to keep both player characters within your camer
The **freeplay** mode uses the default Roblox character camera, letting you move around while also talking to your call partner. Your partner's character will not necessarily be in view.
-### Emote bar
+### Emote Bar
The project's **emote bar** is a cloned version of the [EmoteBar](../resources/modules/emote-bar.md) developer module. Out of the box, the module contains a lot of key features, but [Roblox Connect][robloxconnecturl] requires a few specific changes such as returning the character to "idle" state after performing the emote once.
@@ -55,7 +55,7 @@ The project's **emote bar** is a cloned version of the [EmoteBar](../resources/m
If someone who is not in the call is added to the reserved server, or is already in the reserved server, the call is ended.
-## API implementation
+## API Implementation
[Roblox Connect][robloxconnecturl] takes advantage of new `Class.SocialService` and `Class.PlayerViewService` methods and events to build an immersive communication platform.
diff --git a/content/en-us/resources/the-mystery-of-duvall-drive/construct-the-house.md b/content/en-us/resources/the-mystery-of-duvall-drive/constructing-the-house.md
similarity index 97%
rename from content/en-us/resources/the-mystery-of-duvall-drive/construct-the-house.md
rename to content/en-us/resources/the-mystery-of-duvall-drive/constructing-the-house.md
index 36365285a..8d932557b 100644
--- a/content/en-us/resources/the-mystery-of-duvall-drive/construct-the-house.md
+++ b/content/en-us/resources/the-mystery-of-duvall-drive/constructing-the-house.md
@@ -1,7 +1,7 @@
---
-title: Construct the house
+title: Constructing the House
comments:
-next: /resources/the-mystery-of-duvall-drive/materialize-the-world
+next: /resources/the-mystery-of-duvall-drive/materializing-the-world
prev: /resources/the-mystery-of-duvall-drive
description: Explains the design process for house in The Mystery of Duvall Drive.
---
@@ -10,7 +10,7 @@ It took many iterations and rapid testing at the beginning of the process to mak
-## Begin with a 2D layout
+## Beginning with a 2D Layout
Since the house is both the majority of the playable area and an entire character unto itself, we wanted to give a lot of thought about how to make sure it remained both real and fun. We started with the idea that the house should contain several visual and audio gags, lore, and corrupt puzzle rooms, and we wanted players to initially approach the house with little knowledge of what was going on, learning what happened to the house and the family that lived there as they were playing.
@@ -50,7 +50,7 @@ While we wanted to eventually replace the temporary assets with our own, the onl
-## Build a 3D layout
+## Building a 3D Layout
All the early planning and ideas in the world don't make a fun experience, so it was time to start making the idea 3D! The exterior layout was blocked out and we made space for the house to be expanded or contracted. Earliest iterations were done in another 3D application where we could make simple boxes and shapes to start turning that 2D image into a playable space. You may find that building the early versions in Studio and using simple parts is your favorite method. There's no wrong way, so long as you get your ideas into 3D and playable quickly!
@@ -109,13 +109,13 @@ We went through many small and large iterations to settle on what we have in the
-This list gave us a good understanding of what needed to take priority when gray boxing out the content and populating it throughout the house. By adding high-priority content early, we could easily see when assets were repetitious, had incorrect proportions, or when they would need a second variation or a texture swap when they were in certain rooms. Some content we blocked out early on ended up not being important to the experience and removed, but we didn't lose a lot of work in the process since they were only quick blockouts. For all the furniture and props we kept, we made them into [packages](#utilize-packages) in their blockout phase, and this made it easier for us to replace everything throughout the house with their final versions.
+This list gave us a good understanding of what needed to take priority when gray boxing out the content and populating it throughout the house. By adding high-priority content early, we could easily see when assets were repetitious, had incorrect proportions, or when they would need a second variation or a texture swap when they were in certain rooms. Some content we blocked out early on ended up not being important to the experience and removed, but we didn't lose a lot of work in the process since they were only quick blockouts. For all the furniture and props we kept, we made them into [packages](#utilizing-packages) in their blockout phase, and this made it easier for us to replace everything throughout the house with their final versions.
diff --git a/content/en-us/resources/the-mystery-of-duvall-drive/design-dark-soundscapes.md b/content/en-us/resources/the-mystery-of-duvall-drive/designing-dark-soundscapes.md
similarity index 89%
rename from content/en-us/resources/the-mystery-of-duvall-drive/design-dark-soundscapes.md
rename to content/en-us/resources/the-mystery-of-duvall-drive/designing-dark-soundscapes.md
index 19182fd1f..974aacc8d 100644
--- a/content/en-us/resources/the-mystery-of-duvall-drive/design-dark-soundscapes.md
+++ b/content/en-us/resources/the-mystery-of-duvall-drive/designing-dark-soundscapes.md
@@ -1,7 +1,7 @@
---
-title: Design dark soundscapes
+title: Designing Dark Soundscapes
comments:
-prev: /resources/the-mystery-of-duvall-drive/develop-a-moving-world
+prev: /resources/the-mystery-of-duvall-drive/developing-a-moving-world
description: Explains the design concepts for gloomy soundscapes in The Mystery of Duvall Drive.
---
@@ -11,7 +11,7 @@ Sound design for an experience with horror themes is a balancing act between emb
-## Volumetric audio
+## Volumetric Audio
**[Volumetric audio](../../sound/objects.md#volumetric)** is the most realistic audio option in Studio to how people perceive sound depending on its distance to their ears. This type of audio allows you to place a `Class.Sound` object on a `Class.BasePart`, then use that `Class.BasePart` to cover an entire area of where you want that audio to play. It's highly useful for large objects that make sound, such as waterfalls, vehicles, and large cities. When a player is within a `Class.BasePart` that has a child `Class.Sound` object with volumetric audio enabled, the audio plays all around the player, similar to music in headphones playing at the same volume in each speaker. When the user exits the object, audio gradually decreases in volume and becomes more directional per speaker, moving around the user's head when their listener rotates. This means that if the sound is emitting to the left of your listener, the sound plays louder in your left speaker than your right speaker.
@@ -66,11 +66,11 @@ When adding detail to our outdoor soundscape, it was important to make the rain
This process allowed the sound to emit from the entire surface of the invisible part. If the player was inside of the part, the raindrop audio would play all around the player's head. The larger you make your own volumetric audio emitters, the more spread and area the volumetric sound will cover, so experiment with different sizes and shapes for your emitter to get the soundscape you want for your own experiences!
-## Nested SoundGroup mixing
+## Nested SoundGroup Mixing
As human beings, we like to think we are great multitaskers, but in reality it's quite difficult for us to focus on more than 2 things at once, especially in regards to listening to multiple audio sources! In The Mystery Of Duvall Drive, there could be a dozen sounds playing at any given time, such as ambience, music, footsteps, rain, or UI notifications, but we needed a way to make sure that it didn't feel as though they were all competing for your attention. For this reason, we decided to nest `Class.SoundGroup|SoundGroups` in child/parent relationships so we could create an audio mix to ensure both the organization and consistency of the project's sound design.
-**[Nesting SoundGroups](../../sound/groups.md#nest-soundgroups)** is a new feature that allows you to organize `Class.SoundGroup|SoundGroups` together into meaningful categories under a mix tree for further audio functionality, such as being able to fine-tune the volume of many audio sources at once, or apply common audio effects at a lower CPU cost. As we took a very progression-oriented approach to the mix in this project, we wanted sounds that directly contribute to player progression in the puzzles (puzzle and key object interaction audio) to be given priority over sounds that don't contribute to their progression (wind, rain, footsteps, atmosphere audio). By nesting child `Class.SoundGroup|SoundGroups` into parent `Class.SoundGroup|SoundGroups` of different priority levels, we could then add a `Class.CompressorSoundEffect` that would lower the volume of low-priority `Class.SoundGroup|SoundGroups` in real time whenever audio from high-priority `Class.SoundGroup|SoundGroups` started playing. This process is called [ducking](../../sound/groups.md#ducking).
+**[Nesting SoundGroups](../../sound/groups.md#nesting-soundgroups)** is a new feature that allows you to organize `Class.SoundGroup|SoundGroups` together into meaningful categories under a mix tree for further audio functionality, such as being able to fine-tune the volume of many audio sources at once, or apply common audio effects at a lower CPU cost. As we took a very progression-oriented approach to the mix in this project, we wanted sounds that directly contribute to player progression in the puzzles (puzzle and key object interaction audio) to be given priority over sounds that don't contribute to their progression (wind, rain, footsteps, atmosphere audio). By nesting child `Class.SoundGroup|SoundGroups` into parent `Class.SoundGroup|SoundGroups` of different priority levels, we could then add a `Class.CompressorSoundEffect` that would lower the volume of low-priority `Class.SoundGroup|SoundGroups` in real time whenever audio from high-priority `Class.SoundGroup|SoundGroups` started playing. This process is called [ducking](../../sound/groups.md#ducking).
-## Create the storm
+## Creating the Storm
The storm went through many iterations before we settled on what is live in The Mystery of Duvall Drive. Early on, we thought about the storm as a giant obsidian pillar, and in later iterations we considered it to be a giant portal to the corrupt space. After experimenting with many different storms with unique looks and feels to them, we settled on a storm with a smaller central "eye" because:
@@ -33,9 +33,9 @@ To make the storm feel dynamic, aggressive, and ever-changing within its environ
1. **[Particle Emitters](../../effects/particle-emitters.md)** - For debris flying up to the portal and flying around due to the wind blowing.
1. **[Animations](../../animation/index.md)** - For the trees that were blowing in the wind.
-### Add clouds with textures
+### Adding Clouds with Textures
-While [dynamic clouds](../../environment/clouds.md) are great for normal, high altitude realistic clouds, we needed something that felt dramatic and that we could more heavily direct and customize. To do this, we applied [surface appearance](../../art/modeling/surface-appearance.md) objects with semi-transparency to a series of heavily stacked and layered cloud meshes in order to fake cloud cover. Why did we stack them and layer them so heavily? Because when each cloud mesh moves at different speeds, they intersect and create cloud forms that go inside and out of each other. This process made the clouds feel a bit more dynamic and natural, despite just being spinning discs. It was also important that the clouds were [semi-transparent](../../resources/beyond-the-dark/layered-clothing.md#import-to-studio-1), because we wanted players to be able to peek through them to see something bright in the center prior to arriving at the house!
+While [dynamic clouds](../../environment/clouds.md) are great for normal, high altitude realistic clouds, we needed something that felt dramatic and that we could more heavily direct and customize. To do this, we applied [surface appearance](../../art/modeling/surface-appearance.md) objects with semi-transparency to a series of heavily stacked and layered cloud meshes in order to fake cloud cover. Why did we stack them and layer them so heavily? Because when each cloud mesh moves at different speeds, they intersect and create cloud forms that go inside and out of each other. This process made the clouds feel a bit more dynamic and natural, despite just being spinning discs. It was also important that the clouds were [semi-transparent](../../resources/beyond-the-dark/layered-clothing.md#importing-to-studio-1), because we wanted players to be able to peek through them to see something bright in the center prior to arriving at the house!
-### Make trees blow in the wind
+### Making Trees Blow in the Wind
-After we had the clouds and the lightning working the way we wanted it to, we then needed to add two other major components of a storm: the wind and the rain! These elements presented a few challenges, including needing to work within Studio's current limitations of our physics and special effects systems. For example, making trees move with actual wind isn't possible in today's engine, so we utilized [particle emitter](../../effects/particle-emitters.md) effects and [custom character animations](../../animation/editor.md#create-an-animation) for the trees.
+After we had the clouds and the lightning working the way we wanted it to, we then needed to add two other major components of a storm: the wind and the rain! These elements presented a few challenges, including needing to work within Studio's current limitations of our physics and special effects systems. For example, making trees move with actual wind isn't possible in today's engine, so we utilized [particle emitter](../../effects/particle-emitters.md) effects and [custom character animations](../../animation/editor.md#creating-an-animation) for the trees.
We knew to really sell the effect of the wind and rain, we needed the trees themselves to move. There are a few ways you can do this within the engine, including moving parts using [plugins](../../studio/plugins.md) that are publicly available, using `Class.TweenService`, or animating models directly. For our purposes, animations gave us the ability to control the motion we wanted out of our trees, and it allowed us to use a single animation we could share among all trees within the experience.
@@ -232,7 +232,7 @@ We started by skinning several trees from the [Endorse Model Pack - Forest Asset
@@ -276,7 +276,7 @@ Once we had all the tree types we wanted animated, we made each into [packages](
-## Thought bubbles
+## Thought Bubbles
We needed a way for the player's character to communicate ideas to the player, such as providing additional narrative flavor or reinforcing what they needed to do. Our solution was to display thought bubbles, or **text reactions from the player's character**, near non-lore objects whenever the player selected them. This narrative only displays to the player that clicked or tapped the object, and the tone is always first person and observational.
diff --git a/content/en-us/resources/the-mystery-of-duvall-drive/index.md b/content/en-us/resources/the-mystery-of-duvall-drive/index.md
index fac8a95b2..2563131da 100644
--- a/content/en-us/resources/the-mystery-of-duvall-drive/index.md
+++ b/content/en-us/resources/the-mystery-of-duvall-drive/index.md
@@ -1,7 +1,7 @@
---
title: The Mystery of Duvall Drive
comments:
-next: /resources/the-mystery-of-duvall-drive/construct-the-house
+next: /resources/the-mystery-of-duvall-drive/constructing-the-house
description: The Mystery of Duvall Drive is a showcase demo with accompanying documentation on the concepts and processes used during development.
---
@@ -16,14 +16,14 @@ Similar to the previous [Beyond the Dark](../../resources/beyond-the-dark/index.
- **`Class.MaterialService`** and custom materials
- **Packages** and their ability to streamline processes
-- **Volumetric audio** and `Class.SoundService`
-- **Streaming enabled** for complex experiences
+- **Volumetric Audio** and `Class.SoundService`
+- **Streaming Enabled** for complex experiences
You can follow the articles sequentially or jump between the following sections:
-- **[Construct the house](../../resources/the-mystery-of-duvall-drive/construct-the-house.md)** explores the transformation from a simple blueprint to the final environment, including the process to ensure the environment was fun from start to finish.
-- **[Materialize the world](../../resources/the-mystery-of-duvall-drive/materialize-the-world.md)** details how both `Class.MaterialService` and `Class.SurfaceAppearance` create the look and feel of each room's normal and corrupted state.
-- **[Immersive narrative](../../resources/the-mystery-of-duvall-drive/immersive-narrative.md)** demonstrates how to utilize UI features to build lore throughout the playable area.
-- **[Stream in immersion](../../resources/the-mystery-of-duvall-drive/stream-in-immersion.md)** explains how we both code and constructed the experience to take advantage of Streaming Enabled capabilities.
-- **[Develop a moving world](../../resources/the-mystery-of-duvall-drive/develop-a-moving-world.md)** describes how and why movement can give the world a sense of life and reactiveness.
-- **[Design dark soundscapes](../../resources/the-mystery-of-duvall-drive/design-dark-soundscapes.md)** details how `Class.SoundService` and [volumetric audio](../../sound/objects.md#volumetric) craft the distinct soundscapes of the normal and corrupted worlds.
+- **[Constructing the House](../../resources/the-mystery-of-duvall-drive/constructing-the-house.md)** explores the transformation from a simple blueprint to the final environment, including the process to ensure the environment was fun from start to finish.
+- **[Materializing the World](../../resources/the-mystery-of-duvall-drive/materializing-the-world.md)** details how both `Class.MaterialService` and `Class.SurfaceAppearance` create the look and feel of each room's normal and corrupted state.
+- **[Immersive Narrative](../../resources/the-mystery-of-duvall-drive/immersive-narrative.md)** demonstrates how to utilize UI features to build lore throughout the playable area.
+- **[Streaming in Immersion](../../resources/the-mystery-of-duvall-drive/streaming-in-immersion.md)** explains how we both code and constructed the experience to take advantage of Streaming Enabled capabilities.
+- **[Developing a Moving World](../../resources/the-mystery-of-duvall-drive/developing-a-moving-world.md)** describes how and why movement can give the world a sense of life and reactiveness.
+- **[Designing Dark Soundscapes](../../resources/the-mystery-of-duvall-drive/designing-dark-soundscapes.md)** details how `Class.SoundService` and [volumetric audio](../../sound/objects.md#volumetric) craft the distinct soundscapes of the normal and corrupted worlds.
diff --git a/content/en-us/resources/the-mystery-of-duvall-drive/main-design-requirements.md b/content/en-us/resources/the-mystery-of-duvall-drive/main-design-requirements.md
index b9e76fcf6..7fac28d43 100644
--- a/content/en-us/resources/the-mystery-of-duvall-drive/main-design-requirements.md
+++ b/content/en-us/resources/the-mystery-of-duvall-drive/main-design-requirements.md
@@ -1,5 +1,5 @@
---
-title: Main design requirements
+title: Main Design Requirements
comments:
next: /resources/the-mystery-of-duvall-drive/foundational-gameplay-systems
prev: /resources/the-mystery-of-duvall-drive/technical-overview
@@ -10,13 +10,13 @@ The following list provides an overview of the main technical design requirement
## Missions
-There are several types of missions players must solve in order to progress through the experience, including navigating a [series of spinning platforms](../../resources/the-mystery-of-duvall-drive/developing-a-moving-world.md#make-the-corrupted-treehouse) until players are able to retrieve a special item, or finding different ingredients in an [expanding pantry](../../resources/the-mystery-of-duvall-drive/develop-a-moving-world.md#make-the-expanding-pantry) and placing them into a boiling pot. To organize the scripting process of creating and debugging missions, we created a mission framework and a debug version.
+There are several types of missions players must solve in order to progress through the experience, including navigating a [series of spinning platforms](../../resources/the-mystery-of-duvall-drive/developing-a-moving-world.md#making-the-corrupted-treehouse) until players are able to retrieve a special item, or finding different ingredients in an [expanding pantry](../../resources/the-mystery-of-duvall-drive/developing-a-moving-world.md#making-the-expanding-pantry) and placing them into a boiling pot. To organize the scripting process of creating and debugging missions, we created a mission framework and a debug version.
-### Mission framework
+### Mission Framework
To ensure that we unified each step of the mission throughout the experience, we designed a **simple puzzle mission framework** for each mission which consisted of hooks for the start and finish of the puzzle, a spot to read configuration data, and a button to complete the puzzle for [debugging purposes](#debug-version). For more detailed information on this process and its parameters, see [Missions Logic](../../resources/the-mystery-of-duvall-drive/foundational-gameplay-systems.md#missions-logic).
-#### Seals and game states
+#### Seals and Game States
When players entered specific rooms, we wanted them to interact with special small objects known as **seals** to trigger missions. After they solved the mission, we wanted them to grab the seal and place it in a predefined location within the foyer in order to progress through the overall gameplay. After they placed the seal in the correct location, they could then continue to another room within the house and start the next mission by clicking on that room's special object.
@@ -39,7 +39,7 @@ To implement this, we created **game states**, which would specify the period of
Game states largely control the flow of the experience and how players interact with the experience's [narrative](../../resources/the-mystery-of-duvall-drive/immersive-narrative.md). For more information, see [GameStateManager](../../resources/the-mystery-of-duvall-drive/foundational-gameplay-systems.md#gamestatemanager).
-#### Normal and corrupt rooms
+#### Normal and Corrupt Rooms
We wanted to have two states of six rooms in the house: a normal state and a corrupted state. When a player would touch a corrupted seal in a room to trigger the room's corrupted state, the environment would change to a darker atmosphere with modified lighting, environmental objects, and special effects. Players would then have to solve the mission in order to return to the room's normal state.
@@ -56,7 +56,7 @@ We wanted to have two states of six rooms in the house: a normal state and a cor
To implement this, we prepared a special space in the experience that was very far from the house, about 6,500 studs away in the **X** direction that could accommodate the corrupt state of a room. When a player triggers any corrupted state, the corrupt state of that specific room clones into this area from `Class.ServerStorage` to the **TempStorage/Cloned** folder, then players [teleport](#teleportation) into that room. Small `Class.Part|Parts` exist within each normal and corrupt room that serve as spawn points for players when entering or leaving rooms. After they solve the mission, we simultaneously teleport players back into the normal state of the room, and destroy all objects in the corrupt state of the room. For more information on the game states that control this teleportation process, see [GameStateManager](../../resources/the-mystery-of-duvall-drive/foundational-gameplay-systems.md#gamestatemanager).
-### Debug version
+### Debug Version
To assist us in periodically debugging missions, we created a version of the experience where we wouldn't have to wait in the lobby or for cutscenes. This version had keyboard-based cheats and buttons that would allow us to automatically complete missions so we could quickly test aspects of the experience. We would periodically copy and publish this version into the version we planned to release that had the proper gameplay flow. To distinguish these two versions, we made a **DemoGlobalSettings** script to check the placeID, see if it's running in Studio, and enable/disable various gameplay cheats and buttons. For more information, see [Missions Logic](../../resources/the-mystery-of-duvall-drive/foundational-gameplay-systems.md#missions-logic) and [Configuration Scripts](../../resources/the-mystery-of-duvall-drive/supporting-systems.md#configuration-scripts).
@@ -66,9 +66,9 @@ There are three types of teleportation that occur within the experience:
1. Teleporting players from the simple lobby to the main gameplay area in a [reserved server](#reserved-servers).
1. Teleporting players from a room's normal state to the corrupt state, then back again while showing a [cutscene](#cutscenes).
-1. Teleporting players within some puzzles, or when they [respawn](#respawn-players) after falling off the gameplay area.
+1. Teleporting players within some puzzles, or when they [respawn](#respawning-players) after falling off the gameplay area.
-### Reserved servers
+### Reserved Servers
We decided to group players into groups of five in a **simple lobby** before teleporting them over to a **reserved server** for the main gameplay area of the house. The lobby provided time for additional players to join and play together, and reserved servers prevented additional players from missing aspects of the gameplay and narrative from joining the experience late. This teleportation only happens once.
@@ -80,22 +80,22 @@ We wanted to be able to transport players throughout the game whenever they acco
-### Respawn players
+### Respawning Players
The third type of teleportation we wanted to implement was a short teleport with only a player `Datatype.CFrame` coordinate change within some puzzles and when players fall and respawn. Unlike the previous two types of teleportation, this type doesn't explicitly request async streaming.
-## Gameplay scripting
+## Gameplay Scripting
-Scripting allowed us to execute on specific gameplay elements, such as fading UI elements, creating trigger volumes for key events, and highlighting objects when they were in focus with the player's cursor. Many of these systems relied on tagging objects to perform custom behavior, then using a variety of client or server scripts to contain specific workflows depending on what action needed to happen at set points in the experience. For more information on how we implemented these systems, see [Foundational gameplay systems](../../resources/the-mystery-of-duvall-drive/foundational-gameplay-systems.md) and [Supporting Systems](../../resources/the-mystery-of-duvall-drive/supporting-systems.md).
+Scripting allowed us to execute on specific gameplay elements, such as fading UI elements, creating trigger volumes for key events, and highlighting objects when they were in focus with the player's cursor. Many of these systems relied on tagging objects to perform custom behavior, then using a variety of client or server scripts to contain specific workflows depending on what action needed to happen at set points in the experience. For more information on how we implemented these systems, see [Foundational Gameplay Systems](../../resources/the-mystery-of-duvall-drive/foundational-gameplay-systems.md) and [Supporting Systems](../../resources/the-mystery-of-duvall-drive/supporting-systems.md).
-### Custom behavior with tags
+### Custom Behavior with Tags
We wanted a way to add custom behavior for objects, such as locking doors so players would have to stay within the room until they completed the active mission. To implement this, we decided to use tags for specific objects, then we used `Class.CollectionService` to find these objects and connect any corresponding `Class.Script|Scripts` to add custom behavior. We had one `Class.Script` for each tag category that acted as a manager to handle all objects tagged under that category so we could keep the `Class.Script` in a single location rather than being copied many times in `Class.DataModel`. For more information, see [DoorManager](../../resources/the-mystery-of-duvall-drive/supporting-systems.md#doormanager), [MasterAnimator](../../resources/the-mystery-of-duvall-drive/supporting-systems.md#masteranimator), [DrawerManager](../../resources/the-mystery-of-duvall-drive/supporting-systems.md#drawermanager), [KillVolumes](../../resources/the-mystery-of-duvall-drive/supporting-systems.md#killvolumes), [PlayerMissionRespawn](../../resources/the-mystery-of-duvall-drive/supporting-systems.md#playermissionrespawn), and [PianoManager](../../resources/the-mystery-of-duvall-drive/supporting-systems.md#pianomanager).
The "manager" `Class.Script` uses an `Init` function to find any objects tagged when the experience starts, and connect a custom behavior to them. For example, DoorManager finds any object tagged with **Door**, then it attaches the correct behavior to the door objects (moves the door open when clicked, plays a door swing sound effect, etc.). However, any objects that are added or removed during runtime, such as any objects that are added to a corrupted room after a player interacts with a corrupted seal, miss this initial call and never get the expected behavior. To solve this, we use `Class.CollectionService.GetInstanceAddedSignal` and `Class.CollectionService.GetInstanceRemovedSignal` to grant the same behavior to new objects that are tagged and untagged, respectively.
-### Client and server scripts
+### Client and Server Scripts
We wanted to reduce bandwidth for different aspects of gameplay that would be expensive on performance. We decided that when object functionality can affect simulation for other players, such as moving object through collision, we would run this on the **server**, but if something is more related to environment design, such as lights, environmental animations that don't affect gameplay, special effects, and audio, we would run them on **clients**. This would reduce bandwidth, and keep both movement and environment changes smoother on user devices.
diff --git a/content/en-us/resources/the-mystery-of-duvall-drive/materialize-the-world.md b/content/en-us/resources/the-mystery-of-duvall-drive/materializing-the-world.md
similarity index 94%
rename from content/en-us/resources/the-mystery-of-duvall-drive/materialize-the-world.md
rename to content/en-us/resources/the-mystery-of-duvall-drive/materializing-the-world.md
index f492251fa..8031c564f 100644
--- a/content/en-us/resources/the-mystery-of-duvall-drive/materialize-the-world.md
+++ b/content/en-us/resources/the-mystery-of-duvall-drive/materializing-the-world.md
@@ -1,24 +1,24 @@
---
-title: Materialize the world
+title: Materializing the World
comments:
next: /resources/the-mystery-of-duvall-drive/immersive-narrative
-prev: /resources/the-mystery-of-duvall-drive/construct-the-house
+prev: /resources/the-mystery-of-duvall-drive/constructing-the-house
description: Explains the use of materials and textures in The Mystery of Duvall Drive.
---
-We use [materials](../../parts/materials.md) and [surface appearance](../../art/modeling/surface-appearance.md) objects to create an immersive and realistic indoor and outdoor environment. Without materials, this scene could still have some interesting depth, silhouettes, and lighting, but with our materials and texture systems, we can really bring the room to life and add a dimension of realism to the world.
+We use [materials](../../parts/materials.md) and [Surface Appearance](../../art/modeling/surface-appearance.md) objects to create an immersive and realistic indoor and outdoor environment. Without materials, this scene could still have some interesting depth, silhouettes, and lighting, but with our materials and texture systems, we can really bring the room to life and add a dimension of realism to the world.
These [physically-based rendering](../../art/modeling/surface-appearance.md) (PBR) materials are what makes surfaces like wood look, react, and reflect the way wood does in the real world. In this section, we will go over some of the decisions and processes we went through to create the palette of materials used in the demo. As in the [Beyond the Dark](../../resources/beyond-the-dark/index.md) demo, we wanted a realistic look and feel for our materials and we achieved it through a few different approaches.
You can break down the process of building all our textures and materials into three areas:
-- Surface appearance objects for 1:1 or unique materials for meshes, such as a marble statue.
-- Surface appearance objects for shared trim maps for `Class.MeshPart|MeshParts`, such as repeatable wood trim details on furniture.
+- Surface Appearance objects for 1:1 or unique materials for meshes, such as a marble statue.
+- Surface Appearance objects for shared trim maps for `Class.MeshPart|MeshParts`, such as repeatable wood trim details on furniture.
- [Material variants](../../parts/materials.md#custom-materials) for shared materials on Parts or terrain, such as flagstone replacing cobblestone for both fireplaces and ground.
-## Plan, reuse, and budgets
+## Planning, Reuse, and Budgets
When starting any project, give some thought about material art direction for consistency and reuse. Every platform and device has a limit on the amount of memory you can use for textures so some upfront planning goes a long way to help keep a handle on the number of textures in your experience.
@@ -36,9 +36,9 @@ Distilled down to its basics, [American Craftsman](https://en.wikipedia.org/wiki
-## System folder structure
+## System Folder Structure
The **WeaponsSystem** folder is a unified folder that contains assets, configurations, and scripts that power all endorsed weapons in the experience. If located in **ServerScriptService**, it overrides any equivalent **WeaponsSystem** folders that may reside within individual weapons.
@@ -92,16 +92,16 @@ Within the **WeaponsSystem** folder, different aspects are controlled by the fol
-### Muzzle flashes
+### Muzzle Flashes
This option creates a `Class.Beam` flash effect when the weapon is fired.
@@ -555,7 +555,7 @@ Configuration descendants:
- **MuzzleFlashSize0** (`Class.NumberValue`) (optional) — Minimum size of muzzle flash; default is **1**.
- **MuzzleFlashSize1** (`Class.NumberValue`) (optional) — Maximum size of muzzle flash; default is **1**.
-### Particle trails
+### Particle Trails
This option creates a trail of varying length from the weapon to the projectile impact point.
@@ -567,7 +567,7 @@ Configuration descendants:
- **TrailLengthFactor** (`Class.NumberValue`) (optional) — The trail length will be set to this value multiplied by the distance the bullet/projectile traveled in the last frame; default is **1**. Note that this will be overridden if you include **TrailLength**.
- **ShowEntireTrailUntilHit** (`Class.BoolValue`) (optional) — Set to **true** to render the trail from the weapon tip all the way to wherever the projectile is; this will override both **TrailLength** and **TrailLengthFactor** and the trail will only disappear once the projectile hits something. Set to **false** to use one of the above two options to calculate trail length. Default is **false**.
-### Hit marks
+### Hit Marks
This visual addition appears on the surface where projectiles hit and is useful for arrows, bullet holes, scorch marks, etc.
@@ -589,7 +589,7 @@ You can add the following optional asset within `WeaponsSystem/Assets/Effects/Hi
- **Impact** (`Class.ImageLabel`) (optional) — Direct child of **ImpactBillboard**; this begins fully opaque, grows to the full size of the **ImpactBillboard** over 0.1 seconds, then shrinks to half its size and fades to full transparency over 0.1 seconds.
- Any `Class.Part`/`Class.MeshPart`/`Class.SpecialMesh` that you want to appear as a physical projectile (optional). For example, including an arrow `Class.MeshPart` and setting **AlignHitMarkToNormal** noted above to **false** will make the arrow stick out of the surface from the direction you shot it.
-### Exploding projectiles
+### Exploding Projectiles
Projectiles can include an Explosion object to damage player characters in an area around the impact point.
@@ -602,7 +602,7 @@ Configuration descendants:
- **BlastPressure** (`Class.NumberValue`) (optional) — BlastPressure of explosion; default is **10000**.
- **BlastDamage** (`Class.NumberValue`) (optional) — Damage dealt to things in the center of the explosion. Note that the explosion does less damage the farther away hit objects are from the center of the explosion. Default is **100**.
-### Charging weapon
+### Charging Weapon
A charging weapon like the Railgun must be charged up between shots before it can fire again.
@@ -631,7 +631,7 @@ Configuration descendants:
- **NumChargeCompleteParticles** (`Class.IntValue`) (optional) — Number of particles the - ChargeCompleteParticles emitter will emit once the weapon is fully charged. Default is **25**.
- **NumDischargeCompleteParticles** (`Class.IntValue`) (optional) — Number of particles the - **DischargeCompleteParticles** emitter will emit when the weapon is completely discharged. Default is **25**.
-### Bow weapon
+### Bow Weapon
A bow weapon like the Crossbow can include a realistic string and arms construction, as well as a visual arrow nocked to the string.
@@ -663,7 +663,7 @@ Model descendants:
- **LooseScale** (`Class.Vector3Value`) (optional) — Scale of the `Class.SpecialMesh` when the bow is at rest.
- **TightScale** (`Class.Vector3Value`) (optional) — Scale of the `Class.SpecialMesh` when the bow is fully drawn.
-## Weapons system GUI
+## Weapons System GUI
The core weapons system interfaces with this system to update the GUI based on things like spread of the gun, indicators for when you get hit or hit others, etc.
@@ -674,7 +674,7 @@ The **WeaponsSystemGui** is a `Class.ScreenGui` object in `WeaponsSystem/Assets`
- [Scope](#scope) - A `Class.Frame` for zooming in with weapons that use a scope.
- [SmallTouchscreen](#smalltouchscreen) - A `Class.Frame` for buttons on small touchscreens.
-### Scaling elements
+### Scaling Elements
ScalingElements is a `Class.Folder` parented under WeaponsSystemGui with the following descendants:
@@ -682,7 +682,7 @@ ScalingElements is a `Class.Folder` parented under WeaponsSystemGui with the fol
-## Example project structure
+## Example Project Structure
The [Plant](../resources/plant-reference-project.md) reference project shows how you might organize your code in a large, complex experience.
diff --git a/content/en-us/scripting/module.md b/content/en-us/scripting/module.md
index 70040c6e9..a8a4ae127 100644
--- a/content/en-us/scripting/module.md
+++ b/content/en-us/scripting/module.md
@@ -1,11 +1,11 @@
---
-title: Reuse code
+title: Reusing Code
description: How to use module scripts to reuse code.
---
After creating a few scripts, it's never long before you want to reuse some code between them. Depending on [location](location.md), `Class.ModuleScript|ModuleScripts` let you reuse code between scripts on different sides of the client-server boundary or the same side of the boundary.
-## Create module scripts
+## Creating Module Scripts
You can put module scripts anywhere that you put scripts, but `Class.ReplicatedStorage` is a popular location; storing module scripts here lets you reuse code between the server and clients.
@@ -14,7 +14,7 @@ You can put module scripts anywhere that you put scripts, but `Class.ReplicatedS
1. Right-click the script and rename it to `PickupManager`.
1. Double-click the script to open it in the [Script Editor](../studio/script-editor.md).
-## Anatomy of a module script
+## Anatomy of a Module Script
Each `Class.ModuleScript` starts with the following code:
@@ -57,7 +57,7 @@ return PickupManager
Adding the function to a table isn't strictly necessary—you could just return the function itself—but it's a good pattern to follow; it gives you an easy-to-understand syntax when you call the function from another script and lets you easily add more functions to the module script over time.
-## Require module scripts
+## Requiring Module Scripts
To load a module script, you call the `Global.LuaGlobals.require()` function. In `ReplicatedStorage`, add a new script, and change its `RunContext` to `Client`. Then add the following code to call the `PickupManager.getPickupBonus` function:
@@ -97,7 +97,7 @@ Module scripts have some common patterns that you can use to simplify your code
Most of these patterns require an understanding of events. If you're not familiar with them, see [Events](events.md).
-### Data sharing
+### Data Sharing
To associate data with individual objects, you can assign attributes to them or create `Class.Configuration` folders with value objects such as `Class.StringValue` or `Class.IntValue`. However, both approaches are troublesome if you want to add or modify dozens of objects or data values. They also don't store tables or functions.
@@ -122,7 +122,7 @@ GunConfig.Damage = {
return GunConfig
```
-### Custom events
+### Custom Events
Custom events enable scripts to communicate with each other, but having to keep track of references to individual `Class.BindableEvent` objects can clutter your code.
diff --git a/content/en-us/scripting/multithreading.md b/content/en-us/scripting/multithreading.md
index 9c793fa4f..c84c3ead0 100644
--- a/content/en-us/scripting/multithreading.md
+++ b/content/en-us/scripting/multithreading.md
@@ -7,23 +7,23 @@ With the **Parallel Luau** programming model, you can run code on multiple threa
-## Parallel programming model
+## Parallel Programming Model
-By default, scripts execute sequentially. If your experience has complex logic or content, such as non-player characters (NPCs), raycasting validation, and procedural generation, then sequential execution might cause lag for your users. With the parallel programming model, you can [split tasks into multiple scripts](#split-code-into-multiple-threads) and run them in parallel. This makes your experience code run faster, which improves the user experience.
+By default, scripts execute sequentially. If your experience has complex logic or content, such as non-player characters (NPCs), raycasting validation, and procedural generation, then sequential execution might cause lag for your users. With the parallel programming model, you can [split tasks into multiple scripts](#splitting-code-into-multiple-threads) and run them in parallel. This makes your experience code run faster, which improves the user experience.
The parallel programming model also adds safety benefits to your code. By splitting code into multiple threads, when you edit code in one thread, it doesn't affect other code running in parallel. This reduces the risk of having one bug in your code corrupting the entire experience, and minimizes the delay for users in live servers when you push an update.
-Adopting the parallel programming model doesn't mean to put everything in multiple threads. For example, the [server-side raycasting validation](#server-side-raycasting-validation) sets each individual user a remote event in parallel but still requires the initial code to run serially to change global properties, which is a common pattern for parallel execution.
+Adopting the parallel programming model doesn't mean to put everything in multiple threads. For example, the [Server-side Raycasting Validation](#server-side-raycasting-validation) sets each individual user a remote event in parallel but still requires the initial code to run serially to change global properties, which is a common pattern for parallel execution.
-Most times you need to combine serial and parallel phases to achieve your desired output, since currently there are some operations not supported in parallel that can prevent scripts from running, such as modifying instances in parallel phases. For more information on the level of usage of APIs in parallel, see [thread safety](#thread-safety).
+Most times you need to combine serial and parallel phases to achieve your desired output, since currently there are some operations not supported in parallel that can prevent scripts from running, such as modifying instances in parallel phases. For more information on the level of usage of APIs in parallel, see [Thread Safety](#thread-safety).
-## Split code into multiple threads
+## Splitting Code Into Multiple Threads
To run your experience's scripts in multiple threads concurrently, you need to split them into logical chunks under different **actors** in the [data model](../projects/data-model.md). Actors are represented by `Class.Actor` instances inheriting from `Class.DataModel`. They work as units of execution isolation that distribute the load across multiple cores running simultaneously.
-### Place actor instances
+### Placing Actor Instances
-You can put actors in proper containers or use them to replace the top-level instance types of your 3D entities such as NPCs and raycasters, then add corresponding scripts.
+You can put actors in proper containers or use them to replace the top-level instance types of your 3D entities such as NPCs and raycasters, then add corresponding [scripts](../scripting/index.md).
@@ -31,7 +31,7 @@ For most situations, you shouldn't put an actor as a child of another actor in t
-### Desynchronize threads
+### Desynchronizing Threads
Though putting scripts under actors grants them the capability for parallel execution, by default the code still runs on the single thread serially, which doesn't improve the runtime performance. You need to call the `Library.task.desynchronize()`, a yieldable function that suspends the execution of the current coroutine for running code in parallel and resumes it at the next parallel execution opportunity. To switch a script back to serial execution, call `Library.task.synchronize()`.
@@ -53,7 +53,7 @@ end)
You can't use `require()` in a desynchronized parallel phase. Require scripts you want to use first in a serial context.
-Scripts that are part of the same actor always execute sequentially with respect to each other, so you need multiple actors. For example, if you put all parallel-enabled behavior scripts for your NPC in one actor, they still run serially on a single thread, but if you have multiple actors for different NPC logic, each of them runs in parallel on its own thread. For more information, see [Best practices](#best-practices).
+Scripts that are part of the same actor always execute sequentially with respect to each other, so you need multiple actors. For example, if you put all parallel-enabled behavior scripts for your NPC in one actor, they still run serially on a single thread, but if you have multiple actors for different NPC logic, each of them runs in parallel on its own thread. For more information, see [Best Practices](#best-practices).
+ 
-2. **(Optional)** In the **Properties** window, select the new dynamic effect and adjust its properties.
+2. (Optional) In the **Properties** window, select the new dynamic effect and adjust its properties.
diff --git a/content/en-us/sound/groups.md b/content/en-us/sound/groups.md
index 0c9aa2dfe..540c90391 100644
--- a/content/en-us/sound/groups.md
+++ b/content/en-us/sound/groups.md
@@ -1,42 +1,47 @@
---
-title: Sound groups
+title: Sound Groups
description: Sound Groups are audio mixers that group multiple audio objects so you can control the properties of multiple audio signals at once.
---
A `Class.SoundGroup` is an **audio mixer** that groups multiple audio objects, such as `Class.Sound` objects or additional `Class.SoundGroup|SoundGroups`, allowing you to control the volume and dynamic effects properties of multiple audio signals at once. Useful applications include:
-- [Assigning audio](#assign-audio-objects-to-soundgroups) to **SoundEffects** and **BackgroundMusic** sound groups so that you can adjust each group's master volume for optimal audio balancing.
-- [Nesting sound groups](#nest-soundgroups) into meaningful categories under a mix tree.
+- [Assigning audio](#assigning-audio-objects-to-soundgroups) to **SoundEffects** and **BackgroundMusic** sound groups so that you can adjust each group's master volume for optimal audio balancing.
+- [Nesting sound groups](#nesting-soundgroups) into meaningful categories under a mix tree.
- Grouping all sounds that need a specific [dynamic effect](../sound/dynamic-effects.md). For example, you can group all sounds inside a cave to a **Cave** sound group, then apply a `Class.ReverbSoundEffect` to simulate the sounds reflecting off of the cave's environment.
-When creating `Class.SoundGroup|SoundGroups`, it's best to keep them all in a single location for organizational purposes as you continue to add and edit audio within your experience. The following example stores the new `Class.SoundGroup` under `Class.SoundService`, as this service determines how `Class.Sound` objects play in experiences.
+## Creating SoundGroups
-## Create sound groups
+When creating `Class.SoundGroup|SoundGroups`, it's best to keep them all in a single location of the Workspace for organization purposes as you continue to add and edit audio within your experience. The following example stores the new `Class.SoundGroup` under `Class.SoundService`, as this service determines how `Class.Sound` objects play in experiences.
-To create a `Class.SoundGroup`:
+To create a SoundGroup:
-1. In the **Explorer** window, hover over `Class.SoundService` and click the ⊕ button. A contextual menu displays.
-2. From the menu, insert a `Class.SoundGroup`.
+1. In the **Explorer** window, insert a new SoundGroup into SoundService.
- 
+ 1. Hover over **SoundService** and click the ⊕ button. A contextual menu displays.
+ 1. From the menu, insert a **SoundGroup**.
-3. Triple-click the new sound group and rename it according to its purpose, such as **SoundEffects** or **BackgroundMusic**.
+ 
-## Assign audio objects to sound groups
+2. Triple-click the new sound group and rename it according to its purpose, such as **SoundEffects** or **BackgroundMusic**.
-`Class.SoundGroup|SoundGroups` don't have the typical parent-child behavior of other forms of object grouping like `Class.Model|Models` and `Class.Folder|Folders`. Instead, you must **assign** each `Class.Sound` object to its applicable `Class.SoundGroup` object, regardless of either object's location in the workspace hierarchy, because where you place the `Class.Sound` object changes where audio emits from, not the `Class.SoundGroup` object itself. For more information, see [sound objects](../sound/objects.md).
+## Assigning Audio Objects to SoundGroups
-To assign a `Class.Sound` object to a `Class.SoundGroup`:
+`Class.SoundGroup|SoundGroups` don't have the typical parent-child behavior of other forms of object grouping like `Class.Model|Models` and `Class.Folder|Folders`. Instead, you must assign each `Class.Sound` object to its applicable `Class.SoundGroup` object, regardless of either object's location in the workspace hierarchy, because where you place the `Class.Sound` object changes where audio emits from, not the `Class.SoundGroup` object itself. For more information, see [Creating Sound Objects](../sound/objects.md#creating-sound-objects).
+
+To assign a Sound object to a SoundGroup:
1. In the **Explorer** window, select a sound object.
2. In the **Properties** window, click the **SoundGroup** property field. Your cursor changes.
+
+ 
+
3. In the **Explorer** window, click on the sound group object you want to assign your sound object to. The sound object's **SoundGroup** property updates accordingly.
- 
+ 
-## Nest sound groups
+## Nesting SoundGroups
-You can nest `Class.SoundGroup|SoundGroups` together into meaningful categories under a mix tree for organization and scripting purposes. When you're planning the parent-child relationships in your mix, consider the different sound categories in your experience, and how important they should be for the listener. For example, player ability sounds are likely much more important to gameplay than environmental sounds. If you group them into separate parent `Class.SoundGroup|SoundGroups`, you can easily access and [adjust their volume levels](#adjust-volume) as you add more `Class.Sound` objects to your experience.
+You can nest `Class.SoundGroup|SoundGroups` together into meaningful categories under a mix tree for organization and scripting purposes. When you're planning the parent-child relationships in your mix, consider the different sound categories in your experience, and how important they should be for the listener. For example, player ability sounds are likely much more important to gameplay than environmental sounds. If you group them into separate parent `Class.SoundGroup|SoundGroups`, you can easily access and [adjust their volume levels](#adjusting-volume) as you add more `Class.Sound` objects to your experience.
To nest `Class.SoundGroup|SoundGroups`:
@@ -44,11 +49,11 @@ To nest `Class.SoundGroup|SoundGroups`:
2. Drop the sound group. It displays as a child of the sound group you nested it under.
-## Adjust volume
+## Adjusting Volume
-There are two main ways to think about a sound's volume: how loud the sound is by itself, and how loud it is in relation to other sounds. For example, a waterfall sounds loud when you play it by itself, but when you compare it to other sound effects like tires screeching, it likely sounds much quieter. To ensure that each sound plays at the correct volume for your experience, you can either [add multipliers](#add-multipliers) to `Class.SoundGroup|SoundGroups`, or prioritize audio from one `Class.SoundGroup` over another through the process of [ducking](#ducking).
+There are two main ways to think about a sound's volume: how loud the sound is by itself, and how loud it is in relation to other sounds. For example, a waterfall sounds loud when you play it by itself, but when you compare it to other sound effects like tires screeching, it likely sounds much quieter. To ensure that each sound plays at the correct volume for your experience, you can either [add multipliers](#adding-multipliers) to `Class.SoundGroup|SoundGroups`, or prioritize audio from one `Class.SoundGroup` over another through the process of [ducking](#ducking).
-### Add multipliers
+### Adding Multipliers
The `Class.SoundGroup.Volume|Volume` property of a `Class.SoundGroup` lets you apply a **volume multiplier** between `0` and `10` to each of its child audio objects while they retain their relative volumes. This means that if a `Class.Sound` object has a volume of `0.5` and you child it to a `Class.SoundGroup` that has a volume multiplier of `0.5`, the effective volume of the `Class.Sound` object is `0.25`.
@@ -60,7 +65,7 @@ You can prioritize audio from one `Class.SoundGroup` over another through the `C
The sounds that you choose to duck depend on the needs of your specific experience. For example, one experience might benefit from reducing the volume of background music whenever a GUI notification plays, while others might benefit from reducing the volume of GUI notifications whenever dialogue plays. The following reference mix tree prioritizes `Class.Sound` objects in the high-priority **GUI Notifications** and **Weapons** `Class.SoundGroup|SoundGroups` while de-prioritizing `Class.Sound` objects in low-priority **3D** and **2D Ambience** `Class.SoundGroup|SoundGroups`.
-
+
+
5. In the **Properties** window, navigate to the **SoundId** property and input a valid [audio asset ID](../sound/assets.md).
- 
+ 
6. **(Optional)** If you want the audio to start playing when the experience begins, enable the **Playing** property.
-#### Point source
+#### Point Source
Contrary to volumetric audio, point source audio only emits from a single point source. This type of audio is useful for explosions, impact noises, electronic devices, and dialogue.
@@ -76,10 +79,13 @@ To create a `Class.Sound` object for point source audio:
1. In the **Explorer** window, hover over an attachment, truss, wedge, or corner wedge, then click the ⊕ button. A contextual menu displays.
2. From the menu, insert a **Sound**.
+
+ 
+
3. In the **Properties** window, navigate to the **SoundId** property and input a valid [audio asset ID](../sound/assets.md).
4. **(Optional)** If you want the audio to start playing when the experience begins, enable the **Playing** property.
-### Background audio
+### Background Audio
Background audio plays at the same volume no matter where the user travels within your experience. This type of audio is useful for music that you want to play for users, especially when you want to create a soundtrack of multiple audio files.
@@ -89,11 +95,14 @@ To create a `Class.Sound` object for background audio:
1. In the **Explorer** window, hover over **SoundService**, then click the ⊕ button. A contextual menu displays.
2. From the menu, insert a **Sound**.
+
+ 
+
3. In the **Properties** window, navigate to the **SoundId** property and input a valid [audio asset ID](../sound/assets.md).
4. **(Optional)** If you want the audio to start playing when the experience begins, enable the **Playing** property.
5. **(Optional)** If this `Class.Sound` object is the only track you want to play in the place, enable its **Looped** property.
-## Customize sound objects
+## Customizing Sound Objects
`Class.Sound` object properties work together to influence how users experience your audio, such as:
@@ -233,9 +242,9 @@ end)
The `Class.Sound.Looped|Looped` property allows you to repeat audio after it has finished playing. When set to `true`, the `Class.Sound` object's audio plays again. This is useful to apply to [background audio](#background-audio) to ensure your experience never has abrupt silence.
-## Script sound objects
+## Scripting Sound Objects
-### Play audio contextually
+### Playing Audio Contextually
Aside from auto-playing audio through the `Class.Sound` object's `Class.Sound.Playing|Playing` property, you can play audio contextually from a `Class.LocalScript` by calling `Class.Sound:Play()|Play()` on the corresponding `Class.Sound` object. For example:
@@ -258,7 +267,7 @@ if musicTrack not musicTrack.IsPlaying then
end
```
-### Play interface audio
+### Playing Interface Audio
You can play interface audio for `Class.GuiObject|GuiObjects` such as [buttons](../ui/buttons.md) by hooking up a `Class.Sound` object to the `Class.GuiButton.Activated|Activated` event listener. This lets you provide auditory feedback to users, such as when they hover over or press it.
diff --git a/content/en-us/studio/avatar-tab.md b/content/en-us/studio/avatar-tab.md
index 9accb0010..361bfed5f 100644
--- a/content/en-us/studio/avatar-tab.md
+++ b/content/en-us/studio/avatar-tab.md
@@ -1,5 +1,5 @@
---
-title: Avatar tab
+title: Avatar Tab
description: The Avatar tab contains specialized tools for working with avatars and accessories.
---
@@ -7,7 +7,7 @@ The **Avatar** tab contains the standard [transform tools](../studio/model-tab.m
-## Accessory tools
+## Accessory Tools
The **Accessory** section contains tools for creating layered or rigid [accessories](../art/accessories/index.md) from imported custom meshes.
diff --git a/content/en-us/studio/build-studio-widgets.md b/content/en-us/studio/building-studio-widgets.md
similarity index 97%
rename from content/en-us/studio/build-studio-widgets.md
rename to content/en-us/studio/building-studio-widgets.md
index 9707d332f..6d8d049e8 100644
--- a/content/en-us/studio/build-studio-widgets.md
+++ b/content/en-us/studio/building-studio-widgets.md
@@ -1,11 +1,11 @@
---
-title: Build Studio widgets
+title: Building Studio Widgets
description: Building custom widgets in Studio allows you to customize workflows and views.
---
Studio gives you the power to create custom **widgets** and use them as Studio tools and extensions. These widgets behave as custom windows/panels in Studio, and you can dock them inside of your interface or have them float as separate windows.
-## Create widget UIs
+## Creating Widget UIs
All Studio widgets begin as `Class.DockWidgetPluginGui` objects which you can fill with `Class.GuiObject|GuiObjects`, such as text labels and buttons. To create an empty widget GUI, call the `Class.Plugin:CreateDockWidgetPluginGui()|CreateDockWidgetPluginGui()` function, passing in an ID and a `Datatype.DockWidgetPluginGuiInfo` object.
@@ -87,7 +87,7 @@ testWidget.Title = "Test Widget" -- Optional widget title
You cannot use the `Class.Plugin:CreateDockWidgetPluginGui()|CreateDockWidgetPluginGui()` function in game scripts. You can only call it from the command bar or a [plugin](../studio/plugins.md) script.
-### Customize widget UI
+### Customizing Widget UI
Once you create a widget, you can customize its user interface with `Class.GuiObject|GuiObjects` such as informative `Class.TextLabel|TextLabels` or interactive `Class.ImageButton|ImageButtons`. For example, the following code adds a basic `Class.TextButton` to the GUI window:
@@ -116,7 +116,7 @@ testButton.Parent = testWidget
To help you build consistent, effective Studio widgets, Roblox provides a [GitHub repo](https://github.com/Roblox/StudioWidgets) that contains GUI elements with a standard "Studio" look and feel. These include checkboxes, radio buttons, and input fields which have a Studio style, and they all support dark theme.
-### Change Studio color themes
+### Changing Studio Color Themes
Effective Studio widgets ideally match the Studio **theme** setting and dynamically adjust when the theme changes. For instance, if a developer is using the dark theme, the widget's background color, images, and text labels should look nice alongside Studio's native theme colors.
@@ -144,7 +144,7 @@ end
syncGuiColors({testButton})
```
-### Customize mouse cursors
+### Customizing Mouse Cursors
To improve the expected interaction with widget elements, you can set system-specific **mouse cursors** to GUI events, such as `Class.GuiObject.MouseEnter|MouseEnter` and `Class.GuiObject.MouseLeave|MouseLeave`. The following code demonstrates how to connect a function to the `Class.GuiObject.MouseEnter|MouseEnter` and `Class.GuiObject.MouseLeave|MouseLeave` events of `testButton` to change the mouse cursor:
@@ -259,7 +259,7 @@ Reference the following table for a list of mouse cursors and their potential us
Note that these cursor looks are only an approximation — the actual cursors match your default operating system cursors.
-## Gather user input
+## Gathering User Input
UI elements such as `Class.TextBox` and `Class.TextButton` work normally in Studio widgets, and you can build interfaces just like you normally would on Roblox. However, `Class.UserInputService` and `Class.ContextActionService` don't work since these services expect the main game window to be in focus.
@@ -278,11 +278,11 @@ end
frame.InputBegan:Connect(onInputBegan)
```
-## Drag-and-drop interaction
+## Drag-and-Drop Interaction
Using drag-and-drop interactions for your widgets is a simple way to improve the flow of data. To create this interaction, you must define the element to drag, initiate the drag, create a drop target, and process the drop action.
-### Create drag source
+### Creating a Drag Source
You can start a drag action by calling
`Class.Plugin:StartDrag()` when the user
@@ -304,7 +304,7 @@ dragButton.Text = "Drag me!"
dragButton.Parent = dragSourceWidget
```
-### Initiate the drag
+### Initiating the Drag
When the user clicks on the
`Class.TextButton`, you can initiate drag through the `Class.GuiButton.MouseButton1Down|MouseButton1Down()` event which fires as soon as the user presses the mouse button.
@@ -330,7 +330,7 @@ end
dragButton.MouseButton1Down:Connect(onButton1Down)
```
-### Create drop target
+### Creating a Drop Target
The `Class.PluginGui.PluginDragDropped`
event fires when the user releases their mouse on a window during a drag. When
@@ -348,7 +348,7 @@ textLabel.Text = "Drop here..."
textLabel.Parent = dragTargetWidget
```
-### Process the drop action
+### Processing the Drop Action
After creating a drop target, connect the `Class.PluginGui.PluginDragDropped` event on the drop target widget:
diff --git a/content/en-us/studio/debugging.md b/content/en-us/studio/debugging.md
index d83995670..b27cfe457 100644
--- a/content/en-us/studio/debugging.md
+++ b/content/en-us/studio/debugging.md
@@ -10,24 +10,24 @@ tags:
- Breakpoints
---
-Studio offers many debugging tools commonly found in Integrated Development Environments (IDEs). These tools help you resolve errors and inspect scripts line-by-line as they run. Debugging info is displayed in the [Watch](#watch), [Call Stack](#call-stack), [Breakpoints](#breakpoints-window), and [Output](#output) windows for you to inspect.
+Studio offers many debugging tools commonly found in Integrated Development Environments (IDEs). These tools help you resolve errors and inspect scripts line-by-line as they run. Debugging info is displayed in the **Watch**, **Call Stack**, **Breakpoints**, and [Output](../studio/output.md) windows for you to inspect.
-## General workflow
+## General Workflow
If you notice a problem in your experience or want to verify that it works as you intend, you can debug the code related to it as follows:
-1. [Insert breakpoints](#insert-breakpoints) on the lines of codes that you want to examine.
+1. [Insert breakpoints](#inserting-breakpoints) on the lines of codes that you want to examine.
2. In the [Script](../studio/script-tab.md) tab, click **Play** or **Run** in the test tab to start a playtest session, also known as a debugging session.
-3. When a script hits a breakpoint, the playtest session pauses. Inspect the [Watch](#watch), [Call Stack](#call-stack), and [Output](#output) windows to help you diagnose and understand the problem.
-4. Insert additional breakpoints on lines of code that haven't executed yet to inspect additional data. [Disable](#disable-breakpoints) or [delete](#delete-breakpoints) breakpoints that you don't need anymore.
+3. When a script hits a breakpoint, the playtest session pauses. Step through the code. Inspect the **Watch**, **Call Stack**, and **Output** windows to help you diagnose and understand the problem.
+4. Insert additional breakpoints on lines of code that haven't executed yet to inspect additional data. [Disable](#disabling-breakpoints) or [delete](#deleting-breakpoints) breakpoints that you don't need anymore.
5. In the **Script** tab, click **Stop** to end the debugging session.
-Repeat the previous steps until you solve the problem or find its root cause. As you learn the general workflow, you can configure the breakpoints to break only if certain conditions are met, to print a message to the [Output](#output) window, and to run only on the client or server. For more information, see [Breakpoint Configurations](#breakpoint-configurations).
+Repeat the previous steps until you solve the problem or find its root cause. As you learn the general workflow, you can configure the breakpoints to break only if certain conditions are met, to print a message to the **Output** window, and to run only on the client or server. For more information, see [Breakpoint Configurations](#breakpoint-configurations).
-### Insert breakpoints
+### Inserting Breakpoints
Breakpoints are checkpoints that pause or "break" the execution of your scripts at specific lines. You can use the pauses to inspect and debug your experience, [watch](#watch-window) variables, and inspect the [call stack](#call-stack-window). Breakpoints are one of the most effective ways to debug functions, so they're one of the most important debugging tools. You can insert a breakpoint at any line of executable code.
@@ -35,7 +35,7 @@ To insert a standard breakpoint at a line of code, left-click the margin to the
-### Step through code
+### Stepping Through Code
If you insert a breakpoint at a line in a script, the script pauses before it executes that line. A yellow arrow called the "debugger" indicates which line of code executes next.
@@ -78,11 +78,11 @@ The following table summarizes the three ways to step through code. To continue
-## Breakpoint configurations
+## Breakpoint Configurations
-You can configure breakpoints to break only if certain conditions are met, to print a message to the [Output](#output) window, and to run only on the client or server. You can also mix these configurations together to best suit your debugging needs.
+You can configure breakpoints to break only if certain conditions are met, to print a message to the Output window, and to run only on the client or server. You can also mix these configurations together to best suit your debugging needs.
-### Edit breakpoints
+### Editing Breakpoints
You can edit the configuration of a breakpoint at any time, including during playtest sessions. If you edit breakpoints during a playtest session, the edits persist even after you finish it. You can also edit a breakpoint that's actively pausing your playtest session, but changes don't apply until the next playtest session.
@@ -164,13 +164,13 @@ To edit the configuration of a breakpoint:
-#### Condition, log message, and options
+#### Condition, Log Message, and Options
For each breakpoint, you can set its **Condition**, **Log Message**, **Continue Execution**, and **Context**.
The **Condition** is the expression that determines whether the breakpoint activates. The Condition is optional. If the Condition is empty, the breakpoint always activates. If the Condition exists, then the breakpoint activates only if the condition is true. For example, if you want the breakpoint to activate only if the variable `n` equals `42`, then set the Condition as `n == 42`. Conditions are useful for debugging how functions execute when certain variables have certain values or if you want to break only on certain executions in a loop.
-The **Log Message** is the expression that prints to the [Output](#output) window when the condition is true. The format of the Log Message is the same as the argument for a `print()` statement. For example, set the Log Message as `"The value of n:", n` to print the same message as `print("The value of n:", n)`. You can add and remove Log Messages without having to stop the execution, unlike print statements.
+The **Log Message** is the expression that prints to the Output window when the condition is true. The format of the Log Message is the same as the argument for a `print()` statement. For example, set the Log Message as `"The value of n:", n` to print the same message as `print("The value of n:", n)`. You can add and remove Log Messages without having to stop the execution, unlike print statements.
The **Continue Execution** option determines whether the breakpoint pauses the script if it activates. It's useful if you want to log values of variables or expressions without stopping execution. This option is disabled by default.
@@ -178,17 +178,19 @@ The **Context** of a breakpoint determines whether the breakpoint should activat
-#### Conditional breakpoints and logpoints
+#### Conditional Breakpoints and Logpoints
Studio offers named variations of breakpoints to make breakpoint insertion faster. To insert a named variation, right-click the margin to the right of its line number, then click the variant you want to insert.
-A **Conditional breakpoint** is a breakpoint with a **Condition** and **Continued Execution** disabled. Conditional Breakpoints pause your script only if a condition is true, so they're useful for debugging how functions execute when certain variables have certain values. Conditional Breakpoints use the values of the variables before the line executes. When you insert a Conditional Breakpoint, your cursor focuses on the **Condition** option for you to set quickly.
+A **Conditional Breakpoint** is a breakpoint with a **Condition** and **Continued Execution** disabled. Conditional Breakpoints pause your script only if a condition is true, so they're useful for debugging how functions execute when certain variables have certain values. Conditional Breakpoints use the values of the variables before the line executes. When you insert a Conditional Breakpoint, your cursor focuses on the **Condition** option for you to set quickly.
-A **Logpoint** is a breakpoint with a **Log Message** and **Continued Execution** enabled. Logpoints log messages to the [Output](#output) window without pausing your scripts, so they're useful for debugging variable values. Logpoints use the values of the variables before the line executes. When you insert a Logpoint, your cursor focuses on the **Log Message** for you to set it quickly.
+A **Logpoint** is a breakpoint with a **Log Message** and **Continued Execution** enabled. Logpoints log messages to the Output window without pausing your scripts, so they're useful for debugging variable values. Logpoints use the values of the variables before the line executes. When you insert a Logpoint, your cursor focuses on the **Log Message** for you to set it quickly.
-### Disable breakpoints
+Logpoints are often more efficient for debugging variables than `print()` statements because they allow you to log messages to the Output window without having to stop or restart the active playtest session. Compared to `print()` statements, they keep your code clean while debugging and are easier to remove after you finish debugging.
+
+### Disabling Breakpoints
There are many ways to disable and reenable a breakpoint:
@@ -196,7 +198,7 @@ There are many ways to disable and reenable a breakpoint:
- Edit the breakpoint and toggle its Enabled checkbox.
- Right-click the breakpoint icon and click Disable Breakpoint or Enable Breakpoint.
-### Delete breakpoints
+### Deleting Breakpoints
To delete a breakpoint, middle-click its icon. You can also right-click its icon and click **Delete Breakpoint**.
@@ -204,7 +206,7 @@ To delete a breakpoint, middle-click its icon. You can also right-click its icon
Deleting a breakpoint deletes its Condition and Log Message. If you want to keep the Condition or Log Message for future debugging, disable the breakpoint instead.
-### Breakpoints window
+### Breakpoints Window
The Breakpoints window shows all the breakpoints in your experience. To open the Breakpoints window, click the View tab at the top of Studio, then click Breakpoints.
@@ -237,7 +239,7 @@ You can enable and disable breakpoints by clicking its breakpoint icon in the En
-### Breakpoint icons
+### Breakpoint Icons
The icon of a breakpoint depends on whether it's enabled, has a condition, and has a log message. If a breakpoint has a log message, then it appears as a logpoint regardless of whether it has a condition.
@@ -306,7 +308,7 @@ The icon of a breakpoint depends on whether it's enabled, has a condition, and h
-## Additional debugging tools
+## Additional Debugging Tools
In addition to the debugger, Studio offers additional debugging tools for you to fix problems and bugs in your experience.
@@ -318,7 +320,7 @@ The **Command Bar** allows you to run Luau commands while the experience is runn
The **Developer Console** provides a wide array of details including client and server output, memory usage, network performance, and more. To open the Developer Console while testing or playing an experience, type `/console` into the chat or press F9. For more information, see [Developer Console](../studio/developer-console.md).
-### Log files
+### Log Files
When a script prints or errors in Studio or the Player app, the app records the message in a log file in the local file system. These files are located in different places depending on the operating system.
diff --git a/content/en-us/studio/developer-console.md b/content/en-us/studio/developer-console.md
index 53cfdeb22..1b48d72db 100644
--- a/content/en-us/studio/developer-console.md
+++ b/content/en-us/studio/developer-console.md
@@ -7,9 +7,11 @@ import OpeningSteps from '../includes/developer-console/opening-developer-consol
The **Developer Console** is a tool for debugging your experience when testing in Studio or running it in production. It shows log messages and errors similar to the [Output](../studio/output.md) window and detailed information on [Memory](#memory), [Network](#network), and more.
+## Opening the Console
+
-## Parent-child hierarchy
+## Parent-Child Hierarchy
Roblox uses the concept of **parenting** to organize objects. All children of a parent object appear under its branch when [expanded](#expanding-and-collapsing-branches).
@@ -16,7 +16,7 @@ Roblox uses the concept of **parenting** to organize objects. All children of a
@@ -86,7 +86,7 @@ The **Collisions** checkbox toggles the collisions state when you're transformin
-### Transform coordinates
+### Transform Coordinates
CtrlL on Windows or ⌘L on Mac toggles between transforming an object relative to **world** coordinates or the object's **local** coordinates. When in local mode, an **L** symbol appears to the lower-right of the object.
@@ -111,13 +111,13 @@ The [Toolbox](../projects/assets/toolbox.md) includes all of the models, images,
-## Part insertion
+## Part Insertion
The **Part** button inserts a new part into the workspace. Clicking the small dropdown arrow on the button lets you select either **Block**, **Sphere**, **Wedge**, **Corner Wedge**, or **Cylinder**. For more information, see [Parts](../parts/index.md).
-## UI designer
+## UI Designer
The **UI** button opens a tab which lets you quickly insert, resize, and reposition common on-screen UI objects, such as [labels](../ui/labels.md), [frames](../ui/frames.md), and [buttons](../ui/buttons.md).
@@ -131,7 +131,7 @@ The **Import 3D** tool allows you to import nearly any type of `.fbx` or `.obj`
-## Color widget
+## Color Widget
Clicking the small dropdown arrow on the **Color** widget reveals a hexagonal color picker.
@@ -145,7 +145,7 @@ By default, clicking the overall **Color** button applies the chosen color to an
For alternative ways to apply custom colors, see [Coloring Parts](../parts/index.md#colors-popup).
-## Material widget
+## Material Widget
Clicking the small dropdown arrow on the **Material** widget reveals a [material](../parts/materials.md) picker.
@@ -155,7 +155,7 @@ By default, clicking the overall **Material** button applies the chosen material
-## Group tools
+## Group Tools
You can group objects into a [model](../parts/models.md) by selecting them and clicking the **Group** button. This action has a default shortcut of CtrlG (Windows) or ⌘G (Mac).
@@ -165,7 +165,7 @@ To **ungroup** an existing model or folder, click the small arrow next to the bu
-## Lock tools
+## Lock Tools
You can enable the **Lock Tool** by clicking the small arrow next to the **Lock** button and selecting **Lock Tool**. This action has a default shortcut of AltL (Windows) or ⌥L (Mac).
@@ -175,13 +175,13 @@ To unlock all objects, click the small arrow next to the button and select **Unl
-## Anchor toggle
+## Anchor Toggle
The **Anchor** toggle controls whether the part will be **immovable** by physics. When `Class.BasePart.Anchored|Anchored`, a part will never change position due to gravity, other parts collisions, overlapping other parts, or any other physics-related causes. This action has a default shortcut of AltA (Windows) or ⌥A (Mac).
-## Playtest options
+## Playtest Options
There are three common options for playtesting an experience. Clicking the button starts a playtest of the currently selected mode, and clicking the small arrow below the button lets you choose a different mode.
diff --git a/content/en-us/studio/index.md b/content/en-us/studio/index.md
index 9312867be..518bb6280 100644
--- a/content/en-us/studio/index.md
+++ b/content/en-us/studio/index.md
@@ -8,7 +8,7 @@ Roblox Studio is an all-in-one IDE that lets you create experiences that run on
Roblox. It's free to use and lets you reach millions of users using
the Roblox app on console, desktop, and mobile devices.
-## Powerful 3D building tools
+## Powerful 3D Building Tools
@@ -32,7 +34,7 @@ To view memory allocation:
@@ -162,7 +164,7 @@ To create a snapshot of your memory allocation:
1. Expand the client-server dropdown to select **Client** or **Server**.
1. Click the **Create Snapshot** button.
-### Analyze memory usage
+### Analyzing Memory Usage
The tool provides five views that you can select from to view your Luau memory allocation based on different views:
@@ -174,7 +176,7 @@ The tool provides five views that you can select from to view your Luau memory a
#### Graph
-The **Graph** view is the most detailed and complex view among all Luau heap views. It shows an aggregated memory usage tree with each node representing an object with memory allocated. The tree shows how objects connect to each other and derives the shortest path between object references. It has the following columns of memory size:
+The **Graph** view is the most detailed and complex view among all Luau Heap views. It shows an aggregated memory usage tree with each node representing an object with memory allocated. The tree shows how objects connect to each other and derives the shortest path between object references. It has the following columns of memory size:
Size — The self memory usage plus the memory usage by contents within the data structure.
Self — The memory directly allocated for the data structure itself, excluding the memory usage by any content it contains.
@@ -188,7 +190,7 @@ The root of the tree graph is `registry`, which stores all engine and Luau refer
- `Module @Path.To.Module` is the table returned by a module script.
- `name:123 =Path.To.Module` is a function inside a specified script. Anonymous functions don't have names. The top level node often refers to the global script function. Anonymous functions don't have names. Example: `:1= Workspace.[Username].Animate`.
-- `upvalue` is a reference for captured functions. See [Capture local scope](../../luau/scope.md#capture) for more information.
+- `upvalue` is a reference for captured functions. See [Capturing Local Scope](../../luau/scope.md#capturing) for more information.
- `env` refers to the environment of a function. For most cases, it's a table representing the global scope of a script.
- `globals` refers to the environment of a thread.
- `[key]` represents objects that serve as table keys.
@@ -196,11 +198,11 @@ The root of the tree graph is `registry`, which stores all engine and Luau refer
- `stack` refers to the array that stores all function locals.
- `constants` represents all constant values that functions use.
-#### Memory categories
+#### Memory Categories
The **Memory Categories** view shows memory sizes and counts by memory categories, which the engine assigns to objects at allocation time. By default, the memory category has the same name as the script, or you can assign custom memory category names using the `debug.setmemorycategory` function.
-#### Unique references
+#### Unique References
The **Unique References** view shows memory usage of instances that don't have a parent in the data model and are only reachable by scripts, along with all paths that pin the instance object. This view has two metrics:
diff --git a/content/en-us/studio/optimization/scriptprofiler.md b/content/en-us/studio/optimization/scriptprofiler.md
index cfafddc5f..67f43778b 100644
--- a/content/en-us/studio/optimization/scriptprofiler.md
+++ b/content/en-us/studio/optimization/scriptprofiler.md
@@ -9,7 +9,7 @@ description: Script Profiler is a tool within the Developer Console that records
Script Profiler only records function calls that consume CPU resources, so it doesn't record threads that sleep or wait for results.
-## Record profiling sessions
+## Recording Profiling Sessions
Before recording, you need to select the recording environment from:
@@ -64,7 +64,7 @@ To record a new profiling session:
6. Click **Start** to begin the profiling session. If you set a duration, Script Profiler displays a countdown timer with the remaining time in the session.
7. Click **Stop** or wait until the recording finishes to display the profiling data.
-## Read profiling data
+## Reading Profiling Data
After a session stops, Script Profiler generates a table showing how much time each function call costs in CPU time. The table sorts function calls from the most-time-spent to least-time-spent, and allows you to search for specific functions by their name. It provides the following two views:
@@ -100,7 +100,7 @@ You can also select from the following display options to tailor your debugging
-Plugins can interact with the Output Window through `Class.LogService`, which can record and clear the Output Window contents. You can customize the output through the following elements:
+Plugins can interact with the output window through `Class.LogService`, which can record and clear the output window contents. You can customize the output through the following elements:
-
+
-## Manage Plugins
+## Studio Plugins
-The **Manage Plugins** button lets you enable/disable, update, or uninstall plugins you've [installed](../production/creator-store.md#find-assets) from the Creator Store, while the
+The **Manage Plugins** button lets you enable/disable, update, or uninstall plugins you've [installed](../production/creator-store.md#finding-assets) from the Creator Store, while the
**Plugins Folder** button opens the local system folder containing plugins you've [created](../studio/plugins.md) or manually installed.
diff --git a/content/en-us/studio/plugins.md b/content/en-us/studio/plugins.md
index 7ada6e8ea..14a1d0cc0 100644
--- a/content/en-us/studio/plugins.md
+++ b/content/en-us/studio/plugins.md
@@ -3,11 +3,11 @@ title: Plugins
description: Explains how to create, publish, and monetize extensions to Studio that add custom functionality.
---
-A **plugin** is an extension that adds additional features or functionality to Studio. You can [install](../production/creator-store.md#find-assets) community-made plugins from the Creator Store, or you can [create](#create-new-plugins) and [publish](#upload-distribute-and-monetize-plugins) your own to the [Toolbox](../projects/assets/toolbox.md) to use across your experiences.
+A **plugin** is an extension that adds additional features or functionality to Studio. You can [install](../production/creator-store.md#finding-assets) community-made plugins from the Creator Store, or you can [create](#creating-new-plugins) and [publish](#uploading-distributing-and-monetizing-plugins) your own to the [Toolbox](../projects/assets/toolbox.md) to use across your experiences.
-If you choose to also distribute your plugins to the Creator Store, you can either offer them for free or sell them for **United States Dollars** (the minimum price is $4.99). Roblox offers a market-leading revenue share for these sales, as only taxes and payment processing fees are deducted. For more information on selling plugins, see [Selling on the Creator Store](../production/sell-on-creator-store.md).
+If you choose to also distribute your plugins to the Creator Store, you can either offer them for free or sell them for **United States Dollars** (the minimum price is $4.99). Roblox offers a market-leading revenue share for these sales, as only taxes and payment processing fees are deducted. For more information on selling plugins, see [Selling on the Creator Store](../production/selling-on-creator-store.md).
-## Create new plugins
+## Creating New Plugins
You can create your own plugins to improve your workflow in Studio. The following code sample is a plugin called **EmptyScriptAdder** that inserts an empty script as the child of an object or in `Class.ServerScriptService`. The following sections explain the major parts to creating this plugin.
@@ -42,7 +42,7 @@ end
newScriptButton.Click:Connect(onNewScriptButtonClicked)
```
-### Save plugin scripts
+### Saving a Plugin Script
Plugins start from scripts. To create a plugin, create a `Class.Script` and save it as a plugin using the [Explorer](../studio/explorer.md). For example, to create the **EmptyScriptAdder Plugin**:
@@ -59,28 +59,28 @@ Plugins start from scripts. To create a plugin, create a `Class.Script` and save
Make sure to delete the original script in `Class.ServerStorage` and work from the plugin inside `Class.PluginDebugService`, otherwise you may end up applying changes to the wrong script.
-### Reload and save changes
+### Reloading and Saving Changes
With your `Class.Plugin` inside `Class.PluginDebugService`, you can easily update the plugin by right-clicking it and then selecting **Save and Reload Plugin** from the context menu. If you simply want to reload the plugin, for example to step through a section of code using a breakpoint without saving the plugin, you can
alternatively select **Reload Plugin**.
-### Add toolbar buttons
+### Adding a Toolbar Button
To add a button for your plugin to the **Plugins** tab of the Studio toolbar, use the `Class.Plugin:CreateToolbar()` and `Class.PluginToolbar:CreateButton()` methods. In the code for **EmptyScriptAdder**, line 5 creates a new section in the toolbar named **Custom Script Tools** and line 8 creates a button named **Create Empty Script**.
-### Execute code on click
+### Executing Code on Click
To make the plugin execute code when a user clicks the toolbar button, connect a function to the button's `Class.PluginToolbarButton.Click` event. In the code for **EmptyScriptAdder**, the connecting function is `onNewScriptButtonClicked()`.
-### Check user selection
+### Checking User Selection
To modify a plugin's behavior based on what the user has selected, use the `Class.Selection` service. The `onNewScriptButtonClicked()` function checks if the user has anything selected and creates the new script as its child instead of inside `Class.ServerScriptService`. If the user doesn't have anything selected, it creates the new script in `Class.ServerScriptService`.
-### Support undo and redo
+### Supporting Undo and Redo
Use `Class.ChangeHistoryService` to allow users to undo and redo changes made by a plugin within an experience. In your script, set the plugin to call `Class.ChangeHistoryService:TryBeginRecording()` and store the identifier assigned to the API call before making changes. Then set the plugin to call `Class.ChangeHistoryService:FinishRecording()` after making changes, so it captures any changes made during the recording session for undo and redo.
@@ -128,7 +128,7 @@ button.Click:Connect(function()
end)
```
-## Upload, distribute and monetize plugins
+## Uploading, Distributing and Monetizing Plugins
As with [models](../parts/models.md), [meshes](../parts/meshes.md), [images](../parts/textures-decals.md), and [animations](../animation/editor.md#creating-an-animation), you can distribute plugins to Roblox to make them easy to reuse from the [Toolbox](../projects/assets/toolbox.md). You can choose to make them publicly available to all other creators on the [Creator Store](../production/creator-store.md), or to distribute them privately for your own use. If you choose to distribute your plugin publicly, you can set a price at which to sell it to other creators.
diff --git a/content/en-us/studio/properties.md b/content/en-us/studio/properties.md
index 04971b68b..1339ed5fc 100644
--- a/content/en-us/studio/properties.md
+++ b/content/en-us/studio/properties.md
@@ -1,13 +1,13 @@
---
-title: Properties window
+title: Properties Window
description: The Properties window lets you adjust properties of a selected object to change how it looks and behaves.
---
-The **properties** window, accessible from the [View](../studio/view-tab.md) tab, allows you to adjust certain properties of a selected object to change how the object looks and behaves. Additionally, you can manage [tags](#instance-tags) and configure instance [attributes](#instance-attributes) at the bottom of the window.
+The **Properties** window, accessible from the [View](../studio/view-tab.md) tab, allows you to adjust certain properties of a selected object to change how the object looks and behaves. Additionally, you can manage [tags](#instance-tags) and configure instance [attributes](#instance-attributes) at the bottom of the window.
-## Header bar
+## Header Bar
When you select an object, the window's header bar changes to reflect both the class and name of the object.
@@ -26,7 +26,7 @@ When you select an object, the window's header bar changes to reflect both the c
-## Expand inputs
+## Expanding Inputs
Some properties are collapsed by default, but you can expand them by clicking the small arrow next to its name. For instance, `Class.BasePart|BaseParts` contain a **Position** property which represents an X, Y, Z coordinate in the 3D world. In Studio, these coordinates can be entered in two ways:
@@ -55,13 +55,13 @@ Some properties are collapsed by default, but you can expand them by clicking th
After you expand or collapse a property, it remains expanded or collapsed for other objects of the same class, as well as related objects that share the same property.
-## Filter properties
+## Filtering Properties
You can filter properties by typing a search query into the **Filter Properties** input near the top of the window. For example, filtering by the letters "velo" finds all properties containing them, such as **AssemblyLinearVelocity** and **AssemblyAngularVelocity**. Quickly access this input by pressing CtrlShiftP (⌘ShiftP).
-## Instance tags
+## Instance Tags
The **Tags** section allows you to apply specific tags for use with `Class.CollectionService`. Tags are sets of strings applied to instances that replicate from the server to the client. They are also serialized when places are saved.
@@ -79,7 +79,7 @@ To add tags to an instance through the **Properties** window:
-## Instance attributes
+## Instance Attributes
**Attributes** allow you to customize instances with your own data. They are similar to built-in object properties, but you can create and modify your own attributes for any instance. Key features include:
@@ -105,7 +105,7 @@ Examples of attribute usage include:
-### Supported types
+### Supported Types
You can store the following types/values in attributes:
@@ -144,7 +144,7 @@ You can store the following types/values in attributes:
-### Studio usage
+### Studio Usage
New attributes can be created and modified in Studio as follows:
diff --git a/content/en-us/studio/quick-access.md b/content/en-us/studio/quick-access.md
index 33fd4fe27..b582902bb 100644
--- a/content/en-us/studio/quick-access.md
+++ b/content/en-us/studio/quick-access.md
@@ -1,9 +1,9 @@
---
-title: Quick access toolbar
+title: Quick Access Toolbar
description: The Quick Access Toolbar contains shortcuts to various Studio actions and commands.
---
-The **quick access toolbar** contains shortcuts to various Studio actions and commands.
+The **Quick Access Toolbar** contains shortcuts to various Studio actions and commands.
diff --git a/content/en-us/studio/rig-builder.md b/content/en-us/studio/rig-builder.md
index df3f4cd07..42d1d0e43 100644
--- a/content/en-us/studio/rig-builder.md
+++ b/content/en-us/studio/rig-builder.md
@@ -1,9 +1,9 @@
---
-title: Rig builder
+title: Rig Builder
description: The Rig Builder is a built-in plugin that lets you insert pre-built character models.
---
-The **rig builder** tool allows you to quickly insert basic pre-built character rigs into your experience for use in animation, clothing testing, and other applications. You can also insert a rig of your account's avatar character, including character customizations and accessories. The rig builder generates character `Class.Model|Models` with the appropriate joints and humanoid structure to support [animation](../animation/index.md), [accessories](../art/accessories/index.md), and [character customizations](../characters/appearance.md).
+The **Rig Builder** tool allows you to quickly insert basic pre-built character rigs into your experience for use in animation, clothing testing, and other applications. You can also insert a rig of your account's avatar character, including character customizations and accessories. The rig builder generates character `Class.Model|Models` with the appropriate joints and humanoid structure to support [animation](../animation/index.md), [accessories](../art/accessories/index.md), and [character customizations](../characters/appearance.md).
@@ -11,15 +11,15 @@ The **rig builder** tool allows you to quickly insert basic pre-built character
At this time, the rig builder tool doesn't generate character rigs compatible with facial animation.
-## Rig types
+## Rig Types
-There are two types of default rigs you can [insert](#insert-a-pre-built-rig) into your experience with the rig builder. An **R6** rig is a legacy rig made up of 6 mesh objects, while an **R15** rig is a model with 15 mesh objects, significantly expanding the R6's limited motion range. When creating rigs for use in your experience, use a rig type that is consistent with the rig types you intend to support in your experience.
+There are two types of default rigs you can [insert](#inserting-a-pre-built-rig) into your experience with the rig builder. An **R6** rig is a legacy rig made up of 6 mesh objects, while an **R15** rig is a model with 15 mesh objects, significantly expanding the R6's limited motion range. When creating rigs for use in your experience, use a rig type that is consistent with the rig types you intend to support in your experience.
+ 
-## Code navigation
+## Code Navigation
-### Go to declaration
+### Go to Declaration
You can jump to the declaration of a function or variable by holding Ctrl on Windows or ⌘ on Mac when clicking the call, or by right-clicking its call and clicking **Go to Declaration**.
-### Script function filter
+### Script Function Filter
The **Script Function Filter** displays a list of all functions declared in a script. To open it, press AltF on Windows or ⌥F on Mac. With the list open, you can browse the signatures for each function, filter through them by name, and double-click one to jump to its declaration.
-## Find and replace
+## Find and Replace
The **Find/Replace** widget lets you find and replace code in an open script. The widget supports matching case, matching the whole word, and searching by regular expressions. To open it, press CtrlF on Windows or ⌘F on Mac.
@@ -73,7 +73,7 @@ The **Find/Replace** widget lets you find and replace code in an open script. Th
For broader searches, the **Find All / Replace All** window lets you find/replace code across multiple scripts in the experience. To open it, press CtrlShiftF on Windows or ⌘ShiftF on Mac.
-## Real-time feedback
+## Real-Time Feedback
### Script Analysis
@@ -88,9 +88,9 @@ The **Script Analysis** window, accessible from the [View](./view-tab.md) tab, p
@@ -109,7 +109,7 @@ Press Tab to accept a suggestion, or ignore it by continuing to type.
**Code Assist** helps automate basic coding tasks so you can focus on creative work, but it does not always suggest perfect code (see [Limitations](#limitations)). It's still your responsibility to review, test, and determine if the code suggestion is contextually appropriate.
-### Improve suggestions
+### Improving Suggestions
To get more accurate and relevant suggestions, it's recommended that you follow clean coding practices, regardless of assistance, and:
@@ -134,13 +134,13 @@ The tool helps automate basic coding tasks but it does not always suggest perfec
- The suggestion may be incomplete due to the limited length of output from the learning models.
- There's a daily cap for the number of suggestions and, once the cap is reached, you will get no suggestions until the next day.
-### Code privacy
+### Code Privacy
Currently, Roblox does not use any non-public data to train the learning models. The tool only uses a small subset of free marketplace assets for tuning large language models and the subset has passed various checks for quality and safety filters.
Furthermore, all suggestions are generated **by** the AI model and do not transfer from one user to another. Since your code is not used for model training, it won't be suggested to other users of **Code Assist**, with the one exception of code being posted to free marketplace items.
-## Multi-cursor
+## Multi-Cursor
The Script Editor supports usage of multiple cursors to make edits simultaneously. You can add cursors based on your needs with a mouse click or keyboard shortcut. The initial cursor is called the **primary cursor** and additional cursors are called **secondary cursors**.
@@ -160,42 +160,42 @@ The following table summarizes multi-cursor workflows and their shortcuts.
@@ -108,13 +108,13 @@ The **Format** section lets you format sections or the entirety of the script fo
-## Debugging tools
+## Debugging Tools
The **Debugger** section lets you control the [debugger](../studio/debugging.md).
@@ -172,7 +172,7 @@ In the neighboring **Debug Errors** section, you can opt to treat script errors
-## Beta features
+## Beta Features
Many beta features are available through Studio's **File** ⟩ **Beta Features** menu. Once you've enabled beta features, click the **Save** button and you'll be prompted to restart Studio for the features to take effect.
diff --git a/content/en-us/studio/shortcuts.md b/content/en-us/studio/shortcuts.md
index 6bc144719..5b4a8a773 100644
--- a/content/en-us/studio/shortcuts.md
+++ b/content/en-us/studio/shortcuts.md
@@ -1,11 +1,11 @@
---
-title: Studio shortcuts
+title: Studio Shortcuts
description: Explains Studio default shortcuts and key commands that make development quicker and easier.
---
Studio has many default shortcuts and key commands that make development quicker and easier. You can customize every shortcut and bind many actions without defaults to any key through **File** → **Advanced** → **Customize Shortcuts**.
-## Files and publishing
+## Files and Publishing
-## Edit tab
+## Edit Tab
The **Edit** tab includes the [Select](#select), [Transform](#transform), [Fill](#fill), [Sea Level](#sea-level), [Draw](#draw), [Sculpt](#sculpt), [Smooth](#smooth), [Paint](#paint), and [Flatten](#flatten) tools.
@@ -137,7 +137,7 @@ The **Select** tool is a universal tool for selecting rectangular regions of ter
-## Playtest options
+## Playtest Options
-## Device emulation
+## Device Emulation
-## Mute audio
+## Audio Mute
The **Mute** button allows you to mute in-experience [sounds and music](../sound/index.md).
diff --git a/content/en-us/studio/testing-modes.md b/content/en-us/studio/testing-modes.md
index 8cd6f00b6..29459908f 100644
--- a/content/en-us/studio/testing-modes.md
+++ b/content/en-us/studio/testing-modes.md
@@ -1,5 +1,5 @@
---
-title: Studio testing modes
+title: Studio Testing Modes
description: Explore the built-in Studio testing modes for experiences.
---
@@ -9,15 +9,15 @@ import ControllerEmulator from '../includes/studio/controller-emulator.md'
import PauseResumePhysics from '../includes/studio/pause-resume-physics.md'
import BetaAlert from '../includes/beta-features/beta-alert.md'
-Because of the underlying [client-server model](../projects/client-server.md) of the Roblox Engine, it's important that you test your experience in various modes before [releasing it to the public](../production/publishing/publish-experiences-and-places.md#release-to-the-public). All of the testing options are accessible from the [Test](../studio/test-tab.md) tab.
+Because of the underlying [client-server model](../projects/client-server.md) of the Roblox engine, it's important that you test your experience in various modes before [releasing it to the public](../production/publishing/publishing-experiences-and-places.md#releasing-to-the-public). All of the testing options are accessible from the [Test](../studio/test-tab.md) tab.
-#### Controls and camera
+#### Controls and Camera
Depending on the mode, control of your character and the camera changes as follows:
@@ -44,7 +44,7 @@ Depending on the mode, control of your character and the camera changes as follo
-#### Explorer window
+#### Explorer Window
Within the [Explorer](../studio/explorer.md) window hierarchy, certain objects only exist in their expected containers.
@@ -59,19 +59,19 @@ Within the [Explorer](../studio/explorer.md) window hierarchy, certain objects o
-#### Output
+#### Output Window
In the [Output](../studio/output.md) window, messages are labeled **blue** (client) or **green** (server), indicating their origin from either the client or server. For messages output from `Class.ModuleScript|ModuleScripts`, the label color is determined by whether the module was called from a client-side `Class.LocalScript` or from a server-side `Class.Script`.
-### Pause and resume physics
+### Pausing & Resuming Physics
-## Collaborative testing
+## Collaborative Testing
If you're working on an experience with others in [Collaboration](../projects/collaboration.md) mode, you can test with other creators as follows:
@@ -98,21 +98,21 @@ If you're working on an experience with others in [Collaboration](../projects/co
Only one team test session can run at any given time. To close a session and kick out all testers, click the **Shutdown Server** button.
-## Device emulation
+## Device Emulation
-### Seed control
+### Seed Control
You can choose to either randomize the seed or set a specific seed for texture generation. Setting a specific seed before generating a texture ensures you get consistent results each time you use a specific prompt.
-### Generation angle
+### Generation Angle
Allows you to set a primary generation angle to prioritize during the preview generation phase to ensure the most important areas of your mesh are visible and able to be textured. This angle is also controlled by clicking and dragging the mesh in the preview window.
See [Best Practices](#best-practices) for detailed recommendations on choosing a generation angle.
-### Smart UV unwrap
+### Smart UV Unwrap
In 3D modeling, a **UV map** is a 2D representation of the surface of a 3D model, allowing 2D textures to be accurately applied to the 3D model. UV coordinates **U** and **V** refer to the horizontal and vertical axes of this 2D space, similar to the **X** and **Y** axes in a 2D graph.
@@ -145,7 +145,7 @@ For the texture generator tool to create well-formed textures, your mesh's under
Selecting the **Smart UV Unwrap** option will take a mesh with no UVs (or incompatible UVs) and apply the necessary UV coordinates for texturing. If your UVs are compatible, they won't be affected and you can use your mesh as‑is.
-### Specify front view
+### Specify Front View
When this setting is enabled, the [generation angle](#generation-angle) selected during the preview stage is specified as the "front" of your mesh. This allows the tool to better texture meshes with a clear front and back by identifying each side, resulting in more consistent and coherent textures. This is particularly helpful for objects with a clear front and back, like avatars, animals, and clothing.
@@ -182,10 +182,10 @@ Same prompt with **Specify Front View** enabled, yielding correct "front" and "b
-## Best practices
+## Best Practices
-### Visualization options
+### Visualization Options
In the upper-right corner of the 3D viewport, you can quickly toggle or set common visualization options related to [on‑screen UI](../ui/on-screen-containers.md) overlays, [light sources](../effects/light-sources.md), physics simulation, character [pathfinding](../characters/pathfinding.md), and more. The menu also contains a control for viewing/setting the camera scroll speed.
-## Layout customization
+## Customizing the Layout
Studio's drag-and-drop interface lets you easily customize window layout to best suit your workflows.
-### Reposition windows
+### Repositioning Windows
You can reposition any window by click-dragging its **header bar**. As you begin dragging the window, the interface reveals **empty docking area** regions. If you drag the mouse pointer into any empty region, a floating **position selector** appears in that region. Dragging the pointer over the "center" of the floating selector targets the empty region as the dragged window's destination, indicated by the region darkening and becoming outlined.
@@ -210,47 +210,74 @@ You can reposition any window by click-dragging its **header bar**. As you begin
If you drag the mouse pointer into a **populated** region such as the 3D viewport, a floating position selector appears with multiple options for the window's destination. For example, dragging the pointer over the "left" icon will position the window on the region's left side.
-### Float windows
+### Floating Windows
-To float a window freely of other windows, simply drag‑and‑drop it without selecting any icon from the floating [position selector](#reposition-windows).
+To float a window freely of other windows, simply drag‑and‑drop it without selecting any icon from the floating [position selector](#repositioning-windows).
-## In-Studio testing
+## Saving & Publishing
-Studio offers a suite of options for testing an experience before [releasing it to the public](../production/publishing/publish-experiences-and-places.md#release-to-the-public). All of the testing options are accessible from the [Test](../studio/test-tab.md) tab.
+Options to save and [publish](../production/publishing/publishing-experiences-and-places.md) can be found in the **File** menu in the top left of Studio.
-- [Rapid paytesting](../studio/testing-modes.md#playtest-options) — Provides a close simulation of the experience running on the Roblox application.
-- [Multi-client simulation](../studio/testing-modes.md#multi-client-simulation) — Compares how each client "sees" other clients within the experience.
-- [Device emulation](../studio/testing-modes.md#device-emulation) — Provides insight on how controls operate on a mobile device or how on-screen UI displays on different screens and aspect ratios.
-- [Controller emultation](../studio/testing-modes.md#controller-emulation) — Accurately emulates [gamepad input](../input/gamepad.md) directly in Studio.
+
-## Windows and tools
+## Windows and Tools
The **Show** section lets you toggle specific windows and tools within Studio. Commonly accessed windows/tools include:
@@ -73,9 +73,9 @@ The **View Selector** widget lets you easily navigate between 14 views in 3D spa
- 
-## Continue organization structure
+## Continue Organization Structure
-Before you apply your asset library to your greybox geometry, it's important to continue the organization structure you started in [Greybox a playable area](../../core/building/greybox-a-playable-area.md) by creating new container objects for the new assets you're about to add to your environment. This process keeps your Workspace organized and easy to scan, allowing you to easily make quick updates to specific groupings of assets.
+Before you apply your asset library to your greybox geometry, it's important to continue the organization structure you started in [Greybox a Playable Area](../../core/building/greybox-a-playable-area.md) by creating new container objects for the new assets you're about to add to your environment. This process keeps your Workspace organized and easy to scan, allowing you to easily make quick updates to specific groupings of assets.
To add in additional container objects to your organization structure:
1. In the **Explorer** window, insert two new folders into the **World** folder.
2. Rename the folders **Platforms** and **Mountains**, respectively.
-3. Insert a new model into the **Platforms** folder for each sea stack platform in your environment, and rename them according to sea stack level naming you created in [Greybox a playable area](../../core/building/greybox-a-playable-area.md). For example, the sample experience has 18 individual model containers for every platform in the environment.
+3. Insert a new model into the **Platforms** folder for each sea stack platform in your environment, and rename them according to sea stack level naming you created in [Greybox a Playable Area](../../core/building/greybox-a-playable-area.md). For example, the sample experience has 18 individual model containers for every platform in the environment.
-## Apply asset library
+## Apply Asset Library
@@ -273,7 +273,7 @@ To exactly recreate the sea stack platforms within the sample [Island Jump - Fin
-Congratulations on completing the Core Curriculum! Now that you have experience creating a simple experience from start to finish, you can extend your project with new gameplay features or additional levels, explore Studio's additional [features](../../../../platform.md), or follow additional tutorial curricula, such as the [Environmental art curriculum](../../environmental-art/index.md) that teaches you how to create a high-quality laser tag environment. Happy creating!
+Congratulations on completing the Core Curriculum! Now that you have experience creating a simple experience from start to finish, you can extend your project with new gameplay features or additional levels, explore Studio's additional [features](../../../../platform.md), or follow additional tutorial curricula, such as the [Environmental Art Curriculum](../../environmental-art/index.md) that teaches you how to create a high-quality laser tag environment. Happy creating!
1. In the **Selection Settings** section,
- 1. Set **Position** to `0, -15, 0` to ensure the water fills below the top of the island.
- 1. Set **Size** to `1800, 5, 1800` to ensure the water fills toward the horizon of your experience.
+ 1. Set **Position** to **0, -15, 0** to ensure the water fills below the top of the island.
+ 1. Set **Size** to **1800, 5, 1800** to ensure the water fills toward the horizon of your experience.
1. In the **Material Settings** section, configure the tool with the following settings:
-## Create the dust particles
+## Create the Dust Particles
The second type of particle emitter the sample [Island Jump - Final](https://www.roblox.com/games/14238807008/Island-Jump-Completed-Sample) uses to add dynamic movement to the experience is one that dust particles throughout the atmosphere. These particles surround the player, adding a sense of texture and depth to the air itself.
@@ -162,7 +162,7 @@ To create dust particles:
1. Select this block part, then in the **Properties** window,
1. Set **Name** to **VFX_DustMotes**.
- 1. Set **Transparency** to `1` so the part is invisible.
+ 1. Set **Transparency** to **1** so the part is invisible.
1. Disable **CanCollide** so players don't collide with the part as they move through the playable area.
1. Enable **Anchored** so the physics system doesn't move the part when the experience starts.
@@ -170,7 +170,7 @@ To create dust particles:
-### Configure the dust particles
+### Configure the Dust Particles
The dust particle emitter requires some new properties to change. `Class.ParticleEmitter.Acceleration` determines how a particle's `Class.ParticleEmitter.Speed` changes throughout its lifetime. Acceleration is often used to apply a gravity effect to particles with a negative `Y` value.
@@ -178,12 +178,12 @@ The dust particle emitter requires some new properties to change. `Class.Particl
For each point in a `Datatype.NumberSequence`, you can set an _envelope_ using the number input at the bottom of the window. An envelope sets the range from which Studio picks a random value higher or lower than the point's value each time a particle emits. The size of the envelope determines the range of the random selection. The sequence for `Class.ParticleEmitter.Transparency` includes an envelope so that each particle's visibility is unpredictable.
-Here are the values for all other previously explained properties. Refer back to [Configure the flare](#configure-the-flare) for these explanations.
+Here are the values for all other previously explained properties. Refer back to [Configure the Flare](#configure-the-flare) for these explanations.
1. In the **Explorer** window, select **Emitter_DustMotes**.
1. In the **Properties** window,
- 1. Set **Color** to `192, 241, 255`.
+ 1. Set **Color** to **192, 241, 255**.
1. Set **Size** to the following `Datatype.NumberSequence`:
diff --git a/content/en-us/tutorials/curriculums/core/building/customize-global-lighting.md b/content/en-us/tutorials/curriculums/core/building/customize-global-lighting.md
index dc4595bb7..6007b5355 100644
--- a/content/en-us/tutorials/curriculums/core/building/customize-global-lighting.md
+++ b/content/en-us/tutorials/curriculums/core/building/customize-global-lighting.md
@@ -1,5 +1,5 @@
---
-title: Customize global lighting
+title: Customize Global Lighting
description: Explains how to use global lighting settings to refine the look and feel of your experience.
prev: /tutorials/curriculums/core/building/create-basic-visual-effects
next: /tutorials/curriculums/core/building/apply-polished-assets
@@ -13,10 +13,10 @@ next: /tutorials/curriculums/core/building/apply-polished-assets
Using only a few modifications to Studio's default lighting settings, this section of the tutorial teaches you how to customize your global lighting in order to change the sun's position and light color, make dramatic shadows, and thicken the atmosphere.
-### Insert parts
+### Insert Parts
-1. Navigate back to the **Home** tab, then use the **Move**, **Scale**, and **Rotate** tools to position, scale, and rotate your cylinder until it's a large, flat surface in the middle of your island. For more information on these tools, see [Manipulating parts](../../../../parts/index.md#manipulate-parts).
+1. Navigate back to the **Home** tab, then use the **Move**, **Scale**, and **Rotate** tools to position, scale, and rotate your cylinder until it's a large, flat surface in the middle of your island. For more information on these tools, see [Manipulating Parts](../../../../parts/index.md#manipulating-parts).
@@ -142,7 +144,7 @@ To insert a cylinder part for your first platform:
@@ -291,7 +293,7 @@ To exactly recreate the sea stack platforms within the sample [Island Jump - Bui
+ 
@@ -415,7 +417,7 @@ To create a hollow tunnel:
-## Playtest the layout
+## Playtest
After you finish greyboxing your playable areas, you must playtest the layout of your environment to ensure the experience is both fun and functional, and so that you can catch small issues before they turn into much larger projects the further you are in the development process. For example, your experience's gameplay needs players to steadily upgrade their jumping power according to the amount of coins they collect, so it's important to verify that players are able to jump between platforms in relation to the `Class.Humanoid.JumpPower` you expect players to have at varying platform height levels.
@@ -436,8 +438,8 @@ To playtest your experience:
-1. In the **Properties** window, navigate to the **Jump Settings** section, then enable **UseJumpPower**. The **JumpPower** property displays with a default value of `50`.
-1. Set **JumpPower** to `0`. This ensures your character is unable to jump, emulating the same starting state for players after you script the gameplay.
+1. In the **Properties** window, navigate to the **Jump Settings** section, then enable **UseJumpPower**. The **JumpPower** property displays with a default value of **50**.
+1. Set **JumpPower** to **0**. This ensures your character is unable to jump, emulating the same starting state for players after you script the gameplay.
@@ -445,7 +447,7 @@ To playtest your experience:
If you can't see the **Properties** window, open the **View** tab and ensure **Properties** is selected in the **Show** section.
1. Select the part, then in the **Properties** window, configure the following properties so
the hazard is invisible, and players can pass right through it:
- - Set **Transparency** to `1`. This makes the hazard invisible, so that the
+ - Set **Transparency** to **1**. This makes the hazard invisible, so that the
actual water appears to be the hazard.
- Disable **CanCollide**. This tells the engine that other parts can pass
through the hazard uninterrupted, meaning players can fall through the hazard.
@@ -75,7 +75,7 @@ To create the basic water hazard:
-2. Select the wall component of these assets, then in the **Properties** window, set **Color** to `88, 218, 171`.
+2. Select the wall component of these assets, then in the **Properties** window, set **Color** to **88, 218, 171**.
@@ -502,7 +502,7 @@ To exactly recreate the spawn zones within the sample [Environment Art - Constru
-4. Select the wall component of these assets, then in the **Properties** window, set **Color** to `255, 170, 255`.
+4. Select the wall component of these assets, then in the **Properties** window, set **Color** to **255, 170, 255**.
@@ -511,7 +511,7 @@ To exactly recreate the spawn zones within the sample [Environment Art - Constru
-2. Select the wall component of these assets, then in the **Properties** window, set **Color** to `88, 218, 171`.
+2. Select the wall component of these assets, then in the **Properties** window, set **Color** to **88, 218, 171**.
@@ -819,12 +819,12 @@ To apply your asset library to the combat pockets:
5. Select the wall component of these assets, then in the **Properties** window,
- 1. Set **Color** to `211, 190, 150`.
+ 1. Set **Color** to **211, 190, 150**.
1. Set **MaterialVariant** to **MetalPanels**.
-6. Add a **PlanterSmall** prop asset for a piece of cover at a **CFrame.Position** of `-67.5, 5, 252.5` and a **CFrame.Orientation** of `0, 90, 0`. You can add foliage assets from the asset library to the top of the planter to add more organic life to the building.
+6. Add a **PlanterSmall** prop asset for a piece of cover at a **CFrame.Position** of **-67.5, 5, 252.5** and a **CFrame.Orientation** of **0, 90, 0**. You can add foliage assets from the asset library to the top of the planter to add more organic life to the building.
@@ -1001,7 +1001,7 @@ To apply your asset library to the combat pockets:
8. Select the wall component of these assets, then in the **Properties** window,
- 1. Set **Color** to `181, 173, 156`.
+ 1. Set **Color** to **181, 173, 156**.
1. Set **MaterialVariant** to **Concrete_Ribbed_A**.
@@ -1149,7 +1149,7 @@ To apply your asset library to the combat pockets:
10. Select the wall component of these assets, then in the **Properties** window,
- 1. Set **Color** to `181, 173, 156`.
+ 1. Set **Color** to **181, 173, 156**.
1. Set **MaterialVariant** to **Concrete_Ribbed_A**.
@@ -1290,7 +1290,7 @@ To apply your asset library to the combat pockets:
-12. Select the wall component of these assets, then in the **Properties** window, set **Color** to `255, 170, 255`.
+12. Select the wall component of these assets, then in the **Properties** window, set **Color** to **255, 170, 255**.
@@ -1408,12 +1408,12 @@ To apply your asset library to the combat pockets:
15. Select the wall component of these assets, then in the **Properties** window,
- 1. Set **Color** to `255, 170, 255`.
+ 1. Set **Color** to **255, 170, 255**.
1. Set **MaterialVariant** to **MetalPanels**.
-16. Add a **PlanterSmall** prop asset for a piece of cover at a **CFrame.Position** of `-67.5, 5, 67.5` and a **CFrame.Orientation** of `0, 90, 0`. You can add foliage assets from the asset library to the top of the planter to add more organic life to the building.
+16. Add a **PlanterSmall** prop asset for a piece of cover at a **CFrame.Position** of **-67.5, 5, 67.5** and a **CFrame.Orientation** of **0, 90, 0**. You can add foliage assets from the asset library to the top of the planter to add more organic life to the building.
@@ -1422,7 +1422,7 @@ To apply your asset library to the combat pockets:
-1. Select your wall components, then in the **Properties** window, set **Color** to the same hue as the right spawn zone's color theme.
+1. Select your wall components, then in the Properties window, set Color to the same hue as the right spawn zone's color theme.
1. Anchor all of these perimeter hallway assets.
-2. Select the wall component of these assets, then in the **Properties** window, set **Color** to `255, 170, 255`.
+2. Select the wall component of these assets, then in the **Properties** window, set **Color** to **255, 170, 255**.
@@ -1809,7 +1809,7 @@ To exactly recreate the perimeter hallways within the sample [Environment Art -
2. Group everything into a model, then duplicate the model.
-3. Move the duplicate tower to a **CFrame.Position** of `-30.572, 57.93, 133.5`.
+3. Move the duplicate tower to a **CFrame.Position** of **-30.572, 57.93, 133.5**.
@@ -1997,7 +1997,7 @@ To exactly recreate the towers within the sample [Environment Art - Constructing
The second exterior assets you can convert for the outdoor space are the two columns that hold up the overhang pieces you will make later in this tutorial. Similar to the towers, the technique in this section not only creates objects that are aesthetically pleasing to the eye, but it also provides further visual cues to users about where they are in the overall environment. For example, each column has either mint or carnation pink detailing to inform users if they are closest to either their own or their enemy's spawn zone.
3. Group everything into a model, then duplicate the model.
-4. Move the duplicate column to a **CFrame.Position** of `-18.169, 14.081, 81.5` and a **CFrame.Orientation** of `0, -90, 180`.
+4. Move the duplicate column to a **CFrame.Position** of **-18.169, 14.081, 81.5** and a **CFrame.Orientation** of **0, -90, 180**.
-5. Select the mint **block** part, then in the **Properties** window, set the **Color** property to `255, 170, 255` to match the color theme of the team on the right of the map.
+5. Select the mint **block** part, then in the **Properties** window, set the **Color** property to **255, 170, 255** to match the color theme of the team on the right of the map.
@@ -2172,7 +2172,7 @@ To apply your asset library to the left-most planter:
6. Select the union, then in the **Properties** window,
- 1. Set **Color** to `181, 173, 156`.
+ 1. Set **Color** to **181, 173, 156**.
1. Set **Material** to **Concrete**.
1. Set **MaterialVariant** to **Concrete_Board_Formed_A**.
1. Enable **UsePartColor**.
@@ -2258,7 +2258,7 @@ The roof of the building is one of the most complex assets in the final sample l
The first, top-most layer of the roof is the skylight geometry. The purpose of this layer is to provide outdoor light into interior combat areas.
1. Anchor all of these skylight assets.
@@ -2817,12 +2817,12 @@ To exactly recreate the ceiling within the sample [Environment Art - Constructin
@@ -3063,7 +3063,7 @@ To exactly recreate the top of the roof within the sample [Environment Art - Con
The fourth layer of the roof is the overhang geometry that the column assets hold up in order for the building to be structurally sound. The purpose of this layer is to provide an aesthetically pleasing awning space for users navigating the exterior primary lane.
-2. Select these trim assets, then in the **Properties** window, set **Color** to `248, 248, 248`.
+2. Select these trim assets, then in the **Properties** window, set **Color** to **248, 248, 248**.
@@ -3575,7 +3575,7 @@ To exactly recreate the trim of the roof within the sample [Environment Art - Co
-5. Select these trim assets, then in the **Properties** window, set **Color** to `255, 170, 0`.
+5. Select these trim assets, then in the **Properties** window, set **Color** to **255, 170, 0**.
@@ -3584,7 +3584,7 @@ To exactly recreate the trim of the roof within the sample [Environment Art - Co
-## Sculpt terrain
+## Sculpt Terrain
Right now your environment is mostly architectural aside from foliage in your planters. However, following the sample art style from [Develop Polished Assets](./develop-polished-assets.md), the 3D space should contain a healthy mix of futuristic technology and lush greenery to inform users that the world values technological advances, but not at the expense of the earth.
@@ -3609,7 +3609,7 @@ Using the [Terrain Editor](../../../parts/terrain.md), you can quickly generate
@@ -3677,12 +3677,12 @@ To recreate the terrain within the sample [Environment Art - Constructing](https
5. Navigate back to the Terrain Editor's **Brush Settings** section, then
- 1. Set **Base Size** to `10`.
- 1. Set **Height** to `10`.
+ 1. Set **Base Size** to **10**.
+ 1. Set **Height** to **10**.
1. Set **Ignore Parts** to **True/Enabled**.
1. In the **Edit Plane** setting,
1. Click the **Edit** button.
- 1. Set **Position** to `0, 0, 0`.
+ 1. Set **Position** to **0, 0, 0**.
1. Click the **Apply** button.
6. In the **Material Settings** section, select the **Slate** material, then in the viewport, draw another crescent shape that separates the pool from the architecture, and then a thin boundary around the outside of the pool.
@@ -3692,7 +3692,7 @@ To recreate the terrain within the sample [Environment Art - Constructing](https
7. Navigate back to the **Terrain Editor**, then select the **Paint** tool.
8. In the **Brush Settings** section,
1. Set the brush shape to the cylinder shape.
- 1. Set **Base Size** to `3`.
+ 1. Set **Base Size** to **3**.
1. Set **Pivot Position** to **Top**.
1. Set **Plane Lock** to **Off**.
9. In the **Material Settings** section, alternate between your **Mud**, **Leafy Grass**, **Ground**, **Sand**, **Salt**, **Slate**, and **Snow** custom materials, then in the viewport, draw on the remaining area.
@@ -3701,8 +3701,8 @@ To recreate the terrain within the sample [Environment Art - Constructing](https
10. Using your asset library,
- 1. Add a **FloatingIsland** asset with a `Datatype.CFrame.Position` of `201.726, -14.315, 183.5` for a spawn area users join before they separate into teams.
- 1. Intersperse rock assets with varying `Class.MeshPart.Size` and `Datatype.CFrame.Orientation` values along the border of the playable area.
+ 1. Add a **FloatingIsland** asset with a `Class.CFrame.Position` of **201.726, -14.315, 183.5** for a spawn area users join before they separate into teams.
+ 1. Intersperse rock assets with varying `Class.MeshPart.Size` and `Class.CFrame.Orientation` values along the border of the playable area.
1. Intersperse foliage assets around the outdoor space to add more organic life to the outdoor space.
1. Select these parts, then in the **Properties** window,
- 1. Set **Transparency** to `1`.
+ 1. Set **Transparency** to **1**.
1. Disable **CanCollide**.
1. Enable **Anchored**.
- 1. Set **LightEmission** to `0.3` to blend the colors of the texture and its environment.
- 1. Set **LightInfluence** to `0.2` to allow environment light to have a subtle effect on the color of particles.
+ 1. Set **LightEmission** to **0.3** to blend the colors of the texture and its environment.
+ 1. Set **LightInfluence** to **0.2** to allow environment light to have a subtle effect on the color of particles.
1. Set **Orientation** to **FacingCameraWorldUp** so particles always emit up toward the sky.
- 1. Set **Size** to `100` to create large clouds.
- 1. Set **Squash** to `-0.25` to shrink particles horizontally.
- 1. Set **Texture** to an image of a cloud. The sample uses `rbxassetid://10714362544`.
+ 1. Set **Size** to **100** to create large clouds.
+ 1. Set **Squash** to **-0.25** to shrink particles horizontally.
+ 1. Set **Texture** to an image of a cloud. The sample uses **rbxassetid://10714362544**.
1. Set **Transparency** to a number sequence that looks like the following image.
- 1. Set **Lifetime** to `30` to fade out particles at 30 seconds.
- 1. Set **Rate** to `0.25` to emit particles slowly.
- 1. Set **Acceleration** to `0, -0.8, 0` to impact particle speed over their lifetime.
- 1. Set **Drag** to `0.1` to make particles look their speed over time.
+ 1. Set **Lifetime** to **30** to fade out particles at 30 seconds.
+ 1. Set **Rate** to **0.25** to emit particles slowly.
+ 1. Set **Acceleration** to **0, -0.8, 0** to impact particle speed over their lifetime.
+ 1. Set **Drag** to **0.1** to make particles look their speed over time.
1. Enable **LockedToPart** to keep particles close to the particle emitter.
5. Repeat this process, moving cloud particle emitters throughout the environment.
-In addition, you can layer multiple particle emitters together to give clouds more depth. For example, in the final sample laser tag environment, foreground clouds layer an additional particle emitter with a **Color** property of `248, 248, 248`, **Texture** property of `rbxassetid://10714433747`, and a **Rate** property of `0.1`. You can find both of these particle emitters in the sample [Environment Art Asset Library](https://www.roblox.com/library/14447738661/Environment-Art-Asset-Library).
+In addition, you can layer multiple particle emitters together to give clouds more depth. For example, in the final sample laser tag environment, foreground clouds layer an additional particle emitter with a **Color** property of **248, 248, 248**, **Texture** property of **rbxassetid://10714433747**, and a **Rate** property of **0.1**. You can find both of these particle emitters in the sample [Environment Art Asset Library](https://www.roblox.com/library/14447738661/Environment-Art-Asset-Library).
-### Dust particles
+### Dust Particles
Particle emitters are such a versatile type of special effect because they offer so many properties you can customize to create interesting visual effects, such as glowing portals, green billowing smoke, or vibrant explosions. The final sample laser tag environment uses particle emitters again in this section to create floating dust particles that surround the user as they navigate the outdoor space.
@@ -3958,7 +3958,7 @@ To add and configure dust particles for the outdoor space:
1. Add a **block** part to the environment that covers the entire island.
2. Select this **block** part, then in the **Properties** window,
- 1. Set **Transparency** to `1`.
+ 1. Set **Transparency** to **1**.
1. Disable **CanCollide**.
1. Enable **Anchored**.
3. Create a particle emitter within this part.
@@ -3966,27 +3966,27 @@ To add and configure dust particles for the outdoor space:
1. From the contextual menu, insert a **ParticleEmitter**. The particle emitter immediately emits particles within the part's area.
4. Select this particle emitter, then in the **Properties** window,
- 1. Set **Color** to `192, 241, 255` to give the particles a light blue hue.
+ 1. Set **Color** to **192, 241, 255** to give the particles a light blue hue.
1. Set **Size** to a number sequence that looks like the following image.
- 1. Set **Texture** to a dust mote image. The sample uses `rbxassetid://14302399641`.
+ 1. Set **Texture** to a dust mote image. The sample uses **rbxassetid://14302399641**.
1. Set **Transparency** to a number sequence that looks like the following image.
- 1. Set **ZOffset** to `-5` to move particles away from the camera.
- 1. Set **Lifetime** to `1, 10` to set the minimum and maximum age of a particle to 1 and 10 seconds, respectively.
- 1. Set **Rate** to `50000` to create many particles for your environment.
- 1. Set **RotSpeed** to `-60` to create a range of speeds for newly emitted particles.
- 1. Set **Speed** to `1, 5` to set the minimum and maximum speed of a particle to 1 and 5 studs per second, respectively.
- 1. Set **Acceleration** to `1, -1, 1` to impact particle speed over its lifetime.
+ 1. Set **ZOffset** to **-5** to move particles away from the camera.
+ 1. Set **Lifetime** to **1, 10** to set the minimum and maximum age of a particle to 1 and 10 seconds, respectively.
+ 1. Set **Rate** to **50000** to create many particles for your environment.
+ 1. Set **RotSpeed** to **-60** to create a range of speeds for newly emitted particles.
+ 1. Set **Speed** to **1, 5** to set the minimum and maximum speed of a particle to 1 and 5 studs per second, respectively.
+ 1. Set **Acceleration** to **1, -1, 1** to impact particle speed over its lifetime.
1. Enable **LockedToPart** to keep particles close to the particle emitter.
-## Configure lighting sources
+## Configure Lighting Sources
Now that your environment has movement, the final step in constructing your environment is to configure lighting sources. Studio offers two high-level types of lighting sources:
@@ -3995,7 +3995,7 @@ Now that your environment has movement, the final step in constructing your envi
Both lighting sources are important to consider because your experience has both an indoor and outdoor environment that impact the user's ability to see what is happening around them while they're in combat.
-### Global lighting
+### Global Lighting
Global lighting is the luminescence from either the sun or moon in an experience. By adjusting a couple of key default properties in the `Class.Lighting` service, you can dramatically change how that light appears to users, as well as how it interacts with any other object you place in the experience.
@@ -4004,63 +4004,63 @@ Studio begins every experience with the `Enum.Technology.ShadowMap` lighting sys
For example, the `Enum.Technology.Future` lighting system automatically detects when a user is either in an interior or exterior space, then it responds by enabling the appropriate lighting model. This means that reflections are able to reflect off the floor and ceiling within the building, providing a richer visual experience as users navigate through combat pockets.
-1. In the **Explorer** window, select the **Lighting** service's child **Atmosphere** object, then in the **Properties** window, set its properties to values that reflect the art style of your experience. For more information on these properties, see [Atmospheric effects](../../../environment/atmosphere.md).
+1. In the **Explorer** window, select the **Lighting** service's child **Atmosphere** object, then in the **Properties** window, set its properties to values that reflect the art style of your experience. For more information on these properties, see [Atmospheric Effects](../../../environment/atmosphere.md).
-1. **(Optional)** Apply one or more customizable filters, such as bloom, depth‑of‑field, or sun rays. For more information on these properties, see [Post-processing effects](../../../environment/post-processing-effects.md).
+1. **(Optional)** Apply one or more customizable filters, such as bloom, depth‑of‑field, or sun rays. For more information on these properties, see [Post-Processing Effects](../../../environment/post-processing-effects.md).
-4. In the **Explorer** window, select the **Lighting** service's child **DepthOfField** object, then in the **Properties** window, set **FarIntensity** to `0.05`.
+4. In the **Explorer** window, select the **Lighting** service's child **DepthOfField** object, then in the **Properties** window, set **FarIntensity** to **0.05**.
@@ -4154,18 +4154,18 @@ To exactly recreate the local lighting configuration within the sample [Environm
2. Add and configure the small hallway interior lights.
1. Add a **block** part for one of the small hallway interior lights, then in the **Properties** window,
- 1. Set **Color** to `163, 162, 165`.
+ 1. Set **Color** to **163, 162, 165**.
1. Set **Material** to **Neon**.
- 1. Set **Size** to `0.25, 0.25, 1`.
- 1. Set **CFrame.Position** to `-53.962, 19.936, 291.932`.
+ 1. Set **Size** to **0.25, 0.25, 1**.
+ 1. Set **CFrame.Position** to **-53.962, 19.936, 291.932**.
1. Enable **Anchored**.
1. In the **Explorer** window, add a **SpotLight** object to the part.
1. Hover over the **block** part and click the **⊕** button. A contextual menu displays.
1. From the contextual menu, insert a **SpotLight** object.
1. Select the **SpotLight** object, then in the **Properties** window,
- 1. Set **Angle** to `135`.
+ 1. Set **Angle** to **135**.
1. Set **Face** to **Bottom**.
- 1. Set **Range** to `20`.
+ 1. Set **Range** to **20**.
1. Repeat this process, positioning and orienting parts above doors and hallways until you are happy with the interior lighting.
@@ -4174,19 +4174,19 @@ To exactly recreate the local lighting configuration within the sample [Environm
1. Add a **block** part for the left spawn zone, then in the **Properties** window,
- 1. Set **Color** to `88, 218, 171`.
+ 1. Set **Color** to **88, 218, 171**.
1. Set **Material** to **Neon**.
- 1. Set **Size** to `62.5, 1, 37.5`.
- 1. Set **CFrame.Position** to `-77, 20.6, 321`.
+ 1. Set **Size** to **62.5, 1, 37.5**.
+ 1. Set **CFrame.Position** to **-77, 20.6, 321**.
1. Enable **Anchored**.
1. Add a **block** part for the right spawn zone, then in the **Properties** window,
- 1. Set **Color** to `255, 170, 255`.
+ 1. Set **Color** to **255, 170, 255**.
1. Set **Material** to **Neon**.
- 1. Set **Size** to `62.5, 1, 37.5`.
- 1. Set **CFrame.Position** to `-77, 20.6, 1`.
+ 1. Set **Size** to **62.5, 1, 37.5**.
+ 1. Set **CFrame.Position** to **-77, 20.6, 1**.
1. Enable **Anchored**.
diff --git a/content/en-us/tutorials/curriculums/environmental-art/develop-polished-assets.md b/content/en-us/tutorials/curriculums/environmental-art/develop-polished-assets.md
index a54362098..51e451768 100644
--- a/content/en-us/tutorials/curriculums/environmental-art/develop-polished-assets.md
+++ b/content/en-us/tutorials/curriculums/environmental-art/develop-polished-assets.md
@@ -1,5 +1,5 @@
---
-title: Develop polished assets
+title: Develop Polished Assets
description: Explains the high-level concepts regarding how to design and develop polished assets.
next: /tutorials/curriculums/environmental-art/assemble-an-asset-library
prev: /tutorials/curriculums/environmental-art/greybox-your-environment
@@ -24,7 +24,7 @@ After you complete this section, you will learn how to pull all of your polished
It's important to note the process between polishing assets and constructing your environment hardly ever looks like a straight line from your original idea to the final art. Iteration between each step and across steps is normal and almost always necessary in the development process.
-## Choose an art style
+## Choose an Art Style
Choosing an art style at the start of your design process allows you to have a main source of truth for the aesthetic treatment of your assets. You can treat it as your visual ground rules, constantly referencing it as you design your assets to ensure they always inform users of what you want your environment to communicate. An effective art style provides users information about the world they're playing in, such as its climate, rich history, or relationship to technology.
@@ -32,15 +32,15 @@ Many developers choose to create a mood or theme board, then add as many picture
-## Design textures
+## Design Textures
Now that you have an art style for your experience, it's time to review your layout and figure out what textures you need to create materials for the 3D space. Environments often require textures that can cover large surfaces, as well as textures that can provide a level of detail to your assets without adding additional geometry. For example, your greybox environment needs textures that can cover the outdoor space, such as moss, flowers and stones, as well as textures to provide details to the combat pockets, such as panels and bolts to frame doorways.
There are two high-level texturing methods that you can use to meet these requirements: tileable textures and trim sheets. The following sections provide information and guidance on both texture methods, including what to consider as you find textures on the [Creator Store](../../../production/creator-store.md), or design them in third-party tools.
-### Tileable textures
+### Tileable Textures
-**Tileable textures** are textures that tile both on the X **and** Y axis, and they allow you to cover large surfaces in your environment, such as floors, walls, and terrain. This type of texture requires minimal manual adjustments after you apply them to block `Class.Part|Parts` because blocks have flat surfaces, meaning you don't need to account for how the texture might deform on more complex geometry. In addition, you can import tileable textures `Class.MaterialVariant` objects within the `Class.MaterialService` to apply to your terrain, which is a process you will learn in [Create custom materials](./assemble-an-asset-library.md#create-custom-materials) in the next section of this tutorial.
+**Tileable textures** are textures that tile both on the X **and** Y axis, and they allow you to cover large surfaces in your environment, such as floors, walls, and terrain. This type of texture requires minimal manual adjustments after you apply them to block `Class.Part|Parts` because blocks have flat surfaces, meaning you don't need to account for how the texture might deform on more complex geometry. In addition, you can import tileable textures `Class.MaterialVariant` objects within the `Class.MaterialService` to apply to your terrain, which is a process you will learn in [Creating Custom Materials](./assemble-an-asset-library.md#creating-custom-materials) in the next section of this tutorial.
@@ -85,9 +85,9 @@ If you decide to design your own tileable textures in third-party modeling tools
- Create equal visible distribution so that no one element is more distinguishable than others.
- Even if a tileable texture is technically seamless, review the overall image to ensure it doesn't have an element that is so pronounced that the texture's repetition is noticeable.
-The previous point is near impossible to remove entirely, but you can set Studio material to tile organically, or add in additional decal overlays to hide the repetition effectively. For more information on these techniques, see [Assemble an asset library - Creating custom materials](assemble-an-asset-library.md#create-custom-materials) and [Assembling modular environments - Reducing visible repetition](assemble-modular-environments.md#reduce-visible-repetition), respectively.
+The previous point is near impossible to remove entirely, but you can set Studio material to tile organically, or add in additional decal overlays to hide the repetition effectively. For more information on these techniques, see [Assemble an Asset Library - Creating Custom Materials](assemble-an-asset-library.md#create-custom-materials) and [Assembling Modular Environments - Reducing Visible Repetition](assembling-modular-environments.md#reducing-visible-repetition), respectively.
-### Trim sheets
+### Trim Sheets
**Trim sheets** are textures that tile both on either the X **or** Y axis, and they allow you to add significantly more visual complexity to your experiences without having to import additional textures, saving you a negative impact on memory. Each row or column of a trim sheet has a unique visual appearance, giving you many different surface treatments to choose from when you're mapping UV data to a mesh. For example, the door frame and ceiling assets in the following two images use different layers of the same trim sheet to add detail work to the space.
@@ -100,11 +100,11 @@ The previous point is near impossible to remove entirely, but you can set Studio
-The most fundamental rule for trim sheets is to avoid contextual details that you can only apply to a single object. This is because trim sheets must have use for many types of objects in your world, and highly specific details are also distinguishable to users as they repeat in the 3D space. For example, in the following image from the [Mystery of Duvall showcase](../../../resources/the-mystery-of-duvall-drive/materialize-the-world.md#surface-appearance-and-trim-maps), the left-side furniture set's trim sheet includes more stain detail than the right-side furniture set's trim sheet. Notice how the extra stain detail makes its repetition prominent in comparison to the furniture set on the right.
+The most fundamental rule for trim sheets is to avoid contextual details that you can only apply to a single object. This is because trim sheets must have use for many types of objects in your world, and highly specific details are also distinguishable to users as they repeat in the 3D space. For example, in the following image from the [Mystery of Duvall showcase](../../../resources/the-mystery-of-duvall-drive/materializing-the-world.md#surface-appearance-and-trim-maps), the left-side furniture set's trim sheet includes more stain detail than the right-side furniture set's trim sheet. Notice how the extra stain detail makes its repetition prominent in comparison to the furniture set on the right.
-Following this fundamental rule, the final sample laser tag environment uses the following trim sheet texture maps with six rows of simple detail work to add visual interest and cohesion to its modular kit and props. You can use this 
-Each asset in this modular kit has a consistent pivot point location either at the forward-most, lower corner, or in a location that allows them to snap to a logical position on the building in 5 stud increments when you enable grid snapping, such as trim pieces onto walls, or doors into their doorway position. In addition, each asset is at least 5 studs tall and wide, so there is never any clashing geometry, even when you rotate and move the assets. For more information on this concept, see [Assembling modular environments - The importance of consistent pivot point locations](assemble-modular-environments.md#the-importance-of-consistent-pivot-point-locations).
+Each asset in this modular kit has a consistent pivot point location either at the forward-most, lower corner, or in a location that allows them to snap to a logical position on the building in 5 stud increments when you enable grid snapping, such as trim pieces onto walls, or doors into their doorway position. In addition, each asset is at least 5 studs tall and wide, so there is never any clashing geometry, even when you rotate and move the assets. For more information on this concept, see [Assembling Modular Environments - The Importance of Consistent Pivot Point Locations](assembling-modular-environments.md#the-importance-of-consistent-pivot-point-locations).
@@ -163,7 +163,7 @@ You can use or modify the [sample modular kit](https://www.roblox.com/library/14
No matter what modular kit you use, it's important to test often and look at your assets from multiple perspectives to see if there is any clashing geometry. If there is, it often means that one of the asset's pivot point locations isn't relatively consistent with the other.
-## Design props
+## Design Props
Props are non-modular assets that enhance an environment's level of visual storytelling while providing users important context about the world they're in. For example, if users are exploring a cave and see props like glowing orbs and skeletons, they can infer that their environment is both magical and dangerous, so it might be wise to proceed with caution.
@@ -177,7 +177,7 @@ Unlike modular assets, props don't need to have consistent pivot point locations
You can use or modify props from the [Environment Art Asset Library](https://www.roblox.com/library/14447738661/Environment-Art-Asset-Library) in the world building section of this tutorial. However, if you decide to design your own props in third-party modeling tools like [Blender](https://www.blender.org/) or [Maya](https://www.autodesk.com/products/maya/overview), keep the following in mind:
-- Users often see props from multiple angles, so it's important to include enough detail for users to understand what the prop is, but not too much detail so that it impacts performance. A good rule is to only include enough geometry that users can tell what a prop is from its silhouette. For more information on this concept, see [Developing a moving world - Setting up the eye of the storm](../../../resources/the-mystery-of-duvall-drive/develop-a-moving-world.md).
+- Users often see props from multiple angles, so it's important to include enough detail for users to understand what the prop is, but not too much detail so that it impacts performance. A good rule is to only include enough geometry that users can tell what a prop is from its silhouette. For more information on this concept, see [Developing a Moving World - Setting Up the Eye of the Storm](../../../resources/the-mystery-of-duvall-drive/developing-a-moving-world.md).
- You can use the same trim sheet you used for your modular assets so that you make efficient use of textures that are already within your environment, and so that every asset remains stylistically cohesive.
- Distinct visual markers in props are more noticeable the more you reuse them in your environment.
diff --git a/content/en-us/tutorials/curriculums/environmental-art/greybox-your-environment.md b/content/en-us/tutorials/curriculums/environmental-art/greybox-your-environment.md
index 7e46dfa30..f8a193ff5 100644
--- a/content/en-us/tutorials/curriculums/environmental-art/greybox-your-environment.md
+++ b/content/en-us/tutorials/curriculums/environmental-art/greybox-your-environment.md
@@ -1,5 +1,5 @@
---
-title: Greybox your environment
+title: Greybox Your Environment
description: Explains how to greybox the laser tag environment using basic parts.
next: /tutorials/curriculums/environmental-art/develop-polished-assets
prev: /tutorials/curriculums/environmental-art/
@@ -21,13 +21,13 @@ After you complete this section, you will learn how to develop high-quality asse
-## Three lane map layout
+## Three Lane Map Layout
The **three lane map layout** is a first-person shooter map layout that includes a spawn zone for each team on opposite sides of the map, three primary lanes that each team can use to travel to either spawn zone, and cross lanes that allow for users to travel from one primary lane to another. This type of map layout is a common layout for first-person shooter experiences because it quickly places users into combat zones as soon as they join a match, and it allows for a variety of playstyles depending on which primary lane users choose to follow.
The following sections explain each component of the three lane map layout, including considerations of how each component works together to create intentional gameplay interactions within first-person shooter experiences.
-### Spawn zones
+### Spawn Zones
**Spawn zones** are areas of the map where users either join their team at the start of a match, or rejoin the gameplay after their health reaches zero. At minimum, each team needs to have a central spawn zone when users first join the experience. Many developers place these central spawn zones at opposite ends of their maps to allow users time to navigate the experience at the start of the match before seeing the enemy team.
@@ -35,7 +35,7 @@ The following sections explain each component of the three lane map layout, incl
In addition, many team-based first-person shooter experiences also include spawn zones throughout the map that users can randomly respawn at once their health reaches zero. The placement of these decentralized spawn zones can significantly increase the experience's difficulty, especially when you place spawn zones near areas with heavy combat. To keep the gameplay simple, the sample laser tag greybox environment only includes one central spawn zone for each team.
-### Primary lanes
+### Primary Lanes
**Primary lanes** are paths that extend the length of the map from one spawn zone to another. The three lane map layout includes three primary lanes, and how developers conceptualize them is often dependent on the overall environmental context of the experience. For example, because the sample laser tag map has both an indoor and outdoor environment, the names of the primary lanes are as follows:
@@ -47,7 +47,7 @@ For most first-person shooter experiences using the three lane map layout, the m
-### Cross lanes
+### Cross Lanes
**Cross lanes** are paths that intersect all of the primary lanes, extending from the interior to the exterior primary lane. These are the paths that users can use to travel from one primary lane to another, and they often contain minimal obstructions to help users take cover from enemy fire. This is because coverless zones create transitory spaces that encourage users to not stay in one place for too long without it being dangerous.
@@ -59,7 +59,7 @@ Similar to the reason why the most combat occurs around the middle primary lane,
Building a three lane map layout with these combat pockets in mind allows you to segment the distance from spawn zones, and create intentional spaces where users have to interact with each other. This encourages users to engage in rapid gameplay and quickly become familiar with the map as they jump between primary lanes using cross lanes.
-## Create playable areas
+## Create Playable Areas
Now that you are familiar with three lane map layouts, it's time to learn how to create the playable areas for the sample laser tag greybox environment that follows a three lane map layout. As you follow these instructions that exactly recreate the geometry within the sample [Environment Art - Greyboxing](https://www.roblox.com/games/14447721254/Environment-Art-Greyboxing) `.rbxl` file, you will start to see how it all works together to make up two spawn zones, three primary lanes, and five cross lanes that mirror across the middle of the map when you look at it from a top-down view.
@@ -73,7 +73,7 @@ If you adjust the geometry to meet the specifications of your own experience, no
-### Floor geometry
+### Floor Geometry
The first step in creating the laser tag greybox environment is to create the geometry for each of the following floors:
@@ -90,15 +90,15 @@ It's important to have spaces in the experience with peaks and valleys because i
In addition, a rise in elevation creates both a physical and emotional sense of ascension, allowing users with a high ground to have a bird's eye view of the battlefield in order to get a better sense of where to travel next. When they're ready to move on, the drop in elevation creates both a physical and emotional sense of descension, pushing users to make quick decisions to maneuver around enemy lines of sight and achieve their goals.
@@ -121,15 +121,15 @@ To create your own floor geometry:
1. Anchor all of your parts.
1. In the **Explorer** window, select the block, then in the **Properties** window,
- 1. Set **Size** to `105, 1, 185`.
- 1. Set **CFrame.Position** to `-77.5, 4.5, 252.5`.
+ 1. Set **Size** to **105, 1, 185**.
+ 1. Set **CFrame.Position** to **-77.5, 4.5, 252.5**.
@@ -268,7 +268,7 @@ To exactly recreate the floor geometry within the sample [Environment Art - Grey
-## Review physics and render parameters
+## Review Physics and Rendering Parameters
-In [Assemble an asset library](./assemble-an-asset-library.md), you learned how important it is to set physics and rendering parameters that allow your assets to retain their high visual quality across devices with memory and GPU limitations. However, it's common as you construct your environment to adjust these parameters according to an asset's contextual position and purpose within your experience. For example, much of the foliage in the final sample laser tag environment casts shadows despite a performance cost because it adds to the realism of the environment.
+In [Assemble an Asset Library](./assemble-an-asset-library.md), you learned how important it is to set physics and rendering parameters that allow your assets to retain their high visual quality across devices with memory and GPU limitations. However, it's common as you construct your environment to adjust these parameters according to an asset's contextual position and purpose within your experience. For example, much of the foliage in the final sample laser tag environment casts shadows despite a performance cost because it adds to the realism of the environment.
When you modify physics and rendering parameters, it's useful near the end of the development process to review all parameters to see where you can optimize a parameter while maintaining aesthetic goals and gameplay requirements. To illustrate, you can disable `Class.BasePart.CastShadow` property for the foliage near the edges of the gameplay area to save on performance without interfering with a user's gameplay or visual experience.
@@ -36,26 +36,26 @@ When you modify physics and rendering parameters, it's useful near the end of th
-## Cull nonessential content
+## Cull Nonessential Content
After you review your physics and rendering parameters, you can review the assets themselves to see where you can cull any nonessential content from the experience that doesn't affect your gameplay, such as identical textures with different assetIDs, complex geometry with a high vertice count, or transparencies that layer on top of each other depending on the camera view. The following sections detail what you can do to review this content, and why it helps optimization efforts.
-### Remove duplicate textures
+### Remove Duplicate Textures
-As you transition between developing your assets and constructing your environment, it's common to iterate over meshes or textures as you find what's necessary for your aesthetic goals or gameplay requirements. If you don't convert your assets into [packages](../../../projects/assets/packages.md), when you import these iterations into Studio, you're making unique assetIDs that the Roblox Engine needs to reference as it renders your assets within the environment.
+As you transition between developing your assets and constructing your environment, it's common to iterate over meshes or textures as you find what's necessary for your aesthetic goals or gameplay requirements. If you don't convert your assets into [packages](../../../projects/assets/packages.md), when you import these iterations into Studio, you're making unique assetIDs that the Roblox engine needs to reference as it renders your assets within the environment.
-For example, if you were to import the following two fire hydrant meshes into Studio separately, even if they are exactly the same in appearance, the Roblox Engine treats them as two objects with unique assetIDs. The more unique calls the engine needs to make, the more of an impact on memory and performance. For this reason, it's important to confirm when you're reusing an asset multiple times, each instance of that asset uses the same assetID so that the engine only needs to make a single call to render it repeatedly.
+For example, if you were to import the following two fire hydrant meshes into Studio separately, even if they are exactly the same in appearance, the Roblox engine treats them as two objects with unique assetIDs. The more unique calls the engine needs to make, the more of an impact on memory and performance. For this reason, it's important to confirm when you're reusing an asset multiple times, each instance of that asset uses the same assetID so that the engine only needs to make a single call to render it repeatedly.
-### Optimize geometry
+### Optimize Geometry
If you find that you need to make more adjustments to increase frame rate across devices, it's useful to see where you can optimize your geometry by either:
- Combining groups of meshes into a single asset.
- Decreasing the polygon count of assets with geometric complexity.
-Expanding on this first technique, every unique asset in your experience represents a draw call on the GPU in which it sends a signal to the GPU to call information in order for the Roblox Engine to render the asset correctly. The more unique assets you have, the more draw calls the system needs to make. For this reason, if you have a group of meshes that make up a larger component in your experience, you can group them together in third-party modeling tools to reduce the need for multiple draw calls.
+Expanding on this first technique, every unique asset in your experience represents a draw call on the GPU in which it sends a signal to the GPU to call information in order for the Roblox engine to render the asset correctly. The more unique assets you have, the more draw calls the system needs to make. For this reason, if you have a group of meshes that make up a larger component in your experience, you can group them together in third-party modeling tools to reduce the need for multiple draw calls.
To illustrate this point, the final sample laser tag environment parents multiple parts and meshes together to create the large towers outside of the building. If you were to combine all of these individual components together, you could make it a single asset with only one assetID, and reduce the number of draw calls from 8 to 1. However, it's important to note that this technique removes your ability to freely change the visual and physical characteristics of each component, such as its position or material.
@@ -66,12 +66,12 @@ For example, in the following image, the left tower remains multiple assets unde
Expanding on the second technique, assets with geometric complexity have more polygons, meaning they have more vertices that the engine needs to calculate as it renders their visual appearance. This means that assets with less complexity and fidelity are less costly to render, leading to an improvement in both performance and memory.
-## Start loop
+## Start Loop
**ServerScriptService** > **Gameplay** > **Rounds** handles most of the logic for implementing rounds, and it starts by calling the `startRoundLoopAsync()` function to mark the beginning of a round loop. While players join the lobby and wait to sort into a team, `startRoundLoopAsync()` calls the `resetScores()` function in **ServerScriptService** > **Gameplay** > **Scoring** to reset both the leaderboard and team points.
@@ -52,7 +52,7 @@ For any new players that join the experience after the lobby group was sorts int
end)
```
-## Set objective
+## Set Objective
Now that each player is in the arena with their teammates, the experience needs to provide instructions for what to do to be successful within the round. The sample laser tag experience tackles this requirement by providing an objective prompt at the top of each player's screen with clear guidance on what the team needs to do to win.
@@ -85,7 +85,7 @@ local function setObjective(gui: ScreenGui)
end
```
-## Track points
+## Track Points
Now that players have a goal for the round, the experience needs to keep track of each team's points until they meet their objective. While the `Class.Teams` service's default behavior automatically groups each player underneath their team and adds up each player's contributions to their team score, it's important to store and monitor points in a separate location for round-based gameplay because if a player scores then leaves before the round is over, their contribution is deducted from the leaderboard as soon as they disconnect from the experience.
@@ -160,7 +160,7 @@ function Scoring.incrementScore(player: Player, amount: number)
end
```
-## Display results
+## Display Results
As players tag each other and score points for their team, **ServerScriptService** > **Gameplay** > **Rounds** checks to see if the team that scored met the round objective. If their team score is lower than the `TEAM_SCORE_LIMIT` variable in **ReplicatedStorage** > **TEAM_SCORE_LIMIT**, the server continues to wait until one of the teams scores again.
@@ -218,7 +218,7 @@ local function onRoundWinner(winner: Team, localTeam: Team?)
end
```
-## Reset teams
+## Reset Teams
At the same time that **ServerScriptService** > **Gameplay** > **Rounds** verifies that a team met the round objective and triggers the appropriate UI display for each player, it also transports all players from the arena to the lobby by disconnecting them from the round. This starts the process of formally ending the round and resetting both teams.
diff --git a/content/en-us/tutorials/curriculums/gameplay-scripting/create-teams.md b/content/en-us/tutorials/curriculums/gameplay-scripting/creating-teams.md
similarity index 99%
rename from content/en-us/tutorials/curriculums/gameplay-scripting/create-teams.md
rename to content/en-us/tutorials/curriculums/gameplay-scripting/creating-teams.md
index 3becc9a85..daa1a8abd 100644
--- a/content/en-us/tutorials/curriculums/gameplay-scripting/create-teams.md
+++ b/content/en-us/tutorials/curriculums/gameplay-scripting/creating-teams.md
@@ -1,5 +1,5 @@
---
-title: Create teams
+title: Creating Teams
description: Explains how separate players into teams as they join an experience.
prev: /tutorials/curriculums/gameplay-scripting/
next: /tutorials/curriculums/gameplay-scripting/spawn-respawn
@@ -17,7 +17,7 @@ After you complete this section, you will learn about the scripts that allow pla
-## Assign team colors
+## Assign Team Colors
The sample laser tag experience uses the `Class.Teams` service as a basis for creating two teams because the service offers built-in team sorting behavior that broadly works out-of-the-box. For example, without any additional scripting effort, the service handles actions like:
@@ -130,7 +130,7 @@ end
-## Identify your UI elements
+## Identify Your UI Elements
The first step in choosing an art style for your UI is to identify what UI elements you need for the varying types of information you want to communicate to your audience. Doing this work at the start of your design process is crucial because it allows you to categorize UI elements by their functional purpose, make semantic decisions according to where and when players are going to interact with each UI element, and plan where you can reuse UI elements across your experience.
@@ -71,7 +71,7 @@ After you sort your experience's UI needs into categories, you can create a list
Now that you have a list of UI elements for your experience, it's time to begin making stylistic and semantic choices for each grouping of UI elements, starting with a color theme.
-## Select a color theme
+## Select a Color Theme
A **color theme**, or color palette, is a selection of colors that each communicate a message through consistent application within your experience, such as using a bright color to indicate when something is selectable. Applying a color theme to your UI elements is important, especially when you rely on color conventions within the genre of your experience, because it allows players to quickly understand your UI with minimal effort.
@@ -107,7 +107,7 @@ To highlight the guidance in the last point, the sample laser tag experience uti
-## Outline simple icons
+## Outline Simple Icons
An **icon** is a symbol that represents an action, object, or concept in an experience. Outlining icons that are simple and intuitive is important because the end result enables players to easily recognize what they are able to do and what you want to tell them through your UI without using text, which can clutter the screen and pull attention away from content that matters. This process is even more crucial if your audience accesses your experience using a small screen on mobile devices.
@@ -143,7 +143,7 @@ When outlining simple icons for your own experience, consider the following:
If you don't know what types of icons are common within your experience's genre, check out the [Game UI Database](https://gameuidatabase.com/). This free resource tool for UI designers includes screenshots from hundreds of games of different genres that you can reference during your design process.
-## Establish an interaction order
+## Establish an Interaction Order
An **interaction order** is the sequence of interactions players can have with your UI. As there are often multiple interactable UI elements on the screen, it's important to establish an intuitive interaction order to assist players in making decisions as they navigate various workflows.
@@ -178,7 +178,7 @@ When establishing an interaction order for the workflows in your own experience,
In [Implement in Studio](implement-designs-in-Studio.md), you will learn how to use `Class.UIAspectRatioConstraint` objects to ensure UI elements maintain a specific aspect ratio no matter what device players use to access your experience. In addition to making your design process easier, this technique can also help you meet the Web Content Accessibility Guidelines' [Touch Target Size and Spacing](https://w3c.github.io/Mobile-A11y-TF-Note/#targetSize) recommendation to create a touch zone for interactive UI elements that's at least 9x9 mm on mobile devices.
-## Determine a text system
+## Determine a Text System
A **text system** is a set of rules about fonts and style for all of the words in your UI, such as "always bold headers" or "use green font when referencing a health stat." Determining a text system early into your design process allows you to have a structure that you can consistently apply throughout your experience so players know what to expect as they search for the information they need.
diff --git a/content/en-us/tutorials/curriculums/user-interface-design/implement-designs-in-studio.md b/content/en-us/tutorials/curriculums/user-interface-design/implement-designs-in-studio.md
index 710e1eea4..ccb295020 100644
--- a/content/en-us/tutorials/curriculums/user-interface-design/implement-designs-in-studio.md
+++ b/content/en-us/tutorials/curriculums/user-interface-design/implement-designs-in-studio.md
@@ -1,5 +1,5 @@
---
-title: Implement designs in Studio
+title: Implement Designs in Studio
description: Explains how to greybox the laser tag environment using basic parts.
prev: /tutorials/curriculums/user-interface-design/wireframe-your-layouts
---
@@ -18,7 +18,7 @@ After you review the techniques in this section, you can apply them to your own
The instructions in this section of the tutorial show you how to exactly recreate the UI components using the UI Design Asset Library. This process takes about 90 minutes or less from start to finish. If you don't want to use the provided values, you can adjust each UI element to meet the specifications of your own experience, or use the sample itself for the rest of the tutorial.
-## Get asset library
+## Get Asset Library
Asset libraries are collections of assets you can add into your inventory for easy access and reuse. The asset library you will use for your project from the [Creator Store](../../../production/creator-store.md) includes nine 2D individual UI element assets, and the final versions of the objective, blaster selector, and player info components you are creating in this section of the tutorial.
@@ -115,7 +115,7 @@ To get the asset library from your inventory into your experience:
1. Click the dropdown menu, then select the **My Packages** sort.
1. Click the **Final Screen UI Components** tile, then in the **Explorer** window, select **Completed Components**, then drag them into the **StarterGui** service. You can now enable any of the final components to reference their design.
-## Emulate devices
+## Emulate Devices
Studio's **Device Emulator** allows you to test how players will see and interact with your UI on various devices. This tool is a vital part of the implementation process because the aspect ratio of your viewport in Studio doesn't necessarily reflect the aspect ratio of the screens players use to access your experience, and it's important that your UI is both legible and accessible on every device.
@@ -136,7 +136,7 @@ To emulate your screen to the smallest screen size:
-## Create ScreenGui objects
+## Create ScreenGui Objects
To display UI elements on every player's screen, you can create a `Class.ScreenGui` object in the `Class.StarterGui` service. `Class.ScreenGui` objects are the primary containers for on-screen UI, and the `Class.StarterGui` service copies its contents to each player's `Class.PlayerGui` container as they enter an experience.
@@ -485,7 +485,7 @@ To exactly recreate the crosshair within the sample [Laser Tag](https://www.robl
1. **(Optional)** Insert a **UIAspectRatioConstraint** into **Crosshair** to ensure the label's aspect ratio remains the same no matter the player's screen size. The sample sets its `Class.UIAspectRatioConstraint.AspectRatio` property to **0.895**.
-#### Hit marker
+#### Hit Marker
A hit marker is a UI element that only displays when a blast makes impact with another player on the enemy team. Like the crosshair, this UI element is a vital gameplay requirement for first-person shooter experiences because it provides visual feedback of when players are successful in tagging out their opponents.
@@ -584,7 +584,7 @@ return setupHitmarker
Now, whenever a player blasts their blaster and the blast makes impact with another player, the hit marker momentarilly displays.
-#### Blaster selector
+#### Blaster Selector
A blaster selector is a UI component that players use to select their blaster type before joining or rejoining a round. The sample laser tag experience provides two types of blasters: one that produces several beams with a wide, horizontal spread, and another that produces a single beam. The type of blaster that players select influences their strategy during the round, making this UI component an essential workflow for the overall experience.
@@ -1001,7 +1001,7 @@ return setupNavButtons
Now, whenever a player joins the experience or respawns back into a round after their health reaches zero, the blaster selector UI displays, they can make a selection, and each button functions as expected.
-#### Blast button
+#### Blast Button
A blast button is a UI component that players use to blast their blaster if they are accessing the experience through a mobile or tablet device. The sample laser tag experience uses a blaster button with an icon that depicts both a crosshair and a blast to communicate the button's function without text.
@@ -1162,7 +1162,7 @@ Following the visual hierarchy best practices from [Wireframe Your Layouts](wire
-#### Player indicator
+#### Player Indicator
A player indicator is a UI component that players reference to quickly decipher what team they belong to as soon as they spawn into their team's spawn zone. The sample laser tag experience provides two versions of the player indicator depending on if the player is on the **green** or **pink** team.
@@ -1406,7 +1406,7 @@ return setPlayerName
Now, whenever a player joins or rejoins the round after respawning, the player indicator displays on the bottom-left of their screen.
-#### Force field screen
+#### Force Field Screen
A force field screen is a UI element that overlays the viewport to inform players they're safe from enemy team fire while joining or rejoining a round. Following the aesthetic guidelines for icons from [Choose an Art Style](./choose-an-art-style.md), the sample laser tag experience utilizes a semi-transparent hexagonal pattern to symbolize a force field. This design decision not only reinforces the overall futuristic art style for all UI in the experience, but it also communicates the player's state without any text or additional guidance.
@@ -1603,7 +1603,7 @@ return scheduleDestroyForceField
Now, whenever a player joins or rejoins the round after respawning, the new force field screen UI displays instead of the default first-person `Class.ForceField` visuals.
-#### Respawn screen
+#### Respawn Screen
A respawn screen is a UI element that dims the viewport to inform players that they have been tagged out, and that the server is in the process of respawning them back to their spawn zone. This UI element is important because it gives players time to process that they've been tagged out, and strategize their next move before they rejoin the active round.
@@ -1828,7 +1828,7 @@ Now, whenever a player's health reaches zero, the respawn screen displays until
Now that you are familiar with common `Class.GuiObject|GuiObjects` for on-screen UI, try to recreate the **RoundResultsGui** `Class.ScreenGui` object and all of its children for the on-screen display when players win or lose a match. You can use the [sample laser tag experience](https://www.roblox.com/games/14817965191/Laser-Tag-1A) `.rbxl` file as a reference, or adjust the values to meet the gameplay requirements of your own experience.
-## Create SurfaceGui objects
+## Create SurfaceGui Objects
To display UI on a part's surface in the 3D space that responds to scripting logic for **each individual player**, you can parent a `Class.SurfaceGui` object to the part that you want to display your UI within the `Class.ReplicatedStorage` service. This technique ensures your UI and its scripting logic are available to both the server and each player's client.
@@ -1844,7 +1844,7 @@ To create a `Class.SurfaceGui` object:
-### Cooldown meter
+### Cooldown Meter
A cooldown meter is a UI component that informs players how long they have to wait before they're able to blast their blaster again. This slight pause prevents players from being able to blast as quickly as they can click or press a button, which is unrealistic for laser tag gameplay.
@@ -2079,7 +2079,7 @@ return runCooldownBarEffect
Now, whenever a player blasts their blaster, the cooldown bar animates to communicate when the player can blast again.
-## Create BillboardGui objects
+## Create BillboardGui Objects
In order to display UI elements within the 3D space that respond to scripting logic and always face each player's camera regardless of their viewing angle, such as player names or map markers, you can create a `Class.BillboardGui` object as a child of a `Class.BasePart` or `Class.Attachment` that exists in the 3D space.
@@ -2097,7 +2097,7 @@ To create a `Class.BillboardGui` object:
1. Rename the **BillboardGui** according to the context of its child UI elements.
1. Repeat this process for every UI element you need to contextually display above players' heads.
-### Team indicator
+### Team Indicator
A team indicator is a UI element that informs players which team other players in the round belong to so that they can easily differentiate between their allies and enemy team members. This information is important because the gameplay of a first-person shooter experience requires players to make quick strategic decisions while they're in combat zones so that they don't get tagged out and lose the match.
@@ -2277,7 +2277,7 @@ onLocalTeamChanged()
Now, whenever a player's is in an active round, team indicators display over other players' heads unless they are on the enemy team and behind an object.
-### Tagged out indicator
+### Tagged Out Indicator
A tagged out indicator is a UI element that informs players when other players are no longer active in the round and are in the process of respawning back to their spawn zone. This information is important because the gameplay of a first-person shooter experience requires players to move onto their next target as soon as they tag out a player so that they don't become vulnerable in the arena by playing in the same location for too long.
diff --git a/content/en-us/tutorials/curriculums/user-interface-design/index.md b/content/en-us/tutorials/curriculums/user-interface-design/index.md
index 272b11c2c..eacd70b4d 100644
--- a/content/en-us/tutorials/curriculums/user-interface-design/index.md
+++ b/content/en-us/tutorials/curriculums/user-interface-design/index.md
@@ -1,5 +1,5 @@
---
-title: User inferface design curriculum
+title: User Inferface Design Curriculum
description: //
next: /tutorials/curriculums/user-interface-design/choose-an-art-style
hideInPageNavigation: true
@@ -39,7 +39,7 @@ learning how to build an environment and navigating Studio's UI, try the [core c
-## Create a project
+## Create a Project
A **project** is a collection of assets, settings, and other resources that together represent an experience. All projects start with a single **place** that players load into when they join an experience, but you can create additional places within that same experience to organize assets for different gameplay areas. For example, if you want players to join a dungeon before teleporting to either a vast desert or spooky island, you can organize the assets for each area into their own place.
@@ -75,7 +75,7 @@ To open a project with the Baseplate template:
-## Get asset pack
+## Get Asset Pack
Now that you have a project open, you can add additional 3D objects to the data model aside from the spawn location and baseplate. Studio represents 3D objects as `Class.BasePart` objects that render with physical simulation in the 3D space, and emulate real-world physical behavior like gravity, friction, and force.
@@ -109,8 +109,6 @@ To insert this tutorial's asset pack from the Creator Store to your Studio inven
-## Customize targets
+## Customize Targets
-When you add a 3D object into your experience, Studio updates the **Explorer** window to display the name of the object and a nest of its children within the `Class.Workspace` service. For example, after you add the catapult model into your viewport, the Explorer window displays the **IntrotoStudioCatapult** folder and its child assets alongside the spawn location and baseplate.
+When you add a 3D object into your experience, Studio updates the **Explorer window** to display the name of the object and a nest of its children within the `Class.Workspace` service. For example, after you add the catapult model into your viewport, the Explorer window displays the **IntrotoStudioCatapult** folder and its child assets alongside the spawn location and baseplate.
-## Organize scripts
+## Organize Scripts
-While you have a lot of flexibility in how you organize data models within your projects, the Roblox Engine expects certain objects to be in specific **container services** for simulation and rendering functionality to work properly between the server and the client. The **server** refers to a Roblox computer that acts as the ultimate authority for maintaining the experience's state, and it keeps all connected **clients**, or player devices like mobile phones and laptops, in sync with its source of truth.
+While you have a lot of flexibility in how you organize data models within your projects, the Roblox engine expects certain objects to be in specific **container services** for simulation and rendering functionality to work properly between the server and the client. The **server** refers to a Roblox computer that acts as the ultimate authority for maintaining the experience's state, and it keeps all connected **clients**, or player devices like mobile phones and laptops, in sync with its source of truth.
@@ -242,7 +240,7 @@ To organize folders into their correct container services for the catapult to wo
-## Customize projectiles
+## Customize Projectiles
While your projectiles are exactly the same size as each other, they travel different distances when you launch them from the catapult. This is because each projectile has a unique **material** that emulates the physical characteristics of its real-world counterpart, including its density, elasticity, and friction.
@@ -280,7 +278,7 @@ To customize the third projectile:
-## Publish experience
+## Publish Experience
Roblox not only provides the tooling and engine for you to create and run experiences, it also gives you access to a large social network of players that access the platform on a wide array of devices, including phones, computers, tablets, consoles, and VR hardware. When you're ready to release your experience to this global audience, you must publish and configure the experience's settings so that it's available to all players on any device you want to support.
diff --git a/content/en-us/tutorials/fundamentals/coding-1/coding-fundamentals.md b/content/en-us/tutorials/fundamentals/coding-1/coding-fundamentals.md
index 35643c74f..9eea1206d 100644
--- a/content/en-us/tutorials/fundamentals/coding-1/coding-fundamentals.md
+++ b/content/en-us/tutorials/fundamentals/coding-1/coding-fundamentals.md
@@ -1,16 +1,16 @@
---
-title: Coding fundamentals
+title: Coding Fundamentals
description: Teaches the basics of coding with Lua.
next: /tutorials/fundamentals/coding-1/landing
---
-### Series description
+### Series Description
Start coding on Roblox with this easy-to-follow series covering the fundamentals of how to use the programming language Lua. These courses are perfect for those new to coding or just starting with Lua. Each course centers around a foundational computer science principle, and features individual lessons with step-by-step tutorials you can use to create your own experiences on Roblox.
Before beginning this course, the reader should have basic knowledge of Roblox Studio, as demonstrated in [Introduction to Studio](../../first-experience/index.md).
-### Series contents
+### Series Contents
-3. To test the script, click **Play**. `Hello world!` will show up in the Output Window.
+3. To test the script, click **Play**. `Hello world!` will show up in the Output window.
4. Click **Stop** to end the playtest. You can now return to the Script tab.
-## Identify data types
+## Identifying Data Types
Coding languages classify different kinds of values into **data types**. For example, one data type is a **number**. Number data types are self-explanatory as they are made up of only numbers.
@@ -69,7 +69,7 @@ Strings like `"Hello World"` always sit inside quotation marks, `"like this"`. M
- `"There are 50 players left"`
- `"10"`
-## Create variables
+## Creating Variables
**Variables** are containers for information the program can use and change, like player names or points.
@@ -81,7 +81,7 @@ When declaring new variables, some coding languages require that you also state
In Lua, variables can be global or local. You'll usually use **local** variables. Local variables can only be used within the script or chunk of code where they were created. Global variables can potentially be used by other scripts, but too many global variables can make your experience slow and unresponsive. It's better to stay in the habit of making variables local unless necessary.
-### Use variables and strings together
+### Using Variables and Strings Together
Time to declare your own variables. These steps will use a string to store the name of your favorite animal.
@@ -97,7 +97,7 @@ Time to declare your own variables. These steps will use a string to store the n
Variable names can't include spaces. Be careful not to include spaces or the code won't work as intended.
-### Name variables
+### Naming Variables
Variables can be named anything, but good names will always describe their purpose. Generic names make your code difficult to read and update later. Coders will also use different capitalization styles to remind themselves how the variable is used within the script. A good default style is **camelCase**.
@@ -117,7 +117,7 @@ Bad Variable Names
- `myVariable` - Doesn't describe the purpose of the variable
- `player name` - The included space will cause issues
-### Assign values to variables
+### Assigning Values to Variables
New variables are empty. To **assign** it a value, or put something inside its container, use the `=` symbol. In this case, assign the variable the name of your favorite animal.
@@ -133,7 +133,7 @@ New variables are empty. To **assign** it a value, or put something inside its c
local myAnimal = "Porcupines"
```
-### Use print() for your own messages
+### Using Print() For Your Own Messages
Print functions display text on the screen, as you saw earlier. It's one of the first functions many people learn since it's a simple way of giving the script a command. To see your variable, use the `Global.LuaGlobals.print()` function.
@@ -155,9 +155,9 @@ Print functions display text on the screen, as you saw earlier. It's one of the
If you see a red error in the output editor, it's like there's an error in the code. Each error has a unique way of describing itself. Try and use the information from the error to fix your code.
-3. Test your code with the play button. You should see the name of your animal in the Output Window.
+3. Test your code with the play button. You should see the name of your animal in the Output window.
-### Combine strings
+### Combining Strings
You can display any string in the Output using `print()`; you can even print multiple strings stored within variables or typed directly within the function. **Concatenation** is combining strings. To concatenate the string assigned to your variable and a second string, use two dots `..` The following example concatenates two variables and two typed strings.
@@ -173,7 +173,7 @@ Play around with printing different combinations of strings.
## Summary
-New scripts can be created by clicking the + button next to the name of an object. ServerScriptService is a common place to create new scripts. New scripts include the default code `print("Hello world!")`. This code will display `Hello world!` in the Output Window, where you can see the results of your code and if any errors have occurred.
+New scripts can be created by clicking the + button next to the name of an object. ServerScriptService is a common place to create new scripts. New scripts include the default code `print("Hello world!")`. This code will display `Hello world!` in the Output window, where you can see the results of your code and if any errors have occurred.
"Hello world!" is an example of a string data type. Strings can include any combination of characters that you might type on your keyboard. Concatenation is when multiple strings are combined.
diff --git a/content/en-us/tutorials/fundamentals/coding-1/landing.md b/content/en-us/tutorials/fundamentals/coding-1/landing.md
index 48c3edb79..6f98d9bac 100644
--- a/content/en-us/tutorials/fundamentals/coding-1/landing.md
+++ b/content/en-us/tutorials/fundamentals/coding-1/landing.md
@@ -1,24 +1,24 @@
---
-title: Variables and objects
+title: Variables and Objects
description: Learn how to start coding in Roblox Studio in this tutorial series.
-next: /tutorials/fundamentals/coding-1/create-a-script
+next: /tutorials/fundamentals/coding-1/creating-a-script
prev: /tutorials/fundamentals/coding-1/coding-fundamentals
---
-### Series description
+### Series Description
For anyone interested in learning computer science or coding, this serves as a foundational series. This series is recommended for anyone interested in taking other coding lessons in Roblox Studio.
-### Objectives and prerequisites
+### Objectives and Prerequisites
-### Troubleshooting tips
+### Troubleshooting Tips
If your code doesn't run, check for errors such as the following:
diff --git a/content/en-us/tutorials/fundamentals/coding-2/functions-and-events.md b/content/en-us/tutorials/fundamentals/coding-2/functions-and-events.md
index f09d87d99..5b7c44628 100644
--- a/content/en-us/tutorials/fundamentals/coding-2/functions-and-events.md
+++ b/content/en-us/tutorials/fundamentals/coding-2/functions-and-events.md
@@ -1,17 +1,17 @@
---
-title: Functions and events
+title: Functions and Events
description: Landing page for chapter on coding functions in Lua and using events on Roblox.
next: /tutorials/fundamentals/coding-2/coding-a-function
prev: /tutorials/fundamentals/coding-1/parents-and-children
---
-### Series description
+### Series Description
Use functions and events to make code run when you want, as often as you want. With functions and events you can set up traps, buttons, health pickups, and more.
Covered in this course are functions, parameters, arguments, and returning values.
-### Objectives and prerequisites
+### Objectives and Prerequisites
-## Create the button
+## Create the Button
Now that the bridge is set up, create the button.
@@ -34,7 +34,7 @@ Now that the bridge is set up, create the button.
4. Move the button so it's slightly floating and not touching anything. This is so to make sure the `Touched` event doesn't accidentally fire.
-## Make the button interactive
+## Making the Button Interactive
This time, instead of using the `Class.BasePart.Touched|Touched` event to create a trap, you'll use it to create a button that makes the bridge usable. To make the bridge collidable, use the code `bridge.CanCollide = true` within a custom function that runs when a player touches the button. You know everything else you need to complete the following steps.
@@ -71,7 +71,7 @@ end
button.Touched:Connect(buttonPressed)
```
-### Troubleshoot your code
+### Troubleshooting Your Code
**Issue: The bridge is already solid when the game starts.**
Make sure that the parts are Anchored and not touching anything. The parts might touch something, like terrain or another part, and cause the buttonPressed() function to fire accidentally.
@@ -82,7 +82,7 @@ Check the following:
- The naming of your bridge. The bridge in your script must be named exactly like in the Explorer.
- That `part.Touched:Connect(buttonPressed)` is outside the `buttonPressed()` function.
-### Optional code challenge
+### Optional Code Challenge
The script in this lesson can also be used to keep doors that keep players out of specific areas. Practice your coding skills and do the following:
diff --git a/content/en-us/tutorials/fundamentals/coding-2/use-parameters-and-events.md b/content/en-us/tutorials/fundamentals/coding-2/using-parameters-and-events.md
similarity index 95%
rename from content/en-us/tutorials/fundamentals/coding-2/use-parameters-and-events.md
rename to content/en-us/tutorials/fundamentals/coding-2/using-parameters-and-events.md
index 59e61fc8f..f42148d25 100644
--- a/content/en-us/tutorials/fundamentals/coding-2/use-parameters-and-events.md
+++ b/content/en-us/tutorials/fundamentals/coding-2/using-parameters-and-events.md
@@ -1,19 +1,19 @@
---
-title: Use parameters and events
+title: Using Parameters and Events
description: How to pass information into functions using parameters and arguments. Also covers connecting functions to events.
next: /tutorials/fundamentals/coding-2/parameters-practice-buttons
-prev: /tutorials/fundamentals/coding-2/code-a-function
+prev: /tutorials/fundamentals/coding-2/coding-a-function
---
Normally, functions can only use the information they have coded within them. Sometimes however, you might not know in advance what that information will be, or you want to be able to reuse the same function with multiple pieces of similar information. For example, if you wanted to use a function to display the name of the person who finished an obby course the fastest in giant letters to everyone. You won't know the name of the future winner until the race is finished.
**Parameters** are placeholders for information you want to give to the function at a later time. They're like windows that allow you to **pass** information to the function.
-## Use parameters and events to set up a trap
+## Use Parameters and Events to Set Up a Trap
This script will create a trap part that destroys whatever touches the part, including other parts. You'll have to use a parameter to set it up. Be careful to anchor the trap where it doesn't fall and destroy things unintentionally.
-### Create a new part
+### Create a New Part
A part needs to be set up that will destroy anything that touches it.
@@ -21,7 +21,7 @@ A part needs to be set up that will destroy anything that touches it.
2. In the Explorer, rename the part:TrapPart.
3. **Anchor** the part.
-### Set up the script
+### Set Up the Script
Use what you know about variables and the experience hierarchy to reference the trap part.
@@ -35,7 +35,7 @@ Use what you know about variables and the experience hierarchy to reference the
```
-### Create a function with a parameter
+### Create a Function with a Parameter
The trap will use a function to destroy whatever touched the part. To work, the function needs to know what touched the part. And that means using parameters. Parameters are typed inside the `()` that comes after a function's name. They look like this:
@@ -77,7 +77,7 @@ The actual information that gets passed through the parameter is called an **arg
end
```
-### Use an event to call the function
+### Use an Event to Call the Function
We want the function to run whenever something touches the part. To make that happen, connect the function to the `Touched` event. **Events** are things that happen in the experience. Like a player touching a part or losing health. When a function is connected to an event, the function runs whenever the event happens.
diff --git a/content/en-us/tutorials/fundamentals/coding-3/give-points.md b/content/en-us/tutorials/fundamentals/coding-3/giving-points.md
similarity index 97%
rename from content/en-us/tutorials/fundamentals/coding-3/give-points.md
rename to content/en-us/tutorials/fundamentals/coding-3/giving-points.md
index f460c5acc..f6a727d1c 100644
--- a/content/en-us/tutorials/fundamentals/coding-3/give-points.md
+++ b/content/en-us/tutorials/fundamentals/coding-3/giving-points.md
@@ -1,5 +1,5 @@
---
-title: Else/if practice with giving points
+title: Else/If Practice with Giving Points
description: Create a part that gives players points using if and else statements in Roblox Lua.
next: /tutorials/fundamentals/coding-4/landing
prev: /tutorials/fundamentals/coding-3/multiple-conditions
@@ -9,11 +9,11 @@ This project will use conditional statements to create a part that will give or
-## Set up the project
+## Setting up the Project
The point giving part can be added into any project where points are relevant. For instance, an adventure game where players collect points.
-### Point tracking
+### Point Tracking
To setup this project, you'll need a leaderboard to track the points and a part that changes colors. Code for the leaderboard will be provided.
@@ -40,7 +40,7 @@ To setup this project, you'll need a leaderboard to track the points and a part
Players.PlayerAdded:Connect(onPlayerJoin)
```
-### Color changing part
+### Color Changing Part
The script will cycle through three different colors for the part. Each color will have a variable to store it's RGB value, a data type that includes a set of three numbers (red, green, blue) that create colors.
@@ -80,7 +80,7 @@ The script will cycle through three different colors for the part. Each color wi
local losePoints = 100
```
-### Add the players service
+### Adding the Players Service
To award points, you'll need to get access to the player's information which is stored in the Explorer under Players, and is separate from the character object. This is where information like leaderboard stats can be found.
@@ -100,7 +100,7 @@ You can do so by adding the **Players** service to your script. **Services** are
local Players = game:GetService("Players")
```
-### Functions and events
+### Functions and Events
PointsScript will need two functions. The first function will give and subtract parts. The second function will check if a player has touched the part. These functions will then be connected with a touch event, which runs whenever that part is touched.
@@ -209,18 +209,18 @@ To loop through colors, the script will use a while =loop that changes the part'
-### Troubleshooting tips
+### Troubleshooting Tips
At this point, if the color looping doesn't work as intended, try one of the following below.
- Check that the while loop is at the **bottom** of the script, below the Touched event. If the loop is not at the bottom, it'll keep other parts of the script from running correctly.
- Check that each color inside `Datatype.Color3.fromRGB()` is correctly written. There must be three numbers between 0 and 255 separated by commas, like `(255, 50, 0)`.
-## Give players points
+## Giving Players Points
Players will be given points based on the current color of the part when they touch it.
-### Find the current color
+### Finding the Current Color
Whenever a player touches the part, the script will need to know the current color of the part to award points later.
@@ -253,7 +253,7 @@ Whenever a player touches the part, the script will need to know the current col
end
```
-### Give or subtract points
+### Giving or Subtracting Points
Next, you'll use if and elseif to give or subtract points depending on the color of the part when touched. Remember that blue provides a small amount, green provides many, and red subtracts points.
@@ -312,7 +312,7 @@ Next, you'll use if and elseif to give or subtract points depending on the color
-## Give players feedback
+## Giving Players Feedback
The PointPart works, but players might not notice something happened unless they happen to be looking at their leaderboard. Fix that by creating particles when the PointPart is destroyed.
@@ -320,7 +320,7 @@ Adding feedback when players use a part, like sounds, shakes, or particles, make
-### Create a particle effect
+### Creating a Particle Effect
The particle effect will be the same color as the part when touched. Since the colors were stored in variables, it's easy to reuse them.
@@ -369,7 +369,7 @@ The particle effect will be the same color as the part when touched. Since the c
-### Troubleshooting tips
+### Troubleshooting Tips
At this point, if particles doesn't work as intended, try one of the following below.
diff --git a/content/en-us/tutorials/fundamentals/coding-3/intro-to-if-statements.md b/content/en-us/tutorials/fundamentals/coding-3/intro-to-if-statements.md
index 1470b2899..e48612457 100644
--- a/content/en-us/tutorials/fundamentals/coding-3/intro-to-if-statements.md
+++ b/content/en-us/tutorials/fundamentals/coding-3/intro-to-if-statements.md
@@ -1,5 +1,5 @@
---
-title: Intro to if statements
+title: Intro to If Statements
description: Learn how to code if statements in Roblox Lua.
next: /tutorials/fundamentals/coding-3/traps-with-if-statements
prev: /tutorials/fundamentals/coding-3/landing
@@ -21,7 +21,7 @@ end
Code chunks using conditionals are **control structures.** Control structures are like flow diagrams in code form and can have several conditional statements.
-## If statement practice
+## If Statement practice
These steps show how to create a script that changes a part's color if a statement is true.
@@ -34,7 +34,7 @@ These steps show how to create a script that changes a part's color if a stateme
2. Create a new part named LieDetector.
-### Format if statements
+### Formatting If Statements
**Conditions** can come in various forms but are often simple statements like math equations. For example, if 1+1 equals 2, then run some code. Like ordinary math equations, conditional can use **operators** such as plus (`+`) or less than (`<`) to evaluate statements.
@@ -71,7 +71,7 @@ One particular operator to be aware of is `==`; it stands for "is equal to." So
4. **Test** your code. If three plus three is equal to six, the part will turn green.
-## Check a false condition
+## Checking a False Condition
Now, purposely change the statement to see what happens when the math equation is false.
@@ -85,7 +85,7 @@ Now, purposely change the statement to see what happens when the math equation i
2. Test your code now. The part shouldn't turn green for a false statement.
-### Math operators
+### Math Operators
The table below lists some common Lua operators. More information about operators can be found on [Luau Operators](../../../luau/operators.md).
@@ -116,14 +116,14 @@ The table below lists some common Lua operators. More information about operator
-## Code multiple conditions
+## Coding Multiple Conditions
For this project, you could write a unique if statement for each medal to award players, but that takes a lot of time. Take, for instance, the imaginary code below.
@@ -54,7 +54,7 @@ end
When the if/then statement runs, it'll start at the top and only run the code for the **first** true condition it finds.
-## Set up the race course
+## Setting Up the Race Course
Start by placing the course's starting point and finish line, and then create a script to time the player and award different medals.
@@ -114,7 +114,7 @@ Start by placing the course's starting point and finish line, and then create a
5. Playtest and check that `finish()` is called when you touch the finish line.
-### Keep finish() from repeating
+### Keep finish() From Repeating
Right now, whenever a player touches the finish line, `finish()` gets continuously called as long as the player touches the part.
@@ -156,7 +156,7 @@ Use a **boolean**, a variable that stores true or false, to ensure that finish()
4. Playtest your game to check that you only see your test print statement once.
-### Keep track of time
+### Keeping Track of Time
Like an if statement, a while loop can also use a condition to see if it should run. To time the player, create a timer using a while true do loop that only runs when the `raceActive` boolean is true.
@@ -188,7 +188,7 @@ Like an if statement, a while loop can also use a condition to see if it should
3. Play the game and check that you see each second displayed in the Output Window.
-## Award player medals
+## Awarding Player Medals
To finish, use an if statement with multiple conditions to award players a different prize medal based on their performance. Use an if statement and two elseif statements to check the player's finish time and award them the correct medal.
@@ -216,7 +216,7 @@ To finish, use an if statement with multiple conditions to award players a diffe
3. Playtest and confirm the gold medal can be awarded.
-### Add additional conditions
+### Adding Additional Conditions
Now that you've tested for the gold medal, code conditions for the other medals using the `elseif` keyword.
@@ -254,7 +254,7 @@ Now that you've tested for the gold medal, code conditions for the other medals
3. Playtest for the silver and bronze medals.
-### Troubleshooting tips
+### Troubleshooting Tips
If you don't see the silver and bronze metals appear, try one of the below.
@@ -262,7 +262,7 @@ If you don't see the silver and bronze metals appear, try one of the below.
- In `partTouched()`, make sure the second condition of the if statement uses `==`, like in `raceActive == true`.
- Check that each `elseif` is in scope. Each `elseif` condition must be between the first line of the if/then statement and it's last `end`.
-### Add the else condition
+### Adding the Else Condition
If the player didn't earn any of the medals, you should encourage them to try again. In this case, you can use an `else` statement, which runs if **no other** conditions are true, to show them a message.
@@ -306,7 +306,7 @@ After finishing the project, you can expand upon the script to add new elements
- Add code so players can repeat the race by touching the start line when they finish.
- Design a way to display time during a race. You can either display the time on a part using a Surface GUI, like in the
- [Create a Timed Bridge tutorial](../coding-4/create-a-timed-bridge.md).
+ [Creating a Timed Bridge tutorial](../coding-4/creating-a-timed-bridge.md).
```lua title ="Completed script"
local timePassed = 0
diff --git a/content/en-us/tutorials/fundamentals/coding-3/powerups-with-if-statements.md b/content/en-us/tutorials/fundamentals/coding-3/powerups-with-if-statements.md
index 72ed0acda..d800487da 100644
--- a/content/en-us/tutorials/fundamentals/coding-3/powerups-with-if-statements.md
+++ b/content/en-us/tutorials/fundamentals/coding-3/powerups-with-if-statements.md
@@ -1,5 +1,5 @@
---
-title: Evaluate multiple statements
+title: Evaluating Multiple Statements
description: How to use the and keyword to evaluate more than one statement at a time in Roblox Luau.
next: /tutorials/fundamentals/coding-3/multiple-conditions
prev: /tutorials/fundamentals/coding-3/traps-with-if-statements
@@ -19,11 +19,11 @@ if 4 + 2 == 6 and 4 ~= 6 then
end
```
-## Create a powerup
+## Creating a Powerup
Powerups are in-experience items that give players special abilities like flying, invisibility, or speed. This powerup will boost the player's walking speed every time the powerup is touched. Continuously applying boosts can make the player go way too fast, so `and` will be used to control the upper walking speed limit.
-### Set up the powerup
+### Setting Up the Powerup
Use this code with a simple part or a model, such as a crystal, coin, or glowing neon orb.
@@ -62,7 +62,7 @@ Use this code with a simple part or a model, such as a crystal, coin, or glowing
```
-## Speed players up
+## Speeding Players Up
The speed boost will make avatars walk faster every time the speed boost is touched. That will quickly become very, very fast. The keyword `and` will ensure players can't go too fast by only enabling the speed boost if the player is under a certain speed.
@@ -90,7 +90,7 @@ The speed boost will make avatars walk faster every time the speed boost is touc
```
-### Fine tune the speed boost
+### Fine Tuning the Speed Boost
OnTouch is called every time the speed boost is touched. Every step or slightest bounce triggers the Touched event and calls the connected function. The part's property, `CanTouch` can keep the Touched event from firing. Take advantage of CanTouch and turn off the speed boost for one second every time it's been activated.
diff --git a/content/en-us/tutorials/fundamentals/coding-3/traps-with-if-statements.md b/content/en-us/tutorials/fundamentals/coding-3/traps-with-if-statements.md
index 42b97c239..351fc42d4 100644
--- a/content/en-us/tutorials/fundamentals/coding-3/traps-with-if-statements.md
+++ b/content/en-us/tutorials/fundamentals/coding-3/traps-with-if-statements.md
@@ -1,5 +1,5 @@
---
-title: If/then practice with traps
+title: If/then Practice with Traps
description: Create a trap that sets the player's health to zero with Roblox Lua.
next: /tutorials/fundamentals/coding-3/powerups-with-if-statements
prev: /tutorials/fundamentals/coding-3/intro-to-if-statements
@@ -9,7 +9,7 @@ Traps that decrease players' health are a fun game-play element that can be code
-## Set up the trap
+## Setting up the Trap
Traps work exceptionally well in experiences with movement-based challenges, like obbies. These steps will start by setting up the necessary variables and functions. Do as much as you can without looking at the code boxes first.
@@ -46,7 +46,7 @@ Traps work exceptionally well in experiences with movement-based challenges, lik
trapPart.Touched:Connect(onTouch)
```
-## Check for player touch
+## Checking for Player Touch
Remember, the parameter `otherPart` records whatever touches the trap part, which might be a part of a player or just the baseplate.
@@ -56,7 +56,7 @@ To ensure the trap will only destroy players and won't destroy random decor item
Humanoids are present in player avatars and many NPCs. Humanoids have several unique properties. One such property is Health.
-### Find a specific object
+### Finding a Specific Object
The function `FindFirstChildWhichIsA()` can be used to look for specific object types, which is handy because we're looking for a Humanoid-type object. Players will likely touch the trap with only a part of their avatar, so a variable must be set up to find the parent of the touching part and search it for a Humanoid.
@@ -89,7 +89,7 @@ The function `FindFirstChildWhichIsA()` can be used to look for specific object
trapPart.Touched:Connect(onTouch)
```
-### Check with an if statement
+### Checking with an if Statement
If a Humanoid is found, then set the Humanoid's Health to zero.
@@ -131,7 +131,7 @@ If a Humanoid is found, then set the Humanoid's Health to zero.
3. **Run** the code and check that you can see the output whenever a player touches the part.
-## Change the player's health
+## Changing the Player's Health
If the statement is true, you can use the same humanoid variable to set the player's health to 0.
diff --git a/content/en-us/tutorials/fundamentals/coding-4/create-a-timed-bridge.md b/content/en-us/tutorials/fundamentals/coding-4/creating-a-timed-bridge.md
similarity index 96%
rename from content/en-us/tutorials/fundamentals/coding-4/create-a-timed-bridge.md
rename to content/en-us/tutorials/fundamentals/coding-4/creating-a-timed-bridge.md
index 447171f8a..bf32f0aa5 100644
--- a/content/en-us/tutorials/fundamentals/coding-4/create-a-timed-bridge.md
+++ b/content/en-us/tutorials/fundamentals/coding-4/creating-a-timed-bridge.md
@@ -1,5 +1,5 @@
---
-title: Loops practice - create a timed bridge
+title: Loops Practice - Creating a Timed Bridge
description: Make a bridge that disappears to add challenge to a Roblox game. Combine for loops and while loops in this computer science practice.
next: /tutorials/fundamentals/coding-4/nested-loops
prev: /tutorials/fundamentals/coding-4/glow-lights-with-for-loops
@@ -9,11 +9,11 @@ This project is another example of using for loops in a practical way. For this
-## Set up the project
+## Setting up the Project
This bridge can be included in any game project with movement-based challenges, like an obby.
-### Create parts
+### Creating Parts
1. Find a place to build a bridge, like a river or a large gap in an obby. Create three **anchored** parts like below.
@@ -28,7 +28,7 @@ This bridge can be included in any game project with movement-based challenges,
- **Transparency** = 0.8
- **CanCollide** = False
-### Create the timer display
+### Creating the Timer Display
When crossing the bridge, players will need to see how many seconds are left before the bridge disappears. One way to display images or text is by adding an object called a Surface GUI to a part. **Surface GUIs** can also be used to create in-game signs, custom health bars, and inventory systems. This tutorial will go through this quickly, but more information can be found in the [Tutorials](../../../tutorials/index.md) section.
@@ -45,7 +45,7 @@ When crossing the bridge, players will need to see how many seconds are left bef
- Set **TextScaled** to true.
- Set **Text** to be blank. Text will be updated using the script.
-### Set up the script
+### Setting up the Script
Now that the timer is in place, create a script to control the bridge and display the countdown number to players.
@@ -60,7 +60,7 @@ Now that the timer is in place, create a script to control the bridge and displa
local timerDuration = 5
```
-## Code the touch interaction
+## Coding the Touch Interaction
To use the bridge, you'll need to create two functions. One function will make the bridge walkable and display the timer. The other function will listen for if a player touches the button that activates the bridge.
@@ -118,9 +118,9 @@ To use the bridge, you'll need to create two functions. One function will make t
button.Touched:Connect(buttonPressed)
```
-5. Run the project. Touch the part and check in the Output Window to see the print statement.
+5. Run the project. Touch the part and check in the Output window to see the print statement.
-### Troubleshooting tips
+### Troubleshooting Tips
At this point, if the bridge doesn't work as intended, try one of the following below.
@@ -133,11 +133,11 @@ At this point, if the bridge doesn't work as intended, try one of the following
- Make sure all three parts are Anchored.
- Check the Transparency property for the bridge.
-## Create the timer
+## Creating the Timer
Whenever players step on the bridge, `startTimer()` will make the bridge walkable and start the timer. Once the timer reaches 0, the bridge will become unwalkable, causing anyone who's not fast enough to fall.
-### Make the bridge walkable
+### Making the Bridge Walkable
To start, the script will need to make the bridge solid, or collidable and then start a timer until it becomes unwalkable.
@@ -191,7 +191,7 @@ To start, the script will need to make the bridge solid, or collidable and then
-## Keep the bridge from restarting
+## Keeping the Bridge from Restarting
Notice though, if you move around on the button, the timer will keep restarting.
@@ -265,7 +265,7 @@ This is because the for loop is being called each time you touch the button and
-## Complete timed bridge script
+## Complete Timed Bridge Script
```lua
local bridge = script.Parent
diff --git a/content/en-us/tutorials/fundamentals/coding-4/glow-lights-with-for-loops.md b/content/en-us/tutorials/fundamentals/coding-4/glow-lights-with-for-loops.md
index 5f94ffb9a..a00e183bb 100644
--- a/content/en-us/tutorials/fundamentals/coding-4/glow-lights-with-for-loops.md
+++ b/content/en-us/tutorials/fundamentals/coding-4/glow-lights-with-for-loops.md
@@ -1,5 +1,5 @@
---
-title: Glow lights with for loops
+title: Glowing Lights with For Loops
description: Create glowing lights in Roblox Studio using a for loop. This practical example teaches computer science with Roblox.
next: /tutorials/fundamentals/coding-4/creating-a-timed-bridge
prev: /tutorials/fundamentals/coding-4/intro-to-for-loops
@@ -9,7 +9,7 @@ To practice for loops, you'll create a lamp that gradually glows brighter and th
-## Set up the part and script
+## Setting up the Part and Script
The lamp will be a part with an attached light and script.
@@ -45,11 +45,11 @@ The lamp will be a part with an attached light and script.
local timeChange = 1
```
-## Make the lamp glow
+## Making the Lamp Glow
The lamp will use two **for loops**, one that counts up to make the lamp brighter, and one that counts down to dim it. Each for loop will have a control variable called currentBrightness. That way, as the for loop's control variable goes up and down, so will the brightness of the light.
-### First loop (light increase)
+### First Loop (Light Increase)
Remember, a for loop starts with keyword `for` followed by a control variable. This script will set the brightness value of the light to value in the control variable.
@@ -99,7 +99,7 @@ If you can't see the brightness change over time in the first loop:
- Check that `timeChange` is at least 1 or higher. Smaller numbers will make the brightness change faster, but be harder to see over time.
- Make sure that the first line of your for loop has two total commas separating the control variable, end value, and increment value.
-### Second loop (light decrease)
+### Second Loop (Light Decrease)
To dim the light, use a second for loop. The values of this loop will be reversed so the light starts bright and each second, gets dimmer.
@@ -121,7 +121,7 @@ To dim the light, use a second for loop. The values of this loop will be reverse
-### Make the light repeat
+### Making the Light Repeat
Right now, the light only turns on and off once. To make the lamp continuously glow on and off, the for loops will be placed inside a repeating while loop.
@@ -153,7 +153,7 @@ Right now, the light only turns on and off once. To make the lamp continuously g
-## Finished light script
+## Finished Light Script
A finished version of the script can be referenced below.
diff --git a/content/en-us/tutorials/fundamentals/coding-4/intro-to-for-loops.md b/content/en-us/tutorials/fundamentals/coding-4/intro-to-for-loops.md
index b5506fe54..c1a1d6d9f 100644
--- a/content/en-us/tutorials/fundamentals/coding-4/intro-to-for-loops.md
+++ b/content/en-us/tutorials/fundamentals/coding-4/intro-to-for-loops.md
@@ -1,13 +1,13 @@
---
-title: Intro to for loops
+title: Intro to For Loops
description: Use for loops to repeat code in this lesson for Roblox Lua. This lesson explains how for loops work and includes practice scripts.
next: /tutorials/fundamentals/coding-4/glow-lights-with-for-loops
-prev: /tutorials/fundamentals/coding-4/repeat-code-with-while-loops
+prev: /tutorials/fundamentals/coding-4/repeating-code-with-while-loops
---
There are different ways to make code run over and over. If you want the code to only run a certain amount of times, use a **for loop**. This article will cover the logic behind for loops and demonstrate some practical examples, such as coding a countdown.
-## How for loops work
+## How For Loops Work
For loops use three values to control how many times they run: a **control** variable, an **end** value, and an **increment** value. Starting from the value of the control variable, the for loops will either count up or down each time it runs code inside the loop until it passes the end value. Positive increment values count up, and negative increment values count down.
@@ -17,7 +17,7 @@ For loops use three values to control how many times they run: a **control** var
Different computer languages might use other terminology with for loops. For instance, in C# or JavaScript, the end value might be called the condition.
-## Steps in a for loop
+## Steps in a For Loop
To understand for loops, it helps to see a flow chart diagram showing the logic of how they progress.
@@ -33,7 +33,7 @@ Once the control variable passes the end value, the loop will stop. For example,
-## Code a countdown
+## Code a Countdown
To see how a for loop works, use these steps to code a for loop that starts at 10 and counts down to 0, one number at a time. Every time the loop runs, it'll print the current value inside the control variable.
@@ -90,18 +90,18 @@ To see how a for loop works, use these steps to code a for loop that starts at 1
Notice that the loop will print out the current value of count each time it goes through an **iteration**. An iteration is the complete process of checking the control value, running code, and updating the increment value. Because the control variable starts at 0 and has to go pass 10, the loop will go through 11 iterations before stopping.
-### Troubleshooting tips
+### Troubleshooting Tips
At this point, if the loop doesn't work as intended, try one of the following below.
- Check that you have **two commas** separating the numbers in your for loop. Having extra or missing commas will make the loop not start.
- If the for loop prints all at once, make sure that there is a wait function that uses at least 1 second.
-## Different for loop examples
+## Different For Loop Examples
Changing the three values of a for loop will change how the loop functions. Below are different examples of for loops with different start, end, and increment values. Try putting them into scripts and see what happens.
-### Count up by one
+### Counting Up By One
```lua
for count = 0, 5, 1 do
@@ -110,7 +110,7 @@ for count = 0, 5, 1 do
end
```
-### Count up in even numbers
+### Counting Up in Even Numbers
```lua
for count = 0, 10, 2 do
@@ -119,7 +119,7 @@ for count = 0, 10, 2 do
end
```
-### If for loops don't run at all
+### If For Loops Don't Run At All
If the control variable starts out **beyond** the end value, like in the example below, the for loop won't run at all.
diff --git a/content/en-us/tutorials/fundamentals/coding-4/landing.md b/content/en-us/tutorials/fundamentals/coding-4/landing.md
index b45aa120d..e3d3fba84 100644
--- a/content/en-us/tutorials/fundamentals/coding-4/landing.md
+++ b/content/en-us/tutorials/fundamentals/coding-4/landing.md
@@ -5,16 +5,16 @@ next: /tutorials/fundamentals/coding-4/repeating-code-with-while-loops
prev: /tutorials/fundamentals/coding-3/giving-points
---
-### Series description
+### Series Description
In computer science, loops are a common feature in many scripts, often used to repeat sets of code. This series will cover two of the most common loops: for and while loops.
-### Objectives and prerequisites
+### Objectives and Prerequisites
-## Change dialogue lines
+## Changing Dialogue Lines
When the player interacts with the NPC, the NPC will always say the same line. That's boring. Instead, use a variable to update which index value to use.
@@ -168,7 +168,7 @@ Notice there's an **error** in the Output Window once the script reaches the end
You'll fix this in the next section so the dialogue restarts from the beginning after it shows the last string.
-## Array sizes
+## Array Sizes
You can use the size of the array to know when to reset the desired index to 1. Find the **size** of an array by typing `#`, without spaces, before an array's name.
@@ -176,7 +176,7 @@ For example: `#dialogueArray`
Check the array's size against the variable's current value to know when it's time to start back at the beginning.
-### Restart the dialogue
+### Restarting the Dialogue
Use the array size to check when it's time to cycle back to the first piece of dialogue.
@@ -241,14 +241,14 @@ This script used an array to create a list of possible dialogue lines for a Non-
prompt.Triggered:Connect(speak)
```
-### Troubleshooting tips
+### Troubleshooting Tips
If the character doesn't go through the array of dialogue, try the following troubleshooting tips.
- Check the if statement that `dialogueIndex` is set back to 1. In the else statement, check that `dialogueIndex` has 1 added to itself.
- When getting the array's size, ensure there are no spaces after the # in `#dialogueArray`.
-## Optional challenges
+## Optional Challenges
Try one of the optional challenges below.
diff --git a/content/en-us/tutorials/fundamentals/coding-5/intro-to-dictionaries.md b/content/en-us/tutorials/fundamentals/coding-5/intro-to-dictionaries.md
index ca38071e3..d6ed1453a 100644
--- a/content/en-us/tutorials/fundamentals/coding-5/intro-to-dictionaries.md
+++ b/content/en-us/tutorials/fundamentals/coding-5/intro-to-dictionaries.md
@@ -1,5 +1,5 @@
---
-title: Intro to dictionaries
+title: Intro to Dictionaries
description: Learn how to use a dictionary table to tag values within data sets.
next: /tutorials/fundamentals/coding-5/pairs-and-ipairs
prev: /tutorials/fundamentals/coding-5/making-changes-to-arrays
@@ -18,7 +18,7 @@ local pet = {
Use dictionaries when you need to label values, not just list them in order as an array does. Practice using dictionaries in this tutorial by manipulating values associated with a player.
-## Dictionary syntax
+## Dictionary Syntax
Like arrays, dictionaries are assigned to a variable with curly brackets `{}`. **Key-value pairs** are stored on separate lines followed by a comma. Keys and values can be any data type, including strings, numbers, and variable names.
@@ -47,7 +47,7 @@ print(partList[redPart])
Use consistent data types for dictionary keys. Mixing data types, such as using both strings and variables for keys, can lead to inconsistent results when manipulating the array and confuse other coders.
-## Create a dictionary
+## Creating a Dictionary
One everyday use of dictionaries is organizing player or character information. These steps explore how a theoretical enemy character's information can be stored and accessed.
@@ -84,7 +84,7 @@ One everyday use of dictionaries is organizing player or character information.
}
```
-### Use dictionary values
+### Using Dictionary Values
There are two ways to access dictionary values:
@@ -103,7 +103,7 @@ print("The villain " .. enemy.Name .. " approaches!")
Which style to use usually depends on the purpose of the table. For tables holding a collection of values like a list of players in a server, coders will usually use `tableName["keyName"]`. For a dictionary used to describe an object, coders are more likely to use `tableName.keyName`.
-## Change a dictionary value
+## Changing a Dictionary Value
Changing a key's value is the same as any other variable; use the equal `=` operator.
@@ -120,9 +120,9 @@ Changing a key's value is the same as any other variable; use the equal `=` oper
print("The enemy's name is " .. enemy.Name)
```
-2. Playtest and check the Output Window.
+2. Playtest and check the Output window.
-## Pre-existing variables as keys
+## Pre-existing Variables as Keys
Dictionaries can interact with pre-existing variables declared in other parts of a script. The following coding example uses a variable to add a player's name as a key when they join the experience and then sets their points value to 0.
@@ -203,7 +203,7 @@ end
Players.PlayerAdded:Connect(setPoints)
```
-### Optional challenges
+### Optional Challenges
Below are some challenges that apply to using dictionaries in different ways. See if you can build out the code for these.
diff --git a/content/en-us/tutorials/fundamentals/coding-5/landing.md b/content/en-us/tutorials/fundamentals/coding-5/landing.md
index d3ba42d9d..8d22a2b49 100644
--- a/content/en-us/tutorials/fundamentals/coding-5/landing.md
+++ b/content/en-us/tutorials/fundamentals/coding-5/landing.md
@@ -1,15 +1,15 @@
---
-title: Arrays and dictionaries
+title: Arrays and Dictionaries
description: Learn how to store data in tables with arrays and dictionaries in Roblox Lua.
next: /tutorials/fundamentals/coding-5/intro-to-arrays
prev: /tutorials/fundamentals/coding-4/nested-loops
---
-### Series description
+### Series Description
Data structures are how coders store and organize entire sets of data. In Lua, data structures are tables. Unlike variables, tables can hold any number of values. Tables can store a list of high scores, a player's inventory, or all of an object's properties. Two types of tables covered in this series are **dictionaries** and **arrays**.
-### Objectives and prerequisites
+### Objectives and Prerequisites
-## Add values to arrays
+## Adding Values to Arrays
To add a new value to an array, use `table.insert(array, valueToInsert)`. The second parameter can be any value such as a string, number, or entire object, like `Class.Player` or `Class.IntValue`.
@@ -39,11 +39,11 @@ To practice, you'll create a script that stores player items in a table, then ad
3. Run the project. In Output, expand the three dots `...` to see the printed table.
-## Remove values from arrays
+## Removing Values from Arrays
To remove a value, like if a player used an item or someone in a list of active players leaves an experience, use `Library.table.remove()`. Depending on the parameters provided, the function can either remove the last value of a table, or at a specific index.
-### Remove the last value
+### Removing the Last Value
Sometimes a script needs to remove a specific item. For instance, removing the first item in a player's inventory, or picking the first player in a list. To remove the last value in an array, use `Library.table.remove(arrayName)`. In this use case, the only parameter needed is the table itself.
@@ -61,9 +61,9 @@ Sometimes a script needs to remove a specific item. For instance, removing the f
print(playerItems)
```
-2. Run the project. In the Output Window, the last value, `"Sleeping Bag"`, shouldn't print.
+2. Run the project. In the Output window, the last value, `"Sleeping Bag"`, shouldn't print.
-### Remove by index
+### Removing by Index
To remove a value at a specific point in the array, input in the second parameter the index to remove, such as `table.remove(arrayName, 1)`.
@@ -89,11 +89,11 @@ To remove a value at a specific point in the array, input in the second paramete
Notice also that all the index values changed or have been pushed. Removing a value from an array will change the array size and shift index values **down** after the one removed. `"Bread"` is now index 1, and `"Sleeping Bag"` is now index 2.
-## Search for values in an array
+## Searching for Values in an Array
To find specific values in arrays, like the name of a winning player, use the `Library.table.find()` function. Alternatively, you can code your own search function using `for` loops and `if` statements.
-### Find and return a single value
+### Finding and Returning a Single Value
To find a value in an array, create a function named `findValue()` that goes through an array and stops the first time it finds a matching value.
@@ -150,7 +150,7 @@ Once it finds the value, the function will use the `return` keyword to return th
print("The value is at index " .. valueFound)
```
-### Remove a value
+### Removing a Value
If a value was found using the find function, it can be removed. Check if a value was found with an if statement.
@@ -175,7 +175,7 @@ If a value was found using the find function, it can be removed. Check if a valu
Notice that because this function was called once, only the first instance of `"Bread"` was removed. The following section will cover how to find and remove all instances.
-## Find and remove all of a specific value
+## Finding and Removing All of a Specific Value
While the previous code could only remove the first instance of a value found, this code snippet will find and remove all occurrences from an array. For example, if, say, a player wanted to sell all their bread at an in-game store.
diff --git a/content/en-us/tutorials/fundamentals/coding-5/pairs-and-ipairs.md b/content/en-us/tutorials/fundamentals/coding-5/pairs-and-ipairs.md
index 06b318c29..def66e044 100644
--- a/content/en-us/tutorials/fundamentals/coding-5/pairs-and-ipairs.md
+++ b/content/en-us/tutorials/fundamentals/coding-5/pairs-and-ipairs.md
@@ -1,7 +1,7 @@
---
title: pairs and ipairs
description: pairs() and ipairs() are used to go through Roblox Lua tables. This lesson covers how to code them for a script and when to use them.
-next: /tutorials/fundamentals/coding-5/return-values-from-tables
+next: /tutorials/fundamentals/coding-5/returning-values-from-tables
prev: /tutorials/fundamentals/coding-5/intro-to-dictionaries
---
@@ -143,12 +143,12 @@ Use `pairs()` to see what was picked, and then `ipairs()` to print the list of i
The above step is an example of error checking in computer science. It's always a good practice to code what happens if there's a missing value possible in your code. If not, it's possible there might be an error during run time.
-## Optional challenges
+## Optional Challenges
Below are some challenges that apply using pairs and ipairs in different ways. Try seeing if you can build out the code for these.
**Challenge**: Create a Waiter NPC
-Instead of using the Output Window, use the NPC from [Intro To Arrays](../coding-5/intro-to-arrays.md) to create a waiter to take customer orders.
+Instead of using the output window, use the NPC from [Intro To Arrays](../coding-5/intro-to-arrays.md) to create a waiter to take customer orders.
**Challenge**: Allow Players to Place Orders
Allow players to select an ingredient by touching a physical part such as a proximity prompt. For more information, see [Proximity Prompts](../../../ui/proximity-prompts.md).
diff --git a/content/en-us/tutorials/fundamentals/coding-5/return-values-from-tables.md b/content/en-us/tutorials/fundamentals/coding-5/returning-values-from-tables.md
similarity index 96%
rename from content/en-us/tutorials/fundamentals/coding-5/return-values-from-tables.md
rename to content/en-us/tutorials/fundamentals/coding-5/returning-values-from-tables.md
index 573d98fad..bc37377ee 100644
--- a/content/en-us/tutorials/fundamentals/coding-5/return-values-from-tables.md
+++ b/content/en-us/tutorials/fundamentals/coding-5/returning-values-from-tables.md
@@ -1,5 +1,5 @@
---
-title: Return values from tables
+title: Returning Values from Tables
description: Learn how to write a search function using pairs and ipairs to return values from tables in Roblox Lua.
next: /tutorials/fundamentals/coding-6/landing
prev: /tutorials/fundamentals/coding-5/pairs-and-ipairs
@@ -29,7 +29,7 @@ local placeInLine = getPlaceInLine(shipToFind)
print("Your place in line is " .. placeInLine)
```
-## Dictionary search example
+## Dictionary Search Example
Have you ever searched for a lost pet in house going room by room? On your own code a function to search through a dictionary named house to see which room holds a lost puppy.
diff --git a/content/en-us/tutorials/fundamentals/coding-6/coding-concept-abstraction.md b/content/en-us/tutorials/fundamentals/coding-6/coding-concept-abstraction.md
index 4af1be5aa..2745fac4a 100644
--- a/content/en-us/tutorials/fundamentals/coding-6/coding-concept-abstraction.md
+++ b/content/en-us/tutorials/fundamentals/coding-6/coding-concept-abstraction.md
@@ -1,5 +1,5 @@
---
-title: Coding concept - abstraction
+title: Coding Concept - Abstraction
description: Abstractions in computer science are simplified representations of a larger idea or concept. This is used for computer science AP CSP lessons.
next: /tutorials/fundamentals/coding-6/coding-concept-algorithms
prev: /tutorials/fundamentals/coding-6/creating-with-module-scripts
@@ -11,11 +11,11 @@ prev: /tutorials/fundamentals/coding-6/creating-with-module-scripts
A common example in coding languages is `print()`. Most of its code is hidden, so the coder can focus on what needs to be printed and not the rest of the code.
-## Why create abstractions
+## Why Create Abstractions
Abstractions keeps programs organized, reduces complexity, and makes code easier to update.
-### Shop example
+### Shop Example
Say that you have an in-game shop that sells just two different backpacks. The code for the second backpack was copied with slight changes, such as a different name and selling price.
@@ -38,7 +38,7 @@ Here, the code is **not** abstracted. Each backpack has a script of its own. Wha
- A holiday sale, 25% off all backpacks.
-## Design abstractions
+## Designing Abstractions
Having separate backpack scripts makes adding and updating backpacks time consuming. Instead, create an abstraction so you don't have to make updates in so many different places.
diff --git a/content/en-us/tutorials/fundamentals/coding-6/coding-concept-algorithms.md b/content/en-us/tutorials/fundamentals/coding-6/coding-concept-algorithms.md
index 384984d41..07d314036 100644
--- a/content/en-us/tutorials/fundamentals/coding-6/coding-concept-algorithms.md
+++ b/content/en-us/tutorials/fundamentals/coding-6/coding-concept-algorithms.md
@@ -1,5 +1,5 @@
---
-title: Coding concept - algorithms
+title: Coding Concept - Algorithms
description: Algorithms in computer science are a series of steps used to determine an outcome. This is used for computer science AP CSP lessons.
prev: /tutorials/fundamentals/coding-6/coding-concept-abstraction
---
@@ -29,7 +29,7 @@ For an offline activity, try using this combination of art and computer science
-## Create algorithms in code
+## Creating Algorithms in Code
In real life, we don't usually think about the algorithms we use everyday. Computers however, need algorithms to be coded step-by-step and use at least one of three methods to solve a problem or produce an outcome.
@@ -84,7 +84,7 @@ In real life, we don't usually think about the algorithms we use everyday. Compu
-### Create a module script
+### Create a Module Script
So players can get treasure from chests, create a module script named _TreasureManager_. Using a module script will connect the pickups and leaderboards together.
@@ -41,11 +41,11 @@ So players can get treasure from chests, create a module script named _TreasureM
return TreasureManager
```
-## Use functions in module scripts
+## Using Functions in Module Scripts
To test how functions work in module scripts, create a new function named `getKey()`. When the `getKey()` function is called from another script, it'll receive a key part to destroy and add 1 to the number of keys in the player's inventory.
-### Create a module function for keys
+### Create a Module Function for keys
1. This module script will use a combination of module and local functions, type **two** comments to help you keep them separated.
@@ -87,7 +87,7 @@ To test how functions work in module scripts, create a new function named `getKe
end
```
-### Use the module function
+### Use the Module Function
Now, the module function `getKey()` can be used in other scripts. To test that function, you'll open a premade script and call it.
@@ -141,7 +141,7 @@ Now, the module function `getKey()` can be used in other scripts. To test that f
-### Troubleshooting tips
+### Troubleshooting Tips
**Issue:** Get an error message including: `"Infinite yield possible"`.
@@ -254,11 +254,11 @@ end
return TreasureManager
```
-## Get information from module scripts
+## Getting Information From Module Scripts
The _TreasureManager_ module script will be used when players touch a treasure chest to check if they have at least one key before opening it and giving them gold.
-### Check if chests can be opened
+### Check If Chests Can Be Opened
1. First in **ServerStorage** > _TreasureManager_ script, set up variables for how many keys it costs to open a chest, and how much gold each chest contains.
@@ -306,7 +306,7 @@ The _TreasureManager_ module script will be used when players touch a treasure c
end
```
-### Give players treasure
+### Give Players Treasure
So the player can open a chest, create a function in _TreasureManager_ that awards them treasure.
@@ -335,7 +335,7 @@ So the player can open a chest, create a function in _TreasureManager_ that awar
end
```
-### Call the chest functions
+### Call the Chest Functions
Now that the two module functions, `canOpenChest()` and `openChest()`, have been created, they can be called by the Chest parts whenever a player touches them using the premade `partTouched()` function.
@@ -397,13 +397,13 @@ Now that the two module functions, `canOpenChest()` and `openChest()`, have been
- If you have at least 1 key, touching a chest will destroys it and awards treasure.
- If you have 0 keys, you can't open a treasure chest.
-### Troubleshooting tips
+### Troubleshooting Tips
- In _ChestScript_, make sure that functions called from the module script like `canOpenChest()` are spelled exactly how they're found in the _TreasureManager_ script. Any difference will cause an error.
- Check that copy and pasted functions, like `treasureManager.openChest()`, are exactly as shown in the lesson. Any differences can cause subtle errors in the script.
-## Finished scripts
+## Finished Scripts
```lua title='Finished TreasureManager Script'
diff --git a/content/en-us/tutorials/fundamentals/coding-6/intro-to-module-scripts.md b/content/en-us/tutorials/fundamentals/coding-6/intro-to-module-scripts.md
index d15dbf2f6..58ef47e60 100644
--- a/content/en-us/tutorials/fundamentals/coding-6/intro-to-module-scripts.md
+++ b/content/en-us/tutorials/fundamentals/coding-6/intro-to-module-scripts.md
@@ -1,7 +1,7 @@
---
-title: Intro to module scripts
+title: Intro to Module Scripts
description: Learn key concepts around organizing and reusing code in Roblox with modular scripts.
-next: /tutorials/fundamentals/coding-6/create-with-module-scripts
+next: /tutorials/fundamentals/coding-6/creating-with-module-scripts
prev: /tutorials/fundamentals/coding-6/landing
---
@@ -15,11 +15,11 @@ By storing commonly used code in module scripts, it makes maintaining and organi
Normal scripts should be used for standalone elements of a game, such as touching a pickup, while module scripts are useful for storing code that can be reused by multiple independent scripts, like rewarding points.
-## Module script basics
+## Module Script Basics
Module scripts are actually their own separate object compared to script objects. In Roblox, module scripts can be denoted with a **purple** icon.
-### Create a module script
+### Creating a Module Script
ModuleScripts are commonly placed in **ServerScriptService** when used by server-side scripts and **ReplicatedStorage** when used by client-side local scripts (such as GUI interactions).
@@ -27,7 +27,7 @@ ModuleScripts are commonly placed in **ServerScriptService** when used by server
-### Structure of module scripts
+### Structure of Module Scripts
When created, every module script starts out with the code below:
@@ -47,7 +47,7 @@ return RewardManager
So other scripts can use a module's non-local functions or variables, every module ends with return `MyModule`. Whenever another script tries to get code from the module, return lets that script access code stored inside the module table.
-### Add to module scripts
+### Adding to Module Scripts
To add a function or variable to the module which can be used in another script, type the module table's name, followed by a dot, and the name of the function or variable, like in `TestModule.myVariable`. Using the dot operator is another way of adding code into a table, allowing other scripts to access that code whenever the module table is returned.
@@ -69,7 +69,7 @@ return TestModule
Anything added to the module table should be typed between `local MyModule = {}` and `return MyModule`, or else the code may create an error.
-### Scope in module scripts
+### Scope in Module Scripts
For a module function or variable to be used in an outside script, **don't** type `local`.
@@ -99,7 +99,7 @@ end
return RewardManager
```
-## Use modules in other scripts
+## Using Modules In Others Scripts
By itself, a module script can't run code — it needs to be loaded in another script using the keyword `Global.LuaGlobals.require()`. The function `Global.LuaGlobals.require()` accepts one argument, the location of the module script in the Explorer.
@@ -117,7 +117,7 @@ local MyModule = require(ServerStorage.ModuleScript)
MyModule.myFunction()
```
-## RewardManager example
+## RewardManager Example
```lua title="ModuleScript - RewardManager"
local RewardManager = {}
@@ -156,7 +156,7 @@ print("Should award " .. coins .. " coins")
If you're in another script, make sure that the module script function or variable is spelled **exactly** the same as found in that module. To help, you can copy the exact function or variable name from the module and then just paste it in the normal script where it'll be used.
-## General troubleshooting
+## General Troubleshooting
Some of the tips here address common issues when working with module scripts. Keep in mind that module scripts can be a complicated topic with more nuance. For more details, see this more technical guide on [Module Scripts](../../../scripting/module.md).
diff --git a/content/en-us/tutorials/fundamentals/coding-6/landing.md b/content/en-us/tutorials/fundamentals/coding-6/landing.md
index 9cb01fcc4..d8cef35fd 100644
--- a/content/en-us/tutorials/fundamentals/coding-6/landing.md
+++ b/content/en-us/tutorials/fundamentals/coding-6/landing.md
@@ -1,20 +1,20 @@
---
-title: Organizing code
+title: Organizing Code
description: Roblox module scripts are one way of organizing code. This series covers how they work and how to implement them in a game experience.
next: /tutorials/fundamentals/coding-6/intro-to-module-scripts
prev: /tutorials/fundamentals/coding-5/returning-values-from-tables
---
-### Series description
+### Series Description
As you continue to work with code, scripts will become more complex. To address this, coders have a variety of techniques to make coding efficient, easy to understand, and reduce the chance of error. This series covers methods of organizing scripts, such as module scripts, a special type in script that can store functions and variables used by other scripts.
-### Objectives and prerequisites
+### Objectives and Prerequisites
- 
- 
+ 
- 
-## Pose rig
+## Pose Rig
Every animation is made up of a sequence of key poses at different frames, then Studio programmatically **interpolates**, or "fills in", the in-between frames to create smooth movement. For example, if you were to create a key pose of an arm reaching toward the sky at the 0:00 frame, then another key pose of the same arm reaching toward the ground at the 0:09 frame, Studio fills in the 0:01-0:08 frames between the poses.
@@ -86,7 +86,7 @@ Animation is an art form, and the design decisions you make for your character m
-### Left step
+### Left Step
The first course of action for a walk cycle is to create the four key poses that make up the character's left step, or the step they take to move forward with their left foot. As you complete each pose, consider how the character's weight shifts from an even distribution between both feet to balancing on a single foot, and how that affects movement throughout the rest of their body.
@@ -301,7 +301,7 @@ To create a first pass High pose for the left foot cycle:
1. Save the animation.
-### Right step
+### Right Step
The second course of action for a walk cycle is to create the four key poses that make up the character's right step, or the step they take to move forward with their right foot. While this tutorial focuses on recreating the same process as the character's left foot sequence, you can make subtle adjustments that add personality to your walk cycle, such as a lean to the right or extra pep in their right step.
@@ -483,7 +483,7 @@ To create a first pass High pose for the right foot cycle:
1. Save the animation.
-## Test animation
+## Test Animation
After you complete your first pass of your key poses, it's important to test your animation to see how it flows together. If there are any inconsistencies or choppy transitions, you can make subtle adjustments to ensure the animation is as smooth as it should be for your character's body and personality.
@@ -516,7 +516,7 @@ To test your poses:
-## Publish animation
+## Publish Animation
In order to play your animation in your open experience, as well as store it for reuse in other projects, you must publish the animation to the cloud. This process creates a unique assetID for your animation that you can reference in scripts, which is especially important if you want to replace any of Roblox's default character animations.
diff --git a/content/en-us/tutorials/use-case-tutorials/animation/play-character-animations.md b/content/en-us/tutorials/use-case-tutorials/animation/playing-character-animations.md
similarity index 97%
rename from content/en-us/tutorials/use-case-tutorials/animation/play-character-animations.md
rename to content/en-us/tutorials/use-case-tutorials/animation/playing-character-animations.md
index 87c3c206e..a66ba43e0 100644
--- a/content/en-us/tutorials/use-case-tutorials/animation/play-character-animations.md
+++ b/content/en-us/tutorials/use-case-tutorials/animation/playing-character-animations.md
@@ -1,5 +1,5 @@
---
-title: Play character animations
+title: Playing Character Animations
description: The process for changing default character animations and triggering custom animations.
---
@@ -12,7 +12,7 @@ Using the [Hazardous Space Station](https://www.roblox.com/games/134383324873456
After you complete this tutorial, you will have the skills to customize animations for a wide variety of gameplay situations.
-## Change default animations
+## Changing Default Animations
Every character with a default `Class.Humanoid` object, whether it's a player-controlled avatar or a non-player character (NPC), includes a set of **default animations** that play whenever the character performs specific in-experience actions, such as running, climbing, and jumping. Roblox provides these animations out-of-the-box for every experience without any additional scripting effort.
@@ -33,7 +33,7 @@ Every character with a default `Class.Humanoid` object, whether it's a player-co
However, if these default animations don't meet the design requirements for your world's environment, aesthetic, or overall narrative, you can swap them out with custom animations that apply to every player that joins your experience. This game design technique can help your characters and experiences feel more personal, engaging, and immersive.
-To demonstrate, the following section teaches you how to swap out the default walk animation with a custom walk cycle animation from [Create Character Animations](create-an-animation.md). Using this same process, you can swap out any of the default animations with your own animation assetIDs.
+To demonstrate, the following section teaches you how to swap out the default walk animation with a custom walk cycle animation from [Creating Character Animations](creating-an-animation.md). Using this same process, you can swap out any of the default animations with your own animation assetIDs.
-### Create script
+### Create Script
Now that you have a defined region for triggering your animation, it's time to create a script that programmatically detects whenever players collide with the volume. You can then listen for collision events to trigger any animation that makes sense for your gameplay requirements.
@@ -268,7 +268,7 @@ Setting debounce from `false` to `true` to `false` again after the animation fin
-### Add animation
+### Add Animation
If you were to playtest your experience right now, your `TriggerAnimation` script still wouldn't be able to play an animation in response to the local player-volume collision. This is because it's waiting for a child `Class.Animation` object with an animation assetID it can reference, and that `Class.Animation` object doesn't currently exist.
diff --git a/content/en-us/tutorials/use-case-tutorials/audio/in-game-sounds.md b/content/en-us/tutorials/use-case-tutorials/audio/in-game-sounds.md
index a7fe97c5d..1382c6285 100644
--- a/content/en-us/tutorials/use-case-tutorials/audio/in-game-sounds.md
+++ b/content/en-us/tutorials/use-case-tutorials/audio/in-game-sounds.md
@@ -1,5 +1,5 @@
---
-title: In-game sounds
+title: In-Game Sounds
description: The process for creating positional and feedback sounds to enhance an experience.
---
@@ -7,7 +7,7 @@ In addition to background music, in-game audio can enhance a player's experience
For the first example, you'll create a positional sound for a waterfall. In the second example, a script will be used to play a jingle when players touch a collectable.
-## Positional sounds
+## Positional Sounds
When a **Sound** object is parented to a part or attachment, it becomes positional. Audio will emit from its location and grow louder as players get closer, as in the case of this waterfall.
@@ -15,7 +15,7 @@ When a **Sound** object is parented to a part or attachment, it becomes position
-## Create a brightness NumberSequence
+## Creating a Brightness NumberSequence
A `Datatype.NumberSequence` is a data type that represents a series of number values from 0 to 1 over an instance's lifetime. This type of data type is useful for creating flickering lights because you can specify how you want the lamp light's brightness to change over its lifetime, and when you change brightness from full intensity to no light at all in short succession, you can achieve a flickering effect.
@@ -71,7 +71,7 @@ For example, the following graph makes the light flicker to full brightness for
-## Create a loop duration
+## Creating a Loop Duration
Now that you have a `Datatype.NumberSequence` to determine how the lamp light's brightness changes over its lifetime, you must determine how long you want the flickering loop to take. In other words, this loop duration essentially controls how often the `Datatype.NumberSequence` repeats, in seconds.
@@ -91,7 +91,7 @@ To create a loop duration:
1. Set the new **LoopDuration** attribute to **1**. This tells the `Datatype.NumberSequence` to repeat after one second.
-## Script the light flicker
+## Scripting the Light Flicker
Now that you have all of the elements to control the brightness of your lamp over its lifetime, it's time to create a `Class.Script` that will get everything to work together and flicker the light.
diff --git a/content/en-us/tutorials/use-case-tutorials/lighting/enhance-indoor-environments.md b/content/en-us/tutorials/use-case-tutorials/lighting/enhancing-indoor-environments.md
similarity index 98%
rename from content/en-us/tutorials/use-case-tutorials/lighting/enhance-indoor-environments.md
rename to content/en-us/tutorials/use-case-tutorials/lighting/enhancing-indoor-environments.md
index ae7aaceea..bd1f5a983 100644
--- a/content/en-us/tutorials/use-case-tutorials/lighting/enhance-indoor-environments.md
+++ b/content/en-us/tutorials/use-case-tutorials/lighting/enhancing-indoor-environments.md
@@ -1,5 +1,5 @@
---
-title: Enhance indoor environments with Future lighting
+title: Enhancing Indoor Environments with Future Lighting
description: Explains how to leverage Future Lighting to enhance indoor environments.
---
@@ -26,13 +26,13 @@ If at any point you become stuck in the process, you can use **Lighting Indoors
-### Elevate metal reflections
+### Elevate Metal Reflections
A core advantage of using the Future lighting system is its ability to produce specular highlights on shiny, metallic surfaces. This increases the realism of indoor environments because it emulates real-world lighting behavior, and it provides a sense of depth to objects in the 3D space.
-By default, all materials use [physically-based rendering](../../../art/modeling/surface-appearance.md) (PBR) textures that allow you to display realistic surfaces in various lighting scenarios by using multiple texture maps on a single object. This means that when you use Studio's built-in materials:
+By default, all materials use [Physically-Based Rendering](../../../art/modeling/surface-appearance.md) (PBR) textures that allow you to display realistic surfaces in various lighting scenarios by using multiple texture maps on a single object. This means that when you use Studio's built-in materials:
- The metalness and roughness of a particular surface is already defined for you without any additional steps.
- Objects with Studio's built-in materials naturally react more accurately to the lighting in your environment with realistic reflections.
@@ -100,7 +100,7 @@ To recreate the metal reflections in the sample [Lighting Indoors - Complete](ht
1. In the **Explorer** window, select **Lighting**.
1. In the **Properties** window, ensure that **EnvironmentalDiffuseScale** and **EnvironmentSpecularScale** are set to `1`. If so, the metal in the experience is accurately reflective.
-### Change the time of day
+### Change the Time of Day
In addition to customizing the general atmosphere of the 3D space, global lighting is a powerful tool in creating points of interest within the environment that you want players to explore. When you pair this technique with local light sources, you can indirectly guide players to each section of the gameplay area and prevent them from missing anything important.
@@ -117,7 +117,7 @@ To recreate the time of day in the sample [Lighting Indoors - Complete](https://
-### Amplify the sun rays
+### Amplify the Sun Rays
Now that the sun is at an ideal position in the sky to shine its light in through the window and create a point of interest, you can use the `Class.Lighting` service's child `Class.SunRaysEffect|SunRays` object to exaggerate the sun's illumination by amplifying its individual sun rays. Unlike other static atmospheric effects, sun rays dynamically change shape as objects come between the player's camera and the sun, creating realistic light and shadow visuals.
@@ -141,7 +141,7 @@ To recreate the sun rays in the atmosphere in the sample [Lighting Indoors - Com
1. Set **Intensity** to `0.023` to increase the opacity of the sun's halo.
1. Set **Spread** to `0.266` to widen the sun rays spread across the sky.
-### Adjust the color of ambient light
+### Adjust the Color of Ambient Light
Customizing the color of ambient light, or the general, indirect light in the 3D space, is a common method for both setting the mood of an environment and determining whether its lighting is warm or cool. There are two `Class.Lighting` properties that control the color of ambient lighting:
@@ -168,7 +168,7 @@ To recreate the color of ambient lighting in the sample [Lighting Indoors - Comp
-### Choose a complementary skybox
+### Choose a Complementary Skybox
The `Class.Lighting` service has a child `Class.Sky` object with six individual properties that together create the skybox that makes up an experience's sky. Skyboxes can have a major impact on the look and feel of what's in your environment, so it's important to carefully consider how you can choose a skybox that enhances your experience's visual quality, especially as it influences the overall atmosphere that seeps into indoor spaces.
@@ -217,7 +217,7 @@ To recreate the skybox in the sample [Lighting Indoors - Complete](https://www.r
-### Increase air particle density
+### Increase Air Particle Density
The `Class.Lighting` service has a child `Class.Atmosphere` object with properties that allow you to simulate realistic environments by scattering sunlight in unique ways. While some of these properties are more evident in outdoor environments, such as those that impact the silhouette and blending of distant objects near the skyline, others influence the density and color of the air particles present throughout the 3D space, regardless of whether they are indoors or outdoors.
@@ -243,13 +243,13 @@ To recreate the density of the atmosphere's air particles in the sample [Lightin
-## Configure local lighting
+## Configure Local Lighting
Local lighting is the luminescence from local [light sources](../../../effects/light-sources.md) in your experience, such as `Class.PointLight`, `Class.SpotLight`, and `Class.SurfaceLight` objects. After you configure your global lighting to meet the general lighting and atmosphere requirements of the experience, it's important to utilize these local light sources to meet the specific lighting needs of anything in the scene that you want to illuminate within the 3D space.
The following sections demonstrate how to create each type of local light source and adjust a couple of its default properties to significantly alter how the local lighting compliments your global lighting and interacts with the overall environment.
-### Light the candles
+### Light the Candles
The first objects in the scene that need to illuminate the space are the groupings of candles on the dresser near the window. Their default configuration in the **Lighting Indoors - Start** sample includes the following `Class.ParticleEmitter` objects to add gentle movement to their flames:
@@ -298,7 +298,7 @@ To recreate candle local lighting in the sample [Lighting Indoors - Complete](ht
-### Turn on the desk lamp
+### Turn on the Desk Lamp
The second object in the scene that needs to illuminate the space is the desk lamp near the back corner of the cabin. When you're deciding which local light object you want to use, it's important to review how the type and shape of the light source affects how it shines light in the real world. For example, because the **Lighting Indoors - Start** sample's desk lamp includes a white light bulb under a curved, dark green hood, the lamp must produce two different types of light:
@@ -351,7 +351,7 @@ To recreate the lamp local lighting in the sample [Lighting Indoors - Complete](
-### Illuminate the radio screen
+### Illuminate the Radio Screen
The final object in the scene that needs to illuminate the space is the classic radio in the middle of the statues on the dresser. Similar to the previous section, when deciding which local light object you want to use, it's important to review how the type and shape of the light source **doesn't** emit light in the real world. For example, neither of the previous local light objects work for this radio because its screen wouldn't emit light in every direction like a `Class.PointLight` object, nor from a single point in one direction like a `Class.SpotLight`.
@@ -398,13 +398,13 @@ To recreate the radio surface light in the sample [Lighting Indoors - Complete](
-## Balance light sources
+## Balance Light Sources
Lighting an environment is a balance between your light sources and the camera's perception of their lighting. Even if your light sources have appropriate settings for how they'd illuminate the space in the real world, you may have to adjust and rebalance how the camera perceives that lighting in order to achieve your ideal lighting behavior.
For example, the scene in its current state has an intentionally warm glow throughout the cabin, but its colors and shadows appear both dull and desaturated. To solve this problem, the **Lighting Indoors - Complete** sample adjusts its global lighting to increase its richness in the player's camera without losing details or contrast between light and dark hues throughout the 3D space.
-### Adjust light exposure
+### Adjust Light Exposure
Similar to customizing how long a real-life camera's lens stays open for a picture, the `Class.Lighting` service's `Class.Lighting.ExposureCompensation|ExposureCompensation` property allows you to adjust how much light reaches the camera. Using this property is unique from adjusting the `Class.Lighting.Brightness|Brightness` property because `Class.Lighting.ExposureCompensation|ExposureCompensation` applies a bias toward increasing the effect of brighter parts of the environment.
@@ -432,7 +432,7 @@ To recreate the exposure levels in the sample [Lighting Indoors - Complete](http
-### Adjust color contrast
+### Adjust Color Contrast
Similar to applying a filter over a camera, you can add a `Class.ColorCorrectionEffect` post-processing object to the `Class.Lighting` service to adjust how the camera perceives color. This is useful when you want to make color adjustments that impact the entire environment instead of just a single object or gameplay area.
diff --git a/content/en-us/tutorials/use-case-tutorials/lighting/enhance-outdoor-environments-with-future-lighting.md b/content/en-us/tutorials/use-case-tutorials/lighting/enhancing-outdoor-environments-with-future-lighting.md
similarity index 93%
rename from content/en-us/tutorials/use-case-tutorials/lighting/enhance-outdoor-environments-with-future-lighting.md
rename to content/en-us/tutorials/use-case-tutorials/lighting/enhancing-outdoor-environments-with-future-lighting.md
index d46568401..e63d4e80c 100644
--- a/content/en-us/tutorials/use-case-tutorials/lighting/enhance-outdoor-environments-with-future-lighting.md
+++ b/content/en-us/tutorials/use-case-tutorials/lighting/enhancing-outdoor-environments-with-future-lighting.md
@@ -1,5 +1,5 @@
---
-title: Enhance outdoor environments with Future lighting
+title: Enhancing Outdoor Environments with Future Lighting
description: Explains how to leverage Future Lighting to enhance outdoor environments.
---
@@ -25,11 +25,11 @@ If at any point you become stuck in the process, you can use **Lighting Outdoors
-## Configure global lighting
+## Configure Global Lighting
Global lighting is the luminescence from either the sun or moon in an experience. By adjusting a couple of key default properties in the `Class.Lighting` service, you can dramatically change how that light appears to players, as well as how it interacts with any other object you place in the experience.
-### Enable the Future lighting system
+### Enable the Future Lighting System
The `Class.Lighting.Technology` property determines the behavior of both global and local lighting in your experience. Studio begins every experience with the `Enum.Technology.ShadowMap` lighting system, ensuring that the global lighting has precise shadows and illumination. However, to enhance the environment and equip your local light sources to also produce precise shadows and illumination, such as the light from the campfire, you must enable the `Enum.Technology.Future` lighting system technology directly in Studio. This allows both your global and local lighting to work together and provide more realistic and immersive visuals.
@@ -53,9 +53,9 @@ To enable the `Enum.Technology.Future` lighting system:
-### Elevate metal reflections
+### Elevate Metal Reflections
-By default, all materials use physically-based rendering (PBR) textures that allow you to display realistic surfaces in various lighting scenarios by using multiple image files on a single object. This means that when you use Studio's built-in materials, the metalness and roughness of a particular surface is already defined for you, and the objects with those materials naturally react more accurately to the lighting in your environment with realistic reflections. You can enhance this effect by setting the `Class.Lighting.EnvironmentDiffuseScale` and `Class.Lighting.EnvironmentSpecularScale` properties to `1` to truly take advantage of metal reflections from the `Enum.Technology.Future` lighting system.
+By default, all materials use Physically-Based Rendering (PBR) textures that allow you to display realistic surfaces in various lighting scenarios by using multiple image files on a single object. This means that when you use Studio's built-in materials, the metalness and roughness of a particular surface is already defined for you, and the objects with those materials naturally react more accurately to the lighting in your environment with realistic reflections. You can enhance this effect by setting the `Class.Lighting.EnvironmentDiffuseScale` and `Class.Lighting.EnvironmentSpecularScale` properties to `1` to truly take advantage of metal reflections from the `Enum.Technology.Future` lighting system.
This step is important because it ensures that any PBR textures in your experience, including those from `Class.MaterialVariant|MaterialVariants` or `Class.SurfaceAppearance` objects, look their best and reflect their surroundings better. For example, examine the following two images of the same pan and utensils near the campfire with different `Class.Lighting.EnvironmentDiffuseScale` and `Class.Lighting.EnvironmentSpecularScale` property values. When you adjust these values, the metal becomes more apparent and reflects the lighting from both the global and local light sources significantly more than before.
@@ -73,9 +73,9 @@ This step is important because it ensures that any PBR textures in your experien
To elevate metal reflections:
1. In the **Explorer** window, select **Lighting**.
-1. In the **Properties** window, set **EnvironmentalDiffuseScale** and **EnvironmentSpecularScale** to `1`. The metal in the experience becomes more reflective.
+1. In the **Properties** window, set **EnvironmentalDiffuseScale** and **EnvironmentSpecularScale** to **1**. The metal in the experience becomes more reflective.
-### Change the time of day
+### Change the Time of Day
Now that your experience is using the `Enum.Technology.Future` lighting system and materials are reacting realistically to the light sources in your experience, it's time to move the sun to a different position according to where it would be in the real world for the time of day. The sun's default position is high in the sky, emulating around midday in the real world, so it's best to move it nearer to the skyline, right above the mountains. This step also allows the light to move down the path onto the campfire and achieve a nice golden sun.
@@ -93,9 +93,9 @@ Now that your experience is using the `Enum.Technology.Future` lighting system a
To change the time of day:
1. In the **Explorer** window, select **Lighting**.
-1. In the **Properties** window, set **ClockTime** to `17`. The sun moves to the approximate position it would be in at 5pm.
+1. In the **Properties** window, set **ClockTime** to **17**. The sun moves to the approximate position it would be in at 5pm.
-### Adjust the color of ambient light
+### Adjust the Color of Ambient Light
There are two `Class.Lighting` properties that control the color of ambient lighting:
@@ -118,9 +118,9 @@ By default, these properties are set to produce gray ambient lighting, but to co
To adjust the color of ambient lighting:
1. In the **Explorer** window, select **Lighting**.
-1. In the **Properties** window, set **Outdoor Ambient** and **Ambient** to `156, 136, 176`. The ambient lighting changes to a light purple hue.
+1. In the **Properties** window, set **Outdoor Ambient** and **Ambient** to **156, 136, 176**. The ambient lighting changes to a light purple hue.
-### Choose a skybox
+### Choose a Skybox
A skybox is a cube made up of six individual images that create an experience's sky, including what's above and below the horizon. Skyboxes can have a major impact on the look and feel of what's in your environment, so it's important to carefully consider how you can choose a skybox that enhances your experience's visual quality. For example:
@@ -139,11 +139,11 @@ To illustrate these concepts, examine the following two images to see how the sa
-### Atmospheric effects
+### Atmospheric Effects
The `Class.Lighting` service has a child `Class.Atmosphere` object with properties that allow you to simulate realistic environments by scattering sunlight in unique ways. These properties can be very useful in creating a thickness in the experience's air, giving the environment a tangible sense of depth. The `Class.Atmosphere` object pulls most of its colors from the skybox directly, which is why the previous decisions about your skybox were so important.
-#### Increase air particle density
+#### Increase Air Particle Density
The `Class.Atmosphere.Density` property controls how many particles exist in the air of your experience. When you increase this property, the additional amount of particles obstruct the player's view of objects in the background. For example, when `Class.Atmosphere.Density` is `0`, the background trees, sun, and skybox are clearly visible, but when you increase this property to `0.391`, the particles start to scatter the light and conceal the trees.
@@ -161,33 +161,33 @@ The `Class.Atmosphere.Density` property controls how many particles exist in the
To increase density of the air particles in the atmosphere:
1. In the **Explorer** window, select **Atmosphere**.
-1. In the **Properties** window, set **Density** to `0.272`.
+1. In the **Properties** window, set **Density** to **0.272**.
-#### Add a haze
+#### Add a Haze
The `Class.Atmosphere.Haze` property controls the overall haziness of the atmosphere to create a visible effect both above the horizon and far into the distance from the camera. When you increase this property, it not only affects the overall environment, but it also affects objects that have a particularly powerful fresnel effect, such as metal objects that reflect the environment around them.
To add haze to the atmosphere:
1. In the **Explorer** window, select **Atmosphere**.
-1. In the **Properties** window, set **Haze** to `1`.
+1. In the **Properties** window, set **Haze** to **1**.
-#### Adjust the color of the atmosphere
+#### Adjust the Color of the Atmosphere
The `Class.Atmosphere.Color` property sets the hue of the atmosphere for subtle environmental moods and themes, and it can really enhance the haze within your experience. You can set this to any color you want to suit your experience, but it's recommended to set it to a color value that is close to the average of the objects in the environment.
To adjust the color of the atmosphere:
1. In the **Explorer** window, select **Atmosphere**.
-1. In the **Properties** window, set **Color** to `85, 78, 54`.
+1. In the **Properties** window, set **Color** to **85, 78, 54**.
-## Configure local lighting
+## Configure Local Lighting
Local lighting is the luminescence from local [light sources](../../../effects/light-sources.md) in your experience, such as `Class.SpotLight`, `Class.SurfaceLight`, and `Class.PointLight` objects. The key local light source you can create for this experience is the campfire's glow, and by adjusting a couple of its default properties, you can significantly alter how this local lighting interacts with the overall environment and compliment your global lighting configuration.
@@ -213,18 +213,18 @@ To add a `Class.PointLight` to the campfire:
-### Increase the range of the PointLight
+### Increase the Range of the PointLight
The default properties of the `Class.PointLight` aren't enough to fully brighten the objects surrounding the campfire, so you need to increase the range that the light can reach. Because the fire is large and bright, the light needs to cast far enough to illuminate the nearby trees, rocks, and brush. This also helps to make the space feel warm and cozy, as though the heat of the fire is naturally expanding outward.
To increase the range of the `Class.PointLight`:
1. In the **Explorer** window, select the campfire's **PointLight**.
-1. In the **Properties** window, set **Range** to `48`. The light's maximum lighting range expands.
+1. In the **Properties** window, set **Range** to **48**. The light's maximum lighting range expands.
-### Enable shadows
+### Enable Shadows
While the lighting's range is realistic to its size, it's unrealistic that the surrounding trees and rocks don't cast shadows from the campfire's light. Sometimes this is useful if you need to add in a couple of point lights to brighten dark spaces within your experience, but when you're aiming to emulate the real world, you can enable local lighting's ability to cast shadows. It's important to note that additional shadows can impact your experience's performance on low-end devices, so only enable shadows when they significantly add to the scene.
@@ -235,7 +235,7 @@ To enable shadows from the campfire's local lighting:
-### Adjust the lighting's brightness and color
+### Adjust the Lighting's Brightness and Color
While the local lighting is already looking and feeling closer to realistic behavior, it's still weak in strength and too white for a warm glow. When you increase the campfire's brightness and add a warmer hue, it really brings life to the fire and adds to the coziness of the scene.
@@ -243,8 +243,8 @@ To enable shadows from the campfire's local lighting:
1. In the **Explorer** window, select the campfire's **PointLight**.
1. In the **Properties** window,
- 1. Set **Brightness** to `2`.
- 1. Set **Color** to `255, 179, 73`.
+ 1. Set **Brightness** to **2**.
+ 1. Set **Color** to **255, 179, 73**.
diff --git a/content/en-us/tutorials/use-case-tutorials/lighting/light-with-props.md b/content/en-us/tutorials/use-case-tutorials/lighting/lighting-with-props.md
similarity index 98%
rename from content/en-us/tutorials/use-case-tutorials/lighting/light-with-props.md
rename to content/en-us/tutorials/use-case-tutorials/lighting/lighting-with-props.md
index f08432a43..21ba468ce 100644
--- a/content/en-us/tutorials/use-case-tutorials/lighting/light-with-props.md
+++ b/content/en-us/tutorials/use-case-tutorials/lighting/lighting-with-props.md
@@ -1,5 +1,5 @@
---
-title: Light with props
+title: Lighting with Props
description: The process for creating light sources out of props.
---
@@ -7,13 +7,13 @@ While overall world lighting is globally controlled through the `Class.Lighting`
-## Starter project
+## Starter Project
The remainder of this tutorial uses the [Misty Harbor](https://www.roblox.com/games/6445909934/Misty-Harbor) project as a showcase. To follow along, open it in Studio before proceeding.
-## Point lights
+## Point Lights
A `Class.PointLight` emits light **spherically** from a single point. This object is ideal for non-directional light sources like bulbs, torches, and fireballs.
@@ -67,7 +67,7 @@ Light sources like point lights need to be inserted directly into parts, meshes,
-## Spot lights
+## Spot Lights
A `Class.SpotLight` emits light in the shape of a **cone**. This object is ideal for light sources like street lamps, flashlights, and headlights.
@@ -107,7 +107,7 @@ A `Class.SpotLight` emits light in the shape of a **cone**. This object is ideal
5. Experiment with different **Brightness** and **Color** values, as with the point light.
-## Surface lights
+## Surface Lights
A `Class.SurfaceLight` emits light from the entire surface/face of a part, rather than just from a single point. This object is useful for light sources like TV or computer screens, lighted billboards, and fluorescent panels.
diff --git a/content/en-us/tutorials/use-case-tutorials/modeling/assemble-modular-environments.md b/content/en-us/tutorials/use-case-tutorials/modeling/assembling-modular-environments.md
similarity index 97%
rename from content/en-us/tutorials/use-case-tutorials/modeling/assemble-modular-environments.md
rename to content/en-us/tutorials/use-case-tutorials/modeling/assembling-modular-environments.md
index 21b7df529..6acc1bfef 100644
--- a/content/en-us/tutorials/use-case-tutorials/modeling/assemble-modular-environments.md
+++ b/content/en-us/tutorials/use-case-tutorials/modeling/assembling-modular-environments.md
@@ -1,5 +1,5 @@
---
-title: Assemble modular environments
+title: Assembling Modular Environments
description: Explains how to configure and assemble reusable assets that seamlessly snap together.
---
@@ -20,7 +20,7 @@ Assembling modular environments is useful because it means you don't need to man
Using the same modular building kit pieces that built Studio's Modern City template, this guide walks you through the importance of consistent pivot point locations in order for modular assets to align and snap together, shows you how to combine modular assets to create a realistic building, and demonstrates how to customize modular assets to create variety within your environment.
-## The importance of consistent pivot point locations
+## The Importance of Consistent Pivot Point Locations
Every object in Studio moves and rotates according to the location of its pivot point. By default, parts and meshes start with a pivot point location in the center of the object, so when you move them, they move from the center of the object outwards. The default pivot point location is useful for having symmetrical scaling and rotation, but it becomes problematic when you want to snap together objects of varying shapes in a predictable and uniform way.
@@ -65,7 +65,7 @@ Modular assets can consist of a nearly infinite variety of different shapes, siz
For information on how to configure pivot locations for parts and models you create within Studio, see [Pivot Tools](../../../studio/pivot-tools.md#edit-pivot). For information on how to configure pivot locations for meshes you create in third-party modeling tools, see the pivot point documentation for [Blender](https://docs.blender.org/manual/en/2.80/scene_layout/object/editing/transform/control/pivot_point.html) or [Maya](https://knowledge.autodesk.com/support/maya/learn-explore/caas/CloudHelp/cloudhelp/2022/ENU/Maya-Basics/files/GUID-150B390E-840B-4FE3-B8E9-8DEBCE7CEC97-htm.html).
-## Configure snapping behavior
+## Configuring Snapping Behavior
Studio's default settings allow you to freely move and rotate objects to any fraction of a stud or degree, respectively. However, because modular building kits rely on assets snapping together at exact increments, you must change these default settings **according to the requirements of each modular building kit**. For example, the Modern City sample [modular building kit](https://create.roblox.com/store/asset/13168370735/Modular-Building-Kit-Modern-City) requires each mesh to rotate in 7.5 stud and 45 degree increments with collisions off. This ensures that as you move and rotate meshes around the 3D environment, they can connect and maintain clear alignment to one another as the building grows.
@@ -75,12 +75,12 @@ To configure Studio settings for ideal snapping behavior for the sample modular
1. In the **Tools** section, disable **Collisions**.
1. In the **Snap to Grid** section,
- 1. Enable **Rotate** and set it to `45`.
- 1. Enable **Move** and set it to `7.5`.
+ 1. Enable **Rotate** and set it to 45.
+ 1. Enable **Move** and set it to 7.5.
-## Combine modular assets
+## Combining Modular Assets
When you start to assemble modular assets into a larger complex object, it's helpful to choose one core object whose position coordinates you can reference throughout the entire process. This ensures that each additional object quickly aligns to the right pivot location before moving them to a different position.
@@ -109,11 +109,11 @@ To snap modular assets together to create a building using the sample modular bu
-## Customize modular assets
+## Customizing Modular Assets
To ensure every object looks and feels unique from one another, it's important to customize your modular assets to create visual variety. While the following sections explore customization strategies for the sample modular building kit, such as using alternate materials for the walls and trims, experimenting with different hues for these adornments, removing repetition for materials that tile on large surfaces, and dressing objects with decorative props, you can utilize similar methods for any modular building kit you use to create modular environments.
-### Use custom materials
+### Using Alternative Custom Materials
Every mesh within the sample modular building kit uses a [custom material](../../../parts/materials.md#custom-materials) from the sample [materials pack](https://create.roblox.com/store/asset/13168345645/Modern-City-Materials-Pack) that you can use to alter the appearance and physical qualities of your buildings' walls. For example, by default, all walls start with a **PaintedBrick** custom material, but you can change it to various forms of alternative brick, concrete, and plaster, then set a distinct tint color to the material in order to give each building a unique appearance.
@@ -138,7 +138,7 @@ To use alternative custom materials for wall meshes:
-### Use SurfaceAppearance objects
+### Using Alternative SurfaceAppearance Objects
Every mesh with a trim in the sample modular building kit includes a `Class.SurfaceAppearance` object that utilizes custom textures to make each building's adornments feel more realistic. To make each building in your experience feel unique, you can swap any `Class.SurfaceAppearance` object for another in the **SurfaceAppearance** folder in the workspace, including materials like concrete, plaster, and wood, then set a distinct tint color to the trim for additional variety.
@@ -183,9 +183,9 @@ To swap `Class.SurfaceAppearance` objects for trim meshes:
-### Reduce visible repetition
+### Reducing Visible Repetition
-When you're building large objects that utilize tiling materials like bricks and concrete, the tiling pattern can rapidly reveal visible repetition. To help reduce the visible tiling of these materials, you can create a grunge decal or texture, then add it as a child of your wall meshes to overlay on top of the wall's active materials. This customization strategy has the benefit of adding additional realism to your building, quickly improving the quality of your 3D environment. For information on how to apply and customize textures, see [Textures and decals](../../../parts/textures-decals.md).
+When you're building large objects that utilize tiling materials like bricks and concrete, the tiling pattern can rapidly reveal visible repetition. To help reduce the visible tiling of these materials, you can create a grunge decal or texture, then add it as a child of your wall meshes to overlay on top of the wall's active materials. This customization strategy has the benefit of adding additional realism to your building, quickly improving the quality of your 3D environment. For information on how to apply and customize textures, see [Textures and Decals](../../../parts/textures-decals.md).
-### Add decorative props
+### Adding Decorative Props
As a final step in making objects feel distinct in their larger modular environment, you can add a significant amount of character to each object by dressing them with decorative props. For example, the sample modular building kit includes assets like fire escapes, window balconies, air conditioner units, and foliage that you can experiment with to flourish each building and make it feel lived in. Even just including a few decorative props can add a vast amount of storytelling to your scene.
diff --git a/content/en-us/tutorials/use-case-tutorials/modeling/create-neon-signs.md b/content/en-us/tutorials/use-case-tutorials/modeling/creating-neon-signs.md
similarity index 98%
rename from content/en-us/tutorials/use-case-tutorials/modeling/create-neon-signs.md
rename to content/en-us/tutorials/use-case-tutorials/modeling/creating-neon-signs.md
index 953590169..f6e391e9c 100644
--- a/content/en-us/tutorials/use-case-tutorials/modeling/create-neon-signs.md
+++ b/content/en-us/tutorials/use-case-tutorials/modeling/creating-neon-signs.md
@@ -1,5 +1,5 @@
---
-title: Create neon signs
+title: Creating Neon Signs
description: Explains how to create neon signage to draw attention to something in an experience.
---
@@ -19,7 +19,7 @@ In the following method to create a neon sign, follow each section to learn how
You can create your own assets in third-party modeling tools and follow along with your own design. For information on exporting models for use in Studio, see [Exporting Requirements](../../../art/modeling/export-requirements.md).
-## Create the backboard and border
+## Create the Backboard and Border
A `Class.Part` is Roblox's primary building block that you can move, resize, rotate, and customize to change their appearance, such as their color and material. Using [basic parts](../../../parts/index.md) to create the foundation of neon signs is useful because the signage's backboard and border only require basic shapes.
@@ -56,7 +56,7 @@ To create the backboard and border:
Now that you have three parts that make up the basic shapes of your neon sign, you can sculpt the border's shape.
-## Shape the neon border
+## Shape the Neon Border
Using [solid modeling](../../../parts/solid-modeling.md), you can join and separate parts in unique ways to form more complex shapes known as **unions**. This process enables you to resize and modify the duplicate border part to become the neon border.
@@ -90,7 +90,7 @@ To create the neon border shape:
Now that you have a complete backboard and a glowing neon border, you can create extruding neon 3D text for the words of the sign.
-## Incorporate neon 3D text
+## Incorporate Neon 3D Text
Since Studio doesn't natively support 3D text, this guide provides an open-text.obj file for you to import into your scene that contains a 3D model of text that spells the word "OPEN". You can also use other methods to create 3D texts or custom designs for this process, such as using your own models from third-part modeling software, working with community plugins, or creating your own text manually in Studio through solid modeling.
diff --git a/content/en-us/tutorials/use-case-tutorials/physics/build-a-ferris-wheel.md b/content/en-us/tutorials/use-case-tutorials/physics/building-a-ferris-wheel.md
similarity index 96%
rename from content/en-us/tutorials/use-case-tutorials/physics/build-a-ferris-wheel.md
rename to content/en-us/tutorials/use-case-tutorials/physics/building-a-ferris-wheel.md
index 4e61d13a7..63e70e35b 100644
--- a/content/en-us/tutorials/use-case-tutorials/physics/build-a-ferris-wheel.md
+++ b/content/en-us/tutorials/use-case-tutorials/physics/building-a-ferris-wheel.md
@@ -1,6 +1,6 @@
---
-title: Build a ferris wheel
-description: The process for creating a ferris wheel using a motor.
+title: Building a Ferris Wheel
+description: The process for creating a Ferris Wheel using a motor.
---
Many contraptions in Roblox will use multiple constraints to build more complicated mechanisms. In particular, you can configure several constraints to be **actuated**, meaning they will move under their own power. This tutorial will show you how to actuate a `Class.HingeConstraint` to be a **motor** in order to make a ferris wheel.
@@ -9,7 +9,7 @@ Many contraptions in Roblox will use multiple constraints to build more complica
-## Add attachments
+## Add Attachments
You will need to add attachments to the ferris wheel to determine where it will rotate. When working with attachments, it helps to move the pieces you are working with apart so you can clearly see the position and orientation of the attachments.
@@ -47,7 +47,7 @@ You will need to add attachments to the ferris wheel to determine where it will
-## Create a HingeConstraint
+## Creating a HingeConstraint
Now that both attachments are in place, it's time to add a `Class.HingeConstraint` to act as the motor for the wheel.
@@ -63,7 +63,7 @@ Now that both attachments are in place, it's time to add a `Class.HingeConstrain
-## Change to motor
+## Changing to Motor
By default, `Class.HingeConstraint|HingeConstraints` will only turn if an outside force acts on them, such as a user character pushing in the connected parts. To make a `Class.HingeConstraint` turn on its own, we have to configure it to be a **Motor**, set our desired turn rate, and make sure the hinge has enough torque.
diff --git a/content/en-us/tutorials/use-case-tutorials/physics/build-a-hinged-door.md b/content/en-us/tutorials/use-case-tutorials/physics/building-a-hinged-door.md
similarity index 98%
rename from content/en-us/tutorials/use-case-tutorials/physics/build-a-hinged-door.md
rename to content/en-us/tutorials/use-case-tutorials/physics/building-a-hinged-door.md
index 19173d95d..1448f97cc 100644
--- a/content/en-us/tutorials/use-case-tutorials/physics/build-a-hinged-door.md
+++ b/content/en-us/tutorials/use-case-tutorials/physics/building-a-hinged-door.md
@@ -1,5 +1,5 @@
---
-title: Build a hinged door
+title: Building a Hinged Door
description: The process for creating a door using a HingeConstraint.
---
@@ -9,7 +9,7 @@ Roblox's physics system allows you to construct moving mechanisms like doors, ro
-### Align the attachments
+### Aligning the Attachments
If you keep both attachments at their default positions within the center of their parent parts, the attachments will try to pull each part inside of the other, causing the physics of both parts to collide and render the elevator non-functional. To ensure this doesn't happen, you must move the attachments outside of their parent parts so the platform can freely travel through an unobstructed space along the outside of the track, then align them along their X and Z axes so that the platform only moves up and down the Y axis.
@@ -112,7 +112,7 @@ To align the constraint's attachments:
-### Set PrismaticConstraint values
+### Setting PrismaticConstraint Values
Now that you have a `Class.PrismaticConstraint` and have aligned its associated `Class.Attachment|Attachments`, it's time to set the constraint's values that a `Class.Script` can use to enable the platform to move up and down the track to a set lower and upper range of motion that correlates to the bottom and top of the track. Because the bottom and top of the track are each 10 studs away from the **TrackAttachment** that's in the middle of the track that's 20 studs in length, the constraint's lower and upper limits must be `-10` and `10`, respectively.
@@ -147,7 +147,7 @@ To set values for your constraint to enable elevator movement within a set range
1. Set **Speed** to **10**.
1. Set **TargetPosition** to **-10**.
-## Create the proximity prompt
+## Creating the Proximity Prompt
A `Class.ProximityPrompt` is an object that encourages user interaction to trigger an action when they approach in-experience objects such as doors, light switches, and buttons. This process uses a [proximity prompt](../../../ui/proximity-prompts.md) to allow users to press a key when they are near the platform in order to activate the elevator's movement.
@@ -158,7 +158,7 @@ To create a proximity prompt:
-## Script elevator movement
+## Scripting Elevator Movement
Now that you have all of the elements of your elevator ready to go, it's time to create a `Class.Script` that gets everything to work together and move the platform up and down the track.
diff --git a/content/en-us/tutorials/use-case-tutorials/physics/create-moving-objects.md b/content/en-us/tutorials/use-case-tutorials/physics/creating-moving-objects.md
similarity index 98%
rename from content/en-us/tutorials/use-case-tutorials/physics/create-moving-objects.md
rename to content/en-us/tutorials/use-case-tutorials/physics/creating-moving-objects.md
index 72163155a..2f49a8cd2 100644
--- a/content/en-us/tutorials/use-case-tutorials/physics/create-moving-objects.md
+++ b/content/en-us/tutorials/use-case-tutorials/physics/creating-moving-objects.md
@@ -1,5 +1,5 @@
---
-title: Create moving objects
+title: Creating Moving Objects
description: Explains the process of creating dynamic motion by moving objects.
---
@@ -17,7 +17,7 @@ Using the [Moving Objects](https://www.roblox.com/games/17560154079/UCT-Linear-M
-## Linear motion and physical forces
+## Linear Motion and Physical Forces
Roblox Studio is a real-world simulation engine that emulates physical behavior in real time, so in order to predict how objects moving linearly can behave in experiences, it's important to have a high-level understanding of how objects move in real life with linear motion.
@@ -69,7 +69,7 @@ Understanding linear velocity is important for designing gameplay in your experi
The following sections dive deeper into these concepts as you learn how to move objects at either a constant or initial linear velocity with the necessary force to overcome any oppositional physical forces within the environment. As you review these physics concepts with the upcoming techniques, you can more accurately predict how to adjust property values to achieve any ideal linear movement behavior in Studio.
-## Maintain a constant linear velocity
+## Maintaining a Constant Linear Velocity
For an object to reach and maintain a constant linear velocity, it needs a force to overcome any oppositional physical forces that either decelerate the object's linear velocity, or cause the object to remain stationary. For example, if you want an object to have a linear velocity of `[0, 12, 0]` in Studio, you need enough force for the object to reach and maintain 12 studs per second along the Y axis in its environment.
@@ -88,7 +88,7 @@ The amount of force necessary not only depends on oppositional physical forces w
The following subsections use assemblies of different shapes and sizes to teach you how to move either an entire object or only a portion of the object at a constant linear velocity. As you experiment with different property values, you will learn how to estimate the maximum amount of force you need for assemblies in your own experiences.
-### Use LinearVelocity constraints
+### Using LinearVelocity Constraints
`Class.LinearVelocity` objects are a type of [mover constraint](../../../physics/mechanical-constraints.md) that apply force on an entire assembly to maintain a constant linear velocity. By not locking the assembly's position to an axis during its motion, the assembly is free to rotate as it collides with other objects in the 3D space. This type of movement leads to surprising gameplay scenarios that are more difficult for players to predict.
@@ -107,7 +107,7 @@ To demonstrate this process, you will configure a lily pad with an attachment th
-#### Add attachment
+#### Add Attachment
You can specify the point to apply force by adding an `Class.Attachment` object to the assembly, then configuring the attachment's position in the 3D space. The sample [Moving Objects](https://www.roblox.com/games/17560154079/UCT-Linear-Movement) experience places an attachment in the center of the lily pad so that the constraint can move the mesh from the attachment along a particular axis.
@@ -125,7 +125,7 @@ To add an attachment:
-#### Configure constraint
+#### Configure Constraint
Now that your mesh has a fixed point to move the lily pad, you can configure the properties of a `Class.LinearVelocity` constraint to specify the direction and magnitude for the constant linear velocity, the amount of studs you want the mesh to move per second, and the maximum amount of force the engine can apply for the mesh to reach a constant linear velocity.
@@ -169,7 +169,7 @@ To configure a `Class.LinearVelocity` constraint:
-### Use PrismaticConstraint constraints
+### Using PrismaticConstraint Constraints
`Class.PrismaticConstraint` objects are a type of [mechanical constraint](../../../physics/mechanical-constraints.md) that create a rigid joint between two attachments, allowing their parent assemblies to move along one axis **relative to each other**. By locking both assemblies' position to a single axis, each assembly is only able to rotate if they rotate together in the same direction.
@@ -191,7 +191,7 @@ To demonstrate this process, you will configure a log assembly with two objects
-#### Configure attachments
+#### Configure Attachments
You can specify the direction to move a particular object within an assembly by adding two `Class.Attachment` objects to the assembly, then configuring their alignment and orientation in the 3D space. The sample [Moving Objects](https://www.roblox.com/games/17560154079/UCT-Linear-Movement) experience aligns two attachments along the world's X axis near the position of where the unanchored log overlaps with the anchored part, and orients each attachment's primary axis to face the world's negative X axis.
@@ -219,7 +219,7 @@ To configure attachments for the prismatic constraint:
-#### Configure constraint
+#### Configure Constraint
Now that your attachments are aligned on the same axis and face the same direction you want the log to move, you can configure the properties of a `Class.PrismaticConstraint` constraint to specify whether to apply the target constant linear velocity in the positive or negative direction of each attachment's' primary axis, the amount of studs you want the attachments to move per second, and the maximum amount of force the engine can apply for the log to reach a constant linear velocity.
@@ -256,13 +256,13 @@ To configure a prismatic constraint:
-## Apply an initial linear force
+## Applying an Initial Linear Force
Another way of changing an object's linear velocity is by applying an impulse of force. After the impulse of force, the object either decelerates until it becomes stationary if there is an oppositional force such as friction, or remains in motion with constant linear velocity if there aren't any oppositional forces.
This technique is useful to move objects after a significant gameplay event, such as an explosion or impactful collision, because it provides players instantaneous feedback. To demonstrate, the following subsection teaches you how to launch a player's character upward toward the sky when they collide with a jump pad with an initial impulse that you can adapt with new values to meet your own gameplay requirements.
-### Use ApplyImpulse
+### Using ApplyImpulse
The `Class.BasePart.ApplyImpulse|ApplyImpulse` method applies force on an entire assembly to obtain an initial linear velocity before slowing to a stop when there are oppositional forces. To begin moving the assembly, the method needs to know:
diff --git a/content/en-us/tutorials/use-case-tutorials/physics/create-spinning-objects.md b/content/en-us/tutorials/use-case-tutorials/physics/creating-spinning-objects.md
similarity index 98%
rename from content/en-us/tutorials/use-case-tutorials/physics/create-spinning-objects.md
rename to content/en-us/tutorials/use-case-tutorials/physics/creating-spinning-objects.md
index e2bc89dbe..7a3c04e2f 100644
--- a/content/en-us/tutorials/use-case-tutorials/physics/create-spinning-objects.md
+++ b/content/en-us/tutorials/use-case-tutorials/physics/creating-spinning-objects.md
@@ -1,5 +1,5 @@
---
-title: Create spinning objects
+title: Creating Spinning Objects
description: Explains the process of creating dynamic motion by spinning objects.
---
@@ -17,7 +17,7 @@ Using the [Spinning Objects](https://www.roblox.com/games/16550477904/Spinning-O
You can create your own assemblies using basic parts or meshes from third-party modeling tools, then follow along with your own assets. For information on exporting meshes for use in Studio, see [Exporting Requirements](../../../art/modeling/export-requirements.md).
-## Angular motion and physical forces
+## Angular Motion and Physical Forces
Roblox Studio is a real-world simulation engine that emulates physical behavior in real time, so in order to predict the behavior of spinning objects in experiences, it's important to have a high-level understanding of how objects spin in real life with angular motion.
@@ -59,7 +59,7 @@ This is because torque needs to be _greater_ than any directional physical force
The following sections dive deeper into these concepts as you learn how to spin objects at either a constant or initial angular velocity with the necessary torque to overcome any oppositional physical forces within the environment. As you review these physics concepts with the upcoming techniques, you can more accurately predict how to adjust property values to achieve any ideal spinning behavior in Studio.
-## Maintain a constant angular force
+## Maintaining a Constant Angular Force
For an object to reach and maintain a constant angular velocity, it needs an angular force to overcome any oppositional physical forces that either decelerate the object's angular velocity, or cause the object to remain stationary. For example, if you want an object to have an angular velocity of `[0, 12, 0]` in Studio, you need enough torque for the object to reach and maintain `12` radians per second along the Y axis in its environment, or about two full rotations per second.
@@ -78,7 +78,7 @@ The amount of torque you apply to your objects not only depends on oppositional
The following subsections use assemblies of different shapes and sizes to teach you how to spin either an entire object or only a portion of the object. As you experiment with different property values, you will learn how to estimate the maximum amount of torque you need for assemblies in your own experiences.
-### Use AngularVelocity constraints
+### Using AngularVelocity Constraints
`Class.AngularVelocity` objects are a type of [mover constraint](../../../physics/mover-constraints.md) that apply torque on an entire assembly to maintain a constant angular velocity. To begin spinning the assembly, the `Class.AngularVelocity` constraint needs to know:
@@ -90,7 +90,7 @@ To demonstrate this process, you will add a block to your workspace with an atta
-#### Add attachment
+#### Add Attachment
You can specify the fixed point to spin an assembly by adding an `Class.Attachment` object to the assembly, then configuring the attachment's position in the 3D space. The sample [Spinning Objects](https://www.roblox.com/games/16550477904/Spinning-Objects) experience places an attachment in the center of a block part so that the constraint can spin the part counterclockwise around the center of itself.
@@ -111,7 +111,7 @@ To add an attachment:
-#### Configure constraint
+#### Configure Constraint
Now that your block has a fixed point to spin the block, you can configure the properties of an `Class.AngularVelocity` constraint to specify the rotational direction, axis or axes to apply a target constant angular velocity, the amount of radians you want the block to spin per second, and the maximum amount of torque the engine can apply for the block to reach a constant angular velocity.
@@ -154,7 +154,7 @@ However, if your block is a larger size and on grass terrain, you need to increa
-### Use HingeConstraint constraints
+### Using HingeConstraint Constraints
`Class.HingeConstraint` objects are a type of [mechanical constraint](../../../physics/mechanical-constraints.md) that allows two attachments to rotate around one axis, constraining the attachments to the same position and their primary axes in the same direction. When you set `Class.HingeConstraint.ActuatorType` to **Motor**, this constraint applies torque on the two attachments with the goal of the attachments reaching and maintaining a constant angular velocity.
@@ -173,7 +173,7 @@ To demonstrate this process, you will add a propeller assembly with two objects
-#### Get propeller asset
+#### Get Propeller Asset
The **Creator Store** is a tab of the Toolbox that you can use to find all assets that are made by Roblox and the Roblox community for use within your projects, including model, image, mesh, audio, plugin, video, and font assets. You can use the Creator Store to add an individual asset or asset library directly into an open experience.
@@ -198,7 +198,7 @@ To get this propeller asset from your inventory into your experience:
-#### Configure attachments
+#### Configure Attachments
You can specify both the position of where you want the attachments to overlap and the direction of rotational movement to spin a particular object within an assembly by adding two `Class.Attachment` objects to the assembly, then configuring their alignment and orientation in the 3D space.
@@ -222,7 +222,7 @@ To configure attachments for the hinge constraint:
-#### Configure constraint
+#### Configure Constraint
Now that your attachments have position to overlap and a direction of rotational movement, you can configure the properties of a `Class.HingeConstraint` constraint to specify the amount of radians you want the attachment to spin per second, and the maximum amount of torque the engine can apply for the attachment to reach a constant angular velocity.
@@ -258,13 +258,13 @@ To configure a hinge constraint:
-## Apply an initial angular force
+## Applying an Initial Angular Force
Another way of changing an object's angular velocity is by applying an impulse of angular force. After the impulse of angular force, the object either decelerates until it becomes stationary if there is an oppositional force such as friction, or remains in motion with constant velocity if there aren't any oppositional forces.
This technique is useful to spin objects after a significant gameplay or weather event, such as a strong gust of wind, because it provides players instantaneous feedback. To demonstrate, the following subsection teaches you how to spin an assembly with an initial random angular force that you can adapt with new values to meet your own gameplay requirements.
-### Use ApplyAngularImpulse
+### Using ApplyAngularImpulse
The `Class.BasePart.ApplyAngularImpulse|ApplyAngularImpulse` method applies torque on an entire assembly to obtain an initial angular velocity before slowing to a stop. To begin spinning the assembly, the method needs to know:
diff --git a/content/en-us/tutorials/use-case-tutorials/scripting/basic-scripting/deadly-lava.md b/content/en-us/tutorials/use-case-tutorials/scripting/basic-scripting/deadly-lava.md
index c94d81371..9f489ed95 100644
--- a/content/en-us/tutorials/use-case-tutorials/scripting/basic-scripting/deadly-lava.md
+++ b/content/en-us/tutorials/use-case-tutorials/scripting/basic-scripting/deadly-lava.md
@@ -1,17 +1,17 @@
---
-title: Deadly lava
+title: Deadly Lava
description: The process for creating a lava floor that kills players on contact.
next: /tutorials/scripting/basic-scripting/fading-trap
prev: /tutorials/scripting/basic-scripting/intro-to-scripting
---
-In [Introduction to scripting](./intro-to-scripting.md), you learned how to make changes in an experience in a loop over time. What if you want to make changes based on user behavior? In this tutorial, you'll learn how to make a deadly lava floor which kills users when they step on it.
+In [Introduction to Scripting](./intro-to-scripting.md), you learned how to make changes in an experience in a loop over time. What if you want to make changes based on user behavior? In this tutorial, you'll learn how to make a deadly lava floor which kills users when they step on it.
-## Set up
+## Setting Up
You need a place in your world to put the deadly lava. If you followed the [Introduction to Scripting](./intro-to-scripting.md) course, the lava floor would fit nicely in the gap covered by the disappearing platforms.
@@ -37,7 +37,7 @@ You need a place in your world to put the deadly lava. If you followed the [Intr
local lava = script.Parent
```
-## Connect to an event
+## Connecting to an Event
Use an **event** to detect when a user touches the lava. Every part has a `Touched` event that fires when something touches it. You can **connect** to this event to run a function when it fires.
@@ -57,7 +57,7 @@ Use an **event** to detect when a user touches the lava. Every part has a `Touch
Any code you write in the `kill` function will now run whenever something touches the lava. Note that a **colon** is used for the `Connect` function, **not** a dot - don't worry about why at this point, just remember the difference.
-## Get the touching part
+## Getting the Touching Part
To kill the user, the function will need an object associated with that user. A part's `Touched` event can provide the "other part" that touched it — but only if you request it by making it a **parameter** of the function.
@@ -75,7 +75,7 @@ lava.Touched:Connect(kill)
When the `kill` function is called, the `otherPart` parameter will represent the part that touched the lava floor, and the code you'll write in the function will be able to use it.
-## Character and humanoid
+## Character and Humanoid
When a user touches the lava, Roblox can detect the specific body part of the user that touched it, such as the left leg or right foot. This part is in the user's **Character** model, which contains all of the objects that make up the user's avatar in the experience, including:
@@ -109,7 +109,7 @@ end
lava.Touched:Connect(kill)
```
-## Check the humanoid
+## Checking the Humanoid
You can easily check if the Humanoid was found using an **if** statement. The code in an if statement will only run if the condition defined in the first line is true.
@@ -133,7 +133,7 @@ lava.Touched:Connect(kill)
In Lua, any value other than false or nil (an empty value) is evaluated as true in a conditional statement, so in this case you can use `humanoid` directly as the condition.
-## Set character health
+## Setting Character Health
Now that the `Class.Humanoid` has been checked, its properties can be changed. If you set its `Health` property to **0**, the associated Character dies. In the body of the if statement, set the `Health` property of humanoid to 0.
@@ -151,7 +151,7 @@ lava.Touched:Connect(kill)
With that, your lava floor is complete! Test your experience and you should find that your deadly lava successfully kills users on contact. Try using your lava as an extra challenge in an obby, or as a boundary for a world.
-## Final code
+## Final Code
```lua
local lava = script.Parent
diff --git a/content/en-us/tutorials/use-case-tutorials/scripting/basic-scripting/fading-trap.md b/content/en-us/tutorials/use-case-tutorials/scripting/basic-scripting/fading-trap.md
index 1b3bcabb9..df0ebece4 100644
--- a/content/en-us/tutorials/use-case-tutorials/scripting/basic-scripting/fading-trap.md
+++ b/content/en-us/tutorials/use-case-tutorials/scripting/basic-scripting/fading-trap.md
@@ -1,7 +1,7 @@
---
-title: Fading trap
+title: Fading Trap
description: The process for creating a platform that fades away when a player steps on it.
-next: /tutorials/scripting/basic-scripting/score-points
+next: /tutorials/scripting/basic-scripting/scoring-points
prev: /tutorials/scripting/basic-scripting/deadly-lava
---
@@ -11,7 +11,7 @@ In [Deadly Lava](./deadly-lava.md), you learned how to trigger code based on use
-## Listen for players
+## Listening for Players
In Roblox, a **service** is an object which performs a range of useful functions. The `Class.Players` service has an event called `Class.Players.PlayerAdded|PlayerAdded` that you can use to set up points for each user who joins the experience.
@@ -56,7 +56,7 @@ When declaring a variable to contain a service, it's best to name it with the ex
-## Create a stats folder
+## Create a Stats Folder
To make a user's points display in the leaderboard, all you need to do is create a new `Class.Folder` in their `Class.Player` object called `"leaderstats"` and put their points in there. New objects can be created from within a script via the `Datatype.Instance.new()` function.
@@ -89,7 +89,7 @@ Make sure you name the folder **exactly** as it is shown here (`"leaderstats"`)
-## Create the points
+## Creating the Points
The leaderboard system reads any values in the `leaderstats` folder and displays whatever it finds.
@@ -119,7 +119,7 @@ Players.PlayerAdded:Connect(onPlayerAdded)
Test your experience and you should see the leaderboard appear in the top right with the names of your users and a points score next to them.
-## Count time
+## Counting Time
Each user should earn a point for each second they are alive. A `while` loop and the `Library.task.wait()` function can be used to update the value of points every second.
@@ -134,7 +134,7 @@ while true do
end
```
-## Player list
+## Player List
To run code for every user in the experience, you need to iterate through the **array** of users returned by the `Class.Players:GetPlayers()|GetPlayers` function.
@@ -153,7 +153,7 @@ while true do
end
```
-## Award points
+## Awarding Points
To award a point to each user in the for loop, you'll need to get the user out of the array and add 1 to the **Points** object stored in their `leaderstats` folder.
@@ -181,7 +181,7 @@ Test your experience and you should find that the leaderboard shows your player'
-## Restore health
+## Restoring Health
To begin with, the script needs to restore a player's health. This pattern should be familiar to you from the [Deadly Lava](../basic-scripting/deadly-lava.md) tutorial.
@@ -62,7 +62,7 @@ The code here calls `Class.Instance:FindFirstChildWhichIsA()|FindFirstChildWhich
-## Get the pickups folder
+## Getting the Pickups Folder
The folder holding the health pickups may not have loaded into the game by the time the script runs. `WaitForChild` can be used to pause the script and get the HealthPickups folder when it loads.
@@ -86,7 +86,7 @@ When called on a folder, the `GetChildren` function will return an array of the
end
```
-## Loop with ipairs
+## Looping with ipairs
`onTouchHealthPickup` needs to be called for each health pickup in the array. To do this efficiently, a new kind of loop syntax will be used.
@@ -137,11 +137,11 @@ A health bar should appear in the top right which will disappear when the player
-## Create the frame
+## Create the Frame
To display UI elements on every player's screen, you can create a `Class.ScreenGui` object in the `Class.StarterGui` service. `Class.ScreenGui` objects are the primary containers for on-screen UI, and the `Class.StarterGui` service copies its contents to each player's `Class.PlayerGui` container as they enter an experience.
@@ -66,7 +66,7 @@ To recreate the frame container within the sample [Gold Rush](https://www.roblox
1. Set **FillDirection** to **Horizontal**.
1. Set **VerticalAlignment** to **Center**.
-## Add an icon
+## Add an Icon
An icon is a symbol that represents an action, object, or concept in an experience. Using icons that are simple and intuitive allows players to easily recognize what you're communicating with your UI without using text, which can clutter the screen and pull attention away from content that matters.
@@ -89,7 +89,7 @@ To recreate the gold crown icon within the sample [Gold Rush](https://www.roblox
-## Insert score text
+## Insert Score Text
Score text records the player's score within an experience, such as how many points they earn within a match. It's important that all UI text is both clear and easy to read so players can quickly understand the information they need to be successful within your experience.
@@ -115,7 +115,7 @@ To recreate the score text within the sample [Gold Rush](https://www.roblox.com/
-## Test the design
+## Test the Design
Studio's **Device Emulator** allows you to test how players will see and interact with your UI on various devices. This tool is a vital part of designing UI because the aspect ratio of your viewport in Studio doesn't necessarily reflect the aspect ratio of the screens players use to access your experience, and it's important that your UI is both legible and accessible on every device.
diff --git a/content/en-us/tutorials/use-case-tutorials/ui/create-hud-meters.md b/content/en-us/tutorials/use-case-tutorials/ui/creating-hud-meters.md
similarity index 97%
rename from content/en-us/tutorials/use-case-tutorials/ui/create-hud-meters.md
rename to content/en-us/tutorials/use-case-tutorials/ui/creating-hud-meters.md
index d2a6b3415..57f04c0f5 100644
--- a/content/en-us/tutorials/use-case-tutorials/ui/create-hud-meters.md
+++ b/content/en-us/tutorials/use-case-tutorials/ui/creating-hud-meters.md
@@ -1,5 +1,5 @@
---
-title: Create HUD meters
+title: Creating HUD Meters
description: Learn how to build a custom HUD meter to replace the default character health meter.
---
@@ -17,17 +17,17 @@ Using [Hazardous Space Station](https://www.roblox.com/games/99416825187098/Haza
- How to replace the default Roblox health meter with your own meter and hook it up to the character's health level.
- How to animate the center portion of the health meter and set its color between five color gradient keypoints (red, orange, yellow, lime, green).
-## Use the Device Emulator
+## Using the Device Emulator
Roblox is inherently cross-platform, as players can discover and join experiences on a PC or console, then later pick up their phone and continue where they left off. Mobile devices (phones and tablets) have the least amount of screen space, so it's important that your UI elements fit on smaller screens and that they're clearly visible to players.
-The best way to test UI designs across platforms is Studio's [Device Emulator](../../../studio/test-modes.md#device-emulation). This tool provides a preset selection of devices and allows you to add your own custom presets.
+The best way to test UI designs across platforms is Studio's [Device Emulator](../../../studio/testing-modes.md#device-emulation). This tool provides a preset selection of devices and allows you to add your own custom presets.
1. Open the [Hazardous Space Station](https://www.roblox.com/games/99416825187098/Hazardous-Space-Station) template in Studio.
@@ -35,7 +35,7 @@ The best way to test UI designs across platforms is Studio's [Device Emulator](.
-## Create a screen container
+## Create a Screen Container
A `Class.ScreenGui` container holds UI objects (`Class.GuiObject|GuiObjects`) to display on a player's screen (in this tutorial, the entirety of the health meter). To display a `Class.ScreenGui` and its child objects to every player who joins the experience, place it inside the `Class.StarterGui` container. When a player joins and their character first spawns, the `Class.ScreenGui` and its contents clone into the `Class.PlayerGui` container for that player, located within the `Class.Players` container.
@@ -43,7 +43,7 @@ A `Class.ScreenGui` container holds UI objects (`Class.GuiObject|GuiObjects`) to
To insert an empty `Class.ScreenGui`:
-1. In the **Explorer** window, locate the `Class.StarterGui` container.
+1. In the [Explorer](../../../studio/explorer.md) window, locate the `Class.StarterGui` container.
@@ -55,7 +55,7 @@ To insert an empty `Class.ScreenGui`:
-### Utilize safe areas
+### Utilize Safe Areas
Modern phones take advantage of the entire screen but typically include notches, cutouts, and other elements that occupy screen space. Every Roblox experience also includes the **top bar controls** for quick access to the main menu, [chat](../../../chat/in-experience-text-chat.md), [leaderboard](../../../players/leaderboards.md), and more.
@@ -90,7 +90,7 @@ While the default of `Enum.ScreenInsets|CoreUISafeInsets` ensures all UI objects
-### Set edge padding
+### Set Edge Padding
With `Class.ScreenGui.ScreenInsets|ScreenInsets` set to `Enum.ScreenInsets|DeviceSafeInsets`, content can now extend directly up to the physical top edge of the screen. However, a small amount of **padding** can help push the health meter (and other objects inside the container) slightly away from the screen edges for a cleaner appearance and to prevent them from being clipped.
@@ -106,13 +106,13 @@ One way to apply padding to a UI container is through the insertion of a `Class.
-## Construct the health meter
+## Construct the Health Meter
With the [screen container configured](#create-a-screen-container), you can begin constructing the health meter using Roblox UI objects such as [frames](../../../ui/frames.md) and an [image label](../../../ui/labels.md).
-### Create the parent frame
+### Create the Parent Frame
Similar to design applications like Figma and Photoshop, a `Class.Frame` in Roblox serves as a container for other UI objects. For this tutorial, the entire health meter will be contained in a single parent frame, making it simple to reposition across various HUD layouts.
@@ -128,7 +128,7 @@ Similar to design applications like Figma and Photoshop, a `Class.Frame` in Robl
-### Position the frame
+### Position the Frame
In Roblox, the position of a UI object is represented by a `Datatype.UDim2` coordinate set containing `Datatype.UDim.Scale|Scale` and `Datatype.UDim.Offset|Offset` values for both the **X** and **Y** axes:
@@ -145,7 +145,7 @@ To position a UI object in the upper-right corner of the screen container, `Data
-Additionally, you'll need to set an upper-right [anchor point](../../../ui/position-and-size.md#anchorpoint) for the parent frame to define its origin point. Acceptable values are between `0` and `1`, relative to the size of the object, so an anchor value of 
@@ -159,7 +159,7 @@ Additionally, you'll need to set an upper-right [anchor point](../../../ui/posit
-### Resize the frame
+### Resize the Frame
Like position, the `Class.Frame.Size|Size` of a UI object is represented by a `Datatype.UDim2` coordinate set containing `Datatype.UDim.Scale|Scale` and `Datatype.UDim.Offset|Offset` values for both the **X** and **Y** axes.
@@ -171,7 +171,7 @@ By default, the new frame's size is 
-### Create the inner fill
+### Create the Inner Fill
Now that the health meter's containing frame is complete, you can add an **inner fill** portion to represent the character's variable health. Since it only needs to be a solid‑filled region, a sub‑child `Class.Frame` inside the parent frame is suitable.
@@ -238,7 +238,7 @@ Now that the health meter's containing frame is complete, you can add an **inner
-### Add the icon
+### Add the Icon
To more clearly indicate the purpose of the meter, you can add an [image label](../../../ui/labels.md) to the left side, in this case a red heart which commonly symbolizes health or life.
@@ -254,7 +254,7 @@ To more clearly indicate the purpose of the meter, you can add an [image label](
-4. Locate the icon's `Class.ImageLabel.Image|Image` property and enter `rbxassetid://91715286435585`, the reference to a pre‑uploaded heart image (if desired, you can [import](../../../projects/assets/manager.md#import-assets) your own image and use its asset ID).
+4. Locate the icon's `Class.ImageLabel.Image|Image` property and enter `rbxassetid://91715286435585`, the reference to a pre‑uploaded heart image (if desired, you can [import](../../../projects/assets/manager.md#importing-assets) your own image and use its asset ID).
@@ -271,7 +271,7 @@ To more clearly indicate the purpose of the meter, you can add an [image label](
-### Constrain the size
+### Constrain the Size
While a [scale height](#resize-the-frame) of `0.05` (5%) looks good on modern phone screens and gaming monitors which are 16:9 aspect ratio or wider, the meter may look slightly too tall on tablet screens and older phones. You can check this by emulating a tablet like **iPad 7th Generation** from the **Device Emulator**.
@@ -300,13 +300,13 @@ Now, the meter bar maintains a more consistent height between wider and taller s
-## Replace the default health meter
+## Replace the Default Health Meter
Roblox experiences include a default health meter which becomes visible when characters take damage. If you keep the default meter visible, it will duplicate and potentially overlap the custom meter.
-### Disable the default meter
+### Disable the Default Meter
To disable the default health meter, you'll use a **client script** (`Class.LocalScript`) within `Class.StarterPlayerScripts` that calls `Class.StarterGui:SetCoreGuiEnabled()`.
@@ -357,7 +357,7 @@ If you playtest the experience now and take damage, you'll notice that the defau
-### Listen for health changes
+### Listen for Health Changes
All default Roblox character models contain a `Class.Humanoid` class which provides special behaviors and functionality to the character, such as setting its walk/run speed and managing its health. `Class.Humanoid.Health|Health` changes on the server [replicate](../../../projects/client-server.md#replication) to each player's client and you can detect these changes to update both the size and color of the custom health meter.
@@ -482,7 +482,7 @@ If you playtest the experience now, you'll notice that the custom meter correctl
By default, the Roblox health metering system includes a gradual healing effect which allows characters to slowly regenerate health. If you wish to disable this effect, insert an empty `Class.Script` named **Health** into the `Class.StarterCharacterScripts` container. This will prevent the default internal script from loading for each player character, effectively removing the regeneration effect.
-### Animate the meter bar
+### Animate the Meter Bar
To add an extra level of polish to the custom meter, you can animate health changes through **tweening**, gradually changing the meter bar's size and color over ½ second.
@@ -589,7 +589,7 @@ If you playtest the experience now, you'll notice that the custom meter tweens b
-### Add a damage effect
+### Add a Damage Effect
The default health meter system includes a brief, subtle red tint on the screen edges when the character is damaged. By [disabling the default meter](#disable-the-default-meter), this effect is removed, but you can replace it with your own implementation.
@@ -691,7 +691,7 @@ The default health meter system includes a brief, subtle red tint on the screen
```
@@ -17,15 +17,15 @@ Using [UI Fundamentals - HUD Meter](https://www.roblox.com/games/1045069158
- How to connect buttons to player activation to toggle in/out the settings menu.
- How to connect draggable UI sliders to adjust the volume of sound effects and background ambience separately.
-## Use the Device Emulator
+## Using the Device Emulator
-As noted in [Create HUD Meters](../ui/create-hud-meters.md), phones and tablets have the least amount of screen space, so it's important that your UI elements fit on smaller screens and that they're clearly visible to players. If you haven't done so already, enable the [Device Emulator](../../../studio/test-modes.md#device-emulation) in Studio:
+As noted in [Creating HUD Meters](../ui/creating-hud-meters.md), phones and tablets have the least amount of screen space, so it's important that your UI elements fit on smaller screens and that they're clearly visible to players. If you haven't done so already, enable the [Device Emulator](../../../studio/testing-modes.md#device-emulation) in Studio:
1. Open the [UI Fundamentals - HUD Meter](https://www.roblox.com/games/104506915856758/UI-Fundamentals-HUD-Meter) template in Studio.
@@ -51,7 +51,7 @@ To construct the settings button:
-3. With the new button selected, set the following in the **Properties** window:
+3. With the new button selected, set the following in the [Properties](../../../studio/properties.md) window:
- `Class.ImageButton.AnchorPoint|AnchorPoint` = `0.5, 0.25` (horizontal center and vertical upper quarter)
- `Class.ImageButton.BackgroundTransparency|BackgroundTransparency` = `1` (fully transparent)
@@ -76,7 +76,7 @@ To construct the settings button:
-## Create the settings menu
+## Create the Settings Menu
-### Create the parent frame
+### Create the Parent Frame
-As noted in [Create HUD Meters](../ui/create-hud-meters.md), a `Class.Frame` serves as a container for other UI objects. The entire settings menu will be constructed with a single parent frame, making it simple to manage as a stateful object that reacts to input differently depending on the current state.
+As noted in [Creating HUD Meters](../ui/creating-hud-meters.md), a `Class.Frame` serves as a container for other UI objects. The entire settings menu will be constructed with a single parent frame, making it simple to manage as a stateful object that reacts to input differently depending on the current state.
1. Insert a `Class.Frame` into **HUDContainer** and rename it **SettingsMenu**.
@@ -137,7 +137,7 @@ As noted in [Create HUD Meters](../ui/create-hud-meters.md), a `Class.Frame` ser
-### Construct a slider
+### Construct a Slider
To allow players to adjust volume levels, the settings menu will contain two draggable **slider widgets** powered by `Class.UIDragDetector`, a convenient object that facilitates interaction with 2D user interface elements.
@@ -169,7 +169,7 @@ To create a parent container for the first slider:
- `Class.UIListLayout.HorizontalFlex|HorizontalFlex` = `Enum.UIFlexAlignment.Fill|Fill` (resize elements horizontally to fill the entire parent container, overriding their defined width)
- `Class.UIListLayout.VerticalAlignment|VerticalAlignment` = `Enum.VerticalAlignment.Center|Center` (align elements along their vertical center)
-#### Slider icon
+#### Slider Icon
A simple icon including an audio note and "burst" symbol helps players identify the slider's purpose when they open the settings menu.
@@ -195,7 +195,7 @@ A simple icon including an audio note and "burst" symbol helps players identify
-#### Range frame
+#### Range Frame
Directly to the right of the [icon](#slider-icon), the interactive portion of the slider should be contained within another `Class.Frame`.
@@ -228,7 +228,7 @@ Directly to the right of the [icon](#slider-icon), the interactive portion of th
-#### Interactive handle
+#### Interactive Handle
With the [slider container](#range-frame) constructed, you can now create a **draggable handle** for players to interact with during gameplay.
@@ -278,7 +278,7 @@ If you playtest the experience now, you'll be able to drag the handle left and r
-#### Inner fill
+#### Inner Fill
To more clearly indicate that the slider controls a 0% to 100% range, you can add an **inner fill** to the left side of the container which will sync with the handle's variable position.
@@ -310,7 +310,7 @@ To more clearly indicate that the slider controls a 0% to 100% range, you can ad
-### Duplicate the slider
+### Duplicate the Slider
With the [first slider](#construct-a-slider) constructed, you can easily duplicate it and modify some visual aspects to indicate another purpose, in this case the volume level of background audio symbolized by an icon of musical notes.
@@ -367,7 +367,7 @@ With the [first slider](#construct-a-slider) constructed, you can easily duplica
-### Create the close button
+### Create the Close Button
The final element of the settings menu is a **close button** which provides players an additional input to close the menu (the **SettingsButton** in the top‑center will serve the same purpose).
@@ -394,11 +394,11 @@ The final element of the settings menu is a **close button** which provides play
-## Create the control modules
+## Create the Control Modules
An extensible **control module** setup makes interactive UI management more streamlined than individual scripts placed within each object. `Class.ModuleScript|ModuleScripts` facilitate this extensible functionality by letting you reuse code between scripts on different sides of the client‑server boundary or the same side of the boundary.
-### Stateful object controller
+### Stateful Object Controller
The following stateful object controller module lets you attach behavior to UI objects such as **SettingsButton** and **SettingsMenu**, and easily toggle/tween between various states. To create the module:
@@ -491,7 +491,7 @@ The following stateful object controller module lets you attach behavior to UI o
-### Slider controller
+### Slider Controller
An additional module initializes and controls the two volume sliders. It also allows you to connect a callback function to each slider in order to detect player interaction with the slider and apply desired changes in the experience.
@@ -591,7 +591,7 @@ An additional module initializes and controls the two volume sliders. It also al
-## Create the settings script
+## Create the Settings Script
With the [settings button](#create-the-settings-button) and [settings menu](#create-the-settings-menu) finalized, you can hook everything together with a single script that utilizes the [control modules](#create-the-control-modules).
diff --git a/content/en-us/tutorials/use-case-tutorials/ui/proximity-prompts.md b/content/en-us/tutorials/use-case-tutorials/ui/proximity-prompts.md
index b719ccc81..8a2e15f74 100644
--- a/content/en-us/tutorials/use-case-tutorials/ui/proximity-prompts.md
+++ b/content/en-us/tutorials/use-case-tutorials/ui/proximity-prompts.md
@@ -1,5 +1,5 @@
---
-title: Add proximity prompts
+title: Adding Proximity Prompts
description: The process for creating an interactive prompt that triggers an action on user input.
---
@@ -13,7 +13,7 @@ This tutorial uses the [Dungeon Delve](https://www.roblox.com/games/6749940622/D
-## Create a prompt
+## Create a Prompt
On-screen prompts are generated by a `Class.ProximityPrompt` object parented to an `Class.Attachment`, `Class.BasePart`, or `Class.Model`.
@@ -43,7 +43,7 @@ On-screen prompts are generated by a `Class.ProximityPrompt` object parented to
-### Prompt appearance
+### Prompt Appearance
Prompts consist of three primary elements, each of which can be controlled by the following properties:
@@ -64,7 +64,7 @@ To customize the appearance of the prison door prompt, make the following change
-### Activation distance
+### Activation Distance
Prompts appear when the user's **character** moves within the defined **MaxActivationDistance** range of the prompt object's parent.
@@ -74,7 +74,7 @@ The default value works well in most cases, but you can push user interaction cl
-### Hold duration
+### Hold Duration
The **HoldDuration** property value determines how quickly the prompt's action is triggered, in seconds. Since this door must be picked to unlock it, change the **HoldDuration** property to **4**.
@@ -84,7 +84,7 @@ The **HoldDuration** property value determines how quickly the prompt's action i
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-### Additional properties
+### Additional Properties
To further improve the sparkle effect, try the following property values.
diff --git a/content/en-us/tutorials/use-case-tutorials/vfx/create-volcanoes.md b/content/en-us/tutorials/use-case-tutorials/vfx/creating-volcanoes.md
similarity index 99%
rename from content/en-us/tutorials/use-case-tutorials/vfx/create-volcanoes.md
rename to content/en-us/tutorials/use-case-tutorials/vfx/creating-volcanoes.md
index b18d620f7..4300d2510 100644
--- a/content/en-us/tutorials/use-case-tutorials/vfx/create-volcanoes.md
+++ b/content/en-us/tutorials/use-case-tutorials/vfx/creating-volcanoes.md
@@ -1,5 +1,5 @@
---
-title: Create volcanic eruptions with VFX
+title: Creating Volcanic Eruptions with VFX
description: The process of creating volcanoes to elevate your visual and gameplay requirements.
---
@@ -28,7 +28,7 @@ You can create your own textures in third-party texture creation tools and follo
-## Break down reference
+## Break Down Reference
To create credible volcanoes, it's important to reference real-world volcanic eruptions in the design process because it allows you to break down the subject matter into individual components with distinct visual and behavioral characteristics. For example, the sample [Volcano Island - Complete](https://www.roblox.com/games/17374256579/Volcano-Island-Complete) experience references the volcanic eruption in Iceland to inform all texture and VFX design decisions relating to the caldera and its surrounding terrain.
@@ -53,7 +53,7 @@ It's useful to break down a volcano that's erupting into individual components s
The following sections provide an in-depth analysis of the different design decisions and techniques you can use to recreate each of these components. As you review these decisions and experiment with various lighting, `Class.ParticleEmitter`, and `Class.Beam` properties, you will learn how to utilize lighting and VFX to solve the unique environmental requirements for your own experiences.
-## Configure lighting
+## Configure Lighting
To make an environmental element a point of interest within your experience, it's important to increase its contrast against the overall environment so that it stands out as something that players should explore. For example, to draw players into the caldera, you can configure your lighting sources so that the volcano's lava appears to glow as the only light source within an otherwise dark environment.
@@ -75,7 +75,7 @@ This section of the tutorial teaches you how to utilize both types of lighting s
-### Local lighting
+### Local Lighting
Local lighting is the luminescence from local [light sources](../../../effects/light-sources.md) in your experience, such as `Class.SpotLight`, `Class.SurfaceLight`, and `Class.PointLight` objects. Local lighting is important to add to your volcano because while you can apply brightness to your `Class.ParticleEmitter` and `Class.Beam` textures, they cannot fill the canyon with enough light alone to realistically simulate how the caldera and its flowing lava would illuminate the environment in the real world.
@@ -179,11 +179,11 @@ To recreate the global lighting in the sample [Volcano Island - Complete](https:
-## Configure volcano
+## Configure Volcano
Now that your local and global lighting configuration is complete, it's time to configure all of the VFX objects relating to the actual volcano and its surrounding terrain. As you follow these instructions that exactly recreate the final environment within the sample [Volcano Island](https://www.roblox.com/games/17374256579/Volcano-Island-Complete) `.rbxl` file, observe how each step works together to add character, movement, and illuminance to the environment.
-### Surface ripples
+### Surface Ripples
**Surface ripples** are the small lava waves that flow across the surface of the caldera as a result of internal magma and pressurized gasses moving upward from beneath the earth's crust. This visual phenomenon conveys the real-world physical process of convection, or the movement within a fluid when hotter fluid rises to the surface, and it adds to the realism of your scene.
@@ -352,7 +352,7 @@ To recreate the glowing embers from the surface of the caldera in the sample [Vo
-### Lava splashes
+### Lava Splashes
**Lava splashes** are bursts of thin molten rock that erupt upward from the volcano as a result of internal magma and pressurized gasses applying enough force to break the surface tension of the lava on top of the caldera. This core component of a volcano is one of the most common signs in determining that a volcano is no longer dormant and is actively erupting.
@@ -480,7 +480,7 @@ To recreate the splashing lava from the surface of the caldera in the sample [Vo
Features with custom textures such as flipbooks cost memory to render. If you use many flipbooks with other features that use high memory, then clients automatically deactivate flipbooks when they are low on memory, which is likely for older mobile phones. To reduce the memory usage of flipbooks, use fewer unique animated particle effects or choose a texture of smaller resolution.
-### Lava flow
+### Lava Flow
A **lava flow** is a mass of lava that erupts and oozes away from the caldera and across the earth's surface during a volcanic eruption. As the lava cools due to its exposure to air, it solidifies and transforms into solid rock, creating new land mass.
@@ -609,7 +609,7 @@ To recreate the flowing magma from the caldera in the sample [Volcano Island - C
-### Smoke plume
+### Smoke Plume
A **smoke plume** from the caldera emits warm pressurized gas, steam, and volcanic ash into the atmosphere. This mixture of volcanic emission can be seen for miles in the real world, so volcano designs often incorporate large smoke plumes to be a significant point of interest in the 3D space.
diff --git a/content/en-us/tutorials/use-case-tutorials/vfx/create-waterfalls.md b/content/en-us/tutorials/use-case-tutorials/vfx/creating-waterfalls.md
similarity index 99%
rename from content/en-us/tutorials/use-case-tutorials/vfx/create-waterfalls.md
rename to content/en-us/tutorials/use-case-tutorials/vfx/creating-waterfalls.md
index 544e27a50..faa378af0 100644
--- a/content/en-us/tutorials/use-case-tutorials/vfx/create-waterfalls.md
+++ b/content/en-us/tutorials/use-case-tutorials/vfx/creating-waterfalls.md
@@ -1,5 +1,5 @@
---
-title: Create waterfalls with VFX
+title: Creating Waterfalls with VFX
description: The process of creating waterfalls to elevate your visual and gameplay requirements.
---
@@ -20,7 +20,7 @@ You can create your own textures in third-party texture creation tools and follo
-## Break down reference
+## Break Down Reference
To create credible waterfalls, it's important to reference real-world natural features in the design process because it allows you to break down the subject matter into individual components with distinct visual and behavioral characteristics. For example, the sample [Waterfall Island](https://www.roblox.com/games/16454663889/Use-Case-Tutorials-Volcano-Island) experience references Snoqualmie Falls in Washington state to inform all texture and VFX design decisions relating to the waterfall and its surrounding terrain.
@@ -45,7 +45,7 @@ While a waterfall is a continuous and connected stream of water that involves mu
The following sections provide an in-depth analysis of the different design decisions and techniques you can use to recreate each of these waterfall components that make up the main drop in the sample's 3D space. As you review these decisions and experiment with various `Class.Beam` and `Class.ParticleEmitter` properties, you will learn how to utilize VFX to solve the unique environmental requirements for your own experiences.
-## Configure cascades
+## Configure Cascades
A **cascade** is the falling water that descends over the edge of cliffs or bluffs into underlying plunge pools. Cascades fall at different rates depending on both their volume of water and the scale of their drop into the plunge pool. For example, the sample's main drop appears to fall more slowly because there is a large volume of water falling over a large distance, but the sample's second drop appears to fall more quickly because a smaller volume of water is falling over a short distance.
@@ -217,7 +217,7 @@ To recreate the cascades for the main drop in the sample [Waterfall Island](http
-## Configure splashes
+## Configure Splashes
When cascades impact the density of the underlying plunge pool, the water propels upward from the impact point to create **splashes**. As this aerosolized water propels upward, it expands and breaks apart from itself to produce droplets that scatter in various directions.
@@ -306,7 +306,7 @@ To recreate the splashes at the base of the main drop in the sample [Waterfall I
-## Configure white water
+## Configure White Water
**White water** arises as the water source becomes more turbulent as it gains velocity when approaching its descent and colliding with objects in its path. This results in aerated, webby water that appears white due to more air bubbles in the water source.
@@ -397,7 +397,7 @@ To recreate the white water where the outflow collides with the cliff's boulders
-## Configure foam
+## Configure Foam
Unlike splashes that propel upward as cascades impact the plunge pool, **foam** is aerated water that ripples outward from the base of the impact point. Similar to splashes, foam expands and breaks apart from itself into web-like droplets as it becomes aerosolized.
@@ -452,7 +452,7 @@ To recreate the foam at the base of the main drop in the sample [Waterfall Islan
-## Configure mist
+## Configure Mist
As cascades make impact with the plunge pool, some of the water evaporates and condenses in the cool, humid air to create **mist**. Mist vapors don't catch lighting in the same way that hard surfaces do; instead, they reflect light in often unexpected ways to appear bright within the overall environment until they completely evaporate.
diff --git a/content/en-us/tutorials/use-case-tutorials/vfx/custom-particle-effects.md b/content/en-us/tutorials/use-case-tutorials/vfx/custom-particle-effects.md
index 3c8c29586..e538160e1 100644
--- a/content/en-us/tutorials/use-case-tutorials/vfx/custom-particle-effects.md
+++ b/content/en-us/tutorials/use-case-tutorials/vfx/custom-particle-effects.md
@@ -1,5 +1,5 @@
---
-title: Custom particle effects
+title: Custom Particle Effects
description: The process for creating a multicolor plume of smoke from an active volcano.
---
@@ -9,7 +9,7 @@ Time to look at a more complex example of particle effects. You'll make a multic
-## Particle texture
+## Particle Texture
A `Class.ParticleEmitter` has a property called **Texture** that determines the image that will be repeated in the effect. If you want to use your own image, you'll need to upload it to Roblox and get the **Asset ID** to paste into that property. See [Textures and Decals](../../../parts/textures-decals.md) for more details.
@@ -48,7 +48,7 @@ For a smoke effect, a circle with faded edges works well. A pre-made example of
-## Fading effect
+## Fading Effect
Despite the change of texture, the volcano effect still doesn't look much like smoke. It would look better if the particles faded out over time in the same way that smoke dissipates in the air.
@@ -72,7 +72,7 @@ Some emitter properties can be set up to change over time with a **sequence**. S
-## Configure attachments
+## Configure Attachments
Before you add a `Class.Beam` object to your blaster, it's important to configure two `Class.Attachment` objects in the 3D space to represent the reach of the laser's emission from the blaster's emitter bulb. Beams operate by rendering a texture between attachments, so if you don't have attachments for the beam to reference, it cannot function at all.
@@ -99,7 +99,7 @@ To configure attachments for the laser beam:
-## Customize the beam
+## Customize the Beam
Now that you have `Class.Attachment` objects in the 3D space, you can add and customize a `Class.Beam` object to emulate the visual characteristics of a laser beam. This tutorial provides guidance on how to create a futuristic, bright pink beam that animates quickly, but by experimenting with the same properties, you can create a variety of different special effects.
@@ -132,7 +132,7 @@ To customize the beam:
For more information on all beam properties you can customize, see [Beams](../../../effects/beams.md).
-## Script damage behavior
+## Script Damage Behavior
Your laser beam is currently aesthetically pleasing for its environment, but it's also completely harmless as a blaster weapon. To modify the laser blaster so that it can deal damage to players, you must add in a script to the collision box that triggers this behavior.
diff --git a/content/en-us/tutorials/use-case-tutorials/vfx/use-particles-for-explosions.md b/content/en-us/tutorials/use-case-tutorials/vfx/using-particles-for-explosions.md
similarity index 97%
rename from content/en-us/tutorials/use-case-tutorials/vfx/use-particles-for-explosions.md
rename to content/en-us/tutorials/use-case-tutorials/vfx/using-particles-for-explosions.md
index b5ae296f5..3101fb207 100644
--- a/content/en-us/tutorials/use-case-tutorials/vfx/use-particles-for-explosions.md
+++ b/content/en-us/tutorials/use-case-tutorials/vfx/using-particles-for-explosions.md
@@ -1,5 +1,5 @@
---
-title: Create explosions with VFX
+title: Using Particles for Explosions
description: The process for creating a trap that emits a burst of particles when it kills a player.
---
@@ -9,7 +9,7 @@ Previously, you worked with particles that played continuously, like [smoke from
-3. Begin clicking on the screen to add a series of **control points** to form a path. The initial path will likely be imprecise but you can [fine‑tune](#move-points) the position of any control point later.
+3. Begin clicking on the screen to add a series of **control points** to form a path. The initial path will likely be imprecise but you can [fine‑tune](#moving-points) the position of any control point later.
-### Add points
+### Adding Points
New control points can be added to a `Class.Path2D` either between two existing points or from either end point using the **Add Point** tool (P).
@@ -70,19 +70,19 @@ New control points can be added to a `Class.Path2D` either between two existing
Remember that if you drag the mouse after clicking to add a new control point, [tangents](#control-point-tangents) will be created on that point.
-### Delete points
+### Deleting Points
To delete a control point, hover over and right‑click it, then select **Delete Point** from the contextual popup menu.
-### Control point tangents
+### Control Point Tangents
Control point **tangents** let you create and adjust curves on a path.
-#### Add tangents
+#### Adding Tangents
To add tangents to any control point that doesn't already have tangents:
@@ -90,11 +90,11 @@ To add tangents to any control point that doesn't already have tangents:
-2. Hover over the desired control point, then click to add two [mirrored](#break-and-mirror) tangents (optionally drag after clicking to [adjust](#adjust-tangents) the new tangents).
+2. Hover over the desired control point, then click to add two [mirrored](#breaking-and-mirroring) tangents (optionally drag after clicking to [adjust](#adjusting-tangents) the new tangents).
-#### Adjust tangents
+#### Adjusting Tangents
To adjust existing tangents for an individual control point:
@@ -113,9 +113,9 @@ In the [Properties](../studio/properties.md) window, expand the `Class.Path2D.Se
-2. Set the position for `Datatype.Path2DControlPoint.LeftTangent|LeftTangent` and/or `Datatype.Path2DControlPoint.RightTangent|RightTangent`. Note that this will [break the mirrored behavior](#break-and-mirror) of the tangents.
+2. Set the position for `Datatype.Path2DControlPoint.LeftTangent|LeftTangent` and/or `Datatype.Path2DControlPoint.RightTangent|RightTangent`. Note that this will [break the mirrored behavior](#breaking-and-mirroring) of the tangents.
-#### Delete tangents
+#### Deleting Tangents
To delete both tangents from a control point, hover over and right-click that point, then select **Clear Tangents** from the contextual popup menu.
@@ -125,9 +125,9 @@ To delete just one of the tangents (left or right), hover over and right‑click
-#### Break and mirror
+#### Breaking and Mirroring
-By default, tangents mirror each other. When you [drag to adjust](#adjust-tangents) one tangent marker, the paired tangent point will move in unison.
+By default, tangents mirror each other. When you [drag to adjust](#adjusting-tangents) one tangent marker, the paired tangent point will move in unison.
@@ -139,7 +139,7 @@ To "break" the tangents so that each can be moved independently of the other, ho
To re-establish mirror behavior, hover over and right‑click the associated control point, then select **Mirror Tangents** from the contextual menu. Note that you will **not** see an immediate change in the path after re‑establishing mirror behavior, as the system cannot predict which tangent point you want to begin mirroring. Mirror behavior will resume only once you [drag to adjust](#adjusting-tangents) one of the tangent markers.
-## Path visual properties
+## Path Visual Properties
You can customize the visual appearance of a `Class.Path2D` with the following properties:
@@ -181,11 +181,11 @@ You can customize the visual appearance of a `Class.Path2D` with the following p
- 
-### Set offsets
+### Setting Offsets
In Studio, drag the red lines to set the **offsets** from the left, right, top,
and bottom edges of the image.
diff --git a/content/en-us/ui/animation.md b/content/en-us/ui/animation.md
index 27a8ff3f8..3c63a6759 100644
--- a/content/en-us/ui/animation.md
+++ b/content/en-us/ui/animation.md
@@ -1,5 +1,5 @@
---
-title: UI animation/tweens
+title: UI Animation/Tweens
description: Explains how to animate GuiObjects using the process of tweening.
---
@@ -9,7 +9,7 @@ In animation, **tweening** is the process of generating intermediate frames betw
- Sliding UI menus in and out from the screen edges.
- Gradually animating a health bar between two widths when a user receives a health boost.
-## Single-property tweens
+## Single-Property Tweens
### Position
@@ -248,7 +248,7 @@ Multiple properties control UI borders, depending on the object type.
-## Create buttons on the screen
+## Creating Buttons on the Screen
Buttons on a screen are useful to quickly guide users to various menus or pages.
@@ -33,7 +33,7 @@ To add a button to the screen:
-## Create buttons on part faces
+## Creating Buttons on Part Faces
Buttons on a part are useful for allowing users to interact with parts. For
example, you can let users step on a button to complete an action.
@@ -57,10 +57,10 @@ To add a button to the face of a part:
width="800" />
+### Creating and Parenting
+
To apply a `Class.SurfaceGui` to an in-experience `Class.BasePart`, simply parent it to that part and set the `Class.SurfaceGui.Face` property. Child UI objects then appear on that face of the parent part.
-To link a `Class.BillboardGui` to an in-experience `Class.BasePart` or `Class.Attachment`, simply parent it to that part or attachment and, if desired, adjust its [size/position](#size-and-position-1).
+### Creating and Parenting
+
+To link a `Class.BillboardGui` to an in-experience `Class.BasePart` or `Class.Attachment`, simply parent it to that part or attachment and, if desired, adjust its [size/position](#sizing-and-positioning-1).
-## Create labels on the screen
+## Creating Labels on the Screen
Labels on a screen are useful for things like displaying images of characters
with dialog.
@@ -34,7 +34,7 @@ To add a label to a screen:
@@ -26,21 +28,23 @@ By default, `Class.GuiObject|GuiObjects` inside a `Class.ScreenGui` within `Clas
If `Class.Players.CharacterAutoLoads` is disabled, the contents of `Class.StarterGui` will not be cloned until `Class.Player:LoadCharacter()` is called.
+## Managing Screen Containers
+
As an experience grows in scope, you may require multiple screen interfaces such as a title screen, settings menu, shop interface, and more. In such cases, you can place multiple unique `Class.ScreenGui` containers inside `Class.StarterGui` and toggle each container's `Class.ScreenGui.Enabled|Enabled` property depending on whether it should be visible and active (while `false`, contents will not render, process user input, or update in response to changes).
-The `Class.ScreenGui.Enabled|Enabled` property can be initially toggled through the [Properties](../studio/properties.md) window and/or you can set it during playtime from a client‑side script by [accessing](#access-player-ui) the player's `Class.PlayerGui` and setting it to `true` or `false` for the desired container(s).
+The `Class.ScreenGui.Enabled|Enabled` property can be initially toggled through the [Properties](../studio/properties.md) window and/or you can set it during playtime from a client‑side script by [accessing](#accessing-player-ui) the player's `Class.PlayerGui` and setting it to `true` or `false` for the desired container(s).
-## Layout structures
+## Layout Structures
Layout structures let you quickly organize and display `Class.GuiObject|GuiObjects`, for example into a horizontal or vertical [list](../ui/list-flex-layouts.md), a [grid](../ui/grid-table-layouts.md#grid-layout) of equally‑sized tiles, a [page sequence](../ui/page-layouts.md), and more. Layouts typically override or influence the [position](#position)/[size](#size) of objects under their control.
@@ -119,11 +119,11 @@ Layout structures let you quickly organize and display `Class.GuiObject|GuiObjec
-## Customize proximity prompts
+## Customizing Proximity Prompts
You can customize a proximity prompt based on how you want it to [appear](#appearance), when you want it to be [visible](#visibility), and what you want a user to do to [trigger the action](#interactivity).
@@ -103,7 +103,7 @@ You can customize how a user interacts with a proximity prompt through its `Clas
The `Class.ProximityPrompt.HoldDuration|HoldDuration` property determines how many seconds a user has to press a key before the proximity prompt's action triggers. If this property has a value of `0`, the proximity prompt's action triggers immediately.
-
+
#### ClickablePrompt
@@ -113,7 +113,7 @@ The `Class.ProximityPrompt.ClickablePrompt|ClickablePrompt` property specifies i
Note that if a user is using a phone or a tablet, they can always interact with the proximity prompt by directly clicking the proximity prompt regardless of the `Class.ProximityPrompt.ClickablePrompt|ClickablePrompt` property's value.
-## Script proximity prompts
+## Scripting Proximity Prompts
You can connect to proximity prompt events either on the `Class.ProximityPrompt` object itself or globally through `Class.ProximityPromptService`. The `Class.ProximityPromptService` allows you to manage all proximity prompt behavior from one location, preventing any need for duplicate code in your experience.
diff --git a/content/en-us/ui/rich-text.md b/content/en-us/ui/rich-text.md
index 5627c286e..8733a79a6 100644
--- a/content/en-us/ui/rich-text.md
+++ b/content/en-us/ui/rich-text.md
@@ -1,5 +1,5 @@
---
-title: Rich text markup
+title: Rich Text Markup
description: Rich Text Markup are simple markup tags to style sections of a string.
comments: |
1. Replace numbered footnotes with dedicated style.
@@ -7,7 +7,7 @@ comments: |
UI **rich text** utilizes simple markup tags to style sections of a string in bold, italics, underline, fill color, stroke variations, and more. You can apply styling tags to `Class.TextLabel`, `Class.TextButton`, and `Class.TextBox` objects.
-## Enable rich text
+## Enabling Rich Text
You must enable rich text on a per-object basis through its **RichText** property in the [Properties](../studio/properties.md) window, or by setting the property to `true` in a `Class.LocalScript`.
@@ -29,15 +29,15 @@ When editing an object's **Text** property in Studio, toggling the **RichText**
-### Font face
+### Font Face
` `
@@ -70,7 +70,7 @@ You can also nest tags inside each other as long as you close them in the revers
Font face/family names are listed on the `Datatype.Font` enum reference page.
-### Font family
+### Font Family
` `
@@ -82,7 +82,7 @@ Font face/family names are listed on the `Datatype.Font` enum reference page.
Font face/family names are listed on the `Datatype.Font` enum reference page.
-### Font weight
+### Font Weight
` `
@@ -153,7 +153,7 @@ See [Appearance Modifiers](../ui/appearance-modifiers.md) for details on `
-## Automatic sizing
+## Automatic Sizing
The `Class.GuiObject.AutomaticSize|AutomaticSize` property automatically resizes a parent `Class.GuiObject` to the size of its descendants. You can use this property in a variety of cases, including:
@@ -44,7 +44,7 @@ Once automatic sizing is set, note that other object properties behave as follow
@@ -15,7 +15,7 @@ properties such as `Class.GuiObject.BackgroundColor3|BackgroundColor3`,
`Class.GuiObject.Transparency|Transparency`, and
`Class.GuiObject.Rotation|Rotation` to fit the aesthetics of your experience.
-## Create text inputs on the screen
+## Creating Text Inputs on the Screen
A `Class.TextBox` on a screen is useful for
things like an input field for a form.
@@ -34,7 +34,7 @@ To add a `Class.TextBox` to a screen:
1. Insert a **TextBox**.
-## Create text inputs on part faces
+## Creating Text Inputs on Part Faces
To add a `Class.TextBox` to the face of a part:
@@ -57,10 +57,10 @@ To add a `Class.TextBox` to the face of a part:
1. In the **Explorer** window, select the part.
-
-
-
-
-
-### Zoom distance
+### Zoom Distance
Together, `Class.StarterPlayer.CameraMaxZoomDistance|CameraMaxZoomDistance` and `Class.StarterPlayer.CameraMinZoomDistance|CameraMinZoomDistance` set the range in which players can zoom the camera in respect to their player character. Setting a very high maximum such as 500 allows players to zoom the camera far out in space. If you want to lock the camera to a specific distance away from the character and prevent zooming, set both of these properties to the same value.
@@ -30,7 +30,7 @@ player.CameraMaxZoomDistance = 25
player.CameraMinZoomDistance = 50
```
-### Camera mode
+### Camera Mode
The `Class.StarterPlayer.CameraMode|CameraMode` property sets the overall behavior of the camera between two options:
@@ -53,7 +53,7 @@ The `Class.StarterPlayer.CameraMode|CameraMode` property sets the overall behavi
-The editor functions in either **List View** which favors [docking](../studio/ui-overview.md#reposition-windows) to the left or right side of Studio, or in a wider **Table View**, which favors docking to the top or bottom.
+The editor functions in either **List View** which favors [docking](../studio/ui-overview.md#repositioning-windows) to the left or right side of Studio, or in a wider **Table View**, which favors docking to the top or bottom.
-### Default / nonatomic
+### Default / Nonatomic
When a `Class.Model` is set to **Default** or **Nonatomic**, streaming behavior varies based on whether [ModelStreamingBehavior](#modelstreamingbehavior) is set to **Default** (**Legacy**) or **Improved**.
@@ -250,7 +250,7 @@ When a `Class.Model` is set to **Default** or **Nonatomic**, streaming behavior
