Component:MeshRenderer: Difference between revisions

From Resonite Wiki
Automated: update Replace
Reformat
 
Line 8: Line 8:
<!--T:1-->
<!--T:1-->
The '''MeshRenderer''' component is used for rendering static 3D meshes in the world, and applying materials to that mesh.
The '''MeshRenderer''' component is used for rendering static 3D meshes in the world, and applying materials to that mesh.
== Usage ==
 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Mesh|{{RootFieldType|AssetRef`1|[[Type:Mesh|Mesh]]}}|TypeAdv0=true| The mesh to be rendered. Can be a [[StaticMesh (Component)|StaticMesh]] or a [[:Category:Components:Assets:Procedural Meshes|Procedural Mesh]]
|Mesh|{{RootFieldType|AssetRef`1|[[Type:Mesh|Mesh]]}}|TypeAdv0=true| The mesh to be rendered. Can be a [[StaticMesh (Component)|StaticMesh]] or a [[:Category:Components:Assets:Procedural Meshes|Procedural Mesh]]
|Materials|{{RootFieldType|SyncAssetList`1|[[Type:Material|Material]]}}|TypeAdv1=true| A list of materials to be applied to the mesh
|Materials|{{RootFieldType|SyncAssetList`1|[[Type:Material|Material]]}}|TypeAdv1=true| A list of materials to be applied to the mesh
|MaterialPropertyBlocks|{{RootFieldType|SyncAssetList`1|[[Type:MaterialPropertyBlock|MaterialPropertyBlock]]}}|TypeAdv2=true|
|MaterialPropertyBlocks|{{RootFieldType|SyncAssetList`1|[[Type:MaterialPropertyBlock|MaterialPropertyBlock]]}}|TypeAdv2=true| A list of material property blocks to apply to the materials on this mesh. Usually used for performance reasons where using multiple similar materials would take more resources.
|ShadowCastMode|ShadowCastMode| How this object will cast shadows onto the world, or if it <i>only</i> draws a shadow.
|ShadowCastMode|ShadowCastMode| How this object will cast shadows onto the world, or if it <i>only</i> draws a shadow.
|MotionVectorMode|MotionVectorMode|
|MotionVectorMode|MotionVectorMode| See Motion vector mode.
|SortingOrder|Int|
|SortingOrder|Int| Whether to render this before or after other renderers with geometry in the same location.
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|SplitSubmeshes()|[[Type:Action|Action]]|
|SplitSubmeshes()|[[Type:Action|Action]]| Will split this mesh into additional submeshes, each having only one material.
|MergeByMaterial()|[[Type:Action|Action]]|
|MergeByMaterial()|[[Type:Action|Action]]| Will merge all submeshes that use the same material.
}}
}}


== Behavior == <!--T:3-->
== Usage == <!--T:3-->
 
=== Special Functions === <!--T:4-->
 
{{Table ComponentTriggers
|SplitSubmeshes()|null|Will split this mesh into additional submeshes, each having only one material
|MergeByMaterial()|null|Will merge all submeshes that use the same material
}}


== Examples == <!--T:2-->
== Examples == <!--T:2-->


== Related Components == <!--T:5-->
== See Also == <!--T:5-->
* [[Component:SkinnedMeshRenderer]]
</translate>
</translate>
[[Category:Components{{#translation:}}|Mesh Renderer]]
[[Category:Components{{#translation:}}|Mesh Renderer]]
[[Category:Components:Rendering{{#translation:}}|Mesh Renderer]]
[[Category:Components:Rendering{{#translation:}}|Mesh Renderer]]
[[Category:ComponentStubs]]
[[Category:Renderer]]
[[Category:Renderer]]

Latest revision as of 23:02, 24 December 2024


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Component image 
MeshRenderer component as seen in the Scene Inspector

The MeshRenderer component is used for rendering static 3D meshes in the world, and applying materials to that mesh.

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.
Mesh Mesh The mesh to be rendered. Can be a StaticMesh or a Procedural Mesh
Materials list of Material A list of materials to be applied to the mesh
MaterialPropertyBlocks list of MaterialPropertyBlock A list of material property blocks to apply to the materials on this mesh. Usually used for performance reasons where using multiple similar materials would take more resources.
ShadowCastMode ShadowCastMode How this object will cast shadows onto the world, or if it only draws a shadow.
MotionVectorMode MotionVectorMode See Motion vector mode.
SortingOrder Int Whether to render this before or after other renderers with geometry in the same location.

Sync Delegates

Triggers
Method Name Method type and Arguments. Description
SplitSubmeshes() Action Will split this mesh into additional submeshes, each having only one material.
MergeByMaterial() Action Will merge all submeshes that use the same material.

Usage

Examples

See Also