Component:CylinderMesh: Difference between revisions

Latest revision as of 17:49, 13 November 2024

Component image

**Cylinder Mesh** component as seen in the Scene Inspector

The CylinderMesh component is used to provide a mesh to render. The mesh that it provides is a procedural 3D cylinder with a number of sides and a radius.

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`HighPriorityIntegration`	Bool	If true, integrating this asset (e.g. processing procedural assets) gets higher priority than assets with this flag off. An example is user laser procedural meshes.
`OverrideBoundingBox`	Bool	Force the bounding box calculated from this component to use `OverridenBoundingBox` instead of calculating when requested.
`OverridenBoundingBox`	BoundingBox	the bounding box this component should say it has when `OverrideBoundingBox` is enabled. Useful for bounding box calculations with Flux, or changing the selection box for this component when rendered.
`Profile`	ColorProfile	The profile that the vertex colors for this mesh should be displayed in.
`Height`	Float	The height of the cylinder in meters in local space.
`Radius`	Float	The radius of the cylinder in meters in local space.
`Sides`	Int	How many sides the cylinder should have around it's midsection.
`Caps`	Bool	Whether the cylinder should be a tube or not.
`FlatShading`	Bool	Disable smooth shading.
`UVScale`	Float2	The inverse of the size the material should appear on the surface as.

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Description
`BakeMesh()`	Action	Bake meshes is a sync method that creates a static mesh component with this component, replaces all references to this component with the static mesh component, then deletes this component.

Usage

Attach to a slot, and assign to a Mesh Renderer to see what it looks like. Don't forget to use a Material.

Examples

An example of what a default rotated cylinder mesh looks like

@@ Line 6: / Line 6: @@
 |Name=Cylinder Mesh
 }}
-A cylinder mesh is a component that is used to provide a mesh to render. The mesh that it provides is a procedural 3D cylinder with a number of sides and a radius.
+The '''CylinderMesh''' component is used to provide a mesh to render. The mesh that it provides is a procedural 3D cylinder with a number of sides and a radius.
 <!--T:2-->
@@ Line 21: / Line 21: @@
 |FlatShading|Bool| Disable smooth shading.
 |UVScale|Float2| The inverse of the size the material should appear on the surface as.
+}}
+== Sync Delegates ==
+{{Table ComponentTriggers
+|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}}
 }}
 <!--T:3-->
 == Usage ==
-Attach to a slot, and assign to a [[Component:MeshRenderer|Mesh Renderer]] to see what it looks like. Don't forget to use a material.
+Attach to a slot, and assign to a [[Component:MeshRenderer|Mesh Renderer]] to see what it looks like. Don't forget to use a [[Material]].
 <!--T:4-->
@@ Line 34: / Line 39: @@
 <!--T:5-->
-== Related Components ==
+== See Also ==
 </translate>
 [[Category:Components{{#translation:}}|Cylinder Mesh]]
 [[Category:Components:Assets:Procedural Meshes{{#translation:}}|Cylinder Mesh]]