Skip to content

Commit

Permalink
update Open Source Docs from Roblox internal teams
Browse files Browse the repository at this point in the history
  • Loading branch information
rbx-open-source-docs[bot] committed Oct 14, 2024
1 parent aebde2d commit d2ee7d9
Show file tree
Hide file tree
Showing 77 changed files with 1,092 additions and 1,092 deletions.
4 changes: 2 additions & 2 deletions content/common/navigation/engine/art.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ navigation:
path: /art/characters/facial-animation/animating-heads
- heading: Environment and Lighting
- title: Assembling Modular Environments
path: /tutorials/3D-art/assembling-modular-environments
path: /tutorials/use-case-tutorials/modeling/assembling-modular-environments
- title: Enhancing Outdoor Environments with Future Lighting
path: /tutorials/3D-art/enhancing-outdoor-environments-with-future-lighting
path: /tutorials/use-case-tutorials/lighting/enhancing-outdoor-environments-with-future-lighting

- heading: Example Projects
path:
Expand Down
22 changes: 11 additions & 11 deletions content/common/navigation/engine/tutorials-core.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@ backTo:
navigation:
- heading: Overview
- title: Core Curriculum
path: /tutorials/core/
path: /tutorials/curriculums/core/
- heading: Building
- title: Create a Project
path: /tutorials/core/building/create-a-project
path: /tutorials/curriculums/core/building/create-a-project
- title: Create an Environment with Terrain
path: /tutorials/core/building/create-an-environment-with-terrain
path: /tutorials/curriculums/core/building/create-an-environment-with-terrain
- title: Greybox a Playable Area
path: /tutorials/core/building/greybox-a-playable-area
path: /tutorials/curriculums/core/building/greybox-a-playable-area
- heading: Scripting
- title: Create a Coin Collection Mechanic
path: /tutorials/core/scripting/script-game-behavior
path: /tutorials/curriculums/core/scripting/script-game-behavior
- title: Record and Display Player Data
path: /tutorials/core/scripting/record-and-display-player-data
path: /tutorials/curriculums/core/scripting/record-and-display-player-data
- title: Create Player Hazards
path: /tutorials/core/scripting/create-player-hazards
path: /tutorials/curriculums/core/scripting/create-player-hazards
- title: Script an Upgrade Button
path: /tutorials/core/scripting/script-an-upgrade-button
path: /tutorials/curriculums/core/scripting/script-an-upgrade-button
- heading: Polish
- title: Create Basic Visual Effects
path: /tutorials/core/building/create-basic-visual-effects
path: /tutorials/curriculums/core/building/create-basic-visual-effects
- title: Customize Global Lighting
path: /tutorials/core/building/customize-global-lighting
path: /tutorials/curriculums/core/building/customize-global-lighting
- title: Apply Polished Assets
path: /tutorials/core/building/apply-polished-assets
path: /tutorials/curriculums/core/building/apply-polished-assets
12 changes: 6 additions & 6 deletions content/common/navigation/engine/tutorials-ea.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ backTo:
navigation:
- heading: Environmental Art Curriculum
- title: Overview
path: /tutorials/environmental-art/
path: /tutorials/curriculums/environmental-art/
- title: Greybox Your Environment
path: /tutorials/environmental-art/greybox-your-environment
path: /tutorials/curriculums/environmental-art/greybox-your-environment
- title: Develop Polished Assets
path: /tutorials/environmental-art/develop-polished-assets
path: /tutorials/curriculums/environmental-art/develop-polished-assets
- title: Assemble an Asset Library
path: /tutorials/environmental-art/assemble-an-asset-library
path: /tutorials/curriculums/environmental-art/assemble-an-asset-library
- title: Construct Your World
path: /tutorials/environmental-art/construct-your-world
path: /tutorials/curriculums/environmental-art/construct-your-world
- title: Optimize Your Experience
path: /tutorials/environmental-art/optimize-your-experience
path: /tutorials/curriculums/environmental-art/optimize-your-experience
12 changes: 6 additions & 6 deletions content/common/navigation/engine/tutorials-gs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ backTo:
navigation:
- heading: Gameplay Scripting Curriculum
- title: Overview
path: /tutorials/gameplay-scripting/
path: /tutorials/curriculums/gameplay-scripting/
- title: Creating Teams
path: /tutorials/gameplay-scripting/creating-teams
path: /tutorials/curriculums/gameplay-scripting/creating-teams
- title: Spawning and Respawning
path: /tutorials/gameplay-scripting/spawn-respawn
path: /tutorials/curriculums/gameplay-scripting/spawn-respawn
- title: Adding Rounds
path: /tutorials/gameplay-scripting/adding-rounds
path: /tutorials/curriculums/gameplay-scripting/adding-rounds
- title: Implementing Blaster Behavior
path: /tutorials/gameplay-scripting/implementing-blasters
path: /tutorials/curriculums/gameplay-scripting/implementing-blasters
- title: Detecting Hits
path: /tutorials/gameplay-scripting/detecting-hits
path: /tutorials/curriculums/gameplay-scripting/detecting-hits
8 changes: 4 additions & 4 deletions content/common/navigation/engine/tutorials-ui.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ backTo:
navigation:
- heading: UI Design Curriculum
- title: Overview
path: /tutorials/user-interface-design/
path: /tutorials/curriculums/user-interface-design/
- title: Choose an Art Style
path: /tutorials/user-interface-design/choose-an-art-style
path: /tutorials/curriculums/user-interface-design/choose-an-art-style
- title: Wireframe Your Layouts
path: /tutorials/user-interface-design/wireframe-your-layouts
path: /tutorials/curriculums/user-interface-design/wireframe-your-layouts
- title: Implement Designs in Studio
path: /tutorials/user-interface-design/implement-designs-in-studio
path: /tutorials/curriculums/user-interface-design/implement-designs-in-studio
74 changes: 37 additions & 37 deletions content/common/navigation/engine/tutorials.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,80 +6,80 @@ navigation:
path: /tutorials/first-experience/
- heading: Curriculum Paths
- title: Overview
path: /tutorials/curriculum-overview
path: /tutorials/curriculums/curriculum-overview
- title: Core
path: /tutorials/core/
path: /tutorials/curriculums/core/
navigation: /engine/tutorials-core.yaml
- title: Environmental Art
path: /tutorials/environmental-art/
path: /tutorials/curriculums/environmental-art/
navigation: /engine/tutorials-ea.yaml
- title: Gameplay Scripting
path: /tutorials/gameplay-scripting/
path: /tutorials/curriculums/gameplay-scripting/
navigation: /engine/tutorials-gs.yaml
- title: User Interface Design
path: /tutorials/user-interface-design/
path: /tutorials/curriculums/user-interface-design/
navigation: /engine/tutorials-ui.yaml
- heading: Use Case Tutorials
- title: Overview
path: /tutorials/use-case-tutorial-overview
path: /tutorials/use-case-tutorials/use-case-tutorial-overview
- title: Modeling
section:
- title: Creating Neon Signs
path: /tutorials/3D-art/creating-neon-signs
path: /tutorials/use-case-tutorials/modeling/creating-neon-signs
- title: Assembling Modular Environments
path: /tutorials/3D-art/assembling-modular-environments
path: /tutorials/use-case-tutorials/modeling/assembling-modular-environments
- title: User Interfaces
section:
- title: Creating Score Bars
path: /tutorials/building/ui/creating-a-score-bar
path: /tutorials/use-case-tutorials/ui/creating-a-score-bar
- title: Creating Interactive Buttons
path: /tutorials/building/ui/interactive-buttons
path: /tutorials/use-case-tutorials/ui/interactive-buttons
- title: Creating Proximity Prompts
path: /tutorials/building/ui/proximity-prompts
path: /tutorials/use-case-tutorials/ui/proximity-prompts
- title: Creating Part Interfaces
path: /tutorials/building/ui/interfaces-on-parts
path: /tutorials/use-case-tutorials/ui/interfaces-on-parts
- title: Audio
section:
- title: Playing Background Music
path: /tutorials/building/environments/playing-background-music
path: /tutorials/use-case-tutorials/audio/playing-background-music
- title: Playing Positional Sounds
path: /tutorials/building/environments/in-game-sounds
path: /tutorials/use-case-tutorials/audio/in-game-sounds
- title: Lighting
section:
- title: Enhancing Indoor Environments
path: /tutorials/building/environments/enhancing-indoor-environments
path: /tutorials/use-case-tutorials/lighting/enhancing-indoor-environments
- title: Enhancing Outdoor Environments
path: /tutorials/3D-art/enhancing-outdoor-environments-with-future-lighting
path: /tutorials/use-case-tutorials/lighting/enhancing-outdoor-environments-with-future-lighting
- title: VFX
section:
- title: Creating Laser Beams
path: /tutorials/building/effects/laser-traps-with-beams
path: /tutorials/use-case-tutorials/vfx/laser-traps-with-beams
- title: Creating Waterfalls
path: /tutorials/building/effects/creating-waterfalls
path: /tutorials/use-case-tutorials/vfx/creating-waterfalls
- title: Creating Volcanoes
path: /tutorials/building/effects/creating-volcanoes
path: /tutorials/use-case-tutorials/vfx/creating-volcanoes
- title: Creating Explosions
path: /tutorials/building/effects/using-particles-for-explosions
path: /tutorials/use-case-tutorials/vfx/using-particles-for-explosions
- title: Physics
section:
- title: Creating Moving Objects
path: /tutorials/building/physics/creating-moving-objects
path: /tutorials/use-case-tutorials/physics/creating-moving-objects
- title: Creating Spinning Objects
path: /tutorials/3D-art/creating-spinning-objects
path: /tutorials/use-case-tutorials/physics/creating-spinning-objects
- title: Creating Elevators
path: /tutorials/3D-art/creating-elevators
path: /tutorials/use-case-tutorials/physics/creating-elevators
- title: Building Hinged Doors
path: /tutorials/building/physics/building-a-hinged-door
path: /tutorials/use-case-tutorials/physics/building-a-hinged-door
- title: Building Ferris Wheels
path: /tutorials/building/physics/building-a-ferris-wheel
path: /tutorials/use-case-tutorials/physics/building-a-ferris-wheel
- title: Animation
section:
- title: In Studio
section:
- title: Creating Character Animations
path: /tutorials/building/animation/creating-an-animation
path: /tutorials/use-case-tutorials/animation/creating-an-animation
- title: Playing Character Animations
path: /tutorials/building/animation/scripting-avatar-animations
path: /tutorials/use-case-tutorials/animation/playing-character-animations
- title: In Blender
section:
- title: Rigging Simple Meshes
Expand All @@ -95,26 +95,26 @@ navigation:
- title: Basic Gameplay
section:
- title: Introduction to Scripting
path: /tutorials/scripting/basic-scripting/intro-to-scripting
path: /tutorials/use-case-tutorials/scripting/basic-scripting/intro-to-scripting
- title: Deadly Lava
path: /tutorials/scripting/basic-scripting/deadly-lava
path: /tutorials/use-case-tutorials/scripting/basic-scripting/deadly-lava
- title: Fading Trap
path: /tutorials/scripting/basic-scripting/fading-trap
path: /tutorials/use-case-tutorials/scripting/basic-scripting/fading-trap
- title: Scoring Points
path: /tutorials/scripting/basic-scripting/scoring-points
path: /tutorials/use-case-tutorials/scripting/basic-scripting/scoring-points
- title: Intermediate Gameplay
section:
- title: Creating Health Pickups
path: /tutorials/scripting/intermediate-scripting/creating-a-health-pickup
path: /tutorials/use-case-tutorials/scripting/intermediate-scripting/creating-a-health-pickup
- title: Saving Data
path: /tutorials/scripting/intermediate-scripting/saving-data
path: /tutorials/use-case-tutorials/scripting/intermediate-scripting/saving-data
- title: Creating Player Tools
path: /tutorials/scripting/intermediate-scripting/creating-player-tools
path: /tutorials/use-case-tutorials/scripting/intermediate-scripting/creating-player-tools
- title: Hit Detection with Lasers
path: /tutorials/scripting/intermediate-scripting/hit-detection-with-lasers
path: /tutorials/use-case-tutorials/scripting/intermediate-scripting/hit-detection-with-lasers
- title: Input and Camera
section:
- title: Controlling the User's Camera
path: /tutorials/scripting/input-and-camera/controlling-the-users-camera
path: /tutorials/use-case-tutorials/input-and-camera/controlling-the-users-camera
- title: Detecting User Input
path: /tutorials/scripting/input-and-camera/detecting-user-input
path: /tutorials/use-case-tutorials/input-and-camera/detecting-user-input
24 changes: 12 additions & 12 deletions content/en-us/art/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ style={{position: "relative", paddingBottom: "56.25%", height: 0}}>
<Typography variant='h4'>Environmental Art</Typography>
<Typography variant='body1' >Environmental Art teaches you how to recreate a high-quality environment for a first-person laser tag experience.</Typography>
<div style={{marginTop:16}}>
<a underline="none" href="../tutorials/environmental-art">
<a underline="none" href="../tutorials/curriculums/environmental-art/index.md">
<Button variant="contained" color="secondary" size='large'
style={{marginRight:8, alignSelf: 'flex-start'}}>Create</Button>
</a>
Expand Down Expand Up @@ -123,7 +123,7 @@ Check out the following showcases made by Roblox and the community. Each of thes
<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>
<a href="../resources/the-mystery-of-duvall-drive/index.md"><Typography variant='h6' style={{marginBottom: 12}}>Mystery of Duvall Drive</Typography></a>
<a href="../resources/beyond-the-dark/index.md"><Typography variant='h6' style={{marginBottom: 12}}>Beyond the Dark</Typography></a>
<a href="../tutorials/3D-art/assembling-modular-environments.md"><Typography variant='h6' style={{marginBottom: 12}}>Modern City template</Typography></a>
<a href="../tutorials/use-case-tutorials/modeling/assembling-modular-environments.md"><Typography variant='h6' style={{marginBottom: 12}}>Modern City template</Typography></a>
</Grid>
</Grid>

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

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

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

<a href="../tutorials/environmental-art/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Environmental Art Curriculum</Typography></a>
<a href="../tutorials/3D-art/assembling-modular-environments.md"><Typography variant='body1' style={{marginBottom: 12}}>Assembling Modular Environments</Typography></a>
<a href="../tutorials/building/environments/lighting-with-props.md"><Typography variant='body1' style={{marginBottom: 12}}>Lighting with Props</Typography></a>
<a href="../tutorials/building/environments/in-game-sounds.md"><Typography variant='body1' style={{marginBottom: 12}}>In-Game Sounds</Typography></a>
<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>
<a href="../tutorials/building/effects/basic-particle-effects.md"><Typography variant='body1' style={{marginBottom: 12}}>Basic Particle Effects</Typography></a>
<a href="../tutorials/building/effects/custom-particle-effects.md"><Typography variant='body1' style={{marginBottom: 12}}>Custom Particle Effects</Typography></a>
<a href="../tutorials/curriculums/environmental-art/index.md"><Typography variant='body1' style={{marginBottom: 12}}>Environmental Art Curriculum</Typography></a>
<a href="../tutorials/use-case-tutorials/modeling/assembling-modular-environments.md"><Typography variant='body1' style={{marginBottom: 12}}>Assembling Modular Environments</Typography></a>
<a href="../tutorials/use-case-tutorials/lighting/lighting-with-props.md"><Typography variant='body1' style={{marginBottom: 12}}>Lighting with Props</Typography></a>
<a href="../tutorials/use-case-tutorials/audio/in-game-sounds.md"><Typography variant='body1' style={{marginBottom: 12}}>In-Game Sounds</Typography></a>
<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>
<a href="../tutorials/use-case-tutorials/vfx/basic-particle-effects.md"><Typography variant='body1' style={{marginBottom: 12}}>Basic Particle Effects</Typography></a>
<a href="../tutorials/use-case-tutorials/vfx/custom-particle-effects.md"><Typography variant='body1' style={{marginBottom: 12}}>Custom Particle Effects</Typography></a>
<a href="https://devforum.roblox.com/t/custom-skyboxes-101/2849003"><Typography variant='body1' style={{marginBottom: 12}}>Custom Skyboxes 101 (Staff)</Typography></a>

<br />
Expand Down
4 changes: 2 additions & 2 deletions content/en-us/reference/engine/classes/CollectionService.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ methods:
fires under two conditions:
- The tag is assigned to an instance within the `Class.DataModel` (game)
using `Class.CollectionService:AddTag()`.
using `Class.CollectionService:AddTag()` or `Class.Instance:AddTag()`.
- An instance with the given tag is added as a descendant of the
`Class.DataModel`, e.g. by setting `Class.Instance.Parent` or similar.
Expand Down Expand Up @@ -165,7 +165,7 @@ methods:
fires under two conditions:
- The tag is removed from an instance within the `Class.DataModel` (game)
using `Class.CollectionService:RemoveTag()`.
using `Class.CollectionService:RemoveTag()` or `Class.Instance:RemoveTag()`.
- An instance with the given tag is removed as a descendant of the
`Class.DataModel`, e.g. by un-setting `Class.Instance.Parent` or
similar.
Expand Down
4 changes: 2 additions & 2 deletions content/en-us/reference/engine/libraries/string.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -676,10 +676,10 @@ functions:
code_samples:
- name: string.sub
summary: |
Returns the substring of `s` that starts at `i` and continues until j. `i`
Returns the substring of `s` that starts at `i` and continues until and including `j`. `i`
and `j` can be negative. `i` defaults to 1 and `j` defaults to `-1`.
description: |
Returns the substring of `s` that starts at `i` and continues until j. `i`
Returns the substring of `s` that starts at `i` and continues until and including `j`. `i`
and `j` can be negative. `i` defaults to 1 and `j` defaults to `-1`.
parameters:
- name: s
Expand Down
2 changes: 1 addition & 1 deletion content/en-us/reference/engine/libraries/utf8.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ functions:
default: 1
summary: ''
returns:
- type: int
- type: int?
summary: ''
tags:
code_samples:
Expand Down
Loading

0 comments on commit d2ee7d9

Please sign in to comment.