Component:AssetMultiplexer: Difference between revisions

Revision as of 03:31, 14 February 2024

Component image

**Asset Multiplexer`1** component as seen in the Scene Inspector

The AssetMultiplexer component is used to drive a field to one asset from a list, based on its position in the list.

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.
`Target`	AssetRef<IAsset`1>	The field to drive.
`Index`	Int	Which element in `Assets` to drive to `Target`
`Assets`	SyncAssetList<IAsset`1>	The list of assets to multiplex between.

Usage

Add the list of assets you want to use through the SyncAssetList<IAsset`1> area, then add in your assets into the items. Then you can specify the field through the Target you wanna switch between different assets for. Changing the Index will change which asset the Target has in it.

Examples

Using an asset multiplexer to allow your avatar to switch shirts via changing the texture, a pattern changer for a music visualizer.

Related Components

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=AssetMultiplexer`1Component.png
 |Name=Asset Multiplexer`1
 }}
 The AssetMultiplexer component is used to drive a field to one asset from a list, based on its position in the list.
@@ Line 13: / Line 11: @@
 == Fields ==
 {{Table ComponentFields
-|Target|AssetRef`1|TypeString0=AssetRef<ITexture2D>| The field to drive.
+|Target|AssetRef`1|TypeString0=AssetRef<IAsset`1>| The field to drive.
 |Index|Int| Which element in <code>Assets</code> to drive to <code>Target</code>
-|Assets|SyncAssetList`1|TypeString2=SyncAssetList<ITexture2D>| The list of assets to multiplex between.
+|Assets|Asset`1|TypeString2=SyncAssetList<IAsset`1>| The list of assets to multiplex between.
 }}
 <!--T:3-->
 == Usage ==
+Add the list of assets you want to use through the SyncAssetList<IAsset`1> area, then add in your assets into the items. Then you can specify the field through the Target you wanna switch between different assets for. Changing the Index will change which asset the Target has in it.
 <!--T:4-->
 == Examples ==
+Using an asset multiplexer to allow your avatar to switch shirts via changing the texture, a pattern changer for a music visualizer.
-== Related Issues == <!--T:5-->
-[https://github.com/Neos-Metaverse/NeosPublic/issues/247 #247 - Allow importing a complete directory into a AssertMultiplexer]
 <!--T:6-->
 == Related Components ==
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Generics{{#translation:}}]]
 [[Category:Components{{#translation:}}|Asset Multiplexer`1]]
 [[Category:Components:Assets:Utility{{#translation:}}|Asset Multiplexer`1]]