IModAssets Interface |
Interface exposed to the modder for loading content from the mod package.
Modders should make use of this interface where the mod type includes asset prefabs.
Namespace: UMod
Assembly: UMod-Interface (in UMod-Interface.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public interface IModAssets : IModAssetsIndex<IModAsset>
The IModAssets type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AssetCount |
Returns the number of assets that are included in the mod.
|
| CanLoadAssets |
Returns true if the modder has permission to load from the mod package, otherwise false.
|
Methods| Name | Description | |
|---|---|---|
 | Instantiate(Int32) |
Attempts to instantiate an asset with the specified id.
The asset will be loaded before instantiation if necessary.
|
| Instantiate(String) |
Attempts to instantiate an asset with the specified name.
The asset will be loaded before instantiation if necessary.
|
| Instantiate(Int32, Vector3, Quaternion) |
Attempts to instantiate an asset with the specified id with the given position and rotation.
The asset will be loaded before instantiation if necessary.
|
| Instantiate(String, Vector3, Quaternion) |
Attempts to instantiate an asset with the specified name with the given position and rotation.
The asset will be loaded before instantiation if necessary.
|
| InstantiateT(Int32) |
Attempts to instantiate an asset with the specified id as the genric type.
The asset will be loaded before instantiation if necessary.
|
| InstantiateT(String) |
Attempts to instantiate an asset with the specified name or path as the genric type.
The asset will be loaded before instantiation if necessary.
|
| InstantiateT(Int32, Vector3, Quaternion) |
Attempts to instantiate an asset with the specified id as the generic type with the given position and rotation.
The asset will be loaded before instantiation if necessary.
|
| InstantiateT(String, Vector3, Quaternion) |
Attempts to instantiate an asset with the specified name or path as the generic type with the given position and rotation.
The asset will be loaded before instantiation if necessary.
|
| Load(Int32) |
Attempts to load an asset with the specified id from the mod.
Note that this method will simply load the asset without creating an instance.
|
| Load(String) |
Attempts to load an asset with the specified name or path from the mod.
Note that this method will simply load the asset without creating an instance.
|
| LoadT(Int32) |
Attempts to load an asset with the specified id from the mod.
Note that this method will simply load the asset without creating an instance.
|
| LoadT(String) |
Attempts to load an asset with the specified name or path from the mod.
Note that this method will simply load the asset without creating an instance.
|
| LoadAsync(Int32) |
Attempts to load an asset with the specified id from the mod asynchronously.
Note that this method will simple load the asset without creating an instance.
|
| LoadAsync(String) |
Attempts to load an asset with the specified name or path from the mod asynchronously.
Note that this method will simple load the asset without creating an instance.
|
| LoadAsyncT(Int32) |
Attempts to load an asset with the specified id from the mod asynchronously.
Note that this method will simple load the asset without creating an instance.
|
| LoadAsyncT(String) |
Attempts to load an asset with the specified name or path from the mod asynchronously.
Note that this method will simple load the asset without creating an instance.
|
| LoadWithSubAssets(Int32) |
Attempts to load an asset with the specified id from the mod along with all sub assets.
The return array represents all sub assets of the specfied parent asset.
|
| LoadWithSubAssets(String) |
Attempts to load an asset with the specified name or path from the mod along with all sub assets.
The return array represents all sub assets of the specified parent asset.
|
| LoadWithSubAssetsT(Int32) |
Attempts to load an asset with the specified id from the mod along with all sub assets of the specified generic type.
The return array represents all sub assets of the specified parent asset.
|
| LoadWithSubAssetsT(String) |
Attempts to load an asset with the specified name or path from the mod along with all sub assets of the specified generic type.
The return array represents all sub assets of the specified parent asset
|
| LoadWithSubAssetsAsync(Int32) | |
| LoadWithSubAssetsAsync(String) | |
| LoadWithSubAssetsAsyncT(Int32) | |
| LoadWithSubAssetsAsyncT(String) |
See Also