Interface ISceneTemplatePipeline
Interface a user should derive from when a user wants to package a custom code sequence when a template is instantiated. ISceneTemplatePipeline are instantiated once when a template is instantiated and are notified multiple times through the instantiation sequence.
Namespace: Global Namespace
Assembly: solution.dll
Syntax
public interface ISceneTemplatePipelineMethods
AfterTemplateInstantiation(SceneTemplateAsset, Scene, bool, string)
Event called after the template is instantiated and the new scene is still loaded.
Declaration
void AfterTemplateInstantiation(SceneTemplateAsset sceneTemplateAsset, Scene scene, bool isAdditive, string sceneName)Parameters
| Type | Name | Description |
|---|---|---|
| SceneTemplateAsset | sceneTemplateAsset | Scene Template asset that will be instantiated |
| Scene | scene | The newly created scene |
| bool | isAdditive | Is the new scene created in additive mode. |
| string | sceneName | What is the path of the new scene (could be empty if untitled) |
BeforeTemplateInstantiation(SceneTemplateAsset, bool, string)
Event called before the template is instantiated.
Declaration
void BeforeTemplateInstantiation(SceneTemplateAsset sceneTemplateAsset, bool isAdditive, string sceneName)Parameters
| Type | Name | Description |
|---|---|---|
| SceneTemplateAsset | sceneTemplateAsset | Scene Template asset that will be instantiated |
| bool | isAdditive | Is the new scene created in additive mode. |
| string | sceneName | What is the path of the new scene (could be empty if untitled) |
IsValidTemplateForInstantiation(SceneTemplateAsset)
Event called before we display the New Template Dialog to determine if this template should be available to user.
Declaration
bool IsValidTemplateForInstantiation(SceneTemplateAsset sceneTemplateAsset)Parameters
| Type | Name | Description |
|---|---|---|
| SceneTemplateAsset | sceneTemplateAsset | Scene Template asset that would be avauilable in New Scene Dialog |
Returns
| Type | Description |
|---|---|
| bool |