mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-25 04:54:07 +00:00
288 lines
17 KiB
Markdown
288 lines
17 KiB
Markdown
---
|
||
title: Parts
|
||
description: Parts are Roblox's primary building blocks.
|
||
---
|
||
|
||
`Class.Part|Parts` are descendants of the `Class.BasePart` class and are Roblox's
|
||
primitive building blocks with properties like position, size, orientation, and
|
||
color. You can use basic parts as is, or you can apply [solid
|
||
modeling](/parts/solid-modeling) operations to combine parts into more complex
|
||
shapes.
|
||
|
||
For advanced and intricate 3D models, you can also import third-party model
|
||
files as `Class.MeshPart|MeshParts` as outlined in [Meshes](../parts/meshes.md).
|
||
|
||
<GridContainer numColumns="3">
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Basic-Part-Sphere.png" alt="A single gray sphere part" />
|
||
<figcaption>Basic sphere part</figcaption>
|
||
</figure>
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Part-Example-CSG.jpg"alt="A bright blue hollow bowl that was made with solid modeling operations."/>
|
||
<figcaption>Bowl created with solid modeling</figcaption>
|
||
</figure>
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Mesh-Example.jpg" alt="A high-quality treasure chest mesh with a texture." />
|
||
<figcaption>Mesh with texture</figcaption>
|
||
</figure>
|
||
</GridContainer>
|
||
|
||
By default, parts are rigid bodies that follow real-world physical mechanics,
|
||
including gravity, collision, and momentum. You can connect related parts
|
||
together as a single [assembly](../physics/assemblies.md) using a
|
||
`Class.WeldConstraint`, or a joint like `Class.Motor6D` or `Class.Bone`. As an
|
||
assembly, the connected parts act as a single rigid entity, referencing a common
|
||
position, orientation, and scale.
|
||
|
||
You can use a `Class.Model` container to group related parts together and access
|
||
the group as a single assembly in the [Explorer](../studio/explorer.md). See
|
||
[Models](../parts/models.md) for more information.
|
||
|
||
## Basic part types
|
||
|
||
`Class.Part` objects can take the shape of blocks, spheres, cylinders, wedges, or corner wedges. In addition, `Class.TrussPart` acts as a truss beam that characters can climb like a ladder.
|
||
|
||
<Grid container spacing={1}>
|
||
<Grid item XSmall={4} XLarge={2}>
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Basic-Part-Block.png" alt="A single Block part." />
|
||
<figcaption><center>Block</center></figcaption>
|
||
</figure>
|
||
</Grid>
|
||
<Grid item XSmall={4} XLarge={2}>
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Basic-Part-Sphere.png" alt="A single Sphere part." />
|
||
<figcaption><center>Sphere</center></figcaption>
|
||
</figure>
|
||
</Grid>
|
||
<Grid item XSmall={4} XLarge={2}>
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Basic-Part-Cylinder.png" alt="A single Cylinder part." />
|
||
<figcaption><center>Cylinder</center></figcaption>
|
||
</figure>
|
||
</Grid>
|
||
<Grid item XSmall={4} XLarge={2}>
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Basic-Part-Wedge.png" alt="A single Wedge part." />
|
||
<figcaption><center>Wedge</center></figcaption>
|
||
</figure>
|
||
</Grid>
|
||
<Grid item XSmall={4} XLarge={2}>
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Basic-Part-Corner-Wedge.png" alt="A single Corner Wedge part." />
|
||
<figcaption><center>Corner Wedge</center></figcaption>
|
||
</figure>
|
||
</Grid>
|
||
</Grid>
|
||
|
||
## Part properties
|
||
|
||
Each part has a variety of properties that you can customize through the [Properties](../studio/properties.md) window.
|
||
|
||
<img src="../assets/studio/properties/Sections-Example.png" alt="A close up view of the Properties window with the Appearance and Transform properties highlighted." width="320" />
|
||
|
||
The following are commonly utilized properties:
|
||
|
||
- `Class.BasePart|Anchored` controls if physics affects the position of the part. When this property is set to true, the part never changes position due to gravity or any other force. You should anchor most parts in your experience or gravity and physics will affect your parts as soon as the experience runs.
|
||
|
||
<Alert severity="success">
|
||
To view lighted outlines around the base of anchored parts in order to visualize which parts cannot move under gravity or physics, toggle on **Anchored parts** from the [Visualization Options](../studio/ui-overview.md#visualization-options) widget in the upper‑right corner of the 3D viewport.
|
||
</Alert>
|
||
|
||
- `Class.BasePart|CanCollide` controls whether or not a part can collide with other parts. When this property is set to true, the part is impenetrable and the physics engine accounts for it within your experience. Conversely, when this property is set to false, the part can pass through anything, and the physics engine does **not** account for it.
|
||
- `Class.BasePart|Transparency` sets a part's visibility to any value between the default value of 0 (fully visible) and 1 (fully transparent). If you have many partially transparent parts, they can slow down performance. To alleviate this, merge them using [solid modeling](../parts/solid-modeling.md).
|
||
|
||
## Insert parts
|
||
|
||
The **Part** insertion button, accessible from the **Home** and **Model** tab toolbars, inserts a new part into the workspace. Click‑holding over the small corner arrow on the button lets you select either **Block**, **Sphere**, **Wedge**, **Corner Wedge**, or **Cylinder**.
|
||
|
||
<img src="../assets/studio/general/Toolbar-Insert-Part-Widget.png" width="800" alt="Part tool and its part type picker menu." />
|
||
|
||
<Alert severity="info">
|
||
To insert a `Class.TrussPart` (not available on the insertion menu), use the [Explorer](../studio/explorer.md) as outlined [here](../studio/explorer.md#insert-and-parent).
|
||
</Alert>
|
||
|
||
## Select parts
|
||
|
||
As you hover over parts in the 3D viewport, they are outlined to indicate their potential selection. You can select an outlined part by clicking it, or you can select multiple parts by holding <kbd>Shift</kbd>, <kbd>Ctrl</kbd>, or <kbd>⌘</kbd> as you hover over and click them. See [here](../studio/ui-overview.md#object-selection) for advanced methods of selecting parts in the viewport.
|
||
|
||
<img src="../assets/studio/general/Editor-Window-Object-Selection.jpg" width="800" alt="Multiple models selected in 3D viewport"/>
|
||
|
||
## Transform 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.
|
||
|
||
<img src="../assets/studio/general/Toolbar-Transform-Tools.png" width="800" alt="Transform tools indicated in Studio's toolbar." />
|
||
|
||
<GridContainer numColumns="3">
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Transform-Move-SM.png" alt="Move draggers shown on part in 3D viewport." />
|
||
<figcaption>Move</figcaption>
|
||
</figure>
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Transform-Scale-SM.png" alt="Scale draggers shown on part in 3D viewport." />
|
||
<figcaption>Scale</figcaption>
|
||
</figure>
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Transform-Rotate-SM.png" alt="Rotate draggers shown on part in 3D viewport." />
|
||
<figcaption>Rotate</figcaption>
|
||
</figure>
|
||
</GridContainer>
|
||
|
||
When using the tools, you can move, scale, or rotate parts in either **world** orientation or **local** orientation by pressing <kbd>Ctrl</kbd><kbd>L</kbd> on Windows or <kbd>⌘</kbd><kbd>L</kbd> on Mac. When you enable local orientation,
|
||
the arrow axis indicators change to a part's local orientation, and an **L** indicator displays.
|
||
|
||
<Tabs>
|
||
<TabItem label="World">
|
||
<img src="../assets/modeling/parts/Move-World-Orientation.png" width="720" height="405" alt="An angled block part with draggers in World orientation mode." />
|
||
</TabItem>
|
||
<TabItem label="Local">
|
||
<img src="../assets/modeling/parts/Move-Local-Orientation.png" width="720" height="405" alt="An angled block part with draggers in Local orientation mode." />
|
||
</TabItem>
|
||
</Tabs><br />
|
||
|
||
Tool transform **snapping** increments are based on **studs** for moving/scaling or **degrees** for rotating, each adjustable in the toolbar. While transforming, you can temporarily toggle snapping by holding the <kbd>Shift</kbd> key.
|
||
|
||
<img src="../assets/studio/general/Toolbar-Transform-Snapping.png" width="800" alt="Transform snapping tools indicated in Studio's toolbar." />
|
||
|
||
<Alert severity="info">
|
||
To quickly jump to the **move/scale** increment input, press <kbd>Shift</kbd><kbd>2</kbd>. To quickly jump to the **rotate** increment input, press <kbd>Alt</kbd><kbd>R</kbd> (Windows) or <kbd>⌥</kbd><kbd>R</kbd> (Mac).
|
||
</Alert>
|
||
|
||
### Move
|
||
|
||
You can move a selected part to a new position using the **Move** tool (default shortcut <kbd>2</kbd>) or by **cursor dragging**. While moving a part, you can temporarily toggle snapping by holding <kbd>Shift</kbd>.
|
||
|
||
<Tabs>
|
||
<TabItem label="Move Tool">
|
||
|
||
To move a part by an axis dragger along the **X**, **Y**, or **Z** axis, click/drag an arrow pointing along the desired axis of movement.
|
||
|
||
<img src="../assets/modeling/parts/Transform-Move.png" width="720" alt="A block part with the Move tool's visual aids." />
|
||
|
||
After releasing the drag, the numerical **distance indicator** remains visible. If desired, fine‑tune the distance that was moved by clicking inside the indicator and entering any number.
|
||
|
||
<img src="../assets/modeling/parts/Transform-Move-Indicator.png" width="720" alt="A moved part showing the distance moved in an indicator/input field" />
|
||
|
||
If you drag a part by its [pivot](../studio/pivot-tools.md) point while the **Move** tool is selected, the pivot will "soft snap" to surfaces and edges of nearby parts.
|
||
|
||
<img src="../assets/modeling/parts/Transform-Move-Pivot-Snap.png" width="720" alt="A block part with an offset pivot soft-snapping to the surface of a nearby part." />
|
||
|
||
</TabItem>
|
||
<TabItem label="Cursor Drag">
|
||
To move a part by cursor dragging, click anywhere on the part to grab it. If snapping is **enabled**, a ruler will appear as you hover, showing what point you'll grab the part by. As you drag the part around, another ruler will appear on the surface/edge of nearby parts, indicating alignment of the grab point.
|
||
|
||
<img src="../assets/modeling/parts/Transform-Move-Ruler-Snap.png" width="720" alt="A block part showing the grab point and snapping ruler on a neighboring part." />
|
||
|
||
If snapping is **disabled**, the part will "soft snap" to surfaces and edges of nearby parts.
|
||
|
||
<img src="../assets/modeling/parts/Transform-Move-Cursor-Drag-Snap.png" width="720" alt="A block part soft-snapping to the corner edges of a neighboring part." />
|
||
|
||
While cursor dragging, <kbd>T</kbd> and <kbd>R</kbd> can be used to quickly rotate the part in 90° increments around the point you picked it up by. <kbd>T</kbd> tilts the part 90° towards the camera, while <kbd>R</kbd> rotates the part 90° around the normal of the hovered surface.
|
||
|
||
<img src="../assets/modeling/parts/Transform-Move-Cursor-Drag-T-R.png" width="720" alt="Diagram showing how parts can be tilted and rotated with the T and R keys respectively." />
|
||
</TabItem>
|
||
</Tabs>
|
||
|
||
### Scale
|
||
|
||
To scale (resize) a selected part along the **X**, **Y**, or **Z** axis, use the **Scale** tool (default shortcut <kbd>3</kbd>) and click/drag a handle. While dragging, you can temporarily toggle snapping by holding <kbd>Shift</kbd>.
|
||
|
||
<img src="../assets/modeling/parts/Transform-Scale.png" width="720" alt="A block part with the Scale tool's visual aids." />
|
||
|
||
### Rotate
|
||
|
||
To rotate a selected part around the **X**, **Y**, or **Z** axis, use the **Rotate** tool (default shortcut <kbd>4</kbd>) and click/drag a rotation ring. While dragging, you can temporarily toggle snapping by holding <kbd>Shift</kbd>.
|
||
|
||
<img src="../assets/modeling/parts/Transform-Rotate.png" width="720" alt="A block part with the Rotate tool's visual aids." />
|
||
|
||
<Alert severity="info">
|
||
In addition to using the **Rotate** tool, you can quickly rotate selected objects 90° about their **X** axis by pressing <kbd>Ctrl</kbd><kbd>T</kbd> (<kbd>⌘</kbd><kbd>T</kbd>) or 90° about their **Y** axis by pressing <kbd>Ctrl</kbd><kbd>R</kbd> (<kbd>⌘</kbd><kbd>R</kbd>).
|
||
</Alert>
|
||
|
||
## Other actions
|
||
|
||
### Group
|
||
|
||
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 <kbd>Ctrl</kbd><kbd>G</kbd> (Windows) or <kbd>⌘</kbd><kbd>G</kbd> (Mac).
|
||
|
||
Alternatively, you can group objects into a [folder](../studio/explorer.md#organizing-by-folders) by click‑holding over the small corner arrow on the button and selecting **Group as Folder** (default shortcut of <kbd>Alt</kbd><kbd>Ctrl</kbd><kbd>G</kbd> or <kbd>⌥</kbd><kbd>⌘</kbd><kbd>G</kbd>).
|
||
|
||
<img src="../assets/studio/general/Toolbar-Group.png" width="800" alt="Group tool indicated in Studio's toolbar" />
|
||
|
||
To **ungroup** an existing model or folder, select **Ungroup** from the **Edit** menu (default shortcut of <kbd>Ctrl</kbd><kbd>U</kbd> or <kbd>⌘</kbd><kbd>U</kbd>).
|
||
|
||
### Anchor
|
||
|
||
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 <kbd>Alt</kbd><kbd>A</kbd> (Windows) or <kbd>⌥</kbd><kbd>A</kbd> (Mac).
|
||
|
||
<img src="../assets/studio/general/Toolbar-Anchor.png" width="800" alt="Anchor toggle indicated in Studio's toolbar" />
|
||
|
||
<Alert severity="info">
|
||
If you prefer a click-to-toggle workflow in the 3D viewport, click‑hold over the small corner arrow on the **Anchor** button and enable **Click object to anchor**. Once enabled, the tool operates as a "key" for both states — clicking on an unanchored object in the viewport anchors it, while clicking on an anchored object unanchors it.
|
||
</Alert>
|
||
|
||
### Color
|
||
|
||
While a part is gray by default, you can change it to any color through the following methods.
|
||
|
||
<Tabs>
|
||
<TabItem label="Color Button">
|
||
Clicking the **Color** button applies the selected color to all selected parts. You can choose a color by click‑holding over the small corner arrow on the **Color** button to reveal a hexagonal picker.
|
||
|
||
<img src="../assets/studio/general/Toolbar-Color-Picker.png" width="800" alt="Color widget's hexagonal picker." />
|
||
|
||
<Alert severity="info">
|
||
If you prefer a fill/paint workflow in the 3D viewport, enable **Click object to apply color** at the bottom of the hexagonal picker popup and then click parts in the viewport to apply the chosen color.
|
||
</Alert>
|
||
</TabItem>
|
||
<TabItem label="Color Popup">
|
||
The **Color** 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.
|
||
|
||
<img src="../assets/studio/properties/Color-Picker.png" alt="A close up view of the Properties window with the Color property's color box highlighted." width="320" />
|
||
</TabItem>
|
||
<TabItem label="RGB Value">
|
||
To define a specific RGB color value for a part, enter an RGB value into the
|
||
`Class.BasePart.Color|Color` property field.
|
||
|
||
<img src="../assets/studio/properties/Color-RGB-Entry.png" alt="A close up view of the Properties window with the Color property's RGB color value highlighted." width="320" />
|
||
</TabItem>
|
||
</Tabs>
|
||
|
||
### Material
|
||
|
||
Similar to [color](#color), you can customize a part's [material](../parts/materials.md) to simulate real‑world materials such as wood, glass, or fabric. Click‑holding over the small corner arrow on the **Material** button reveals the [material](../parts/materials.md) picker.
|
||
|
||
<img src="../assets/studio/general/Toolbar-Material-Picker.png" width="800" alt="Material widget's picker highlighted." />
|
||
|
||
When selecting a material, consider the following:
|
||
|
||
- **Material affects the physical traits of a part, not just its appearance**. For example, the `Enum.Material.Concrete|Concrete` material is heavier than the `Enum.Material.Plastic|Plastic` material, so a concrete brick will have higher density than a plastic brick and sink in water faster.
|
||
|
||
- Some materials have special physical effects. For example, parts will appear to glow if they are set to the `Enum.Material.Neon|Neon` material.
|
||
|
||
<GridContainer numColumns="3">
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Material-SmoothPlastic.png" alt="An angled red block part with a smooth plastic material." />
|
||
<figcaption>SmoothPlastic</figcaption>
|
||
</figure>
|
||
<figure>
|
||
<img src="../assets/modeling/parts/Material-Neon.png" alt="An angled red block part with a glowing neon material."/>
|
||
<figcaption>Neon</figcaption>
|
||
</figure>
|
||
</GridContainer>
|
||
|
||
See [Materials](../parts/materials.md) for more information on how to apply both
|
||
default and custom materials to parts.
|
||
|
||
### Lock
|
||
|
||
The **Lock** toggle controls whether the part can be selected from the 3D viewport. This action has a default shortcut of <kbd>Alt</kbd><kbd>L</kbd> (Windows) or <kbd>⌥</kbd><kbd>L</kbd> (Mac).
|
||
|
||
<img src="../assets/studio/general/Toolbar-Lock.png" width="800" alt="Lock tool indicated in Studio's toolbar" />
|
||
|
||
<Alert severity="info">
|
||
If you prefer a click-to-toggle workflow in the 3D viewport, click‑hold over the small corner arrow on the **Lock** button and enable **Click object to lock**. Once enabled, the tool operates as a "key" for both states — clicking on an unlocked object in the viewport locks it, while clicking on a locked object unlocks it.
|
||
</Alert>
|
||
|
||
To unlock all objects, select **Unlock All** from the **Edit** menu.
|