Component:AssetProxy: Difference between revisions

Latest revision as of 01:22, 21 March 2024

Component image

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

Asset Proxy is a component that allows for access to an asset through a slot when being grabbed by the user.

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.
`AssetReference`	IAsset`1	The asset to expose to asset ref fields when grabbing the object root of the slot this component is on.

Usage

put this component on a slot and fill the AssetReference with an asset reference to allow access to an asset via holding this slot's object root. The asset will then be available when holding onto the object root of the slot this component is on, and clicking on a UIX field (ex: an inspector field) places the asset type that this component has inside of it into the field.

Examples

This is used on items like imported audio clips and images, to allow them to be used and dropped into inspector fields.

Related Components

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=AssetProxy`1Component.png
 |Name=Asset Proxy`1
 }}
+Asset Proxy is a component that allows for access to an asset through a slot when being grabbed by the user.
 <!--T:2-->
 == Fields ==
 {{Table ComponentFields
-|AssetReference|IAssetProvider`1|TypeString0=IAssetProvider<ITexture2D>|
+|AssetReference|{{RootFieldType|AssetRef`1|[[Type:IAsset`1|IAsset`1]]}}|TypeAdv0=true| The asset to expose to asset ref fields when grabbing the object root of the slot this component is on.
 }}
 <!--T:3-->
 == Usage ==
+put this component on a slot and fill the <code>AssetReference</code> with an asset reference to allow access to an asset via holding this slot's object root. The asset will then be available when holding onto the object root of the slot this component is on, and clicking on a UIX field (ex: an inspector field) places the asset type that this component has inside of it into the field.
 <!--T:4-->
 == Examples ==
+This is used on items like imported audio clips and images, to allow them to be used and dropped into inspector fields.
 <!--T:5-->
 == Related Components ==
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Generics{{#translation:}}]]
 [[Category:Components{{#translation:}}|Asset Proxy`1]]
+[[Category:Generic Components{{#translation:}}|Asset Proxy`1]]
 [[Category:Components:Uncategorized{{#translation:}}|Asset Proxy`1]]