AssetList Class

Summary

A UnityEngine.ScriptableObject containing a list automatically populated with all assets of a given type in a specific folder. Gathering takes place in the Unity Editor so the list can be loaded efficiently at runtime.
Assembly
Weaver.dll
Namespace
Weaver
Interfaces
  • WeaverWindow.IItem
Base Types
Derived Types
graph BT Type-->Base0["AssetListBase"] click Base0 "/weaver/api/Weaver/AssetListBase" Base0-->Base1["ScriptableObject"] Type-.->Interface0["WeaverWindow.IItem"] Type["AssetList"] class Type type-node Derived0["LazyAssetList<T>"]-->Type click Derived0 "/weaver/api/Weaver/LazyAssetList_1" Derived1["AssetList<T>"]-->Type click Derived1 "/weaver/api/Weaver/AssetList_1"

Syntax

public abstract class AssetList : AssetListBase, WeaverWindow.IItem

Properties

Name Value Summary
AssetType Type
The type of assets in this list.
Inherited from AssetListBase
Count int
The number of assets in this list.
Inherited from AssetListBase
Directory DefaultAsset
[Editor-Only] The directory from which this list will gather assets.
IsLazy bool
If true: this list will only load its assets as they are needed rather than on startup.
Inherited from AssetListBase
MetaDataType Type
The type of meta data in this list.
Inherited from AssetListBase
Recursive bool
[Editor-Only] If true: this list will gather assets in any sub-directories as well as the target directory.
Tooltip string
[Editor-Only] The text to use to describe this list when showing a tooltip in the Weaver.Editor.Window.WeaverWindow.
Inherited from AssetListBase

Methods

Name Value Summary
Clear() void
Clears all the assets from this list.
Inherited from AssetListBase
DoDetailsGUI() void
[Editor-Only] Draws the details of this list in the inspector.
Inherited from AssetListBase
GatherAssets() void
[Editor-Only] Override to gather the assets in the target Weaver.AssetListBase.Directory.
Inherited from AssetListBase
GatherAssets<T>(List<T>) void
[Editor-Only] Gathers all assets in the target Weaver.AssetListBase.Directory into the `assets` list.
Inherited from AssetListBase
GatherAssets<T>(List<T>, string, bool) void
[Editor-Only] Gathers all assets in the target Weaver.AssetListBase.Directory into the `assets` list.
Inherited from AssetListBase
static
GatherAssetsIfDirty() void
[Editor-Only] Gathers the assets in the target Weaver.AssetListBase.Directory if they might have changed since this method was last called.
Inherited from AssetListBase
GatherResources<T>(List<string>, List<T>) void
[Editor-Only] Gathers all assets and their resource paths in the target Weaver.AssetListBase.Directory.
Inherited from AssetListBase
GetAndVerifyDirectoryPath() string
[Editor-Only] Returns the path of the target Weaver.AssetListBase.Directory relative to the project root or null if a valid folder isn't assigned.
Inherited from AssetListBase
GetRandomIndex() int
Returns a random index in this list.
Inherited from AssetListBase
OnDisable() void
[Editor-Only] Called by Unity when this list is unloaded. Ensures that all assets in the target Weaver.AssetListBase.Directory are gathered so they can be serialized.
Inherited from AssetListBase
OnEnable() void
[Editor-Only] Ensures that this list is in the global collection of all lists so it can be displayed in the Weaver Window and can show project window overlays on its target assets.
Inherited from AssetListBase
Reset() void
[Editor-Only] Assigns the currently selected object as the Weaver.AssetListBase.Directory if possible.
Inherited from AssetListBase
SetListTypes(Type, Type, Type) void
[Editor-Only] Assigns the list types that need to be defined outside this assembly so they c an be used internally.
Inherited from AssetListBase
static