Component:MaterialRelay: Difference between revisions

Revision as of 20:25, 24 January 2025

Component image

The MaterialRelay component is used to specify to a Material Tool when hitting a slot what materials to grab/apply to when using the tool.

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.
`MaterialRefs`	list of AssetRef`1<Material>	A list of material storage fields that a material tool when applying should apply to. The first non null item in the list is the one a material tool will pick up when using the secondary action.

Attach to the root of an object and provide a list of material storage fields from, for example, Component:MeshRenderer or Component:SkinnedMeshRenderer to make Relays for.

Added to the root of new avatars made with the avatar creator.

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=MaterialRelayComponent.png
 |Name=Material Relay
 }}
+The '''MaterialRelay''' component is used to specify to a [[Material Tool]] when hitting a slot what materials to grab/apply to when using the tool.
 <!--T:2-->
 == Fields ==
 {{Table ComponentFields
-|MaterialRefs|{{RootFieldType|SyncRefList`1|[[Type:AssetRef`1|AssetRef`1]]&lt;[[Type:Material|Material]]&gt;}}|TypeAdv0=true|
+|MaterialRefs|{{RootFieldType|SyncRefList`1|[[Type:AssetRef`1|AssetRef`1]]&lt;[[Type:Material|Material]]&gt;}}|TypeAdv0=true| A list of material storage fields that a material tool when applying should apply to. The first non null item in the list is the one a material tool will pick up when using the secondary action.
 }}
 <!--T:3-->
 == Usage ==
+Attach to the root of an object and provide a list of material storage fields from, for example, [[Component:MeshRenderer]] or [[Component:SkinnedMeshRenderer]] to make Relays for.
 <!--T:4-->
 == Examples ==
+Added to the root of new avatars made with the avatar creator.
 <!--T:5-->
-== Related Components ==
+== See Also ==
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Material Relay]]
 [[Category:Components:Assets:Tagging{{#translation:}}|Material Relay]]