CylinderHandleAdornment
A cylinder-shaped handle that can be adorned to a BasePart.
| Memory category | Instances |
|---|
Member index 5
Description
History 28
- 731 Change Default of Shading from to Default
- 731 Change Default of Radius from to 1
- 731 Change Default of InnerRadius from to 0
- 731 Change Default of Height from to 1
- 731 Change Default of Angle from to 360
- 726 Change Default of Shading from Default to
- 726 Change Default of Radius from 1 to
- 726 Change Default of InnerRadius from 0 to
- 726 Change Default of Height from 1 to
- 726 Change Default of Angle from 360 to
- 686 Add Shading
- 553 Change Default of Radius from to 1
- 553 Change Default of InnerRadius from to 0
- 553 Change Default of Height from to 1
- 553 Change Default of Angle from to 360
- 486 Change ThreadSafety of Radius from ReadOnly to ReadSafe
- 486 Change ThreadSafety of InnerRadius from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Height from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Angle from ReadOnly to ReadSafe
- 462 Change ThreadSafety of Radius from to ReadOnly
- 462 Change ThreadSafety of InnerRadius from to ReadOnly
- 462 Change ThreadSafety of Height from to ReadOnly
- 462 Change ThreadSafety of Angle from to ReadOnly
- 441 Add InnerRadius
- 441 Add Angle
- 196 Add Radius
- 196 Add Height
- 196 Add CylinderHandleAdornment
Members 5
Angle
| Type | Default | |
|---|---|---|
| float | 360 | |
The angle of the cylinder handle as in a "pie slice" sector. For example,
if set to 90, a quarter cylinder will render instead of a full cylinder.
This property can be combined with
InnerRadius to render a sector
of a hollow cylinder.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
Height
| Type | Default | |
|---|---|---|
| float | 1 | |
The height of the cylinder adornment in studs.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
InnerRadius
| Type | Default | |
|---|---|---|
| float | 0 | |
The inner radius with which to render a hollow cylinder, in studs. For
example, if Radius is 2 and
InnerRadius is 1, the adornment will be a hollow cylinder with a "wall
thickness" of 1 stud. This property can be combined with
Angle to render a sector of a hollow
cylinder.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 6
- 731 Change Default of InnerRadius from to 0
- 726 Change Default of InnerRadius from 0 to
- 553 Change Default of InnerRadius from to 0
- 486 Change ThreadSafety of InnerRadius from ReadOnly to ReadSafe
- 462 Change ThreadSafety of InnerRadius from to ReadOnly
- 441 Add InnerRadius
Radius
| Type | Default | |
|---|---|---|
| float | 1 | |
The radius of the cylinder adornment in studs.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
Shading
| Type | Default | |
|---|---|---|
| AdornShading | Default | |
Shading selects the material and render pass used to draw the cylinder,
using a value of the AdornShading enum. It defaults to
Default, which draws the cylinder unlit and occluded
by scene geometry like an ordinary world object.
Shaded and XRayShaded light the cylinder with the scene's lighting instead of drawing it unlit, while XRay and XRayShaded draw the cylinder through geometry that would otherwise occlude it. AlwaysOnTop draws the cylinder on top of everything else with no depth testing.
The legacy HandleAdornment.AlwaysOnTop property only takes effect
while Shading is Default; any other Shading value
determines the render pass on its own.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |