Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

TileBase.GetTileData

Suggest a change

Success!

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

Close

Submission failed

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

Close

Cancel

public method GetTileData(position: Vector3Int, tilemap: Tilemaps.ITilemap, ref tileData: Tilemaps.TileData): void;
public void GetTileData(Vector3Int position, Tilemaps.ITilemap tilemap, ref Tilemaps.TileData tileData);

Parameters

positionPosition of the Tile on the Tilemap.
tilemapThe Tilemap the tile is present on.
tileDataData to render the tile.

Returns

void Whether the call was successful.

Description

Retrieves any tile rendering data from the scripted tile.

Implement this and fill in the TileData to have the Tilemap to render the tile.

no example available in JavaScript
using UnityEngine;
using UnityEngine.Tilemaps;

// Tile that repeats two sprites in checkerboard pattern [CreateAssetMenu] public class CheckerboardTile : TileBase { public Sprite spriteA; public Sprite spriteB;

public override void GetTileData(Vector3Int position, ITilemap tilemap, ref TileData tileData) { bool evenCell = Mathf.Abs(position.y + position.x) % 2 > 0; tileData.sprite = evenCell ? spriteA : spriteB; } }

Did you find this page useful? Please give it a rating: