IModScenes Interface |
Interface exposed to the modder for loading scene content from the mod package.
Modders may want to make use of this interface if their mod contains scene assets.
Namespace: UMod
Assembly: UMod-Interface (in UMod-Interface.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public interface IModScenes : IModAssetsIndex<IModScene>
The IModScenes type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CanLoadScenes |
Returns true if the modder has permission to load scenes from the mod package, otherwise false.
|
| DefaultScene |
Get the default IModScene for the mod or null if there are no scenes in the mod.
|
| SceneCount |
Returns the number of scenes that are included in the mod.
|
Methods| Name | Description | |
|---|---|---|
 | Load(Int32, Boolean) |
Attempts to load a scene with the specified name or path from the mod.
Note that if the scene is not found then this method does nothing.
You can use [!:Exists(int)] before calling this method to ensure that the scene will be loaded.
|
| Load(String, Boolean) |
Attempts to load a scene with the specified name or path from the mod.
Note that if the scene is not found then this method does nothing.
You can use [!:Exists(string)] before calling this method to ensure that the scene will be loaded.
|
| LoadAsync(Int32, Boolean) |
Attempts to load a scene with the specified name or path from the mod asynchronously.
Note that if the scene is not found then this method does nothing.
You can use [!:Exists(int)] before calling this method to ensure that the scene will be loaded.
|
| LoadAsync(String, Boolean) |
Attempts to load a scene with the specified name or path from the mod asynchronously.
Note that if the scene is not found then this method does nothing.
You can use [!:Exists(string)] before calling this method to ensure that the scene will be loaded.
|
See Also