UnityEngine.TilemapModule.xml 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.TilemapModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.CustomGridBrushAttribute">
  8. <summary>
  9. <para>Attribute to define the class as a grid brush and to make it available in the palette window.</para>
  10. </summary>
  11. </member>
  12. <member name="P:UnityEngine.CustomGridBrushAttribute.defaultBrush">
  13. <summary>
  14. <para>If set to true, brush will replace Unity built-in brush as the default brush in palette window.
  15. Only one class at any one time should set defaultBrush to true.</para>
  16. </summary>
  17. </member>
  18. <member name="P:UnityEngine.CustomGridBrushAttribute.defaultName">
  19. <summary>
  20. <para>Name of the default instance of this brush.</para>
  21. </summary>
  22. </member>
  23. <member name="P:UnityEngine.CustomGridBrushAttribute.hideAssetInstances">
  24. <summary>
  25. <para>Hide all asset instances of this brush in the tile palette window.</para>
  26. </summary>
  27. </member>
  28. <member name="P:UnityEngine.CustomGridBrushAttribute.hideDefaultInstance">
  29. <summary>
  30. <para>Hide the default instance of brush in the tile palette window.</para>
  31. </summary>
  32. </member>
  33. <member name="M:UnityEngine.CustomGridBrushAttribute.#ctor">
  34. <summary>
  35. <para>Attribute to define the class as a grid brush and to make it available in the palette window.</para>
  36. </summary>
  37. <param name="defaultBrush">If set to true, brush will replace Unity built-in brush as the default brush in palette window.</param>
  38. <param name="defaultName">Name of the default instance of this brush.</param>
  39. <param name="hideAssetInstanes">Hide all asset instances of this brush in the tile palette window.</param>
  40. <param name="hideDefaultInstance">Hide the default instance of brush in the tile palette window.</param>
  41. <param name="hideAssetInstances"></param>
  42. </member>
  43. <member name="M:UnityEngine.CustomGridBrushAttribute.#ctor(System.Boolean,System.Boolean,System.Boolean,System.String)">
  44. <summary>
  45. <para>Attribute to define the class as a grid brush and to make it available in the palette window.</para>
  46. </summary>
  47. <param name="defaultBrush">If set to true, brush will replace Unity built-in brush as the default brush in palette window.</param>
  48. <param name="defaultName">Name of the default instance of this brush.</param>
  49. <param name="hideAssetInstanes">Hide all asset instances of this brush in the tile palette window.</param>
  50. <param name="hideDefaultInstance">Hide the default instance of brush in the tile palette window.</param>
  51. <param name="hideAssetInstances"></param>
  52. </member>
  53. <member name="T:UnityEngine.GridBrushBase">
  54. <summary>
  55. <para>Base class for authoring data on a grid with grid painting tools like paint, erase, pick, select and fill.</para>
  56. </summary>
  57. </member>
  58. <member name="M:UnityEngine.GridBrushBase.BoxErase(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.BoundsInt)">
  59. <summary>
  60. <para>Erases data on a grid within the given bounds.</para>
  61. </summary>
  62. <param name="gridLayout">Grid used for layout.</param>
  63. <param name="brushTarget">Target of the erase operation. By default the currently selected GameObject.</param>
  64. <param name="position">The bounds to erase data from.</param>
  65. </member>
  66. <member name="M:UnityEngine.GridBrushBase.BoxFill(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.BoundsInt)">
  67. <summary>
  68. <para>Box fills tiles and GameObjects into given bounds within the selected layers.</para>
  69. </summary>
  70. <param name="gridLayout">Grid used for layout.</param>
  71. <param name="brushTarget">Target of box fill operation. By default the currently selected GameObject.</param>
  72. <param name="position">The bounds to box fill data to.</param>
  73. </member>
  74. <member name="M:UnityEngine.GridBrushBase.Erase(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.Vector3Int)">
  75. <summary>
  76. <para>Erases data on a grid within the given bounds.</para>
  77. </summary>
  78. <param name="grid">Grid used for layout.</param>
  79. <param name="brushTarget">Target of the erase operation. By default the currently selected GameObject.</param>
  80. <param name="position">The coordinates of the cell to erase data from.</param>
  81. <param name="gridLayout"></param>
  82. </member>
  83. <member name="M:UnityEngine.GridBrushBase.Flip(UnityEngine.GridBrushBase/FlipAxis,UnityEngine.GridLayout/CellLayout)">
  84. <summary>
  85. <para>Flips the grid brush in the given FlipAxis.</para>
  86. </summary>
  87. <param name="flip">Axis to flip by.</param>
  88. <param name="layout">CellLayout for flipping.</param>
  89. </member>
  90. <member name="T:UnityEngine.GridBrushBase.FlipAxis">
  91. <summary>
  92. <para>Axis to flip tiles in the GridBrushBase by.</para>
  93. </summary>
  94. </member>
  95. <member name="F:UnityEngine.GridBrushBase.FlipAxis.X">
  96. <summary>
  97. <para>Flip the brush in the X Axis.</para>
  98. </summary>
  99. </member>
  100. <member name="F:UnityEngine.GridBrushBase.FlipAxis.Y">
  101. <summary>
  102. <para>Flip the brush in the Y Axis.</para>
  103. </summary>
  104. </member>
  105. <member name="M:UnityEngine.GridBrushBase.FloodFill(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.Vector3Int)">
  106. <summary>
  107. <para>Flood fills data onto a grid given the starting coordinates of the cell.</para>
  108. </summary>
  109. <param name="gridLayout">Grid used for layout.</param>
  110. <param name="brushTarget">Targets of flood fill operation. By default the currently selected GameObject.</param>
  111. <param name="position">Starting position of the flood fill.</param>
  112. </member>
  113. <member name="M:UnityEngine.GridBrushBase.Move(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.BoundsInt,UnityEngine.BoundsInt)">
  114. <summary>
  115. <para>Move is called when user moves the area previously selected with the selection marquee.</para>
  116. </summary>
  117. <param name="grid">Grid used for layout.</param>
  118. <param name="brushTarget">Target of the move operation. By default the currently selected GameObject.</param>
  119. <param name="from">Source bounds of the move.</param>
  120. <param name="to">Target bounds of the move.</param>
  121. <param name="gridLayout"></param>
  122. </member>
  123. <member name="M:UnityEngine.GridBrushBase.MoveEnd(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.BoundsInt)">
  124. <summary>
  125. <para>MoveEnd is called when user has ended the move of the area previously selected with the selection marquee.</para>
  126. </summary>
  127. <param name="position">Layers affected by the move operation.</param>
  128. <param name="brushTarget">Target of the move operation. By default the currently selected GameObject.</param>
  129. <param name="grid">Grid used for layout.</param>
  130. <param name="gridLayout"></param>
  131. </member>
  132. <member name="M:UnityEngine.GridBrushBase.MoveStart(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.BoundsInt)">
  133. <summary>
  134. <para>MoveEnd is called when user starts moving the area previously selected with the selection marquee.</para>
  135. </summary>
  136. <param name="grid">Grid used for layout.</param>
  137. <param name="brushTarget">Target of the move operation. By default the currently selected GameObject.</param>
  138. <param name="position">Position where the move operation has started.</param>
  139. <param name="gridLayout"></param>
  140. </member>
  141. <member name="M:UnityEngine.GridBrushBase.Paint(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.Vector3Int)">
  142. <summary>
  143. <para>Paints data into a grid within the given bounds.</para>
  144. </summary>
  145. <param name="grid">Grid used for layout.</param>
  146. <param name="brushTarget">Target of the paint operation. By default the currently selected GameObject.</param>
  147. <param name="position">The coordinates of the cell to paint data to.</param>
  148. <param name="gridLayout"></param>
  149. </member>
  150. <member name="M:UnityEngine.GridBrushBase.Pick(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.BoundsInt,UnityEngine.Vector3Int)">
  151. <summary>
  152. <para>Picks data from a grid given the coordinates of the cells.</para>
  153. </summary>
  154. <param name="grid">Grid used for layout.</param>
  155. <param name="brushTarget">Target of the paint operation. By default the currently selected GameObject.</param>
  156. <param name="position">The coordinates of the cells to paint data from.</param>
  157. <param name="pivot">Pivot of the picking brush.</param>
  158. <param name="gridLayout"></param>
  159. </member>
  160. <member name="M:UnityEngine.GridBrushBase.Rotate(UnityEngine.GridBrushBase/RotationDirection,UnityEngine.GridLayout/CellLayout)">
  161. <summary>
  162. <para>Rotates all tiles on the grid brush with the given RotationDirection.</para>
  163. </summary>
  164. <param name="direction">Direction to rotate by.</param>
  165. <param name="layout">Cell Layout for rotating.</param>
  166. </member>
  167. <member name="T:UnityEngine.GridBrushBase.RotationDirection">
  168. <summary>
  169. <para>Direction to rotate tiles in the GridBrushBase by.</para>
  170. </summary>
  171. </member>
  172. <member name="F:UnityEngine.GridBrushBase.RotationDirection.Clockwise">
  173. <summary>
  174. <para>Rotates tiles clockwise.</para>
  175. </summary>
  176. </member>
  177. <member name="F:UnityEngine.GridBrushBase.RotationDirection.CounterClockwise">
  178. <summary>
  179. <para>Rotates tiles counter-clockwise.</para>
  180. </summary>
  181. </member>
  182. <member name="M:UnityEngine.GridBrushBase.Select(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.BoundsInt)">
  183. <summary>
  184. <para>Select an area of a grid.</para>
  185. </summary>
  186. <param name="grid">Grid used for layout.</param>
  187. <param name="brushTarget">Targets of paint operation. By default the currently selected GameObject.</param>
  188. <param name="position">Area to get selected.</param>
  189. <param name="gridLayout"></param>
  190. </member>
  191. <member name="T:UnityEngine.GridBrushBase.Tool">
  192. <summary>
  193. <para>Tool mode for the GridBrushBase.</para>
  194. </summary>
  195. </member>
  196. <member name="F:UnityEngine.GridBrushBase.Tool.Box">
  197. <summary>
  198. <para>Box Fill.</para>
  199. </summary>
  200. </member>
  201. <member name="F:UnityEngine.GridBrushBase.Tool.Erase">
  202. <summary>
  203. <para>Erase.</para>
  204. </summary>
  205. </member>
  206. <member name="F:UnityEngine.GridBrushBase.Tool.FloodFill">
  207. <summary>
  208. <para>Flood Fill.</para>
  209. </summary>
  210. </member>
  211. <member name="F:UnityEngine.GridBrushBase.Tool.Move">
  212. <summary>
  213. <para>Move.</para>
  214. </summary>
  215. </member>
  216. <member name="F:UnityEngine.GridBrushBase.Tool.Paint">
  217. <summary>
  218. <para>Paint.</para>
  219. </summary>
  220. </member>
  221. <member name="F:UnityEngine.GridBrushBase.Tool.Pick">
  222. <summary>
  223. <para>Pick.</para>
  224. </summary>
  225. </member>
  226. <member name="F:UnityEngine.GridBrushBase.Tool.Select">
  227. <summary>
  228. <para>Select.</para>
  229. </summary>
  230. </member>
  231. <member name="T:UnityEngine.Tilemaps.ITilemap">
  232. <summary>
  233. <para>Class passed onto when information is queried from the tiles.</para>
  234. </summary>
  235. </member>
  236. <member name="P:UnityEngine.Tilemaps.ITilemap.cellBounds">
  237. <summary>
  238. <para>Returns the boundaries of the Tilemap in cell size.</para>
  239. </summary>
  240. </member>
  241. <member name="P:UnityEngine.Tilemaps.ITilemap.localBounds">
  242. <summary>
  243. <para>Returns the boundaries of the Tilemap in local space size.</para>
  244. </summary>
  245. </member>
  246. <member name="P:UnityEngine.Tilemaps.ITilemap.origin">
  247. <summary>
  248. <para>The origin of the Tilemap in cell position.</para>
  249. </summary>
  250. </member>
  251. <member name="P:UnityEngine.Tilemaps.ITilemap.size">
  252. <summary>
  253. <para>The size of the Tilemap in cells.</para>
  254. </summary>
  255. </member>
  256. <member name="M:UnityEngine.Tilemaps.ITilemap.GetColor(UnityEngine.Vector3Int)">
  257. <summary>
  258. <para>Gets the color of a.</para>
  259. </summary>
  260. <param name="position">Position of the Tile on the Tilemap.</param>
  261. <returns>
  262. <para>Color of the at the XY coordinate.</para>
  263. </returns>
  264. </member>
  265. <member name="M:UnityEngine.Tilemaps.ITilemap.GetComponent">
  266. <summary>
  267. <para>Returns the component of type T if the GameObject of the tile map has one attached, null if it doesn't.</para>
  268. </summary>
  269. <returns>
  270. <para>The Component of type T to retrieve.</para>
  271. </returns>
  272. </member>
  273. <member name="M:UnityEngine.Tilemaps.ITilemap.GetSprite(UnityEngine.Vector3Int)">
  274. <summary>
  275. <para>Gets the.</para>
  276. </summary>
  277. <param name="position">Position of the Tile on the Tilemap.</param>
  278. <returns>
  279. <para>Sprite at the XY coordinate.</para>
  280. </returns>
  281. </member>
  282. <member name="M:UnityEngine.Tilemaps.ITilemap.GetTile(UnityEngine.Vector3Int)">
  283. <summary>
  284. <para>Gets the.</para>
  285. </summary>
  286. <param name="position">Position of the Tile on the Tilemap.</param>
  287. <returns>
  288. <para> placed at the cell.</para>
  289. </returns>
  290. </member>
  291. <member name="M:UnityEngine.Tilemaps.ITilemap.GetTile(UnityEngine.Vector3Int)">
  292. <summary>
  293. <para>Gets the.</para>
  294. </summary>
  295. <param name="position">Position of the Tile on the Tilemap.</param>
  296. <returns>
  297. <para> placed at the cell.</para>
  298. </returns>
  299. </member>
  300. <member name="M:UnityEngine.Tilemaps.ITilemap.GetTileFlags(UnityEngine.Vector3Int)">
  301. <summary>
  302. <para>Gets the TileFlags of the Tile at the given position.</para>
  303. </summary>
  304. <param name="position">Position of the Tile on the Tilemap.</param>
  305. <returns>
  306. <para>TileFlags from the Tile.</para>
  307. </returns>
  308. </member>
  309. <member name="M:UnityEngine.Tilemaps.ITilemap.GetTransformMatrix(UnityEngine.Vector3Int)">
  310. <summary>
  311. <para>Gets the transform matrix of a.</para>
  312. </summary>
  313. <param name="position">Position of the Tile on the Tilemap.</param>
  314. <returns>
  315. <para>The transform matrix.</para>
  316. </returns>
  317. </member>
  318. <member name="M:UnityEngine.Tilemaps.ITilemap.RefreshTile(UnityEngine.Vector3Int)">
  319. <summary>
  320. <para>Refreshes a.</para>
  321. </summary>
  322. <param name="position">Position of the Tile on the Tilemap.</param>
  323. </member>
  324. <member name="T:UnityEngine.Tilemaps.Tile">
  325. <summary>
  326. <para>Class for a default tile in the Tilemap.</para>
  327. </summary>
  328. </member>
  329. <member name="P:UnityEngine.Tilemaps.Tile.color">
  330. <summary>
  331. <para>Color of the Tile.</para>
  332. </summary>
  333. </member>
  334. <member name="P:UnityEngine.Tilemaps.Tile.flags">
  335. <summary>
  336. <para>TileFlags of the Tile.</para>
  337. </summary>
  338. </member>
  339. <member name="P:UnityEngine.Tilemaps.Tile.gameObject">
  340. <summary>
  341. <para>GameObject of the Tile.</para>
  342. </summary>
  343. </member>
  344. <member name="P:UnityEngine.Tilemaps.Tile.sprite">
  345. <summary>
  346. <para>Sprite to be rendered at the Tile.</para>
  347. </summary>
  348. </member>
  349. <member name="P:UnityEngine.Tilemaps.Tile.transform">
  350. <summary>
  351. <para>Matrix4x4|Transform matrix of the Tile.</para>
  352. </summary>
  353. </member>
  354. <member name="T:UnityEngine.Tilemaps.Tile.ColliderType">
  355. <summary>
  356. <para>Enum for determining what collider shape is generated for this Tile by the TilemapCollider2D.</para>
  357. </summary>
  358. </member>
  359. <member name="F:UnityEngine.Tilemaps.Tile.ColliderType.Grid">
  360. <summary>
  361. <para>The grid layout boundary outline is used as the collider shape for the Tile by the TilemapCollider2D.</para>
  362. </summary>
  363. </member>
  364. <member name="F:UnityEngine.Tilemaps.Tile.ColliderType.None">
  365. <summary>
  366. <para>No collider shape is generated for the Tile by the TilemapCollider2D.</para>
  367. </summary>
  368. </member>
  369. <member name="F:UnityEngine.Tilemaps.Tile.ColliderType.Sprite">
  370. <summary>
  371. <para>The Sprite outline is used as the collider shape for the Tile by the TilemapCollider2D.</para>
  372. </summary>
  373. </member>
  374. <member name="M:UnityEngine.Tilemaps.Tile.GetTileData(UnityEngine.Vector3Int,UnityEngine.Tilemaps.ITilemap,UnityEngine.Tilemaps.TileData&amp;)">
  375. <summary>
  376. <para>Retrieves the tile rendering data for the Tile.</para>
  377. </summary>
  378. <param name="position">Position of the Tile on the Tilemap.</param>
  379. <param name="tilemap">The Tilemap the tile is present on.</param>
  380. <param name="tileData">Data to render the tile. This is filled with Tile, Tile.color and Tile.transform.</param>
  381. <returns>
  382. <para>Whether the call was successful. This returns true for Tile.</para>
  383. </returns>
  384. </member>
  385. <member name="T:UnityEngine.Tilemaps.TileAnimationData">
  386. <summary>
  387. <para>A Struct for the required data for animating a Tile.</para>
  388. </summary>
  389. </member>
  390. <member name="P:UnityEngine.Tilemaps.TileAnimationData.animatedSprites">
  391. <summary>
  392. <para>The array of that are ordered by appearance in the animation.</para>
  393. </summary>
  394. </member>
  395. <member name="P:UnityEngine.Tilemaps.TileAnimationData.animationSpeed">
  396. <summary>
  397. <para>The animation speed.</para>
  398. </summary>
  399. </member>
  400. <member name="P:UnityEngine.Tilemaps.TileAnimationData.animationStartTime">
  401. <summary>
  402. <para>The start time of the animation. The animation will begin at this time offset.</para>
  403. </summary>
  404. </member>
  405. <member name="T:UnityEngine.Tilemaps.TileBase">
  406. <summary>
  407. <para>Base class for a tile in the Tilemap.</para>
  408. </summary>
  409. </member>
  410. <member name="M:UnityEngine.Tilemaps.TileBase.GetTileAnimationData(UnityEngine.Vector3Int,UnityEngine.Tilemaps.ITilemap,UnityEngine.Tilemaps.TileAnimationData&amp;)">
  411. <summary>
  412. <para>Retrieves any tile animation data from the scripted tile.</para>
  413. </summary>
  414. <param name="position">Position of the Tile on the Tilemap.</param>
  415. <param name="tilemap">The Tilemap the tile is present on.</param>
  416. <param name="tileAnimationData">Data to run an animation on the tile.</param>
  417. <returns>
  418. <para>Whether the call was successful.</para>
  419. </returns>
  420. </member>
  421. <member name="M:UnityEngine.Tilemaps.TileBase.GetTileData(UnityEngine.Vector3Int,UnityEngine.Tilemaps.ITilemap,UnityEngine.Tilemaps.TileData&amp;)">
  422. <summary>
  423. <para>Retrieves any tile rendering data from the scripted tile.</para>
  424. </summary>
  425. <param name="position">Position of the Tile on the Tilemap.</param>
  426. <param name="tilemap">The Tilemap the tile is present on.</param>
  427. <param name="tileData">Data to render the tile.</param>
  428. <returns>
  429. <para>Whether the call was successful.</para>
  430. </returns>
  431. </member>
  432. <member name="M:UnityEngine.Tilemaps.TileBase.RefreshTile(UnityEngine.Vector3Int,UnityEngine.Tilemaps.ITilemap)">
  433. <summary>
  434. <para>This method is called when the tile is refreshed.</para>
  435. </summary>
  436. <param name="position">Position of the Tile on the Tilemap.</param>
  437. <param name="tilemap">The Tilemap the tile is present on.</param>
  438. </member>
  439. <member name="M:UnityEngine.Tilemaps.TileBase.StartUp(UnityEngine.Vector3Int,UnityEngine.Tilemaps.ITilemap,UnityEngine.GameObject)">
  440. <summary>
  441. <para>StartUp is called on the first frame of the running scene.</para>
  442. </summary>
  443. <param name="position">Position of the Tile on the Tilemap.</param>
  444. <param name="tilemap">The Tilemap the tile is present on.</param>
  445. <param name="go">The GameObject instantiated for the Tile.</param>
  446. <returns>
  447. <para>Whether the call was successful.</para>
  448. </returns>
  449. </member>
  450. <member name="T:UnityEngine.Tilemaps.TileData">
  451. <summary>
  452. <para>A Struct for the required data for rendering a Tile.</para>
  453. </summary>
  454. </member>
  455. <member name="P:UnityEngine.Tilemaps.TileData.color">
  456. <summary>
  457. <para>Color of the Tile.</para>
  458. </summary>
  459. </member>
  460. <member name="P:UnityEngine.Tilemaps.TileData.flags">
  461. <summary>
  462. <para>TileFlags of the Tile.</para>
  463. </summary>
  464. </member>
  465. <member name="P:UnityEngine.Tilemaps.TileData.gameObject">
  466. <summary>
  467. <para>GameObject of the Tile.</para>
  468. </summary>
  469. </member>
  470. <member name="P:UnityEngine.Tilemaps.TileData.sprite">
  471. <summary>
  472. <para>Sprite to be rendered at the Tile.</para>
  473. </summary>
  474. </member>
  475. <member name="P:UnityEngine.Tilemaps.TileData.transform">
  476. <summary>
  477. <para>Matrix4x4|Transform matrix of the Tile.</para>
  478. </summary>
  479. </member>
  480. <member name="T:UnityEngine.Tilemaps.TileFlags">
  481. <summary>
  482. <para>Flags controlling behavior for the TileBase.</para>
  483. </summary>
  484. </member>
  485. <member name="F:UnityEngine.Tilemaps.TileFlags.InstantiateGameObjectRuntimeOnly">
  486. <summary>
  487. <para>TileBase does not instantiate its associated GameObject in editor mode and instantiates it only during play mode.</para>
  488. </summary>
  489. </member>
  490. <member name="F:UnityEngine.Tilemaps.TileFlags.LockAll">
  491. <summary>
  492. <para>All lock flags.</para>
  493. </summary>
  494. </member>
  495. <member name="F:UnityEngine.Tilemaps.TileFlags.LockColor">
  496. <summary>
  497. <para>TileBase locks any color set by brushes or the user.</para>
  498. </summary>
  499. </member>
  500. <member name="F:UnityEngine.Tilemaps.TileFlags.LockTransform">
  501. <summary>
  502. <para>TileBase locks any transform matrix set by brushes or the user.</para>
  503. </summary>
  504. </member>
  505. <member name="F:UnityEngine.Tilemaps.TileFlags.None">
  506. <summary>
  507. <para>No TileFlags are set.</para>
  508. </summary>
  509. </member>
  510. <member name="T:UnityEngine.Tilemaps.Tilemap">
  511. <summary>
  512. <para>The tile map stores component.</para>
  513. </summary>
  514. </member>
  515. <member name="P:UnityEngine.Tilemaps.Tilemap.animationFrameRate">
  516. <summary>
  517. <para>The frame rate for all tile animations in the tile map.</para>
  518. </summary>
  519. </member>
  520. <member name="P:UnityEngine.Tilemaps.Tilemap.cellBounds">
  521. <summary>
  522. <para>Returns the boundaries of the Tilemap in cell size.</para>
  523. </summary>
  524. </member>
  525. <member name="P:UnityEngine.Tilemaps.Tilemap.color">
  526. <summary>
  527. <para>The color of the tile map layer.</para>
  528. </summary>
  529. </member>
  530. <member name="P:UnityEngine.Tilemaps.Tilemap.layoutGrid">
  531. <summary>
  532. <para>Gets the Grid associated with this tile map.</para>
  533. </summary>
  534. </member>
  535. <member name="P:UnityEngine.Tilemaps.Tilemap.layoutGrid">
  536. <summary>
  537. <para>Gets the Grid associated with this tile map.</para>
  538. </summary>
  539. </member>
  540. <member name="P:UnityEngine.Tilemaps.Tilemap.localBounds">
  541. <summary>
  542. <para>Returns the boundaries of the Tilemap in local space size.</para>
  543. </summary>
  544. </member>
  545. <member name="P:UnityEngine.Tilemaps.Tilemap.orientation">
  546. <summary>
  547. <para>Orientation of the tiles in the Tilemap.</para>
  548. </summary>
  549. </member>
  550. <member name="P:UnityEngine.Tilemaps.Tilemap.orientationMatrix">
  551. <summary>
  552. <para>Orientation Matrix of the orientation of the tiles in the Tilemap.</para>
  553. </summary>
  554. </member>
  555. <member name="P:UnityEngine.Tilemaps.Tilemap.origin">
  556. <summary>
  557. <para>The origin of the Tilemap in cell position.</para>
  558. </summary>
  559. </member>
  560. <member name="P:UnityEngine.Tilemaps.Tilemap.size">
  561. <summary>
  562. <para>The size of the Tilemap in cells.</para>
  563. </summary>
  564. </member>
  565. <member name="P:UnityEngine.Tilemaps.Tilemap.tileAnchor">
  566. <summary>
  567. <para>Gets the anchor point of tiles in the Tilemap.</para>
  568. </summary>
  569. </member>
  570. <member name="M:UnityEngine.Tilemaps.Tilemap.AddTileFlags(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileFlags)">
  571. <summary>
  572. <para>Adds the TileFlags onto the Tile at the given position.</para>
  573. </summary>
  574. <param name="position">Position of the Tile on the Tilemap.</param>
  575. <param name="flags">TileFlags to add (with bitwise or) onto the flags provided by Tile.TileBase.</param>
  576. </member>
  577. <member name="M:UnityEngine.Tilemaps.Tilemap.BoxFill(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileBase,System.Int32,System.Int32,System.Int32,System.Int32)">
  578. <summary>
  579. <para>Does a box fill with the given. Starts from given coordinates and fills the limits from start to end (inclusive).</para>
  580. </summary>
  581. <param name="position">Position of the Tile on the Tilemap.</param>
  582. <param name="tile"> to place.</param>
  583. <param name="startX">The minimum X coordinate limit to fill to.</param>
  584. <param name="startY">The minimum Y coordinate limit to fill to.</param>
  585. <param name="endX">The maximum X coordinate limit to fill to.</param>
  586. <param name="endY">The maximum Y coordinate limit to fill to.</param>
  587. </member>
  588. <member name="M:UnityEngine.Tilemaps.Tilemap.ClearAllTiles">
  589. <summary>
  590. <para>Clears all tiles that are placed in the Tilemap.</para>
  591. </summary>
  592. </member>
  593. <member name="M:UnityEngine.Tilemaps.Tilemap.CompressBounds">
  594. <summary>
  595. <para>Compresses the origin and size of the Tilemap to bounds where tiles exist.</para>
  596. </summary>
  597. </member>
  598. <member name="M:UnityEngine.Tilemaps.Tilemap.ContainsTile(UnityEngine.Tilemaps.TileBase)">
  599. <summary>
  600. <para>Returns true if the Tilemap contains the given. Returns false if not.</para>
  601. </summary>
  602. <param name="tileAsset">Tile to check.</param>
  603. <returns>
  604. <para>Whether the Tilemap contains the tile.</para>
  605. </returns>
  606. </member>
  607. <member name="M:UnityEngine.Tilemaps.Tilemap.FloodFill(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileBase)">
  608. <summary>
  609. <para>Does a flood fill with the given starting from the given coordinates.</para>
  610. </summary>
  611. <param name="position">Start position of the flood fill on the Tilemap.</param>
  612. <param name="tile"> to place.</param>
  613. </member>
  614. <member name="M:UnityEngine.Tilemaps.Tilemap.GetCellCenterLocal(UnityEngine.Vector3Int)">
  615. <summary>
  616. <para>Get the logical center coordinate of a grid cell in local space.</para>
  617. </summary>
  618. <param name="position">Grid cell position.</param>
  619. <returns>
  620. <para>Center of the cell transformed into local space coordinates.</para>
  621. </returns>
  622. </member>
  623. <member name="M:UnityEngine.Tilemaps.Tilemap.GetCellCenterWorld(UnityEngine.Vector3Int)">
  624. <summary>
  625. <para>Get the logical center coordinate of a grid cell in world space.</para>
  626. </summary>
  627. <param name="position">Grid cell position.</param>
  628. <returns>
  629. <para>Center of the cell transformed into world space coordinates.</para>
  630. </returns>
  631. </member>
  632. <member name="M:UnityEngine.Tilemaps.Tilemap.GetColliderType(UnityEngine.Vector3Int)">
  633. <summary>
  634. <para>Gets the collider type of a.</para>
  635. </summary>
  636. <param name="position">Position of the Tile on the Tilemap.</param>
  637. <returns>
  638. <para>Collider type of the at the XY coordinate.</para>
  639. </returns>
  640. </member>
  641. <member name="M:UnityEngine.Tilemaps.Tilemap.GetColor(UnityEngine.Vector3Int)">
  642. <summary>
  643. <para>Gets the color of a.</para>
  644. </summary>
  645. <param name="position">Position of the Tile on the Tilemap.</param>
  646. <returns>
  647. <para>Color of the at the XY coordinate.</para>
  648. </returns>
  649. </member>
  650. <member name="M:UnityEngine.Tilemaps.Tilemap.GetInstantiatedObject(UnityEngine.Vector3Int)">
  651. <summary>
  652. <para>Gets the.</para>
  653. </summary>
  654. <param name="position">Position of the Tile on the Tilemap.</param>
  655. <returns>
  656. <para>GameObject instantiated by the Tile at the position.</para>
  657. </returns>
  658. </member>
  659. <member name="M:UnityEngine.Tilemaps.Tilemap.GetSprite(UnityEngine.Vector3Int)">
  660. <summary>
  661. <para>Gets the.</para>
  662. </summary>
  663. <param name="position">Position of the Tile on the Tilemap.</param>
  664. <returns>
  665. <para>Sprite at the XY coordinate.</para>
  666. </returns>
  667. </member>
  668. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTile(UnityEngine.Vector3Int)">
  669. <summary>
  670. <para>Gets the.</para>
  671. </summary>
  672. <param name="position">Position of the Tile on the Tilemap.</param>
  673. <returns>
  674. <para>Tilemaps.TileBase placed at the cell.</para>
  675. </returns>
  676. </member>
  677. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTile(UnityEngine.Vector3Int)">
  678. <summary>
  679. <para>Gets the.</para>
  680. </summary>
  681. <param name="position">Position of the Tile on the Tilemap.</param>
  682. <returns>
  683. <para>Tilemaps.TileBase|Tile of type T placed at the cell.</para>
  684. </returns>
  685. </member>
  686. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTileFlags(UnityEngine.Vector3Int)">
  687. <summary>
  688. <para>Gets the TileFlags of the Tile at the given position.</para>
  689. </summary>
  690. <param name="position">Position of the Tile on the Tilemap.</param>
  691. <returns>
  692. <para>TileFlags from the Tile.</para>
  693. </returns>
  694. </member>
  695. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTilesBlock(UnityEngine.BoundsInt)">
  696. <summary>
  697. <para>Retrieves an array of tiles with the given bounds.</para>
  698. </summary>
  699. <param name="bounds">Bounds to retrieve from.</param>
  700. <returns>
  701. <para>An array of at the given bounds.</para>
  702. </returns>
  703. </member>
  704. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTransformMatrix(UnityEngine.Vector3Int)">
  705. <summary>
  706. <para>Gets the transform matrix of a.</para>
  707. </summary>
  708. <param name="position">Position of the Tile on the Tilemap.</param>
  709. <returns>
  710. <para>The transform matrix.</para>
  711. </returns>
  712. </member>
  713. <member name="M:UnityEngine.Tilemaps.Tilemap.GetUsedTilesCount">
  714. <summary>
  715. <para>Get the total number of different.</para>
  716. </summary>
  717. <returns>
  718. <para>The total number of different.</para>
  719. </returns>
  720. </member>
  721. <member name="M:UnityEngine.Tilemaps.Tilemap.GetUsedTilesNonAlloc(UnityEngine.Tilemaps.TileBase[])">
  722. <summary>
  723. <para>Fills the given array with the total number of different and returns the number of tiles filled.</para>
  724. </summary>
  725. <param name="usedTiles">The array to be filled.</param>
  726. <returns>
  727. <para>The number of tiles filled.</para>
  728. </returns>
  729. </member>
  730. <member name="M:UnityEngine.Tilemaps.Tilemap.HasTile(UnityEngine.Vector3Int)">
  731. <summary>
  732. <para>Returns whether there is a tile at the position.</para>
  733. </summary>
  734. <param name="position">Position to check.</param>
  735. <returns>
  736. <para>True if there is a tile at the position. False if not.</para>
  737. </returns>
  738. </member>
  739. <member name="T:UnityEngine.Tilemaps.Tilemap.Orientation">
  740. <summary>
  741. <para>Determines the orientation of.</para>
  742. </summary>
  743. </member>
  744. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.Custom">
  745. <summary>
  746. <para>Use a custom orientation to all tiles in the tile map.</para>
  747. </summary>
  748. </member>
  749. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.XY">
  750. <summary>
  751. <para>Orients tiles in the XY plane.</para>
  752. </summary>
  753. </member>
  754. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.XZ">
  755. <summary>
  756. <para>Orients tiles in the XZ plane.</para>
  757. </summary>
  758. </member>
  759. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.YX">
  760. <summary>
  761. <para>Orients tiles in the YX plane.</para>
  762. </summary>
  763. </member>
  764. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.YZ">
  765. <summary>
  766. <para>Orients tiles in the YZ plane.</para>
  767. </summary>
  768. </member>
  769. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.ZX">
  770. <summary>
  771. <para>Orients tiles in the ZX plane.</para>
  772. </summary>
  773. </member>
  774. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.ZY">
  775. <summary>
  776. <para>Orients tiles in the ZY plane.</para>
  777. </summary>
  778. </member>
  779. <member name="M:UnityEngine.Tilemaps.Tilemap.RefreshAllTiles">
  780. <summary>
  781. <para>Refreshes all. The tile map will retrieve the rendering data, animation data and other data for all tiles and update all relevant components.</para>
  782. </summary>
  783. </member>
  784. <member name="M:UnityEngine.Tilemaps.Tilemap.RefreshTile(UnityEngine.Vector3Int)">
  785. <summary>
  786. <para>Refreshes a.</para>
  787. </summary>
  788. <param name="position">Position of the Tile on the Tilemap.</param>
  789. </member>
  790. <member name="M:UnityEngine.Tilemaps.Tilemap.RemoveTileFlags(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileFlags)">
  791. <summary>
  792. <para>Removes the TileFlags onto the Tile at the given position.</para>
  793. </summary>
  794. <param name="position">Position of the Tile on the Tilemap.</param>
  795. <param name="flags">TileFlags to remove from the Tile.</param>
  796. </member>
  797. <member name="M:UnityEngine.Tilemaps.Tilemap.ResizeBounds">
  798. <summary>
  799. <para>Resizes tiles in the Tilemap to bounds defined by origin and size.</para>
  800. </summary>
  801. </member>
  802. <member name="M:UnityEngine.Tilemaps.Tilemap.SetColliderType(UnityEngine.Vector3Int,UnityEngine.Tilemaps.Tile/ColliderType)">
  803. <summary>
  804. <para>Sets the collider type of a.</para>
  805. </summary>
  806. <param name="position">Position of the Tile on the Tilemap.</param>
  807. <param name="colliderType">Collider type to set the to at the XYZ coordinate.</param>
  808. </member>
  809. <member name="M:UnityEngine.Tilemaps.Tilemap.SetColor(UnityEngine.Vector3Int,UnityEngine.Color)">
  810. <summary>
  811. <para>Sets the color of a.</para>
  812. </summary>
  813. <param name="position">Position of the Tile on the Tilemap.</param>
  814. <param name="color">Color to set the to at the XY coordinate.</param>
  815. </member>
  816. <member name="M:UnityEngine.Tilemaps.Tilemap.SetTile(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileBase)">
  817. <summary>
  818. <para>Sets a.</para>
  819. </summary>
  820. <param name="position">Position of the Tile on the Tilemap.</param>
  821. <param name="tile"> to be placed the cell.</param>
  822. </member>
  823. <member name="M:UnityEngine.Tilemaps.Tilemap.SetTileFlags(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileFlags)">
  824. <summary>
  825. <para>Sets the TileFlags onto the Tile at the given position.</para>
  826. </summary>
  827. <param name="position">Position of the Tile on the Tilemap.</param>
  828. <param name="flags">TileFlags to add onto the Tile.</param>
  829. </member>
  830. <member name="M:UnityEngine.Tilemaps.Tilemap.SetTiles(UnityEngine.Vector3Int[],UnityEngine.Tilemaps.TileBase[])">
  831. <summary>
  832. <para>Sets an array of.</para>
  833. </summary>
  834. <param name="positionArray">An array of positions of Tiles on the Tilemap.</param>
  835. <param name="tileArray">An array of to be placed.</param>
  836. </member>
  837. <member name="M:UnityEngine.Tilemaps.Tilemap.SetTilesBlock(UnityEngine.BoundsInt,UnityEngine.Tilemaps.TileBase[])">
  838. <summary>
  839. <para>Fills bounds with array of tiles.</para>
  840. </summary>
  841. <param name="position">Bounds to be filled.</param>
  842. <param name="tileArray">An array of to be placed.</param>
  843. </member>
  844. <member name="M:UnityEngine.Tilemaps.Tilemap.SetTransformMatrix(UnityEngine.Vector3Int,UnityEngine.Matrix4x4)">
  845. <summary>
  846. <para>Sets the transform matrix of a tile given the XYZ coordinates of a cell in the.</para>
  847. </summary>
  848. <param name="position">Position of the Tile on the Tilemap.</param>
  849. <param name="transform">The transform matrix.</param>
  850. </member>
  851. <member name="M:UnityEngine.Tilemaps.Tilemap.SwapTile(UnityEngine.Tilemaps.TileBase,UnityEngine.Tilemaps.TileBase)">
  852. <summary>
  853. <para>Swaps all existing tiles of changeTile to newTile and refreshes all the swapped tiles.</para>
  854. </summary>
  855. <param name="changeTile">Tile to swap.</param>
  856. <param name="newTile">Tile to swap to.</param>
  857. </member>
  858. <member name="T:UnityEngine.Tilemaps.TilemapCollider2D">
  859. <summary>
  860. <para>Collider for 2D physics representing shapes defined by the corresponding Tilemap.</para>
  861. </summary>
  862. </member>
  863. <member name="T:UnityEngine.Tilemaps.TilemapRenderer">
  864. <summary>
  865. <para>The tile map renderer is used to render the tile map marked out by a component.</para>
  866. </summary>
  867. </member>
  868. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.chunkCullingBounds">
  869. <summary>
  870. <para>Bounds used for culling of Tilemap chunks.</para>
  871. </summary>
  872. </member>
  873. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.chunkSize">
  874. <summary>
  875. <para>Size in number of tiles of each chunk created by the TilemapRenderer.</para>
  876. </summary>
  877. </member>
  878. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.detectChunkCullingBounds">
  879. <summary>
  880. <para>Returns whether the TilemapRenderer automatically detects the bounds to extend chunk culling by.</para>
  881. </summary>
  882. </member>
  883. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.maskInteraction">
  884. <summary>
  885. <para>Specifies how the Tilemap interacts with the masks.</para>
  886. </summary>
  887. </member>
  888. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.maxChunkCount">
  889. <summary>
  890. <para>Maximum number of chunks the TilemapRenderer caches in memory.</para>
  891. </summary>
  892. </member>
  893. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.maxFrameAge">
  894. <summary>
  895. <para>Maximum number of frames the TilemapRenderer keeps unused chunks in memory.</para>
  896. </summary>
  897. </member>
  898. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.sortOrder">
  899. <summary>
  900. <para>Active sort order for the TilemapRenderer.</para>
  901. </summary>
  902. </member>
  903. <member name="T:UnityEngine.Tilemaps.TilemapRenderer.DetectChunkCullingBounds">
  904. <summary>
  905. <para>Returns whether the TilemapRenderer automatically detects the bounds to extend chunk culling by.</para>
  906. </summary>
  907. </member>
  908. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.DetectChunkCullingBounds.Auto">
  909. <summary>
  910. <para>The TilemapRenderer will automatically detect the bounds of extension by inspecting the Sprite/s used in the Tilemap.</para>
  911. </summary>
  912. </member>
  913. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.DetectChunkCullingBounds.Manual">
  914. <summary>
  915. <para>The user adds in the values used for extend the bounds for culling of Tilemap chunks.</para>
  916. </summary>
  917. </member>
  918. <member name="T:UnityEngine.Tilemaps.TilemapRenderer.SortOrder">
  919. <summary>
  920. <para>Sort order for all tiles rendered by the TilemapRenderer.</para>
  921. </summary>
  922. </member>
  923. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.SortOrder.BottomLeft">
  924. <summary>
  925. <para>Sorts tiles for rendering starting from the tile with the lowest X and the lowest Y cell positions.</para>
  926. </summary>
  927. </member>
  928. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.SortOrder.BottomRight">
  929. <summary>
  930. <para>Sorts tiles for rendering starting from the tile with the highest X and the lowest Y cell positions.</para>
  931. </summary>
  932. </member>
  933. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.SortOrder.TopLeft">
  934. <summary>
  935. <para>Sorts tiles for rendering starting from the tile with the lowest X and the highest Y cell positions.</para>
  936. </summary>
  937. </member>
  938. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.SortOrder.TopRight">
  939. <summary>
  940. <para>Sorts tiles for rendering starting from the tile with the highest X and the lowest Y cell positions.</para>
  941. </summary>
  942. </member>
  943. <member name="A:UnityEngine.TilemapModule">
  944. <summary>
  945. <para>The Tilemap module implements the Tilemap class.</para>
  946. </summary>
  947. </member>
  948. </members>
  949. </doc>