PyramidHandleAdornment
A pyramid-shaped handle that can be adorned to a BasePart.
| Memory category | Instances |
|---|
Member index 4
Description
History 5
Members 4
Height
| Type | Default | |
|---|---|---|
| float | 2 | |
The height of the pyramid adornment in studs.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
Shading
| Type | Default | |
|---|---|---|
| AdornShading | Default | |
An AdornShading value that selects the material and render pass used to draw the pyramid. Defaults to Default, which draws the pyramid unlit and occluded by scene geometry like an ordinary world object.
Shaded and XRayShaded light the pyramid with the scene's lighting instead of drawing it unlit, while XRay and XRayShaded draw the pyramid through geometry that would otherwise occlude it. AlwaysOnTop draws the pyramid 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 |
Sides
| Type | Default | |
|---|---|---|
| int | 4 | |
The number of sides for the pyramid adornment. Default is 4, minimum is
3, and maximum is 32.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
Size
| Type | Default | |
|---|---|---|
| float | 1 | |
The size of the pyramid adornment's base in studs.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |