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 Sep 26, 2024
1 parent 664336e commit 324e070
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 10 deletions.
4 changes: 3 additions & 1 deletion content/common/navigation/engine/tutorials.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,9 @@ navigation:
section:
- title: Creating Character Animations
path: /tutorials/building/animation/creating-an-animation
- title: Scripting Avatar Animations
- title: Changing Default Animations
path: /tutorials/building/animation/creating-an-animation
- title: Triggering Animations
path: /tutorials/building/animation/scripting-avatar-animations
- title: In Blender
section:
Expand Down
Git LFS file not shown
12 changes: 6 additions & 6 deletions content/en-us/studio/microprofiler/modes.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ Pausing the MicroProfiler with <kbd>Ctrl</kbd><kbd>P</kbd> (<kbd>⌘</kbd><kbd>P

## Detailed Mode

In addition to the bar graph from frame mode, detailed mode adds a colorful timeline that shows the different tasks the engine is performing.
In addition to the bar graph from frame mode, detailed mode adds a colorful timeline that shows labels for each engine process.

- Labels that appear directly below another label indicate tasks that are performed as part of the higher-level task.
- Labels that appear directly below another label indicate processes that are performed as part of the higher-level process.

Rather than the parent process, you typically want to troubleshoot the worst-performing child processes; the sum of all child processes defines the length of the parent process.
Rather than the parent process, you typically want to troubleshoot the worst-performing child processes; a parent process can't be shorter than the sum of its child processes.

- Scrolling zooms the timeline in or out. Combined with the millisecond labels at the top of the timeline, you can get a sense of how long a task took in an absolute sense, but also how long it took relative to other tasks.

Expand Down Expand Up @@ -58,7 +58,7 @@ In addition to the bar graph from frame mode, detailed mode adds a colorful time

## Timers Mode

**Timers mode** is an alternative way of visualizing the data in the detailed view: as a list of labels with processing times and call counts. Horizontal bar graphs in some columns help you spot the busiest tasks.
**Timers mode** is an alternative way of visualizing the data in the detailed view: as a list of labels with processing times and call counts. Horizontal bar graphs in some columns help you spot the busiest processes.

<img alt="Timers mode." src="../../assets/optimization/microprofiler/micro-timer.png" width="800px" />

Expand All @@ -80,11 +80,11 @@ Counters mode is a lengthy list of categories and statistics, including instance
<img alt="Counters mode with a single graph." src="../../assets/optimization/microprofiler/micro-counter.png" width="800px" />

- Just like the detailed view, left-click and hold to pan up and down.
- Left-click in the Graph column to add a small usage graph with minimum and maximum values. Left-click the graph again to expand it.
- Left-click in the **Graph** column to add a small usage graph with minimum and maximum values. Left-click the graph again to expand it.
- Right-click a graph to close it.
- You can't filter this view, but you can left-click on a category (for example, `memory`) to collapse it.

While counters mode can be useful, the [Developer Console](../../studio/optimization/memory-usage.md) is the recommended way to [identify memory issues](../../performance-optimization/identifying.md#memory). You might also find the [x-ray view](index.md#using-the-web-ui) in the web UI helpful for identifying when problematic memory allocation occurs.
While counters mode can be useful, the [Developer Console](../../studio/optimization/memory-usage.md) is the recommended way to [identify memory issues](../../performance-optimization/identifying.md#memory). You might also find the [X-ray view](index.md#using-the-web-ui) in the web UI helpful for identifying when problematic memory allocation occurs.

## Hidden Mode

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: The process for using the Animation Editor to create custom charact

**Character animations** include a series of key poses that programmatically flow together to make your characters appear as if they're moving in their environment. While Roblox provides a set of default character animations for every experience, creating custom animations for your characters helps players understand their unique personalities by how they carry themselves and interact with other characters.

Using the [Walking Character Animations](https://www.roblox.com/games/76570977337311/Walking-Character-Animation) `.rbxl` file as a starting place, this tutorial shows you how to create a walk cycle character animation from start to finish, including guidance on:
Using the [Walking Character Animations](https://www.roblox.com/games/134383324873456/Walking-Character-Animation) `.rbxl` file as a starting place, this tutorial shows you how to create a walk cycle character animation from start to finish, including guidance on:

- Adding a pre-built character rig to the 3D space that you can move and rotate into different key poses.
- Breaking down a reference image to guide your animation decisions and ensure each pose reflects your character's personality.
Expand All @@ -16,6 +16,8 @@ After you complete this tutorial, you will have an assetID for your animation, a

<img src="../../../assets/tutorials/creating-character-animations/Ref-All.jpg" alt="" width="100%" />

<video controls src="../../../assets/tutorials/creating-character-animations/Final-Animation.mp4" width="100%"></video>

## Add Rig

**Rigs**, or collections of parts connected by joints like `Class.Bone` or `Class.Motor6D` objects, are necessary to create character animations because they include the internal structure you need to move and rotate body parts into different poses. While you can [create your own rigs](../../../art/modeling/rigging-a-humanoid-model.md) using external 3D modeling tools, Studio provides several pre-built rigs that you can access through the [Rig Builder](../../../studio/rig-builder.md) plugin.
Expand Down Expand Up @@ -512,6 +514,8 @@ To test your poses:

1. Select, move, and rotate your rig until the animation matches your character's personality.

<video controls src="../../../assets/tutorials/creating-character-animations/Final-Animation.mp4" width="80%"></video>

## 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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Scripting Avatar Animations
description: The process for updating default animations.
prev: /tutorials/building/animation/creating-an-animation
---

Scripts can be used to update default animations and to add new ones. The two examples covered by this tutorial will change the default run animation and will play an animation on command when a player touches an object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Using a sample [Laser Beam Blaster](https://create.roblox.com/store/asset/163826
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).
</Alert>

<video controls src="../../../assets/tutorials/laser-traps-with-beams/Script.mp4" width="90%"></video>
<video controls src="../../../assets/tutorials/laser-traps-with-beams/Script.mp4" width="100%"></video>

## Get Blaster Asset

Expand Down

0 comments on commit 324e070

Please sign in to comment.