Component:TubeMesh: Difference between revisions

From Resonite Wiki
Automated: update DeDuplicate
Add info
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=TubeMeshComponent.png
|Image=TubeMeshComponent.png
|Name=Tube Mesh
|Name=Tube Mesh
}}
}}
The '''TubeMesh''' component is used to generate a procedural tube mesh for use with a [[Component:MeshRenderer]].
The <code>Points</code> field currently requires [[Mods]] to edit.


<!--T:2-->
<!--T:2-->
Line 12: Line 14:
{{Table ComponentFields
{{Table ComponentFields
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|OverrideBoundingBox|Bool|
|OverrideBoundingBox|Bool| {{Template:Override Bounding Box}}
|OverridenBoundingBox|BoundingBox|
|OverridenBoundingBox|BoundingBox| {{Template:Overridden Bounding Box}}
|Profile|ColorProfile|
|Profile|ColorProfile| {{Template:ProceduralMeshColorProfile}}
|Points|{{RootFieldType|SyncArray`1|[[Type:TubePoint|TubePoint]]}}|TypeAdv4=true|
|Points|{{RootFieldType|SyncArray`1|[[Type:TubePoint|TubePoint]]}}|TypeAdv4=true| A list of points that the tube should follow in order.
|SegmentPoints|Int|
|SegmentPoints|Int| How many cuts/bend points there should be between each [[Type:TubePoint|TubePoint]] in <code>Points</code>
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|BakeMesh()|[[Type:Action|Action]]|
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Attach the component into a slot and insert it into a [[Component:MeshRenderer]] to view the geometry. Don't forget a [[Material]].


<!--T:4-->
<!--T:4-->
Line 31: Line 34:


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>


[[Category:Components{{#translation:}}|Tube Mesh]]
[[Category:Components{{#translation:}}|Tube Mesh]]
[[Category:ComponentStubs]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Tube Mesh]]
[[Category:Components:Assets:Procedural Meshes{{#translation:}}|Tube Mesh]]

Latest revision as of 21:03, 10 November 2024

Component image 
Tube Mesh component as seen in the Scene Inspector

The TubeMesh component is used to generate a procedural tube mesh for use with a Component:MeshRenderer.

The Points field currently requires Mods to edit.

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.
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.
Points array of TubePoint A list of points that the tube should follow in order.
SegmentPoints Int How many cuts/bend points there should be between each TubePoint in Points

Sync Delegates

Triggers
Name 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 the component into a slot and insert it into a Component:MeshRenderer to view the geometry. Don't forget a Material.

Examples

See Also