Component:RenderMaterialOverride: Difference between revisions

Latest revision as of 15:36, 10 March 2025

Component image

**Render Material Override** component as seen in the Scene Inspector

The RenderMaterialOverride Component allows for overriding materials on a renderer when it is rendered in certain contexts.

Note: This only overrides materials properly if all Contexts are used, with a component for each one. This may be a bug.

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.
`Context`	RenderingContext	The context in which to override the materials of `Renderer` with the list of `Overrides`.
`Renderer`	MeshRenderer	The renderer to override materials for.
`Overrides`	list of MaterialOverride	A list of materials to override during rendering in a `Context` context.

MaterialOverride

Fields
Name	Type	Description
`Index`	Int	The material index on `Renderer` to override.
`Material`	Material	The material to override `Renderer`'s materials for material `Index`.

Usage

Used to hide materials or change them in a mirror. like showing an evil version of yourself in a mirror, or to hide your head material from your own viewpoint

@@ Line 3: / Line 3: @@
 |Name=Render Material Override
 }}
-{{stub}}
+The '''RenderMaterialOverride''' Component allows for overriding materials on a renderer when it is rendered in certain contexts.
-== Usage ==
+Note: This only overrides materials properly if all <code>Context</code>s are used, with a component for each one. This may be a bug.
+== Fields ==
 {{Table ComponentFields
-|Context|RenderingContext|
+|Context|RenderingContext| The context in which to override the materials of <code>Renderer</code> with the list of <code>Overrides</code>.
-|Renderer|'''[[Component:MeshRenderer|MeshRenderer]]'''|TypeAdv1=true|
+|Renderer|'''[[Component:MeshRenderer|MeshRenderer]]'''|TypeAdv1=true| The renderer to override materials for.
-|Overrides|{{RootFieldType|SyncList`1|[[#MaterialOverride|MaterialOverride]]}}|TypeAdv2=true|
+|Overrides|{{RootFieldType|SyncList`1|[[#MaterialOverride|MaterialOverride]]}}|TypeAdv2=true| A list of materials to override during rendering in a <code>Context</code> context.
 }}
-== Behavior ==
+== MaterialOverride ==
+{{Table TypeFields
+|Index|Int| The material index on <code>Renderer</code> to override.
+|Material|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv1=true| The material to override <code>Renderer</code>'s materials for material <code>Index</code>.
+}}
+== Usage ==
+Used to hide materials or change them in a mirror. like showing an evil version of yourself in a mirror, or to hide your head material from your own viewpoint
 == Examples ==
 == See Also ==
+* [[Component:RenderTransformOverride]]
 [[Category:Components:Rendering{{#translation:}}|Render Material Override]]
 [[Category:Components{{#translation:}}|Render Material Override]]
 [[Category:Components With Nested Types{{#translation:}}|Render Material Override]]
-[[Category:ComponentStubs]]