BoxHandleAdornment
A box-shaped handle that can be adorned to a BasePart.
| Memory category | Instances |
|---|
Member index 2
Description
History 6
Members 2
Shading
| Type | Default | |
|---|---|---|
| AdornShading | Default | |
Shading selects the material and render pass used to draw the box, using
a value of the AdornShading enum. It defaults to
Default, which draws the box unlit and occluded by
scene geometry like an ordinary world object.
Shaded and XRayShaded light the box with the scene's lighting instead of drawing it unlit, while XRay and XRayShaded draw the box through geometry that would otherwise occlude it. AlwaysOnTop draws the box 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 |
Size
| Type | Default | |
|---|---|---|
| Vector3 | 1, 1, 1 | |
The size of the adornment in studs.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |