Class AnimatedEntityIdTile

Animated Tiles are tiles which run through and display a list of sprites in sequence.

Inheritance
object
Object
ScriptableObject
TileBase
EntityIdTileBase
AnimatedEntityIdTile
Inherited Members
Object.MemberwiseClone()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T, InstantiateParameters)
Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Object.FindObjectsByType<T>()
Object.FindObjectsByType<T>(FindObjectsInactive)
Namespace: Unity.Tilemaps.Experimental
Assembly: Unity.2D.Tilemap.Experimental.dll
Syntax
[BurstCompile]
[Serializable]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.2d.tilemap.extras@latest/index.html?subfolder=/manual/AnimatedEntityIdTile.html")]
public class AnimatedEntityIdTile : EntityIdTileBase

Properties

animatedSprites

The List of Sprites set for the Animated Tile. This will be played in sequence.

Declaration
public Sprite[] animatedSprites { get; set; }
Property Value
Type Description
Sprite[]

animationStartFrame

The starting frame of this Animated Tile. This allows you to start the Animation from a particular Sprite in the list of Animated Sprites. If this is set, this overrides m_AnimationStartTime.

Declaration
public int animationStartFrame { get; set; }
Property Value
Type Description
int

animationStartTime

The starting time of this Animated Tile. This allows you to start the Animation from time in the list of Animated Sprites depending on the Tilemap's Animation Frame Rate.

Declaration
public float animationStartTime { get; set; }
Property Value
Type Description
float

getTileAnimationDataJobDelegate

Returns the delegate function called by Tilemap using Unity Jobs to get Tile Animation Data from AnimatedEntityIdTiles

Declaration
protected override EntityIdTileBase.GetTileAnimationDataJobDelegate getTileAnimationDataJobDelegate { get; }
Property Value
Type Description
EntityIdTileBase.GetTileAnimationDataJobDelegate
Overrides

getTileDataJobDelegate

Returns the delegate function called by Tilemap using Unity Jobs to get Tile Data from AnimatedEntityIdTiles

Declaration
protected override EntityIdTileBase.GetTileDataJobDelegate getTileDataJobDelegate { get; }
Property Value
Type Description
EntityIdTileBase.GetTileDataJobDelegate
Overrides

maxSpeed

The maximum possible speed at which the Animation of the Tile will be played. A speed value will be randomly chosen between the minimum and maximum speed.

Declaration
public float maxSpeed { get; set; }
Property Value
Type Description
float

minSpeed

The minimum possible speed at which the Animation of the Tile will be played. A speed value will be randomly chosen between the minimum and maximum speed.

Declaration
public float minSpeed { get; set; }
Property Value
Type Description
float

refreshTileJobDelegate

Returns the delegate function called by Tilemap using Unity Jobs to refresh AnimatedEntityIdTiles

Declaration
protected override EntityIdTileBase.RefreshTileJobDelegate refreshTileJobDelegate { get; }
Property Value
Type Description
EntityIdTileBase.RefreshTileJobDelegate
Overrides

structType

Returns the type of data struct used for the AnimatedEntityIdTile, which is the type of AnimatedEntityIdData.

Declaration
public override Type structType { get; }
Property Value
Type Description
Type
Overrides

tileAnimationFlags

Flags for controlling the Tile Animation.

Declaration
public TileAnimationFlags tileAnimationFlags { get; set; }
Property Value
Type Description
TileAnimationFlags

tileColliderType

The Collider Shape generated by the Tile.

Declaration
public Tile.ColliderType tileColliderType { get; set; }
Property Value
Type Description
Tile.ColliderType

Methods

CopyDataStruct(void*)

Copies the Data struct used for this AnimatedEntityIdTile to the outPtr buffer for use in Unity Jobs.

Declaration
public override void CopyDataStruct(void* outPtr)
Parameters
Type Name Description
void* outPtr

Data buffer to copy data struct from AnimatedEntityIdTile to.
Overrides

GetTileAnimationData(Vector3Int, ITilemap, ref TileAnimationData)

Retrieves any tile animation data from the scripted tile.

Declaration
public override bool GetTileAnimationData(Vector3Int position, ITilemap tilemap, ref TileAnimationData tileAnimationData)
Parameters
Type Name Description
Vector3Int position

Position of the Tile on the Tilemap.
ITilemap tilemap

The Tilemap the tile is present on.
TileAnimationData tileAnimationData

Data to run an animation on the tile.
Returns
Type Description
bool

Whether the call was successful.
Overrides
UnityEngine.Tilemaps.TileBase.GetTileAnimationData(UnityEngine.Vector3Int, UnityEngine.Tilemaps.ITilemap, ref UnityEngine.Tilemaps.TileAnimationData)

GetTileData(Vector3Int, ITilemap, ref TileData)

Retrieves any tile rendering data from the scripted tile.

Declaration
public override void GetTileData(Vector3Int position, ITilemap tilemap, ref TileData tileData)
Parameters
Type Name Description
Vector3Int position

Position of the Tile on the Tilemap.
ITilemap tilemap

The Tilemap the tile is present on.
TileData tileData

Data to render the tile.
Overrides
UnityEngine.Tilemaps.TileBase.GetTileData(UnityEngine.Vector3Int, UnityEngine.Tilemaps.ITilemap, ref UnityEngine.Tilemaps.TileData)

OnDisable()

Does clean up for the AnimatedEntityIdTile

Declaration
public override void OnDisable()
Overrides

OnEnable()

Initialises the AnimatedEntityIdTile

Declaration
public override void OnEnable()
Overrides