UnityEngine.TilemapModule.xml 61 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319
  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.ChangeZPosition(System.Int32)">
  75. <summary>
  76. <para>Changes the Z position of the GridBrushBase.</para>
  77. </summary>
  78. <param name="change">Modify the Z position of GridBrushBase by this value.</param>
  79. </member>
  80. <member name="M:UnityEngine.GridBrushBase.Erase(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.Vector3Int)">
  81. <summary>
  82. <para>Erases data on a grid within the given bounds.</para>
  83. </summary>
  84. <param name="grid">Grid used for layout.</param>
  85. <param name="brushTarget">Target of the erase operation. By default the currently selected GameObject.</param>
  86. <param name="position">The coordinates of the cell to erase data from.</param>
  87. <param name="gridLayout"></param>
  88. </member>
  89. <member name="M:UnityEngine.GridBrushBase.Flip(UnityEngine.GridBrushBase/FlipAxis,UnityEngine.GridLayout/CellLayout)">
  90. <summary>
  91. <para>Flips the grid brush in the given FlipAxis.</para>
  92. </summary>
  93. <param name="flip">Axis to flip by.</param>
  94. <param name="layout">CellLayout for flipping.</param>
  95. </member>
  96. <member name="T:UnityEngine.GridBrushBase.FlipAxis">
  97. <summary>
  98. <para>Axis to flip tiles in the GridBrushBase by.</para>
  99. </summary>
  100. </member>
  101. <member name="F:UnityEngine.GridBrushBase.FlipAxis.X">
  102. <summary>
  103. <para>Flip the brush in the X Axis.</para>
  104. </summary>
  105. </member>
  106. <member name="F:UnityEngine.GridBrushBase.FlipAxis.Y">
  107. <summary>
  108. <para>Flip the brush in the Y Axis.</para>
  109. </summary>
  110. </member>
  111. <member name="M:UnityEngine.GridBrushBase.FloodFill(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.Vector3Int)">
  112. <summary>
  113. <para>Flood fills data onto a grid given the starting coordinates of the cell.</para>
  114. </summary>
  115. <param name="gridLayout">Grid used for layout.</param>
  116. <param name="brushTarget">Targets of flood fill operation. By default the currently selected GameObject.</param>
  117. <param name="position">Starting position of the flood fill.</param>
  118. </member>
  119. <member name="M:UnityEngine.GridBrushBase.Move(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.BoundsInt,UnityEngine.BoundsInt)">
  120. <summary>
  121. <para>Move is called when user moves the area previously selected with the selection marquee.</para>
  122. </summary>
  123. <param name="grid">Grid used for layout.</param>
  124. <param name="brushTarget">Target of the move operation. By default the currently selected GameObject.</param>
  125. <param name="from">Source bounds of the move.</param>
  126. <param name="to">Target bounds of the move.</param>
  127. <param name="gridLayout"></param>
  128. </member>
  129. <member name="M:UnityEngine.GridBrushBase.MoveEnd(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.BoundsInt)">
  130. <summary>
  131. <para>MoveEnd is called when user has ended the move of the area previously selected with the selection marquee.</para>
  132. </summary>
  133. <param name="position">Layers affected by the move operation.</param>
  134. <param name="brushTarget">Target of the move operation. By default the currently selected GameObject.</param>
  135. <param name="grid">Grid used for layout.</param>
  136. <param name="gridLayout"></param>
  137. </member>
  138. <member name="M:UnityEngine.GridBrushBase.MoveStart(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.BoundsInt)">
  139. <summary>
  140. <para>MoveEnd is called when user starts moving the area previously selected with the selection marquee.</para>
  141. </summary>
  142. <param name="grid">Grid used for layout.</param>
  143. <param name="brushTarget">Target of the move operation. By default the currently selected GameObject.</param>
  144. <param name="position">Position where the move operation has started.</param>
  145. <param name="gridLayout"></param>
  146. </member>
  147. <member name="M:UnityEngine.GridBrushBase.Paint(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.Vector3Int)">
  148. <summary>
  149. <para>Paints data into a grid within the given bounds.</para>
  150. </summary>
  151. <param name="grid">Grid used for layout.</param>
  152. <param name="brushTarget">Target of the paint operation. By default the currently selected GameObject.</param>
  153. <param name="position">The coordinates of the cell to paint data to.</param>
  154. <param name="gridLayout"></param>
  155. </member>
  156. <member name="M:UnityEngine.GridBrushBase.Pick(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.BoundsInt,UnityEngine.Vector3Int)">
  157. <summary>
  158. <para>Picks data from a grid given the coordinates of the cells.</para>
  159. </summary>
  160. <param name="grid">Grid used for layout.</param>
  161. <param name="brushTarget">Target of the paint operation. By default the currently selected GameObject.</param>
  162. <param name="position">The coordinates of the cells to paint data from.</param>
  163. <param name="pivot">Pivot of the picking brush.</param>
  164. <param name="gridLayout"></param>
  165. </member>
  166. <member name="M:UnityEngine.GridBrushBase.ResetZPosition">
  167. <summary>
  168. <para>Resets Z position changes of the GridBrushBase.</para>
  169. </summary>
  170. </member>
  171. <member name="M:UnityEngine.GridBrushBase.Rotate(UnityEngine.GridBrushBase/RotationDirection,UnityEngine.GridLayout/CellLayout)">
  172. <summary>
  173. <para>Rotates all tiles on the grid brush with the given RotationDirection.</para>
  174. </summary>
  175. <param name="direction">Direction to rotate by.</param>
  176. <param name="layout">CellLayout for rotating.</param>
  177. </member>
  178. <member name="T:UnityEngine.GridBrushBase.RotationDirection">
  179. <summary>
  180. <para>Rotate tiles in the GridBrushBase in this direction.</para>
  181. </summary>
  182. </member>
  183. <member name="F:UnityEngine.GridBrushBase.RotationDirection.Clockwise">
  184. <summary>
  185. <para>Rotates tiles clockwise.</para>
  186. </summary>
  187. </member>
  188. <member name="F:UnityEngine.GridBrushBase.RotationDirection.CounterClockwise">
  189. <summary>
  190. <para>Rotates tiles counter-clockwise.</para>
  191. </summary>
  192. </member>
  193. <member name="M:UnityEngine.GridBrushBase.Select(UnityEngine.GridLayout,UnityEngine.GameObject,UnityEngine.BoundsInt)">
  194. <summary>
  195. <para>Select an area of a grid.</para>
  196. </summary>
  197. <param name="grid">Grid used for layout.</param>
  198. <param name="brushTarget">Targets of paint operation. By default the currently selected GameObject.</param>
  199. <param name="position">Area to get selected.</param>
  200. <param name="gridLayout"></param>
  201. </member>
  202. <member name="T:UnityEngine.GridBrushBase.Tool">
  203. <summary>
  204. <para>Tool mode for the GridBrushBase.</para>
  205. </summary>
  206. </member>
  207. <member name="F:UnityEngine.GridBrushBase.Tool.Box">
  208. <summary>
  209. <para>Box Fill.</para>
  210. </summary>
  211. </member>
  212. <member name="F:UnityEngine.GridBrushBase.Tool.Erase">
  213. <summary>
  214. <para>Erase.</para>
  215. </summary>
  216. </member>
  217. <member name="F:UnityEngine.GridBrushBase.Tool.FloodFill">
  218. <summary>
  219. <para>Flood Fill.</para>
  220. </summary>
  221. </member>
  222. <member name="F:UnityEngine.GridBrushBase.Tool.Move">
  223. <summary>
  224. <para>Move.</para>
  225. </summary>
  226. </member>
  227. <member name="F:UnityEngine.GridBrushBase.Tool.Paint">
  228. <summary>
  229. <para>Paint.</para>
  230. </summary>
  231. </member>
  232. <member name="F:UnityEngine.GridBrushBase.Tool.Pick">
  233. <summary>
  234. <para>Pick.</para>
  235. </summary>
  236. </member>
  237. <member name="F:UnityEngine.GridBrushBase.Tool.Select">
  238. <summary>
  239. <para>Select.</para>
  240. </summary>
  241. </member>
  242. <member name="T:UnityEngine.Tilemaps.ITilemap">
  243. <summary>
  244. <para>Class passed onto Tiles when information is queried from the Tiles.</para>
  245. </summary>
  246. </member>
  247. <member name="P:UnityEngine.Tilemaps.ITilemap.cellBounds">
  248. <summary>
  249. <para>Returns the boundaries of the Tilemap in cell size.</para>
  250. </summary>
  251. </member>
  252. <member name="P:UnityEngine.Tilemaps.ITilemap.localBounds">
  253. <summary>
  254. <para>Returns the boundaries of the Tilemap in local space size.</para>
  255. </summary>
  256. </member>
  257. <member name="P:UnityEngine.Tilemaps.ITilemap.origin">
  258. <summary>
  259. <para>The origin of the Tilemap in cell position.</para>
  260. </summary>
  261. </member>
  262. <member name="P:UnityEngine.Tilemaps.ITilemap.size">
  263. <summary>
  264. <para>The size of the Tilemap in cells.</para>
  265. </summary>
  266. </member>
  267. <member name="M:UnityEngine.Tilemaps.ITilemap.GetColor(UnityEngine.Vector3Int)">
  268. <summary>
  269. <para>Gets the color of a Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  270. </summary>
  271. <param name="position">Position of the Tile on the Tilemap.</param>
  272. <returns>
  273. <para>Color of the Tile at the XYZ coordinate.</para>
  274. </returns>
  275. </member>
  276. <member name="M:UnityEngine.Tilemaps.ITilemap.GetComponent">
  277. <summary>
  278. <para>Returns the component of type T if the GameObject of the tile map has one attached, null if it doesn't.</para>
  279. </summary>
  280. <returns>
  281. <para>The Component of type T to retrieve.</para>
  282. </returns>
  283. </member>
  284. <member name="M:UnityEngine.Tilemaps.ITilemap.GetSprite(UnityEngine.Vector3Int)">
  285. <summary>
  286. <para>Gets the Sprite used in a Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  287. </summary>
  288. <param name="position">Position of the Tile on the Tilemap.</param>
  289. <returns>
  290. <para>Sprite at the XYZ coordinate.</para>
  291. </returns>
  292. </member>
  293. <member name="M:UnityEngine.Tilemaps.ITilemap.GetTile(UnityEngine.Vector3Int)">
  294. <summary>
  295. <para>Gets the Tile at the given XYZ coordinates of a cell in the Tilemap.</para>
  296. </summary>
  297. <param name="position">Position of the Tile on the Tilemap.</param>
  298. <returns>
  299. <para>Tile placed at the cell.</para>
  300. </returns>
  301. </member>
  302. <member name="M:UnityEngine.Tilemaps.ITilemap.GetTile(UnityEngine.Vector3Int)">
  303. <summary>
  304. <para>Gets the Tile of type T at the given XYZ coordinates of a cell in the Tilemap.</para>
  305. </summary>
  306. <param name="position">Position of the Tile on the Tilemap.</param>
  307. <returns>
  308. <para>Tile of type T placed at the cell.</para>
  309. </returns>
  310. </member>
  311. <member name="M:UnityEngine.Tilemaps.ITilemap.GetTileFlags(UnityEngine.Vector3Int)">
  312. <summary>
  313. <para>Gets the Tile Flags of the Tile at the given position.</para>
  314. </summary>
  315. <param name="position">Position of the Tile on the Tilemap.</param>
  316. <returns>
  317. <para>TileFlags from the Tile.</para>
  318. </returns>
  319. </member>
  320. <member name="M:UnityEngine.Tilemaps.ITilemap.GetTransformMatrix(UnityEngine.Vector3Int)">
  321. <summary>
  322. <para>Gets the transform matrix of a Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  323. </summary>
  324. <param name="position">Position of the Tile on the Tilemap.</param>
  325. <returns>
  326. <para>The transform matrix.</para>
  327. </returns>
  328. </member>
  329. <member name="M:UnityEngine.Tilemaps.ITilemap.RefreshTile(UnityEngine.Vector3Int)">
  330. <summary>
  331. <para>Refreshes a Tile at the given XYZ coordinates of a cell in the :Tilemap.</para>
  332. </summary>
  333. <param name="position">Position of the Tile on the Tilemap.</param>
  334. </member>
  335. <member name="T:UnityEngine.Tilemaps.Tile">
  336. <summary>
  337. <para>Class for a default tile in the Tilemap.</para>
  338. </summary>
  339. </member>
  340. <member name="P:UnityEngine.Tilemaps.Tile.color">
  341. <summary>
  342. <para>Color of the Tile.</para>
  343. </summary>
  344. </member>
  345. <member name="P:UnityEngine.Tilemaps.Tile.flags">
  346. <summary>
  347. <para>TileFlags of the Tile.</para>
  348. </summary>
  349. </member>
  350. <member name="P:UnityEngine.Tilemaps.Tile.gameObject">
  351. <summary>
  352. <para>GameObject of the Tile.</para>
  353. </summary>
  354. </member>
  355. <member name="P:UnityEngine.Tilemaps.Tile.sprite">
  356. <summary>
  357. <para>Sprite to be rendered at the Tile.</para>
  358. </summary>
  359. </member>
  360. <member name="P:UnityEngine.Tilemaps.Tile.transform">
  361. <summary>
  362. <para>Matrix4x4|Transform matrix of the Tile.</para>
  363. </summary>
  364. </member>
  365. <member name="T:UnityEngine.Tilemaps.Tile.ColliderType">
  366. <summary>
  367. <para>Enum for determining what collider shape is generated for this Tile by the TilemapCollider2D.</para>
  368. </summary>
  369. </member>
  370. <member name="F:UnityEngine.Tilemaps.Tile.ColliderType.Grid">
  371. <summary>
  372. <para>The grid layout boundary outline is used as the collider shape for the Tile by the TilemapCollider2D.</para>
  373. </summary>
  374. </member>
  375. <member name="F:UnityEngine.Tilemaps.Tile.ColliderType.None">
  376. <summary>
  377. <para>No collider shape is generated for the Tile by the TilemapCollider2D.</para>
  378. </summary>
  379. </member>
  380. <member name="F:UnityEngine.Tilemaps.Tile.ColliderType.Sprite">
  381. <summary>
  382. <para>The Sprite outline is used as the collider shape for the Tile by the TilemapCollider2D.</para>
  383. </summary>
  384. </member>
  385. <member name="M:UnityEngine.Tilemaps.Tile.GetTileData(UnityEngine.Vector3Int,UnityEngine.Tilemaps.ITilemap,UnityEngine.Tilemaps.TileData&amp;)">
  386. <summary>
  387. <para>Retrieves the tile rendering data for the Tile.</para>
  388. </summary>
  389. <param name="position">Position of the Tile on the Tilemap.</param>
  390. <param name="tilemap">The Tilemap the tile is present on.</param>
  391. <param name="tileData">Data to render the tile. This is filled with Tile, Tile.color and Tile.transform.</param>
  392. <returns>
  393. <para>Whether the call was successful. This returns true for Tile.</para>
  394. </returns>
  395. </member>
  396. <member name="T:UnityEngine.Tilemaps.TileAnimationData">
  397. <summary>
  398. <para>A Struct for the required data for animating a Tile.</para>
  399. </summary>
  400. </member>
  401. <member name="P:UnityEngine.Tilemaps.TileAnimationData.animatedSprites">
  402. <summary>
  403. <para>The array of that are ordered by appearance in the animation.</para>
  404. </summary>
  405. </member>
  406. <member name="P:UnityEngine.Tilemaps.TileAnimationData.animationSpeed">
  407. <summary>
  408. <para>The animation speed.</para>
  409. </summary>
  410. </member>
  411. <member name="P:UnityEngine.Tilemaps.TileAnimationData.animationStartTime">
  412. <summary>
  413. <para>The start time of the animation. The animation will begin at this time offset.</para>
  414. </summary>
  415. </member>
  416. <member name="T:UnityEngine.Tilemaps.TileBase">
  417. <summary>
  418. <para>Base class for a tile in the Tilemap.</para>
  419. </summary>
  420. </member>
  421. <member name="M:UnityEngine.Tilemaps.TileBase.GetTileAnimationData(UnityEngine.Vector3Int,UnityEngine.Tilemaps.ITilemap,UnityEngine.Tilemaps.TileAnimationData&amp;)">
  422. <summary>
  423. <para>Retrieves any tile animation 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="tileAnimationData">Data to run an animation on the tile.</param>
  428. <returns>
  429. <para>Whether the call was successful.</para>
  430. </returns>
  431. </member>
  432. <member name="M:UnityEngine.Tilemaps.TileBase.GetTileData(UnityEngine.Vector3Int,UnityEngine.Tilemaps.ITilemap,UnityEngine.Tilemaps.TileData&amp;)">
  433. <summary>
  434. <para>Retrieves any tile rendering data from the scripted tile.</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. <param name="tileData">Data to render the tile.</param>
  439. <returns>
  440. <para>Whether the call was successful.</para>
  441. </returns>
  442. </member>
  443. <member name="M:UnityEngine.Tilemaps.TileBase.RefreshTile(UnityEngine.Vector3Int,UnityEngine.Tilemaps.ITilemap)">
  444. <summary>
  445. <para>This method is called when the tile is refreshed.</para>
  446. </summary>
  447. <param name="position">Position of the Tile on the Tilemap.</param>
  448. <param name="tilemap">The Tilemap the tile is present on.</param>
  449. </member>
  450. <member name="M:UnityEngine.Tilemaps.TileBase.StartUp(UnityEngine.Vector3Int,UnityEngine.Tilemaps.ITilemap,UnityEngine.GameObject)">
  451. <summary>
  452. <para>StartUp is called on the first frame of the running Scene.</para>
  453. </summary>
  454. <param name="position">Position of the Tile on the Tilemap.</param>
  455. <param name="tilemap">The Tilemap the tile is present on.</param>
  456. <param name="go">The GameObject instantiated for the Tile.</param>
  457. <returns>
  458. <para>Whether the call was successful.</para>
  459. </returns>
  460. </member>
  461. <member name="T:UnityEngine.Tilemaps.TileChangeData">
  462. <summary>
  463. <para>Represents the position and Tile information to change in a Tilemap.</para>
  464. </summary>
  465. </member>
  466. <member name="P:UnityEngine.Tilemaps.TileChangeData.color">
  467. <summary>
  468. <para>The color to set the Tile to.</para>
  469. </summary>
  470. </member>
  471. <member name="P:UnityEngine.Tilemaps.TileChangeData.position">
  472. <summary>
  473. <para>The position to change Tile properties at.</para>
  474. </summary>
  475. </member>
  476. <member name="P:UnityEngine.Tilemaps.TileChangeData.tile">
  477. <summary>
  478. <para>The Tile to set on the Tilemap.</para>
  479. </summary>
  480. </member>
  481. <member name="P:UnityEngine.Tilemaps.TileChangeData.transform">
  482. <summary>
  483. <para>The transform matrix to set the Tile to.</para>
  484. </summary>
  485. </member>
  486. <member name="T:UnityEngine.Tilemaps.TileData">
  487. <summary>
  488. <para>A Struct for the required data for rendering a Tile.</para>
  489. </summary>
  490. </member>
  491. <member name="P:UnityEngine.Tilemaps.TileData.color">
  492. <summary>
  493. <para>Color of the Tile.</para>
  494. </summary>
  495. </member>
  496. <member name="P:UnityEngine.Tilemaps.TileData.flags">
  497. <summary>
  498. <para>TileFlags of the Tile.</para>
  499. </summary>
  500. </member>
  501. <member name="P:UnityEngine.Tilemaps.TileData.gameObject">
  502. <summary>
  503. <para>GameObject of the Tile.</para>
  504. </summary>
  505. </member>
  506. <member name="P:UnityEngine.Tilemaps.TileData.sprite">
  507. <summary>
  508. <para>Sprite to be rendered at the Tile.</para>
  509. </summary>
  510. </member>
  511. <member name="P:UnityEngine.Tilemaps.TileData.transform">
  512. <summary>
  513. <para>Matrix4x4|Transform matrix of the Tile.</para>
  514. </summary>
  515. </member>
  516. <member name="T:UnityEngine.Tilemaps.TileFlags">
  517. <summary>
  518. <para>Flags controlling behavior for the TileBase.</para>
  519. </summary>
  520. </member>
  521. <member name="F:UnityEngine.Tilemaps.TileFlags.InstantiateGameObjectRuntimeOnly">
  522. <summary>
  523. <para>TileBase does not instantiate its associated GameObject in editor mode and instantiates it only during Play mode.</para>
  524. </summary>
  525. </member>
  526. <member name="F:UnityEngine.Tilemaps.TileFlags.KeepGameObjectRuntimeOnly">
  527. <summary>
  528. <para>Keeps the TileBase's associated GameObject in Play mode when replaced with another TileBase or erased</para>
  529. </summary>
  530. </member>
  531. <member name="F:UnityEngine.Tilemaps.TileFlags.LockAll">
  532. <summary>
  533. <para>All lock flags.</para>
  534. </summary>
  535. </member>
  536. <member name="F:UnityEngine.Tilemaps.TileFlags.LockColor">
  537. <summary>
  538. <para>TileBase locks any color set by brushes or the user.</para>
  539. </summary>
  540. </member>
  541. <member name="F:UnityEngine.Tilemaps.TileFlags.LockTransform">
  542. <summary>
  543. <para>TileBase locks any transform matrix set by brushes or the user.</para>
  544. </summary>
  545. </member>
  546. <member name="F:UnityEngine.Tilemaps.TileFlags.None">
  547. <summary>
  548. <para>No TileFlags are set.</para>
  549. </summary>
  550. </member>
  551. <member name="T:UnityEngine.Tilemaps.Tilemap">
  552. <summary>
  553. <para>The Tilemap stores Sprites in a layout marked by a Grid component.</para>
  554. </summary>
  555. </member>
  556. <member name="P:UnityEngine.Tilemaps.Tilemap.animationFrameRate">
  557. <summary>
  558. <para>The frame rate for all Tile animations in the Tilemap.</para>
  559. </summary>
  560. </member>
  561. <member name="P:UnityEngine.Tilemaps.Tilemap.cellBounds">
  562. <summary>
  563. <para>Returns the boundaries of the Tilemap in cell size.</para>
  564. </summary>
  565. </member>
  566. <member name="P:UnityEngine.Tilemaps.Tilemap.color">
  567. <summary>
  568. <para>The color of the Tilemap layer.</para>
  569. </summary>
  570. </member>
  571. <member name="P:UnityEngine.Tilemaps.Tilemap.editorPreviewOrigin">
  572. <summary>
  573. <para>The origin of the Tilemap in cell position inclusive of editor preview Tiles.</para>
  574. </summary>
  575. </member>
  576. <member name="P:UnityEngine.Tilemaps.Tilemap.editorPreviewSize">
  577. <summary>
  578. <para>The size of the Tilemap in cells inclusive of editor preview Tiles.</para>
  579. </summary>
  580. </member>
  581. <member name="P:UnityEngine.Tilemaps.Tilemap.layoutGrid">
  582. <summary>
  583. <para>Gets the Grid associated with this Tilemap.</para>
  584. </summary>
  585. </member>
  586. <member name="P:UnityEngine.Tilemaps.Tilemap.layoutGrid">
  587. <summary>
  588. <para>Gets the Grid associated with this Tilemap.</para>
  589. </summary>
  590. </member>
  591. <member name="P:UnityEngine.Tilemaps.Tilemap.localBounds">
  592. <summary>
  593. <para>Returns the boundaries of the Tilemap in local space size.</para>
  594. </summary>
  595. </member>
  596. <member name="P:UnityEngine.Tilemaps.Tilemap.orientation">
  597. <summary>
  598. <para>Orientation of the Tiles in the Tilemap.</para>
  599. </summary>
  600. </member>
  601. <member name="P:UnityEngine.Tilemaps.Tilemap.orientationMatrix">
  602. <summary>
  603. <para>Orientation Matrix of the orientation of the Tiles in the Tilemap.</para>
  604. </summary>
  605. </member>
  606. <member name="P:UnityEngine.Tilemaps.Tilemap.origin">
  607. <summary>
  608. <para>The origin of the Tilemap in cell position.</para>
  609. </summary>
  610. </member>
  611. <member name="P:UnityEngine.Tilemaps.Tilemap.size">
  612. <summary>
  613. <para>The size of the Tilemap in cells.</para>
  614. </summary>
  615. </member>
  616. <member name="P:UnityEngine.Tilemaps.Tilemap.tileAnchor">
  617. <summary>
  618. <para>Gets the anchor point of Tiles in the Tilemap.</para>
  619. </summary>
  620. </member>
  621. <member name="?:UnityEngine.Tilemaps.Tilemap.tilemapTileChanged(System.Action`2&lt;UnityEngine.Tilemaps.Tilemap,UnityEngine.Tilemaps.Tilemap/SyncTile[]&gt;)">
  622. <summary>
  623. <para>Callback when Tiles on a Tilemap have changed.</para>
  624. </summary>
  625. <param name="value">A callback set by a user to notify them when Tiles are changed on a Tilemap.</param>
  626. </member>
  627. <member name="M:UnityEngine.Tilemaps.Tilemap.AddTileFlags(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileFlags)">
  628. <summary>
  629. <para>Adds the TileFlags onto the Tile at the given position.</para>
  630. </summary>
  631. <param name="position">Position of the Tile on the Tilemap.</param>
  632. <param name="flags">TileFlags to add (with bitwise or) onto the flags provided by Tile.TileBase.</param>
  633. </member>
  634. <member name="M:UnityEngine.Tilemaps.Tilemap.BoxFill(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileBase,System.Int32,System.Int32,System.Int32,System.Int32)">
  635. <summary>
  636. <para>Does a box fill with the given Tile on the Tilemap. Starts from given coordinates and fills the limits from start to end (inclusive).</para>
  637. </summary>
  638. <param name="position">Position of the Tile on the Tilemap.</param>
  639. <param name="tile">Tile to place.</param>
  640. <param name="startX">The minimum X coordinate limit to fill to.</param>
  641. <param name="startY">The minimum Y coordinate limit to fill to.</param>
  642. <param name="endX">The maximum X coordinate limit to fill to.</param>
  643. <param name="endY">The maximum Y coordinate limit to fill to.</param>
  644. </member>
  645. <member name="M:UnityEngine.Tilemaps.Tilemap.ClearAllEditorPreviewTiles">
  646. <summary>
  647. <para>Clears all editor preview Tiles that are placed in the Tilemap.</para>
  648. </summary>
  649. </member>
  650. <member name="M:UnityEngine.Tilemaps.Tilemap.ClearAllTiles">
  651. <summary>
  652. <para>Clears all Tiles that are placed in the Tilemap.</para>
  653. </summary>
  654. </member>
  655. <member name="M:UnityEngine.Tilemaps.Tilemap.CompressBounds">
  656. <summary>
  657. <para>Compresses the origin and size of the Tilemap to bounds where Tiles exist.</para>
  658. </summary>
  659. </member>
  660. <member name="M:UnityEngine.Tilemaps.Tilemap.ContainsTile(UnityEngine.Tilemaps.TileBase)">
  661. <summary>
  662. <para>Returns true if the Tilemap contains the given Tile. Returns false if not.</para>
  663. </summary>
  664. <param name="tileAsset">Tile to check.</param>
  665. <returns>
  666. <para>Whether the Tilemap contains the Tile.</para>
  667. </returns>
  668. </member>
  669. <member name="M:UnityEngine.Tilemaps.Tilemap.DeleteCells(UnityEngine.Vector3Int,UnityEngine.Vector3Int)">
  670. <summary>
  671. <para>Removes cells from within the Tilemap's bounds.</para>
  672. </summary>
  673. <param name="position">The target position to remove from.</param>
  674. <param name="deleteCells">The number of columns, rows and layers of cells to remove.</param>
  675. </member>
  676. <member name="M:UnityEngine.Tilemaps.Tilemap.DeleteCells(UnityEngine.Vector3Int,System.Int32,System.Int32,System.Int32)">
  677. <summary>
  678. <para>Removes cells from within the Tilemap's bounds.</para>
  679. </summary>
  680. <param name="position">Target position to delete from.</param>
  681. <param name="numColumns">The number of columns to remove.</param>
  682. <param name="numRows">The number of rows to remove.</param>
  683. <param name="numLayers">The number of layers of cells to remove.</param>
  684. </member>
  685. <member name="M:UnityEngine.Tilemaps.Tilemap.EditorPreviewBoxFill(UnityEngine.Vector3Int,UnityEngine.Object,System.Int32,System.Int32,System.Int32,System.Int32)">
  686. <summary>
  687. <para>Does an editor preview of a box fill with the given Tile on the Tilemap. Starts from given coordinates and fills the limits from start to end (inclusive).</para>
  688. </summary>
  689. <param name="position">Position of the Tile on the Tilemap.</param>
  690. <param name="tile">Tile to place.</param>
  691. <param name="startX">The start X coordinate limit to fill to.</param>
  692. <param name="startY">The start Y coordinate limit to fill to.</param>
  693. <param name="endX">The ending X coordinate limit to fill to.</param>
  694. <param name="endY">The ending Y coordinate limit to fill to.</param>
  695. </member>
  696. <member name="M:UnityEngine.Tilemaps.Tilemap.EditorPreviewFloodFill(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileBase)">
  697. <summary>
  698. <para>Does an editor preview of a flood fill with the given Tile to place. on the Tilemap starting from the given coordinates.</para>
  699. </summary>
  700. <param name="position">Start position of the flood fill on the Tilemap.</param>
  701. <param name="tile">TileBase to place.</param>
  702. </member>
  703. <member name="M:UnityEngine.Tilemaps.Tilemap.FloodFill(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileBase)">
  704. <summary>
  705. <para>Does a flood fill with the given Tile to place. on the Tilemap starting from the given coordinates.</para>
  706. </summary>
  707. <param name="position">Start position of the flood fill on the Tilemap.</param>
  708. <param name="tile">Tile to place.</param>
  709. </member>
  710. <member name="M:UnityEngine.Tilemaps.Tilemap.GetAnimationFrame(UnityEngine.Vector3Int)">
  711. <summary>
  712. <para>Retrieves the current animation frame for a Tile at the given position.</para>
  713. </summary>
  714. <param name="position">Grid cell position.</param>
  715. <returns>
  716. <para>Returns the current animation frame. Returns -1 when there is no animation for the Tile at the given position.</para>
  717. </returns>
  718. </member>
  719. <member name="M:UnityEngine.Tilemaps.Tilemap.GetAnimationFrameCount(UnityEngine.Vector3Int)">
  720. <summary>
  721. <para>Retrieves the number of animation frames for a Tile at the given position.</para>
  722. </summary>
  723. <param name="position">Grid cell position.</param>
  724. <returns>
  725. <para>Returns the number of animation frames. Returns 0 when there is no animation for the Tile at the given position.</para>
  726. </returns>
  727. </member>
  728. <member name="M:UnityEngine.Tilemaps.Tilemap.GetAnimationTime(UnityEngine.Vector3Int)">
  729. <summary>
  730. <para>Retrieves the current running animation time for a Tile at the given position.</para>
  731. </summary>
  732. <param name="position">Grid cell position.</param>
  733. <returns>
  734. <para>Returns the running animation time in seconds.</para>
  735. </returns>
  736. </member>
  737. <member name="M:UnityEngine.Tilemaps.Tilemap.GetCellCenterLocal(UnityEngine.Vector3Int)">
  738. <summary>
  739. <para>Gets the logical center coordinate of a Grid cell in local space. The logical center for a cell of the Tilemap is defined by the Tile Anchor of the Tilemap.</para>
  740. </summary>
  741. <param name="position">Grid cell position.</param>
  742. <returns>
  743. <para>Returns the center of the cell transformed into local space coordinates.</para>
  744. </returns>
  745. </member>
  746. <member name="M:UnityEngine.Tilemaps.Tilemap.GetCellCenterWorld(UnityEngine.Vector3Int)">
  747. <summary>
  748. <para>Gets the logical center coordinate of a Grid cell in world space. The logical center for a cell of the Tilemap is defined by the Tile Anchor of the Tilemap.</para>
  749. </summary>
  750. <param name="position">Grid cell position.</param>
  751. <returns>
  752. <para>Returns the center of the cell transformed into world space coordinates.</para>
  753. </returns>
  754. </member>
  755. <member name="M:UnityEngine.Tilemaps.Tilemap.GetColliderType(UnityEngine.Vector3Int)">
  756. <summary>
  757. <para>Gets the Collider type of a Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  758. </summary>
  759. <param name="position">Position of the Tile on the Tilemap.</param>
  760. <returns>
  761. <para>Collider type of the Tile at the XYZ coordinate.</para>
  762. </returns>
  763. </member>
  764. <member name="M:UnityEngine.Tilemaps.Tilemap.GetColor(UnityEngine.Vector3Int)">
  765. <summary>
  766. <para>Gets the Color of a Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  767. </summary>
  768. <param name="position">Position of the Tile on the Tilemap.</param>
  769. <returns>
  770. <para>Color of the Tile at the XYZ coordinate.</para>
  771. </returns>
  772. </member>
  773. <member name="M:UnityEngine.Tilemaps.Tilemap.GetEditorPreviewColor(UnityEngine.Vector3Int)">
  774. <summary>
  775. <para>Gets the Color of an editor preview Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  776. </summary>
  777. <param name="position">Position of the Tile on the Tilemap.</param>
  778. <returns>
  779. <para>Color of the editor preview Tile at the XYZ coordinate.</para>
  780. </returns>
  781. </member>
  782. <member name="M:UnityEngine.Tilemaps.Tilemap.GetEditorPreviewSprite(UnityEngine.Vector3Int)">
  783. <summary>
  784. <para>Gets the Sprite used in an editor preview Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  785. </summary>
  786. <param name="position">Position of the editor preview Tile on the Tilemap.</param>
  787. <returns>
  788. <para>Sprite at the XYZ coordinate.</para>
  789. </returns>
  790. </member>
  791. <member name="M:UnityEngine.Tilemaps.Tilemap.GetEditorPreviewTile(UnityEngine.Vector3Int)">
  792. <summary>
  793. <para>Gets the editor preview Tile at the given XYZ coordinates of a cell in the Tilemap.</para>
  794. </summary>
  795. <param name="position">Position of the editor preview Tile on the Tilemap.</param>
  796. <returns>
  797. <para>The editor preview Tile placed at the cell.</para>
  798. </returns>
  799. </member>
  800. <member name="M:UnityEngine.Tilemaps.Tilemap.GetEditorPreviewTile(UnityEngine.Vector3Int)">
  801. <summary>
  802. <para>Gets the editor preview Tile at the given XYZ coordinates of a cell in the Tilemap.</para>
  803. </summary>
  804. <param name="position">Position of the editor preview Tile on the Tilemap.</param>
  805. <returns>
  806. <para>The editor preview Tile placed at the cell.</para>
  807. </returns>
  808. </member>
  809. <member name="M:UnityEngine.Tilemaps.Tilemap.GetEditorPreviewTileFlags(UnityEngine.Vector3Int)">
  810. <summary>
  811. <para>Gets the TileFlags of the editor preview Tile at the given position.</para>
  812. </summary>
  813. <param name="position">Position of the Tile on the Tilemap.</param>
  814. <returns>
  815. <para>TileFlags from the editor preview Tile.</para>
  816. </returns>
  817. </member>
  818. <member name="M:UnityEngine.Tilemaps.Tilemap.GetEditorPreviewTransformMatrix(UnityEngine.Vector3Int)">
  819. <summary>
  820. <para>Gets the transform matrix of an editor preview Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  821. </summary>
  822. <param name="position">Position of the editor preview Tile on the Tilemap.</param>
  823. <returns>
  824. <para>The transform matrix.</para>
  825. </returns>
  826. </member>
  827. <member name="M:UnityEngine.Tilemaps.Tilemap.GetInstantiatedObject(UnityEngine.Vector3Int)">
  828. <summary>
  829. <para>Gets the GameObject instantiated by a Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  830. </summary>
  831. <param name="position">Position of the Tile on the Tilemap.</param>
  832. <returns>
  833. <para>GameObject instantiated by the Tile at the position.</para>
  834. </returns>
  835. </member>
  836. <member name="M:UnityEngine.Tilemaps.Tilemap.GetObjectToInstantiate(UnityEngine.Vector3Int)">
  837. <summary>
  838. <para>Gets the GameObject which will be instantiated by a Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  839. </summary>
  840. <param name="position">The position of the Tile on the Tilemap.</param>
  841. <returns>
  842. <para>Returns the GameObject to be instantiated by the Tile at the position.</para>
  843. </returns>
  844. </member>
  845. <member name="M:UnityEngine.Tilemaps.Tilemap.GetSprite(UnityEngine.Vector3Int)">
  846. <summary>
  847. <para>Gets the Sprite used in a Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  848. </summary>
  849. <param name="position">Position of the Tile on the Tilemap.</param>
  850. <returns>
  851. <para>Sprite at the XYZ coordinate.</para>
  852. </returns>
  853. </member>
  854. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTile(UnityEngine.Vector3Int)">
  855. <summary>
  856. <para>Gets the Tile at the given XYZ coordinates of a cell in the Tilemap.</para>
  857. </summary>
  858. <param name="position">Position of the Tile on the Tilemap.</param>
  859. <returns>
  860. <para>Tilemaps.TileBase placed at the cell.</para>
  861. </returns>
  862. </member>
  863. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTile(UnityEngine.Vector3Int)">
  864. <summary>
  865. <para>Gets the Tile of type T at the given XYZ coordinates of a cell in the Tilemap.</para>
  866. </summary>
  867. <param name="position">Position of the Tile on the Tilemap.</param>
  868. <returns>
  869. <para>Tilemaps.TileBase|Tile of type T placed at the cell.</para>
  870. </returns>
  871. </member>
  872. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTileFlags(UnityEngine.Vector3Int)">
  873. <summary>
  874. <para>Gets the TileFlags of the Tile at the given position.</para>
  875. </summary>
  876. <param name="position">Position of the Tile on the Tilemap.</param>
  877. <returns>
  878. <para>TileFlags from the Tile.</para>
  879. </returns>
  880. </member>
  881. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTilesBlock(UnityEngine.BoundsInt)">
  882. <summary>
  883. <para>Retrieves an array of Tiles with the given bounds.</para>
  884. </summary>
  885. <param name="bounds">The bounds to retrieve from.</param>
  886. <returns>
  887. <para>The array of Tiles at the given bounds.</para>
  888. </returns>
  889. </member>
  890. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTilesBlockNonAlloc(UnityEngine.BoundsInt,UnityEngine.Tilemaps.TileBase[])">
  891. <summary>
  892. <para>Retrieves an array of Tiles with the given bounds.</para>
  893. </summary>
  894. <param name="bounds">The bounds to retrieve from.</param>
  895. <param name="tiles">The array of Tiles to contain the Tiles at the given bounds.</param>
  896. <returns>
  897. <para>Returns the number of Tiles retrieved, including null entries.</para>
  898. </returns>
  899. </member>
  900. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTilesRangeCount(UnityEngine.Vector3Int,UnityEngine.Vector3Int)">
  901. <summary>
  902. <para>Retrieves the number of Tiles within the given range, inclusive of the Cells at both the starting position and the ending positions. This method begins at the given starting position and iterates through all available Z Positions, then iterates through the X and Y positions until it reaches the ending position.</para>
  903. </summary>
  904. <param name="startPosition">The starting position of the range to retrieve Tiles from.</param>
  905. <param name="endPosition">The ending position of the range to retrieve Tiles from.</param>
  906. <returns>
  907. <para>Returns the number of Tiles within the given range.</para>
  908. </returns>
  909. </member>
  910. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTilesRangeNonAlloc(UnityEngine.Vector3Int,UnityEngine.Vector3Int,UnityEngine.Vector3Int[],UnityEngine.Tilemaps.TileBase[])">
  911. <summary>
  912. <para>Retrieves an array of Tiles within the given range, inclusive of the Cells at both the starting position and the ending positions. This method begins at the given starting position and iterates through all available Z Positions, then iterates through the X and Y positions until it reaches the ending position.</para>
  913. </summary>
  914. <param name="startPosition">The starting position of the range to retrieve Tiles from.</param>
  915. <param name="endPosition">The ending position of the range to retrieve Tiles from.</param>
  916. <param name="positions">The positions of Tiles within the given range.</param>
  917. <param name="tiles">The Tiles within the given range.</param>
  918. <returns>
  919. <para>Returns the number of positions and Tiles retrieved.</para>
  920. </returns>
  921. </member>
  922. <member name="M:UnityEngine.Tilemaps.Tilemap.GetTransformMatrix(UnityEngine.Vector3Int)">
  923. <summary>
  924. <para>Gets the transform matrix of a Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  925. </summary>
  926. <param name="position">Position of the Tile on the Tilemap.</param>
  927. <returns>
  928. <para>The transform matrix.</para>
  929. </returns>
  930. </member>
  931. <member name="M:UnityEngine.Tilemaps.Tilemap.GetUsedSpritesCount">
  932. <summary>
  933. <para>Gets the total number of different Sprites used in the Tilemap.</para>
  934. </summary>
  935. <returns>
  936. <para>The total number of different Sprites used in the Tilemap.</para>
  937. </returns>
  938. </member>
  939. <member name="M:UnityEngine.Tilemaps.Tilemap.GetUsedSpritesNonAlloc(UnityEngine.Sprite[])">
  940. <summary>
  941. <para>Fills the given array with the total number of different Sprites used in the Tilemap and returns the number of Sprites filled.</para>
  942. </summary>
  943. <param name="usedSprites">The array to be filled.</param>
  944. <returns>
  945. <para>The number of Sprites filled.</para>
  946. </returns>
  947. </member>
  948. <member name="M:UnityEngine.Tilemaps.Tilemap.GetUsedTilesCount">
  949. <summary>
  950. <para>Gets the total number of different Tiles used in the Tilemap.</para>
  951. </summary>
  952. <returns>
  953. <para>The total number of different Tiles used in the Tilemap.</para>
  954. </returns>
  955. </member>
  956. <member name="M:UnityEngine.Tilemaps.Tilemap.GetUsedTilesNonAlloc(UnityEngine.Tilemaps.TileBase[])">
  957. <summary>
  958. <para>Fills the given array with the total number of different Tiles used in the Tilemap and returns the number of Tiles filled.</para>
  959. </summary>
  960. <param name="usedTiles">The array to be filled.</param>
  961. <returns>
  962. <para>The number of Tiles filled.</para>
  963. </returns>
  964. </member>
  965. <member name="M:UnityEngine.Tilemaps.Tilemap.HasEditorPreviewTile(UnityEngine.Vector3Int)">
  966. <summary>
  967. <para>Returns whether there is an editor preview Tile at the position.</para>
  968. </summary>
  969. <param name="position">Position to check.</param>
  970. <returns>
  971. <para>Returns true if there is an Editor Preview Tile at the position. Returns false otherwise.</para>
  972. </returns>
  973. </member>
  974. <member name="M:UnityEngine.Tilemaps.Tilemap.HasTile(UnityEngine.Vector3Int)">
  975. <summary>
  976. <para>Returns whether there is a Tile at the position.</para>
  977. </summary>
  978. <param name="position">Position to check.</param>
  979. <returns>
  980. <para>Returns true if there is a Tile at the position. Returns false otherwise.</para>
  981. </returns>
  982. </member>
  983. <member name="M:UnityEngine.Tilemaps.Tilemap.InsertCells(UnityEngine.Vector3Int,UnityEngine.Vector3Int)">
  984. <summary>
  985. <para>Inserts cells into the Tilemap.</para>
  986. </summary>
  987. <param name="position">The target position to insert at.</param>
  988. <param name="insertCells">The number of columns, rows or layers of cells to insert.</param>
  989. </member>
  990. <member name="M:UnityEngine.Tilemaps.Tilemap.InsertCells(UnityEngine.Vector3Int,System.Int32,System.Int32,System.Int32)">
  991. <summary>
  992. <para>Inserts cells into the Tilemap.</para>
  993. </summary>
  994. <param name="position">The target position to insert at.</param>
  995. <param name="numColumns">The number of columns to insert.</param>
  996. <param name="numRows">The number of rows to insert.</param>
  997. <param name="numLayers">The number of layers of cells to insert.</param>
  998. </member>
  999. <member name="T:UnityEngine.Tilemaps.Tilemap.Orientation">
  1000. <summary>
  1001. <para>Determines the orientation of Tiles in the Tilemap.</para>
  1002. </summary>
  1003. </member>
  1004. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.Custom">
  1005. <summary>
  1006. <para>Use a custom orientation to all tiles in the tile map.</para>
  1007. </summary>
  1008. </member>
  1009. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.XY">
  1010. <summary>
  1011. <para>Orients Tiles in the XY plane.</para>
  1012. </summary>
  1013. </member>
  1014. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.XZ">
  1015. <summary>
  1016. <para>Orients Tiles in the XZ plane.</para>
  1017. </summary>
  1018. </member>
  1019. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.YX">
  1020. <summary>
  1021. <para>Orients Tiles in the YX plane.</para>
  1022. </summary>
  1023. </member>
  1024. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.YZ">
  1025. <summary>
  1026. <para>Orients Tiles in the YZ plane.</para>
  1027. </summary>
  1028. </member>
  1029. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.ZX">
  1030. <summary>
  1031. <para>Orients Tiles in the ZX plane.</para>
  1032. </summary>
  1033. </member>
  1034. <member name="F:UnityEngine.Tilemaps.Tilemap.Orientation.ZY">
  1035. <summary>
  1036. <para>Orients Tiles in the ZY plane.</para>
  1037. </summary>
  1038. </member>
  1039. <member name="M:UnityEngine.Tilemaps.Tilemap.RefreshAllTiles">
  1040. <summary>
  1041. <para>Refreshes all Tiles in the Tilemap. The Tilemap will retrieve the rendering data, animation data and other data for all tiles and update all relevant components.</para>
  1042. </summary>
  1043. </member>
  1044. <member name="M:UnityEngine.Tilemaps.Tilemap.RefreshTile(UnityEngine.Vector3Int)">
  1045. <summary>
  1046. <para>Refreshes a Tile at the given XYZ coordinates of a cell in the Tilemap.</para>
  1047. </summary>
  1048. <param name="position">Position of the Tile on the Tilemap.</param>
  1049. </member>
  1050. <member name="M:UnityEngine.Tilemaps.Tilemap.RemoveTileFlags(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileFlags)">
  1051. <summary>
  1052. <para>Removes the TileFlags onto the Tile at the given position.</para>
  1053. </summary>
  1054. <param name="position">Position of the Tile on the Tilemap.</param>
  1055. <param name="flags">TileFlags to remove from the Tile.</param>
  1056. </member>
  1057. <member name="M:UnityEngine.Tilemaps.Tilemap.ResizeBounds">
  1058. <summary>
  1059. <para>Resizes Tiles in the Tilemap to bounds defined by origin and size.</para>
  1060. </summary>
  1061. </member>
  1062. <member name="M:UnityEngine.Tilemaps.Tilemap.SetAnimationFrame(UnityEngine.Vector3Int,System.Int32)">
  1063. <summary>
  1064. <para>Sets the current animation frame for a Tile at the given position.</para>
  1065. </summary>
  1066. <param name="position">The grid cell position.</param>
  1067. <param name="frame">The animation frame to set to.</param>
  1068. </member>
  1069. <member name="M:UnityEngine.Tilemaps.Tilemap.SetAnimationTime(UnityEngine.Vector3Int,System.Single)">
  1070. <summary>
  1071. <para>Sets the running animation time for a Tile at the given position.</para>
  1072. </summary>
  1073. <param name="position">The grid cell position.</param>
  1074. <param name="time">The running animation time in seconds.</param>
  1075. </member>
  1076. <member name="M:UnityEngine.Tilemaps.Tilemap.SetColliderType(UnityEngine.Vector3Int,UnityEngine.Tilemaps.Tile/ColliderType)">
  1077. <summary>
  1078. <para>Sets the Collider type of a Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  1079. </summary>
  1080. <param name="position">Position of the Tile on the Tilemap.</param>
  1081. <param name="colliderType">Collider type to set the Tile to at the XYZ coordinate.</param>
  1082. </member>
  1083. <member name="M:UnityEngine.Tilemaps.Tilemap.SetColor(UnityEngine.Vector3Int,UnityEngine.Color)">
  1084. <summary>
  1085. <para>Sets the color of a Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  1086. </summary>
  1087. <param name="position">Position of the Tile on the Tilemap.</param>
  1088. <param name="color">Color to set the Tile to at the XYZ coordinate.</param>
  1089. </member>
  1090. <member name="M:UnityEngine.Tilemaps.Tilemap.SetEditorPreviewColor(UnityEngine.Vector3Int,UnityEngine.Color)">
  1091. <summary>
  1092. <para>Sets the color of an editor preview Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  1093. </summary>
  1094. <param name="position">Position of the editor preview Tile on the Tilemap.</param>
  1095. <param name="color">Color to set the editor preview Tile to at the XYZ coordinate.</param>
  1096. </member>
  1097. <member name="M:UnityEngine.Tilemaps.Tilemap.SetEditorPreviewTile(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileBase)">
  1098. <summary>
  1099. <para>Sets an editor preview Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  1100. </summary>
  1101. <param name="position">Position of the editor preview Tile on the Tilemap.</param>
  1102. <param name="tile">The editor preview Tile to be placed the cell.</param>
  1103. </member>
  1104. <member name="M:UnityEngine.Tilemaps.Tilemap.SetEditorPreviewTransformMatrix(UnityEngine.Vector3Int,UnityEngine.Matrix4x4)">
  1105. <summary>
  1106. <para>Sets the transform matrix of an editor preview Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  1107. </summary>
  1108. <param name="position">Position of the editor preview Tile on the Tilemap.</param>
  1109. <param name="transform">The transform matrix.</param>
  1110. </member>
  1111. <member name="M:UnityEngine.Tilemaps.Tilemap.SetTile(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileBase)">
  1112. <summary>
  1113. <para>Sets a Tile at the given XYZ coordinates of a cell in the Tilemap.</para>
  1114. </summary>
  1115. <param name="position">Position of the Tile on the Tilemap.</param>
  1116. <param name="tile">The Tile to be placed in the cell.</param>
  1117. </member>
  1118. <member name="M:UnityEngine.Tilemaps.Tilemap.SetTile(UnityEngine.Tilemaps.TileChangeData,System.Boolean)">
  1119. <summary>
  1120. <para>Sets a Tile with additional properties at the given XYZ coordinates of a cell in the Tilemap.</para>
  1121. </summary>
  1122. <param name="tileChangeData">The Tile with additional properties to be placed in the cell.</param>
  1123. <param name="ignoreLockFlags">Whether to ignore Lock Flags set in the Tile's TileFlags when applying Color and Transform changes from TileChangeData.</param>
  1124. </member>
  1125. <member name="M:UnityEngine.Tilemaps.Tilemap.SetTileFlags(UnityEngine.Vector3Int,UnityEngine.Tilemaps.TileFlags)">
  1126. <summary>
  1127. <para>Sets the TileFlags onto the Tile at the given position.</para>
  1128. </summary>
  1129. <param name="position">Position of the Tile on the Tilemap.</param>
  1130. <param name="flags">TileFlags to add onto the Tile.</param>
  1131. </member>
  1132. <member name="M:UnityEngine.Tilemaps.Tilemap.SetTiles(UnityEngine.Vector3Int[],UnityEngine.Tilemaps.TileBase[])">
  1133. <summary>
  1134. <para>Sets an array of Tiles at the given XYZ coordinates of the corresponding cells in the Tilemap.</para>
  1135. </summary>
  1136. <param name="positionArray">An array of positions of Tiles on the Tilemap.</param>
  1137. <param name="tileArray">An array of Tiles to be placed.</param>
  1138. </member>
  1139. <member name="M:UnityEngine.Tilemaps.Tilemap.SetTiles(UnityEngine.Tilemaps.TileChangeData[],System.Boolean)">
  1140. <summary>
  1141. <para>Sets an array of Tiles with additonal properties at the given XYZ coordinates of the corresponding cells in the Tilemap. The Color and Transform of the TileChangeData will take precedence over the values from the Tile.</para>
  1142. </summary>
  1143. <param name="tileChangeDataArray">The array of Tiles with additional properties to place.</param>
  1144. <param name="ignoreLockFlags">Whether to ignore Lock Flags set in the Tile's TileFlags when applying Color and Transform changes from TileChangeData.</param>
  1145. </member>
  1146. <member name="M:UnityEngine.Tilemaps.Tilemap.SetTilesBlock(UnityEngine.BoundsInt,UnityEngine.Tilemaps.TileBase[])">
  1147. <summary>
  1148. <para>Fills bounds with array of Tiles.</para>
  1149. </summary>
  1150. <param name="position">Bounds to be filled.</param>
  1151. <param name="tileArray">An array of Tiles to be placed.</param>
  1152. </member>
  1153. <member name="M:UnityEngine.Tilemaps.Tilemap.SetTransformMatrix(UnityEngine.Vector3Int,UnityEngine.Matrix4x4)">
  1154. <summary>
  1155. <para>Sets the transform matrix of a Tile given the XYZ coordinates of a cell in the Tilemap.</para>
  1156. </summary>
  1157. <param name="position">Position of the Tile on the Tilemap.</param>
  1158. <param name="transform">The transform matrix.</param>
  1159. </member>
  1160. <member name="M:UnityEngine.Tilemaps.Tilemap.SwapTile(UnityEngine.Tilemaps.TileBase,UnityEngine.Tilemaps.TileBase)">
  1161. <summary>
  1162. <para>Swaps all existing Tiles of changeTile to newTile and refreshes all the swapped Tiles.</para>
  1163. </summary>
  1164. <param name="changeTile">Tile to swap.</param>
  1165. <param name="newTile">Tile to swap to.</param>
  1166. </member>
  1167. <member name="T:UnityEngine.Tilemaps.Tilemap.SyncTile">
  1168. <summary>
  1169. <para>A Struct for containing changes to a Tile when it has been changed on a Tilemap.</para>
  1170. </summary>
  1171. </member>
  1172. <member name="P:UnityEngine.Tilemaps.Tilemap.SyncTile.position">
  1173. <summary>
  1174. <para>The position of the Tile on a Tilemap which has changed.</para>
  1175. </summary>
  1176. </member>
  1177. <member name="P:UnityEngine.Tilemaps.Tilemap.SyncTile.tile">
  1178. <summary>
  1179. <para>The Tile at the given position on the Tilemap.</para>
  1180. </summary>
  1181. </member>
  1182. <member name="P:UnityEngine.Tilemaps.Tilemap.SyncTile.tileData">
  1183. <summary>
  1184. <para>The properties of the Tile at the given position on the Tilemap.</para>
  1185. </summary>
  1186. </member>
  1187. <member name="T:UnityEngine.Tilemaps.TilemapCollider2D">
  1188. <summary>
  1189. <para>Collider for 2D physics representing shapes defined by the corresponding Tilemap.</para>
  1190. </summary>
  1191. </member>
  1192. <member name="P:UnityEngine.Tilemaps.TilemapCollider2D.extrusionFactor">
  1193. <summary>
  1194. <para>The amount of Collider shapes each Tile extrudes to facilitate compositing with neighboring Tiles. This eliminates fine gaps between Tiles when using a CompositeCollider2D. This is calculated in Unity units within world space.</para>
  1195. </summary>
  1196. </member>
  1197. <member name="P:UnityEngine.Tilemaps.TilemapCollider2D.hasTilemapChanges">
  1198. <summary>
  1199. <para>Returns true if there are Tilemap changes that require processing for Collider updates. Returns false otherwise.</para>
  1200. </summary>
  1201. </member>
  1202. <member name="P:UnityEngine.Tilemaps.TilemapCollider2D.maximumTileChangeCount">
  1203. <summary>
  1204. <para>Maximum number of Tile Changes accumulated before doing a full collider rebuild instead of an incremental rebuild.</para>
  1205. </summary>
  1206. </member>
  1207. <member name="M:UnityEngine.Tilemaps.TilemapCollider2D.ProcessTilemapChanges">
  1208. <summary>
  1209. <para>Processes Tilemap changes for Collider updates immediately, if there are any.</para>
  1210. </summary>
  1211. </member>
  1212. <member name="T:UnityEngine.Tilemaps.TilemapRenderer">
  1213. <summary>
  1214. <para>The tile map renderer is used to render the tile map marked out by a component.</para>
  1215. </summary>
  1216. </member>
  1217. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.chunkCullingBounds">
  1218. <summary>
  1219. <para>Bounds used for culling of Tilemap chunks.</para>
  1220. </summary>
  1221. </member>
  1222. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.chunkSize">
  1223. <summary>
  1224. <para>Size in number of tiles of each chunk created by the TilemapRenderer.</para>
  1225. </summary>
  1226. </member>
  1227. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.detectChunkCullingBounds">
  1228. <summary>
  1229. <para>Returns whether the TilemapRenderer automatically detects the bounds to extend chunk culling by.</para>
  1230. </summary>
  1231. </member>
  1232. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.maskInteraction">
  1233. <summary>
  1234. <para>Specifies how the Tilemap interacts with the masks.</para>
  1235. </summary>
  1236. </member>
  1237. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.maxChunkCount">
  1238. <summary>
  1239. <para>Maximum number of chunks the TilemapRenderer caches in memory.</para>
  1240. </summary>
  1241. </member>
  1242. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.maxFrameAge">
  1243. <summary>
  1244. <para>Maximum number of frames the TilemapRenderer keeps unused chunks in memory.</para>
  1245. </summary>
  1246. </member>
  1247. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.mode">
  1248. <summary>
  1249. <para>The mode in which the TileMapRenderer batches the for rendering.</para>
  1250. </summary>
  1251. </member>
  1252. <member name="P:UnityEngine.Tilemaps.TilemapRenderer.sortOrder">
  1253. <summary>
  1254. <para>Active sort order for the TilemapRenderer.</para>
  1255. </summary>
  1256. </member>
  1257. <member name="T:UnityEngine.Tilemaps.TilemapRenderer.DetectChunkCullingBounds">
  1258. <summary>
  1259. <para>Returns whether the TilemapRenderer automatically detects the bounds to extend chunk culling by.</para>
  1260. </summary>
  1261. </member>
  1262. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.DetectChunkCullingBounds.Auto">
  1263. <summary>
  1264. <para>The TilemapRenderer will automatically detect the bounds of extension by inspecting the Sprite/s used in the Tilemap.</para>
  1265. </summary>
  1266. </member>
  1267. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.DetectChunkCullingBounds.Manual">
  1268. <summary>
  1269. <para>The user adds in the values used for extend the bounds for culling of Tilemap chunks.</para>
  1270. </summary>
  1271. </member>
  1272. <member name="T:UnityEngine.Tilemaps.TilemapRenderer.Mode">
  1273. <summary>
  1274. <para>Determines how the TilemapRenderer should batch the for rendering.</para>
  1275. </summary>
  1276. </member>
  1277. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.Mode.Chunk">
  1278. <summary>
  1279. <para>Batches each Sprite from the Tilemap into grouped chunks to be rendered.</para>
  1280. </summary>
  1281. </member>
  1282. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.Mode.Individual">
  1283. <summary>
  1284. <para>Sends each Sprite from the Tilemap to be rendered individually.</para>
  1285. </summary>
  1286. </member>
  1287. <member name="T:UnityEngine.Tilemaps.TilemapRenderer.SortOrder">
  1288. <summary>
  1289. <para>Sort order for all tiles rendered by the TilemapRenderer.</para>
  1290. </summary>
  1291. </member>
  1292. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.SortOrder.BottomLeft">
  1293. <summary>
  1294. <para>Sorts tiles for rendering starting from the tile with the lowest X and the lowest Y cell positions.</para>
  1295. </summary>
  1296. </member>
  1297. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.SortOrder.BottomRight">
  1298. <summary>
  1299. <para>Sorts tiles for rendering starting from the tile with the highest X and the lowest Y cell positions.</para>
  1300. </summary>
  1301. </member>
  1302. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.SortOrder.TopLeft">
  1303. <summary>
  1304. <para>Sorts tiles for rendering starting from the tile with the lowest X and the highest Y cell positions.</para>
  1305. </summary>
  1306. </member>
  1307. <member name="F:UnityEngine.Tilemaps.TilemapRenderer.SortOrder.TopRight">
  1308. <summary>
  1309. <para>Sorts tiles for rendering starting from the tile with the highest X and the lowest Y cell positions.</para>
  1310. </summary>
  1311. </member>
  1312. <member name="A:UnityEngine.TilemapModule">
  1313. <summary>
  1314. <para>The Tilemap module implements the Tilemap class.</para>
  1315. </summary>
  1316. </member>
  1317. </members>
  1318. </doc>