PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

CylinderMesh

Show deprecated

CylinderMesh

Show deprecated

The CylinderMesh object applies a ‘cylinder’ mesh to the BasePart it is parented to.

What does a CylinderMesh do?

A CylinderMesh gives the BasePart it was applied to a cylinder shaped mesh.

The mesh applied gives the same appearance as that due to the SpecialMesh/MeshType of a SpecialMesh being set to ‘Cylinder’ or Part/Shape being set to ‘Cylinder’. However, unlike those two cases, it is orientated so that the height of the cylinder is along the BasePart's Y axis.

The dimensions of the mesh scale relative to the BasePart/Size of the BasePart. This scale is uniformly along the BasePart's Y axis and maintaining a 1:1 ratio for the part’s X and Z axis, using the lowest value. This means the BasePart can be resized normally, but the cross section of the cylinder will always remain a circle and cannot be stretched or compressed.

Note as the CylinderMesh object does not include a texture the DataModelMesh/VertexColor property does not do anything.

Why use a CylinderMesh?

The advantage of using a mesh over setting the Part/Shape property of a part to ‘Cylinder’ is that the DataModelMesh/Scale and DataModelMesh/Offset properties are exposed. These allow the position and dimensions of the mesh that is displayed to be changed without changing the BasePart/Position or BasePart/Size of the Part the mesh is parented to.

The key difference between a CylinderMesh or a SpecialMesh with SpecialMesh/MeshType set to ‘Cylinder’ is the orientation of the cylinder mesh. With a CylinderMesh, the height of the cylinder is aligned with the height (Y axis) of the part. With a SpecialMesh (or Part with Part/Shape set to ‘Cylinder’), the height of the cylinder is aligned with the X axis.

Properties

Inherited from DataModelMesh: Show Hide

Vector3

VertexColor

Changes the hue of the mesh's texture. Only functional when used with the `SpecialMesh` object as it includes the `SpecialMesh/TextureId` property.
Vector3

Scale

The Scale of a mesh determines the size of the mesh relative to its original dimensions.
Vector3

Offset

The Offset of a mesh determines the relative position from the `BasePart/Position` of a `BasePart` that the mesh will be displayed at.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

Inherited from Instance: Show Hide

Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
string

GetFullName ( )

Returns a string describing the `Instance`'s ancestry.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.