Skip to content

Commit d2ee7d9

Browse files
update Open Source Docs from Roblox internal teams
1 parent aebde2d commit d2ee7d9

File tree

77 files changed

+1092
-1092
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+1092
-1092
lines changed

content/common/navigation/engine/art.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ navigation:
4040
path: /art/characters/facial-animation/animating-heads
4141
- heading: Environment and Lighting
4242
- title: Assembling Modular Environments
43-
path: /tutorials/3D-art/assembling-modular-environments
43+
path: /tutorials/use-case-tutorials/modeling/assembling-modular-environments
4444
- title: Enhancing Outdoor Environments with Future Lighting
45-
path: /tutorials/3D-art/enhancing-outdoor-environments-with-future-lighting
45+
path: /tutorials/use-case-tutorials/lighting/enhancing-outdoor-environments-with-future-lighting
4646

4747
- heading: Example Projects
4848
path:

content/common/navigation/engine/tutorials-core.yaml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@ backTo:
44
navigation:
55
- heading: Overview
66
- title: Core Curriculum
7-
path: /tutorials/core/
7+
path: /tutorials/curriculums/core/
88
- heading: Building
99
- title: Create a Project
10-
path: /tutorials/core/building/create-a-project
10+
path: /tutorials/curriculums/core/building/create-a-project
1111
- title: Create an Environment with Terrain
12-
path: /tutorials/core/building/create-an-environment-with-terrain
12+
path: /tutorials/curriculums/core/building/create-an-environment-with-terrain
1313
- title: Greybox a Playable Area
14-
path: /tutorials/core/building/greybox-a-playable-area
14+
path: /tutorials/curriculums/core/building/greybox-a-playable-area
1515
- heading: Scripting
1616
- title: Create a Coin Collection Mechanic
17-
path: /tutorials/core/scripting/script-game-behavior
17+
path: /tutorials/curriculums/core/scripting/script-game-behavior
1818
- title: Record and Display Player Data
19-
path: /tutorials/core/scripting/record-and-display-player-data
19+
path: /tutorials/curriculums/core/scripting/record-and-display-player-data
2020
- title: Create Player Hazards
21-
path: /tutorials/core/scripting/create-player-hazards
21+
path: /tutorials/curriculums/core/scripting/create-player-hazards
2222
- title: Script an Upgrade Button
23-
path: /tutorials/core/scripting/script-an-upgrade-button
23+
path: /tutorials/curriculums/core/scripting/script-an-upgrade-button
2424
- heading: Polish
2525
- title: Create Basic Visual Effects
26-
path: /tutorials/core/building/create-basic-visual-effects
26+
path: /tutorials/curriculums/core/building/create-basic-visual-effects
2727
- title: Customize Global Lighting
28-
path: /tutorials/core/building/customize-global-lighting
28+
path: /tutorials/curriculums/core/building/customize-global-lighting
2929
- title: Apply Polished Assets
30-
path: /tutorials/core/building/apply-polished-assets
30+
path: /tutorials/curriculums/core/building/apply-polished-assets

content/common/navigation/engine/tutorials-ea.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ backTo:
44
navigation:
55
- heading: Environmental Art Curriculum
66
- title: Overview
7-
path: /tutorials/environmental-art/
7+
path: /tutorials/curriculums/environmental-art/
88
- title: Greybox Your Environment
9-
path: /tutorials/environmental-art/greybox-your-environment
9+
path: /tutorials/curriculums/environmental-art/greybox-your-environment
1010
- title: Develop Polished Assets
11-
path: /tutorials/environmental-art/develop-polished-assets
11+
path: /tutorials/curriculums/environmental-art/develop-polished-assets
1212
- title: Assemble an Asset Library
13-
path: /tutorials/environmental-art/assemble-an-asset-library
13+
path: /tutorials/curriculums/environmental-art/assemble-an-asset-library
1414
- title: Construct Your World
15-
path: /tutorials/environmental-art/construct-your-world
15+
path: /tutorials/curriculums/environmental-art/construct-your-world
1616
- title: Optimize Your Experience
17-
path: /tutorials/environmental-art/optimize-your-experience
17+
path: /tutorials/curriculums/environmental-art/optimize-your-experience

content/common/navigation/engine/tutorials-gs.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ backTo:
44
navigation:
55
- heading: Gameplay Scripting Curriculum
66
- title: Overview
7-
path: /tutorials/gameplay-scripting/
7+
path: /tutorials/curriculums/gameplay-scripting/
88
- title: Creating Teams
9-
path: /tutorials/gameplay-scripting/creating-teams
9+
path: /tutorials/curriculums/gameplay-scripting/creating-teams
1010
- title: Spawning and Respawning
11-
path: /tutorials/gameplay-scripting/spawn-respawn
11+
path: /tutorials/curriculums/gameplay-scripting/spawn-respawn
1212
- title: Adding Rounds
13-
path: /tutorials/gameplay-scripting/adding-rounds
13+
path: /tutorials/curriculums/gameplay-scripting/adding-rounds
1414
- title: Implementing Blaster Behavior
15-
path: /tutorials/gameplay-scripting/implementing-blasters
15+
path: /tutorials/curriculums/gameplay-scripting/implementing-blasters
1616
- title: Detecting Hits
17-
path: /tutorials/gameplay-scripting/detecting-hits
17+
path: /tutorials/curriculums/gameplay-scripting/detecting-hits

content/common/navigation/engine/tutorials-ui.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ backTo:
44
navigation:
55
- heading: UI Design Curriculum
66
- title: Overview
7-
path: /tutorials/user-interface-design/
7+
path: /tutorials/curriculums/user-interface-design/
88
- title: Choose an Art Style
9-
path: /tutorials/user-interface-design/choose-an-art-style
9+
path: /tutorials/curriculums/user-interface-design/choose-an-art-style
1010
- title: Wireframe Your Layouts
11-
path: /tutorials/user-interface-design/wireframe-your-layouts
11+
path: /tutorials/curriculums/user-interface-design/wireframe-your-layouts
1212
- title: Implement Designs in Studio
13-
path: /tutorials/user-interface-design/implement-designs-in-studio
13+
path: /tutorials/curriculums/user-interface-design/implement-designs-in-studio

content/common/navigation/engine/tutorials.yaml

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,80 +6,80 @@ navigation:
66
path: /tutorials/first-experience/
77
- heading: Curriculum Paths
88
- title: Overview
9-
path: /tutorials/curriculum-overview
9+
path: /tutorials/curriculums/curriculum-overview
1010
- title: Core
11-
path: /tutorials/core/
11+
path: /tutorials/curriculums/core/
1212
navigation: /engine/tutorials-core.yaml
1313
- title: Environmental Art
14-
path: /tutorials/environmental-art/
14+
path: /tutorials/curriculums/environmental-art/
1515
navigation: /engine/tutorials-ea.yaml
1616
- title: Gameplay Scripting
17-
path: /tutorials/gameplay-scripting/
17+
path: /tutorials/curriculums/gameplay-scripting/
1818
navigation: /engine/tutorials-gs.yaml
1919
- title: User Interface Design
20-
path: /tutorials/user-interface-design/
20+
path: /tutorials/curriculums/user-interface-design/
2121
navigation: /engine/tutorials-ui.yaml
2222
- heading: Use Case Tutorials
2323
- title: Overview
24-
path: /tutorials/use-case-tutorial-overview
24+
path: /tutorials/use-case-tutorials/use-case-tutorial-overview
2525
- title: Modeling
2626
section:
2727
- title: Creating Neon Signs
28-
path: /tutorials/3D-art/creating-neon-signs
28+
path: /tutorials/use-case-tutorials/modeling/creating-neon-signs
2929
- title: Assembling Modular Environments
30-
path: /tutorials/3D-art/assembling-modular-environments
30+
path: /tutorials/use-case-tutorials/modeling/assembling-modular-environments
3131
- title: User Interfaces
3232
section:
3333
- title: Creating Score Bars
34-
path: /tutorials/building/ui/creating-a-score-bar
34+
path: /tutorials/use-case-tutorials/ui/creating-a-score-bar
3535
- title: Creating Interactive Buttons
36-
path: /tutorials/building/ui/interactive-buttons
36+
path: /tutorials/use-case-tutorials/ui/interactive-buttons
3737
- title: Creating Proximity Prompts
38-
path: /tutorials/building/ui/proximity-prompts
38+
path: /tutorials/use-case-tutorials/ui/proximity-prompts
3939
- title: Creating Part Interfaces
40-
path: /tutorials/building/ui/interfaces-on-parts
40+
path: /tutorials/use-case-tutorials/ui/interfaces-on-parts
4141
- title: Audio
4242
section:
4343
- title: Playing Background Music
44-
path: /tutorials/building/environments/playing-background-music
44+
path: /tutorials/use-case-tutorials/audio/playing-background-music
4545
- title: Playing Positional Sounds
46-
path: /tutorials/building/environments/in-game-sounds
46+
path: /tutorials/use-case-tutorials/audio/in-game-sounds
4747
- title: Lighting
4848
section:
4949
- title: Enhancing Indoor Environments
50-
path: /tutorials/building/environments/enhancing-indoor-environments
50+
path: /tutorials/use-case-tutorials/lighting/enhancing-indoor-environments
5151
- title: Enhancing Outdoor Environments
52-
path: /tutorials/3D-art/enhancing-outdoor-environments-with-future-lighting
52+
path: /tutorials/use-case-tutorials/lighting/enhancing-outdoor-environments-with-future-lighting
5353
- title: VFX
5454
section:
5555
- title: Creating Laser Beams
56-
path: /tutorials/building/effects/laser-traps-with-beams
56+
path: /tutorials/use-case-tutorials/vfx/laser-traps-with-beams
5757
- title: Creating Waterfalls
58-
path: /tutorials/building/effects/creating-waterfalls
58+
path: /tutorials/use-case-tutorials/vfx/creating-waterfalls
5959
- title: Creating Volcanoes
60-
path: /tutorials/building/effects/creating-volcanoes
60+
path: /tutorials/use-case-tutorials/vfx/creating-volcanoes
6161
- title: Creating Explosions
62-
path: /tutorials/building/effects/using-particles-for-explosions
62+
path: /tutorials/use-case-tutorials/vfx/using-particles-for-explosions
6363
- title: Physics
6464
section:
6565
- title: Creating Moving Objects
66-
path: /tutorials/building/physics/creating-moving-objects
66+
path: /tutorials/use-case-tutorials/physics/creating-moving-objects
6767
- title: Creating Spinning Objects
68-
path: /tutorials/3D-art/creating-spinning-objects
68+
path: /tutorials/use-case-tutorials/physics/creating-spinning-objects
6969
- title: Creating Elevators
70-
path: /tutorials/3D-art/creating-elevators
70+
path: /tutorials/use-case-tutorials/physics/creating-elevators
7171
- title: Building Hinged Doors
72-
path: /tutorials/building/physics/building-a-hinged-door
72+
path: /tutorials/use-case-tutorials/physics/building-a-hinged-door
7373
- title: Building Ferris Wheels
74-
path: /tutorials/building/physics/building-a-ferris-wheel
74+
path: /tutorials/use-case-tutorials/physics/building-a-ferris-wheel
7575
- title: Animation
7676
section:
7777
- title: In Studio
7878
section:
7979
- title: Creating Character Animations
80-
path: /tutorials/building/animation/creating-an-animation
80+
path: /tutorials/use-case-tutorials/animation/creating-an-animation
8181
- title: Playing Character Animations
82-
path: /tutorials/building/animation/scripting-avatar-animations
82+
path: /tutorials/use-case-tutorials/animation/playing-character-animations
8383
- title: In Blender
8484
section:
8585
- title: Rigging Simple Meshes
@@ -95,26 +95,26 @@ navigation:
9595
- title: Basic Gameplay
9696
section:
9797
- title: Introduction to Scripting
98-
path: /tutorials/scripting/basic-scripting/intro-to-scripting
98+
path: /tutorials/use-case-tutorials/scripting/basic-scripting/intro-to-scripting
9999
- title: Deadly Lava
100-
path: /tutorials/scripting/basic-scripting/deadly-lava
100+
path: /tutorials/use-case-tutorials/scripting/basic-scripting/deadly-lava
101101
- title: Fading Trap
102-
path: /tutorials/scripting/basic-scripting/fading-trap
102+
path: /tutorials/use-case-tutorials/scripting/basic-scripting/fading-trap
103103
- title: Scoring Points
104-
path: /tutorials/scripting/basic-scripting/scoring-points
104+
path: /tutorials/use-case-tutorials/scripting/basic-scripting/scoring-points
105105
- title: Intermediate Gameplay
106106
section:
107107
- title: Creating Health Pickups
108-
path: /tutorials/scripting/intermediate-scripting/creating-a-health-pickup
108+
path: /tutorials/use-case-tutorials/scripting/intermediate-scripting/creating-a-health-pickup
109109
- title: Saving Data
110-
path: /tutorials/scripting/intermediate-scripting/saving-data
110+
path: /tutorials/use-case-tutorials/scripting/intermediate-scripting/saving-data
111111
- title: Creating Player Tools
112-
path: /tutorials/scripting/intermediate-scripting/creating-player-tools
112+
path: /tutorials/use-case-tutorials/scripting/intermediate-scripting/creating-player-tools
113113
- title: Hit Detection with Lasers
114-
path: /tutorials/scripting/intermediate-scripting/hit-detection-with-lasers
114+
path: /tutorials/use-case-tutorials/scripting/intermediate-scripting/hit-detection-with-lasers
115115
- title: Input and Camera
116116
section:
117117
- title: Controlling the User's Camera
118-
path: /tutorials/scripting/input-and-camera/controlling-the-users-camera
118+
path: /tutorials/use-case-tutorials/input-and-camera/controlling-the-users-camera
119119
- title: Detecting User Input
120-
path: /tutorials/scripting/input-and-camera/detecting-user-input
120+
path: /tutorials/use-case-tutorials/input-and-camera/detecting-user-input

content/en-us/art/index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ style={{position: "relative", paddingBottom: "56.25%", height: 0}}>
8080
<Typography variant='h4'>Environmental Art</Typography>
8181
<Typography variant='body1' >Environmental Art teaches you how to recreate a high-quality environment for a first-person laser tag experience.</Typography>
8282
<div style={{marginTop:16}}>
83-
<a underline="none" href="../tutorials/environmental-art">
83+
<a underline="none" href="../tutorials/curriculums/environmental-art/index.md">
8484
<Button variant="contained" color="secondary" size='large'
8585
style={{marginRight:8, alignSelf: 'flex-start'}}>Create</Button>
8686
</a>
@@ -123,7 +123,7 @@ Check out the following showcases made by Roblox and the community. Each of thes
123123
<Typography variant='body1' >Check out various experiences created by Roblox. Click to see documentation, downloadable resources, and links to try out the experiences yourself!</Typography>
124124
<a href="../resources/the-mystery-of-duvall-drive/index.md"><Typography variant='h6' style={{marginBottom: 12}}>Mystery of Duvall Drive</Typography></a>
125125
<a href="../resources/beyond-the-dark/index.md"><Typography variant='h6' style={{marginBottom: 12}}>Beyond the Dark</Typography></a>
126-
<a href="../tutorials/3D-art/assembling-modular-environments.md"><Typography variant='h6' style={{marginBottom: 12}}>Modern City template</Typography></a>
126+
<a href="../tutorials/use-case-tutorials/modeling/assembling-modular-environments.md"><Typography variant='h6' style={{marginBottom: 12}}>Modern City template</Typography></a>
127127
</Grid>
128128
</Grid>
129129

@@ -257,9 +257,9 @@ The following is a list of common 3D art resources ordered by subject, as well a
257257
<Grid item container wrap="nowrap" direction="column" style={{gap: 8, flex: 1}}>
258258
<Typography variant='h5'>3D Art Tutorials</Typography>
259259

260-
<a href="../tutorials/core/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Core Curriculum</Typography></a>
261-
<a href="../tutorials/environmental-art/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Environmental Art</Typography></a>
262-
<a href="../tutorials/gameplay-scripting/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Gameplay Scripting</Typography></a>
260+
<a href="../tutorials/curriculums/core/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Core Curriculum</Typography></a>
261+
<a href="../tutorials/curriculums/environmental-art/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Environmental Art</Typography></a>
262+
<a href="../tutorials/curriculums/gameplay-scripting/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Gameplay Scripting</Typography></a>
263263
<br />
264264

265265
<p><Typography variant='body1' style={{marginBottom: 12}}>See <a href="../tutorials/index.md">Engine Tutorials</a> for additional 3D Art tutorials.</Typography></p>
@@ -359,13 +359,13 @@ The following is a list of common 3D art resources ordered by subject, as well a
359359
<Grid item container wrap="nowrap" direction="column" style={{gap: 8, flex: 1}}>
360360
<Typography variant='h5'>Environment, Lighting, and Effects</Typography>
361361

362-
<a href="../tutorials/environmental-art/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Environmental Art Curriculum</Typography></a>
363-
<a href="../tutorials/3D-art/assembling-modular-environments.md"><Typography variant='body1' style={{marginBottom: 12}}>Assembling Modular Environments</Typography></a>
364-
<a href="../tutorials/building/environments/lighting-with-props.md"><Typography variant='body1' style={{marginBottom: 12}}>Lighting with Props</Typography></a>
365-
<a href="../tutorials/building/environments/in-game-sounds.md"><Typography variant='body1' style={{marginBottom: 12}}>In-Game Sounds</Typography></a>
366-
<a href="../tutorials/3D-art/enhancing-outdoor-environments-with-future-lighting.md"><Typography variant='body1' style={{marginBottom: 12}}>Enhancing Outdoor Environments with Future Lighting</Typography></a>
367-
<a href="../tutorials/building/effects/basic-particle-effects.md"><Typography variant='body1' style={{marginBottom: 12}}>Basic Particle Effects</Typography></a>
368-
<a href="../tutorials/building/effects/custom-particle-effects.md"><Typography variant='body1' style={{marginBottom: 12}}>Custom Particle Effects</Typography></a>
362+
<a href="../tutorials/curriculums/environmental-art/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Environmental Art Curriculum</Typography></a>
363+
<a href="../tutorials/use-case-tutorials/modeling/assembling-modular-environments.md"><Typography variant='body1' style={{marginBottom: 12}}>Assembling Modular Environments</Typography></a>
364+
<a href="../tutorials/use-case-tutorials/lighting/lighting-with-props.md"><Typography variant='body1' style={{marginBottom: 12}}>Lighting with Props</Typography></a>
365+
<a href="../tutorials/use-case-tutorials/audio/in-game-sounds.md"><Typography variant='body1' style={{marginBottom: 12}}>In-Game Sounds</Typography></a>
366+
<a href="../tutorials/use-case-tutorials/lighting/enhancing-outdoor-environments-with-future-lighting.md"><Typography variant='body1' style={{marginBottom: 12}}>Enhancing Outdoor Environments with Future Lighting</Typography></a>
367+
<a href="../tutorials/use-case-tutorials/vfx/basic-particle-effects.md"><Typography variant='body1' style={{marginBottom: 12}}>Basic Particle Effects</Typography></a>
368+
<a href="../tutorials/use-case-tutorials/vfx/custom-particle-effects.md"><Typography variant='body1' style={{marginBottom: 12}}>Custom Particle Effects</Typography></a>
369369
<a href="https://devforum.roblox.com/t/custom-skyboxes-101/2849003"><Typography variant='body1' style={{marginBottom: 12}}>Custom Skyboxes 101 (Staff)</Typography></a>
370370

371371
<br />

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ methods:
128128
fires under two conditions:
129129
130130
- The tag is assigned to an instance within the `Class.DataModel` (game)
131-
using `Class.CollectionService:AddTag()`.
131+
using `Class.CollectionService:AddTag()` or `Class.Instance:AddTag()`.
132132
- An instance with the given tag is added as a descendant of the
133133
`Class.DataModel`, e.g. by setting `Class.Instance.Parent` or similar.
134134
@@ -165,7 +165,7 @@ methods:
165165
fires under two conditions:
166166
167167
- The tag is removed from an instance within the `Class.DataModel` (game)
168-
using `Class.CollectionService:RemoveTag()`.
168+
using `Class.CollectionService:RemoveTag()` or `Class.Instance:RemoveTag()`.
169169
- An instance with the given tag is removed as a descendant of the
170170
`Class.DataModel`, e.g. by un-setting `Class.Instance.Parent` or
171171
similar.

content/en-us/reference/engine/libraries/string.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -676,10 +676,10 @@ functions:
676676
code_samples:
677677
- name: string.sub
678678
summary: |
679-
Returns the substring of `s` that starts at `i` and continues until j. `i`
679+
Returns the substring of `s` that starts at `i` and continues until and including `j`. `i`
680680
and `j` can be negative. `i` defaults to 1 and `j` defaults to `-1`.
681681
description: |
682-
Returns the substring of `s` that starts at `i` and continues until j. `i`
682+
Returns the substring of `s` that starts at `i` and continues until and including `j`. `i`
683683
and `j` can be negative. `i` defaults to 1 and `j` defaults to `-1`.
684684
parameters:
685685
- name: s

content/en-us/reference/engine/libraries/utf8.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ functions:
161161
default: 1
162162
summary: ''
163163
returns:
164-
- type: int
164+
- type: int?
165165
summary: ''
166166
tags:
167167
code_samples:

0 commit comments

Comments
 (0)