Component:BoxArrayMesh: Difference between revisions

Revision as of 13:11, 6 November 2024

Component image

Box Array Mesh is a component that is generated by brush tools and can be a cloud of boxes with points, sizes, and rotations.

Note: Points, Sizes, Rotations, Colors, and UV_Scales arrays must be the same length for this component to work.

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 Float3	List of positions that there should be boxes
`Sizes`	array of Float3	List of sizes for each box.
`Rotations`	array of FloatQ	List of rotations for each box.
`Colors`	array of Color	List of colors for each box.
`ColorsProfile`	ColorProfile	The profile that the vertex colors for this mesh should be displayed in.. However, this is for every box in the array.
`UV_Scales`	array of Float3	List of UV scales for each box, scaling the material surface detail bigger or smaller.

Triggers
Method Name	Method type and Arguments.	Description
`BakeMesh()`	Action

Use a brush tool from ResoniteEssentials/Tools/Brushes/Box Brushes and draw to make one of these with values already initialized.

An example of the result of a box array mesh generated by a brush tool.

@@ Line 23: / Line 23: @@
 |ColorsProfile|ColorProfile| {{Template:ProceduralMeshColorProfile}}. However, this is for every box in the array.
 |UV_Scales|{{RootFieldType|SyncArray`1|[[Type:Float3|Float3]]}}|TypeAdv9=true| List of UV scales for each box, scaling the material surface detail bigger or smaller.
+}}
+== Sync Delegates ==
+{{Table ComponentTriggers
+|BakeMesh()|[[Type:Action|Action]]|
 }}
@@ Line 39: / Line 44: @@
 </translate>
 [[Category:Components{{#translation:}}|Box Array Mesh]]
+[[Category:ComponentStub]]
 [[Category:Components:Assets:Procedural Meshes{{#translation:}}|Box Array Mesh]]