Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetTileAnimationData(Vector3Int, ITilemap, ref TileAnimationData)

Retrieves any tile animation data from the scripted tile.
Read time 1 minuteLast updated 5 days ago

Definition

GetTileAnimationData(Vector3Int, ITilemap, TileAnimationData)

public virtual bool GetTileAnimationData(Vector3Int position, ITilemap tilemap, ref TileAnimationData tileAnimationData)

Parameters

position

Vector3Int
Position of the Tile on the Tilemap.

tilemap

ITilemap
The Tilemap the tile is present on.

tileAnimationData

TileAnimationData
Data to run an animation on the tile.

Returns

Type

Description

boolWhether the call was successful.

Remarks

Implement this and fill in the TileAnimationData to have the Tilemap run an animation for the tile.

Examples

using UnityEngine;using UnityEngine.Tilemaps; // Tile that plays an animated loops of sprites[CreateAssetMenu]public class AnimatedTile : TileBase{    public Sprite[] m_AnimatedSprites;    public float m_AnimationSpeed = 1f;    public float m_AnimationStartTime;    public override void GetTileData(Vector3Int location, ITilemap tileMap, ref TileData tileData)    {        if (m_AnimatedSprites != null && m_AnimatedSprites.Length > 0)        {            tileData.sprite = m_AnimatedSprites[m_AnimatedSprites.Length - 1];        }    }    public override bool GetTileAnimationData(Vector3Int location, ITilemap tileMap, ref TileAnimationData tileAnimationData)    {        if (m_AnimatedSprites != null && m_AnimatedSprites.Length > 0)        {            tileAnimationData.animatedSprites = m_AnimatedSprites;            tileAnimationData.animationSpeed = m_AnimationSpeed;            tileAnimationData.animationStartTime = m_AnimationStartTime;            return true;        }        return false;    }}