Reference API Roblox

Engine API

Website

Related

Reference API Roblox

CylinderMesh

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

This class is deprecated. It exists only for backward compatibility, and should not be used for new work.
Memory categoryPhysicsParts
Tags: [Deprecated]

Member index 0

HistoryMember
No members defined by CylinderMesh.
inherited from BevelMesh
inherited from DataModelMesh
553Offset: Vector3
553Scale: Vector3
553VertexColor: Vector3
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

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 Y axis.

The dimensions of the mesh scale relative to the BasePart.Size of the BasePart. This scale is uniformly along the BasePart 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.

History 5

Settings