UnityEditor.SceneTemplateModule.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEditor.SceneTemplateModule</name>
  6. </assembly>
  7. <member name="T:UnityEditor.SceneTemplate.DependencyInfo">
  8. <summary>
  9. <para>A descriptor that stores one of a template Scene's dependency Assets, and specifies whether to clone or reference it when the template is instantiated.</para>
  10. </summary>
  11. </member>
  12. <member name="F:UnityEditor.SceneTemplate.DependencyInfo.dependency">
  13. <summary>
  14. <para>A dependency Asset of the template Scene.</para>
  15. </summary>
  16. </member>
  17. <member name="F:UnityEditor.SceneTemplate.DependencyInfo.instantiationMode">
  18. <summary>
  19. <para>The action to take with the dependency when the template is instantiated.</para>
  20. </summary>
  21. </member>
  22. <member name="M:UnityEditor.SceneTemplate.DependencyInfo.#ctor">
  23. <summary>
  24. <para>Constructor for a DependencyInfo.</para>
  25. </summary>
  26. </member>
  27. <member name="T:UnityEditor.SceneTemplate.InstantiationResult">
  28. <summary>
  29. <para>A class that holds the data created when a SceneTemplateAsset is instantiated.</para>
  30. </summary>
  31. </member>
  32. <member name="P:UnityEditor.SceneTemplate.InstantiationResult.scene">
  33. <summary>
  34. <para>The Scene that is created and loaded when a SceneTemplateAsset is instantiated.</para>
  35. </summary>
  36. </member>
  37. <member name="P:UnityEditor.SceneTemplate.InstantiationResult.sceneAsset">
  38. <summary>
  39. <para>The SceneAsset that is created when a SceneTemplateAsset is instantiated.</para>
  40. </summary>
  41. </member>
  42. <member name="?:UnityEditor.SceneTemplate.ISceneTemplatePipeline">
  43. <summary>
  44. <para>Derive from this interface to package a custom code sequence when a Scene template is instantiated. ISceneTemplatePipeline is instantiated once when a template is instantiated, and is notified multiple times during the instantiation sequence.</para>
  45. </summary>
  46. </member>
  47. <member name="M:UnityEditor.SceneTemplate.ISceneTemplatePipeline.AfterTemplateInstantiation(UnityEditor.SceneTemplate.SceneTemplateAsset,UnityEngine.SceneManagement.Scene,System.Boolean,System.String)">
  48. <summary>
  49. <para>An event called after the Scene template is instantiated, and while the new scene is still loaded.</para>
  50. </summary>
  51. <param name="sceneTemplateAsset">The Scene template asset to instantiate.</param>
  52. <param name="scene">The newly created Scene.</param>
  53. <param name="isAdditive">When set to true, the new Scene is created in additive mode.</param>
  54. <param name="sceneName">The path to the newly created Scene. If the template you instantiated does not have any cloneable dependencies, this can be empty.</param>
  55. </member>
  56. <member name="M:UnityEditor.SceneTemplate.ISceneTemplatePipeline.BeforeTemplateInstantiation(UnityEditor.SceneTemplate.SceneTemplateAsset,System.Boolean,System.String)">
  57. <summary>
  58. <para>An event called before the Scene template is instantiated.</para>
  59. </summary>
  60. <param name="sceneTemplateAsset">The Scene template Asset to instantiate.</param>
  61. <param name="isAdditive">When set to true, the new Scene is created in additive mode.</param>
  62. <param name="sceneName">The path to the newly created Scene. If the temlate you instantiated does not have any cloneable dependencies, this can be empty.</param>
  63. </member>
  64. <member name="M:UnityEditor.SceneTemplate.ISceneTemplatePipeline.IsValidTemplateForInstantiation(UnityEditor.SceneTemplate.SceneTemplateAsset)">
  65. <summary>
  66. <para>An event called before the New Scene dialog is displayed to determine whether this template is available in the dialog.</para>
  67. </summary>
  68. <param name="sceneTemplateAsset">A Scene Template asset that is available in New Scene dialog.</param>
  69. <returns>
  70. <para>True if the Scene template can be instantiated. False otherwise.</para>
  71. </returns>
  72. </member>
  73. <member name="T:UnityEditor.SceneTemplate.SceneTemplateAsset">
  74. <summary>
  75. <para>An Asset that stores everything required to instantiate a new Scene from a templated Scene.</para>
  76. </summary>
  77. </member>
  78. <member name="F:UnityEditor.SceneTemplate.SceneTemplateAsset.addToDefaults">
  79. <summary>
  80. <para>Use this field to add this template to the list of default templates in the New scene dialog.</para>
  81. </summary>
  82. </member>
  83. <member name="F:UnityEditor.SceneTemplate.SceneTemplateAsset.dependencies">
  84. <summary>
  85. <para>Lists Scene dependencies, and specifies whether to clone or reference each one.</para>
  86. </summary>
  87. </member>
  88. <member name="F:UnityEditor.SceneTemplate.SceneTemplateAsset.description">
  89. <summary>
  90. <para>A description of the Scene template. This description can be long. In the Unity editor, it appears on multiple lines.</para>
  91. </summary>
  92. </member>
  93. <member name="P:UnityEditor.SceneTemplate.SceneTemplateAsset.isValid">
  94. <summary>
  95. <para>Specifies whether the Scene template is valid. Invalid templates do not appear in the New Scene dialog.</para>
  96. </summary>
  97. </member>
  98. <member name="F:UnityEditor.SceneTemplate.SceneTemplateAsset.preview">
  99. <summary>
  100. <para>The Scene template's preview image or icon.</para>
  101. </summary>
  102. </member>
  103. <member name="F:UnityEditor.SceneTemplate.SceneTemplateAsset.templateName">
  104. <summary>
  105. <para>A user-defined name for the Scene template Asset. By default, this is the template's file name.</para>
  106. </summary>
  107. </member>
  108. <member name="F:UnityEditor.SceneTemplate.SceneTemplateAsset.templatePipeline">
  109. <summary>
  110. <para>A script that derives from ISceneTemplatePipeline. It allows you to execute custom code when a template is instantiated.</para>
  111. </summary>
  112. </member>
  113. <member name="F:UnityEditor.SceneTemplate.SceneTemplateAsset.templateScene">
  114. <summary>
  115. <para>The Scene that is copied when the Scene template is instantiated.</para>
  116. </summary>
  117. </member>
  118. <member name="T:UnityEditor.SceneTemplate.SceneTemplatePipelineAdapter">
  119. <summary>
  120. <para>An adapter that implements all the functions of ISceneTemplatePipeline for easier usage. Use it to partially override a ISceneTemplatePipeline.</para>
  121. </summary>
  122. </member>
  123. <member name="M:UnityEditor.SceneTemplate.SceneTemplatePipelineAdapter.AfterTemplateInstantiation(UnityEditor.SceneTemplate.SceneTemplateAsset,UnityEngine.SceneManagement.Scene,System.Boolean,System.String)">
  124. <summary>
  125. <para>An event called after the Scene template is instantiated, and while the new Scene is still loaded.</para>
  126. </summary>
  127. <param name="sceneTemplateAsset">The Scene template Asset to instantiate.</param>
  128. <param name="scene">The newly created Scene.</param>
  129. <param name="isAdditive">When set to true, the new Scene is created in additive mode.</param>
  130. <param name="sceneName">The path to the newly created Scene. If the template you instantiated does not have any cloneable dependencies, this can be empty.</param>
  131. </member>
  132. <member name="M:UnityEditor.SceneTemplate.SceneTemplatePipelineAdapter.BeforeTemplateInstantiation(UnityEditor.SceneTemplate.SceneTemplateAsset,System.Boolean,System.String)">
  133. <summary>
  134. <para>An event called before the Scene template is instantiated.</para>
  135. </summary>
  136. <param name="sceneTemplateAsset">The Scene template Asset to instantiate.</param>
  137. <param name="isAdditive">When set to true, the new Scene is created in additive mode.</param>
  138. <param name="sceneName">The path to the newly created Scene. If the template you instantiated does not have any cloneable dependencies, this can be empty.</param>
  139. </member>
  140. <member name="M:UnityEditor.SceneTemplate.SceneTemplatePipelineAdapter.IsValidTemplateForInstantiation(UnityEditor.SceneTemplate.SceneTemplateAsset)">
  141. <summary>
  142. <para>An event called before the New Scene dialog is displayed to determine whether this template is available in the dialog.</para>
  143. </summary>
  144. <param name="sceneTemplateAsset">A Scene Template asset that is available in New Scene dialog.</param>
  145. <returns>
  146. <para>True if the Scene template can be instantiated. False otherwise.</para>
  147. </returns>
  148. </member>
  149. <member name="T:UnityEditor.SceneTemplate.SceneTemplateService">
  150. <summary>
  151. <para>A utility class that manages SceneTemplateAsset instantiation.</para>
  152. </summary>
  153. </member>
  154. <member name="?:UnityEditor.SceneTemplate.SceneTemplateService.newSceneTemplateInstantiated(UnityEditor.SceneTemplate.SceneTemplateService/NewTemplateInstantiated)">
  155. <summary>
  156. <para>Events fired after a Scene template is instantiated.</para>
  157. </summary>
  158. <param name="value">A user-defined handler that is called after a Scene template is instantiated.</param>
  159. </member>
  160. <member name="?:UnityEditor.SceneTemplate.SceneTemplateService.newSceneTemplateInstantiating(UnityEditor.SceneTemplate.SceneTemplateService/NewTemplateInstantiating)">
  161. <summary>
  162. <para>Events fired before a Scene template is instantiated.</para>
  163. </summary>
  164. <param name="value">A user-defined handler that is called before a Scene template is instantiated.</param>
  165. </member>
  166. <member name="M:UnityEditor.SceneTemplate.SceneTemplateService.CreateSceneTemplate(System.String)">
  167. <summary>
  168. <para>Creates a new Scene template at a specific path. The template is not bound to a Scene.</para>
  169. </summary>
  170. <param name="sceneTemplatePath">The path to the new Scene template asset.</param>
  171. <returns>
  172. <para>Returns a new Scene template Asset instance.</para>
  173. </returns>
  174. </member>
  175. <member name="M:UnityEditor.SceneTemplate.SceneTemplateService.CreateTemplateFromScene(UnityEditor.SceneAsset,System.String)">
  176. <summary>
  177. <para>Creates a new Scene template bound to a specific Scene. All of the template Scene's dependencies are extracted and set to be referenced.</para>
  178. </summary>
  179. <param name="sourceSceneAsset">The Scene Asset that serves as the template.</param>
  180. <param name="sceneTemplatePath">The path to the new Scene template asset.</param>
  181. <returns>
  182. <para>A new Scene template Asset instance.</para>
  183. </returns>
  184. </member>
  185. <member name="M:UnityEditor.SceneTemplate.SceneTemplateService.Instantiate(UnityEditor.SceneTemplate.SceneTemplateAsset,System.Boolean,System.String)">
  186. <summary>
  187. <para>Instantiates a new Scene from a template.</para>
  188. </summary>
  189. <param name="sceneTemplate">A Scene template Asset that contains the information required to instantiate the Scene.</param>
  190. <param name="loadAdditively">Specifies whether the new Scene is created additively in the currently loaded Scene.</param>
  191. <param name="newSceneOutputPath">The path to the new Scene created from the template. This is set only when the SceneTemplateAsset has cloneable dependencies, because in that case, the new Scene must be be saved on disk.</param>
  192. <returns>
  193. <para>The new Scene and its SceneTemplateAsset counterpart.</para>
  194. </returns>
  195. </member>
  196. <member name="T:UnityEditor.SceneTemplate.SceneTemplateService.NewTemplateInstantiated">
  197. <summary>
  198. <para>An event called after a Scene template is instantiated.</para>
  199. </summary>
  200. <param name="sceneTemplateAsset">The Scene template that was instantiated.</param>
  201. <param name="scene">The template Scene that was instantiated.</param>
  202. <param name="sceneAsset">The new Scene Asset created by instantiating the Scene template.</param>
  203. <param name="additiveLoad">Specifies whether the template was instantiated in additive mode.</param>
  204. </member>
  205. <member name="T:UnityEditor.SceneTemplate.SceneTemplateService.NewTemplateInstantiating">
  206. <summary>
  207. <para>An event called before a Scene template is instantiated.</para>
  208. </summary>
  209. <param name="sceneTemplateAsset">The Scene template to instantiate.</param>
  210. <param name="newSceneOutputPath">The output path for the new Scene. This can be empty if the scene is created in memory.</param>
  211. <param name="additiveLoad">Specifies whether to instantiate the Scene template in additive mode.</param>
  212. </member>
  213. <member name="T:UnityEditor.SceneTemplate.TemplateInstantiationMode">
  214. <summary>
  215. <para>An enumeration of options for handling a Scene dependency Asset when you instantiate a SceneTemplateAsset.</para>
  216. </summary>
  217. </member>
  218. <member name="F:UnityEditor.SceneTemplate.TemplateInstantiationMode.Clone">
  219. <summary>
  220. <para>Specifies that the dependency Asset is cloned when the SceneTemplateAsset is instantiated.</para>
  221. </summary>
  222. </member>
  223. <member name="F:UnityEditor.SceneTemplate.TemplateInstantiationMode.Reference">
  224. <summary>
  225. <para>Specifies that the dependency Asset is kept as a reference when the SceneTemplateAsset is instantiated.</para>
  226. </summary>
  227. </member>
  228. </members>
  229. </doc>