Version: 2023.1
LanguageEnglish
  • C#

SceneTemplateAsset

class in UnityEditor.SceneTemplate

/

Inherits from:ScriptableObject

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

An Asset that stores everything required to instantiate a new Scene from a templated Scene.

Properties

addToDefaultsUse this field to add this template to the list of default templates in the New scene dialog.
badgeThe Scene template's badge.
dependenciesLists Scene dependencies, and specifies whether to clone or reference each one.
descriptionA description of the Scene template. This description can be long. In the Unity editor, it appears on multiple lines.
isValidSpecifies whether the Scene template is valid. Invalid templates do not appear in the New Scene dialog.
previewThe Scene template's preview image or icon.
templateNameA user-defined name for the Scene template Asset. By default, this is the template's file name.
templatePipelineA script that derives from ISceneTemplatePipeline. It allows you to execute custom code when a template is instantiated.
templateSceneThe Scene that is copied when the Scene template is instantiated.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
CreateInstanceCreates an instance of a scriptable object.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Messages

AwakeThis function is called when the ScriptableObject script is started.
OnDestroyThis function is called when the scriptable object will be destroyed.
OnDisableThis function is called when the scriptable object goes out of scope.
OnEnableThis function is called when the object is loaded.
OnValidateEditor-only function that Unity calls when the script is loaded or a value changes in the Inspector.
ResetReset to default values.