Data type
Faces
A data type containing six booleans, each representing a face of a
BasePart.
The Faces data type contains six booleans representing whether a
feature is enabled for each face (NormalId) of a Part. In other words,
this contains a boolean for each axes (X/Y/Z) in both directions
(positive/negative). The Handles object uses this data type to enable
whether a direction has a visible handle on a Part's face.
local handles = Instance.new("Handles")
handles.Faces = Faces.new(Enum.NormalId.Front, Enum.NormalId.Left)Like most data types on Roblox, the Faces data type is immutable and you
cannot assign to its properties once created.
Constructors 1#
new(normalIds...: Tuple)#
Creates a new Faces given some number of NormalId as arguments.
Each NormalId provided indicates the property of the same name in
the new Faces will be true.
- The
table.unpack()function can be used to unpack a table of NormalId to be included. - Passing values that are not a
NormalIdwill do nothing; they are ignored silently.
| Name | Type | Default | Description |
|---|---|---|---|
normalIds... | Tuple | Any number of NormalId values indicating which faces to enable
in the new Faces. |
Properties 6#
Topbool | Whether the top face is included. |
Bottombool | Whether the bottom face is included. |
Leftbool | Whether the left face is included. |
Rightbool | Whether the right face is included. |
Backbool | Whether the back face is included. |
Frontbool | Whether the front face is included. |
Top: bool#
Whether the top face (positive Y direction, corresponding to
NormalId.Top) is included in this Faces value. Defaults
to false when NormalId.Top is not passed to the
Faces.new() constructor.
Bottom: bool#
Whether the bottom face (negative Y direction, corresponding to
NormalId.Bottom) is included in this Faces value.
Defaults to false when NormalId.Bottom is not passed to the
Faces.new() constructor.
Left: bool#
Whether the left face (negative X direction, corresponding to
NormalId.Left) is included in this Faces value. Defaults
to false when NormalId.Left is not passed to the
Faces.new() constructor.
Right: bool#
Whether the right face (positive X direction, corresponding to
NormalId.Right) is included in this Faces value.
Defaults to false when NormalId.Right is not passed to the
Faces.new() constructor.
Back: bool#
Whether the back face (positive Z direction, corresponding to
NormalId.Back) is included in this Faces value. Defaults
to false when NormalId.Back is not passed to the
Faces.new() constructor.
Front: bool#
Whether the front face (negative Z direction, corresponding to
NormalId.Front) is included in this Faces value.
Defaults to false when NormalId.Front is not passed to the
Faces.new() constructor.