Simple version of an animated tile that works with TilePlus. More...

Inheritance diagram for TilePlus.TpAnimatedTile:

[legend]

Collaboration diagram for TilePlus.TpAnimatedTile:

[legend]

Public Member Functions
override void	PauseAnimation (bool pause)
	Pause a running animation.
override void	ActivateAnimation (bool turnOn, int startingFrame=0, bool ignoreRewindingState=false)
	Use this to turn animation on/off. Note that restarting a running animation isn't automatic.
override void	LoopEndedCallback ()
	loop-ended callback from Tilemap.
override bool	StartUp (Vector3Int position, ITilemap tilemap, GameObject go)
override void	GetTileData (Vector3Int position, ITilemap tilemap, ref TileData tileData)
	get data for this tile. Override of TilePlusBase and its superclasses
override bool	GetTileAnimationData (Vector3Int position, ITilemap tilemap, ref TileAnimationData tileAnimationData)
	Get animation info for this tile. Override of TileBase.
Public Member Functions inherited from TilePlus.TilePlusBase
override bool	StartUp (Vector3Int position, ITilemap tilemap, GameObject go)
	Tiles can be in three states: Asset, Clone, Locked. See the Programmer's Guide for more info. NOTE: if overriding this BE SURE to call this base method as the FIRST thing you do! Note the return value and return FALSE if this base method returns FALSE.
override void	GetTileData (Vector3Int position, ITilemap tilemap, ref TileData tileData)
	Get data for this tile. Override of Tile. Note that Tilemap.RefreshTile calls this.
virtual void	CleanUp ()
	Implement to perform cleanup. RequiresCleanup
override string	ToString ()
virtual void	ResetState (TileResetOperation op)
	Used to reset state variables. May need overriding in subclasses. See programmer's guide for info on overriding this.
virtual bool	UpdateInstance (string[] value)
	Default inplementation of UpdateInstance.
Public Member Functions inherited from TilePlus.ITilePlus
bool	ExecEventAction (UnityEngine.Object? obj)
	Exec the event action, if any.
Public Member Functions inherited from TilePlus.ITpMessaging< in T >
void	MessageTarget (T sentPacket)
	Send a message of type T.
bool	CanAcceptMessage ()
	Optional "are you ready?" method that can be used in filtering prior to sending a message. Useful in some edge cases. Override in implementation if necc. NOTE this is NOT checked internally somehow. You have to use a filter and test this.

Public Attributes
bool	m_PlayOnStart
	Set true to have the animation play on start.
float	m_AnimationSpeed = 1f
	Set animation speed. Note to change via code, turn animation off, change value, then turn animation on. Alternatively, you could change the value and use Tilemap.RefreshTile.
bool	m_OneShot
	See the description of TileAnimationFlags in the Unity scripting reference. Control whether or not the animation repeats.
bool	m_RewindAfterOneShot
	If one shot animation is used, this flag determines if a rewind occurs.
Sprite?[]	m_AnimatedSprites
	The List of Sprites set for the Animated Tile. This will be played in sequence.
bool	m_UpdatePhysics
	See the description of TileAnimationFlags in the Unity scripting reference. This controls the UpdatePhysics flags.
Public Attributes inherited from TilePlus.TilePlusBase
int	count
	Property to get a tuple of (count, array of individually-trimmed tags). not cached.
ColliderMode	m_ColliderMode = ColliderMode.NoCollider
	Used to set up the tile's collider.
SpriteClearMode	m_TileSpriteClear = SpriteClearMode.Ignore
	m_TileClear controls whether or not the tile's sprite is cleared or if the tile is deleted at runtime, or nothing.
string	m_Tag = string.Empty
	The tag for this tile.
OversizeSpriteMode	m_OversizeSpriteMode = OversizeSpriteMode.Ignore
	How to handle oversize sprite recognition.
Vector2	m_SpriteSize = Vector2.one
	The true size of the tile sprite. See Oversize Sprite Mode.
TpTileEventAction?	m_EventAction
	TpTileEventAction project asset reference. May be null.
TpTileZoneAction?	m_ZoneAction
	TpTileZoneAction project asset reference. May be null.
bool	m_ZoneIsInUse = false
	Zone capabilities active.
Public Attributes inherited from TilePlus.ITilePlus
int	count
	Property to get an array of individually-trimmed tags.

Properties
bool	AnimationSupported `[get]`
	This tile supports animation if true.
override bool	IsOneShotWaitingToRewind `[get]`
	Is the animation waiting to rewind?
Properties inherited from TilePlus.TilePlusBase
bool	SpriteShouldBeCleared `[get]`
	Returns true if tile sprite should be cleared based on setting of TileSpriteClear field, tile state, and whether in Play mode or not.
byte?[]	TileGuidBytes `[get, set]`
	The clone's GUID. Note that IDs are individual for each clone. This value can only be set once. Calling ResetState allows it to be changed until the next StartUp. If a new GUID isn't added before StartUp then that method will add it. For example: see TpLib.CopyAndPasteTile Note: generally speaking, don't reset the GUID.
string	TileName `[get]`
TilePlusBase	ThisTileInstance `[get]`
	Get the tile's instance thru this interface.
int	Id `[get]`
	Id of tile. Nominally GetInstanceId. Default returns 0.
bool	GetTileDataHasRun `[get]`
	TRUE if GetTileData has run. If this is false when TpLib.RegisterTilePlus is executed then TpLib checks to see if the tile's sprite needs to be affected. See that code for an explanation.
static Vector3Int	ImpossibleGridPosition = new(int.MinValue, int.MinValue, int.MinValue) `[get]`
	No tile will ever be here!
Vector3Int	TileGridPosition `[get]`
	This is the tile grid position as set from StartUp. Intentionally non-virtual. Does not need (and should not have) serialized backing field. Note that backing field is initialized to "Impossible Grid Position".
Vector3	TileWorldPosition `[get]`
	Handy property to get the world position from the TileGridPosition property. returns Vector3.negativeInfinity for error SO CHECK FOR THAT! note: returns cell center as world position.
Vector3Int	LastTileGridPosition `[get]`
	Get the last tile grid position Note that backing field is initialized to "Impossible Grid Position".
Tilemap?	LastParentTilemap `[get]`
	Get the last parent Tilemap. Note that backing firld is initialized to NULL.
bool	TileGridPosHasChanged `[get]`
	Has the tile position changed since the last StartUp?
bool	ParentTilemapHasChanged `[get]`
	Has the tile's parent tilemap changed since the last StartUp?
Tilemap?	ParentTilemap `[get]`
	Parent tilemap for this tile (set in clone). Intentionally non-virtual. Does not need (and should not have) serialized backing field.
int	ParentTilemapInstanceId `[get]`
	The instance ID of the parent tilemap.
bool	AnimationIsPaused `[get]`
	Property to determine if animation is PAUSED.
virtual bool	IsOneShotWaitingToRewind `[get]`
	Override in any animated tiles.
bool	TileAnimationActive `[get]`
	Property to determine if animation is running in the tile. Note: running=true and paused=true is fine.
bool	AnimationIsRunning `[get]`
	Property to determine if Tile animation is ACTIVE and not paused: IE actual animation is running.
bool	IsClone `[get]`
	Is this a clone? Read-only.
bool	IsAsset `[get]`
	Is this an asset? Read-only.
bool	IsLocked `[get]`
	Is this a locked tile? Read-only.
bool	IsPaletteTile `[get, set]`
	Valid only in-editor, is this tile from the Palette?
string	TileStateString `[get]`
	String version of TileState.
Guid	TileGuid `[get]`
	Get the tile's GUID as a GUID struct.
string	TileGuidString `[get]`
	The clone's GUID as a string.
int string[] tags	TrimmedTags `[get]`
virtual bool	RequiresCleanup `[get]`
	If a particular tile requires special cleanup prior to deletion, EXPLICITLY implement this method and return TRUE. TpZoneAnimator
bool	SanityCheck `[get]`
	If handling an animation callback, this is useful to ensure that the TPT tile instance is actually still attached to a Tilemap and not just transiently sitting in memory (ie deleted but not yet purged from a List or HashSet somewhere.
static TpTweener	TweenerService `[get]`
	GET a reference to the tweener service. It's only used by TilePlus tiles.
virtual ColliderMode	TileColliderMode `[get, set]`
	Used to set up the tile's collider.
SpriteClearMode	TileSpriteClear `[get, set]`
	Get the the tile sprite clear mode.
string	Tag `[get, set]`
	Property to get the optional tag.
OversizeSpriteMode	OversizeSpriteMode `[get]`
	This is used by the PositionDb to calculate the actual size of a sprite when determining if a position is occupied.
Vector2	SpriteSize `[get]`
	What is the size of the sprite? Override when implementing OversizeSpriteMode.
TpTileEventAction?	EventAction `[get]`
	A TpTileEventAction.
virtual ? object	EventActionObject `[get, set]`
TpTileZoneAction?	ZoneAction `[get]`
	A TpTileZoneAction.
BoundsInt	ZoneBoundsInt `[get, set]`
	The BoundsInt for the zone.
Bounds	ZoneBounds `[get]`
	A bounds based on the ZoneBoundsInt.
Properties inherited from TilePlus.ITilePlus
Scene	ParentScene `[get]`
	Return the scene that the Tile is in. Only works on a placed tile; on a non-cloned tile it should return default Note: check the return value for Scene.IsValid.
bool	IsComputeOnly `[get]`
	Indicate that this tile is 'compute only'.
GameObject?	InstantiatedGameObject `[get]`
	Get the GameObject of the tile. Convenience, saves casting in editors.

Additional Inherited Members
Protected Member Functions inherited from TilePlus.TilePlusBase
void	SetColliderType (ref TileData tileData)
	Sets up colliders.
Protected Attributes inherited from TilePlus.TilePlusBase
Vector3Int	m_TileGridPosition = new(int.MinValue, int.MinValue, int.MinValue)
	The tile grid position gets initialized in Startup. It's initialized with 'ImpossibleGridPosition'.
Vector3Int	m_LastTileGridPosition = new(int.MinValue, int.MinValue, int.MinValue)
	The previous tile grid position.
Tilemap?	m_LastParentMap
	The previous parent Tilemap.
bool	m_TileGridPosHasChanged
	True if the tile grid position has changed.
bool	m_ParentTilemapHasChanged
	Parent tilemap has changed if true.
Tilemap?	m_ParentTilemap
	Parent tile map is initialized in Startup.
BoundsInt	m_ZoneBoundsInt = new(Vector3Int.zero,new Vector3Int(3,3,1))
	BoundsInt of trigger zone. Initialized to a 3x3 area centered at the Tile's location.

Detailed Description

Simple version of an animated tile that works with TilePlus.

Member Function Documentation

◆ ActivateAnimation()

override void TilePlus.TpAnimatedTile.ActivateAnimation	(	bool	turnOn,
		int	startingFrame = 0,
		bool	ignoreRewindingState = false )

virtual

Use this to turn animation on/off. Note that restarting a running animation isn't automatic.

Parameters

turnOn	On or Off
startingFrame	sets the current frame to 0 (for either operation). Set to -1 for this param to be ignored
ignoreRewindingState	if false(default) then this method does not execute when waiting for a rewind - only when one-shot is used w/rewindAfterOneShot set true

When turnOn==true, the startingFrame is set prior to starting animation. When false, the startingFrame is set after stopping the animation.

Reimplemented from TilePlus.TilePlusBase.

◆ GetTileAnimationData()

override bool TilePlus.TpAnimatedTile.GetTileAnimationData	(	Vector3Int	position,
		ITilemap	tilemap,
		ref TileAnimationData	tileAnimationData )

Get animation info for this tile. Override of TileBase.

Parameters

position	The position.
tilemap	The tilemap.
tileAnimationData	The tile animation data.

Returns: true if animation should be performed

◆ GetTileData()

override void TilePlus.TpAnimatedTile.GetTileData	(	Vector3Int	position,
		ITilemap	tilemap,
		ref TileData	tileData )

get data for this tile. Override of TilePlusBase and its superclasses

Parameters

position	The position.
tilemap	The tilemap.
tileData	The tile data.

◆ LoopEndedCallback()

override void TilePlus.TpAnimatedTile.LoopEndedCallback ( )

virtual

loop-ended callback from Tilemap.

Reimplemented from TilePlus.TilePlusBase.

◆ PauseAnimation()

override void TilePlus.TpAnimatedTile.PauseAnimation ( bool pause )

virtual

Pause a running animation.

Parameters

pause

Reimplemented from TilePlus.TilePlusBase.

◆ StartUp()

override bool TilePlus.TpAnimatedTile.StartUp	(	Vector3Int	position,
		ITilemap	tilemap,
		GameObject	go )

Member Data Documentation

◆ m_AnimatedSprites

Sprite? [] TilePlus.TpAnimatedTile.m_AnimatedSprites

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

◆ m_AnimationSpeed

float TilePlus.TpAnimatedTile.m_AnimationSpeed = 1f

Set animation speed. Note to change via code, turn animation off, change value, then turn animation on. Alternatively, you could change the value and use Tilemap.RefreshTile.

◆ m_OneShot

bool TilePlus.TpAnimatedTile.m_OneShot

See the description of TileAnimationFlags in the Unity scripting reference. Control whether or not the animation repeats.

◆ m_PlayOnStart

bool TilePlus.TpAnimatedTile.m_PlayOnStart

Set true to have the animation play on start.

◆ m_RewindAfterOneShot

bool TilePlus.TpAnimatedTile.m_RewindAfterOneShot

If one shot animation is used, this flag determines if a rewind occurs.

◆ m_UpdatePhysics

bool TilePlus.TpAnimatedTile.m_UpdatePhysics

See the description of TileAnimationFlags in the Unity scripting reference. This controls the UpdatePhysics flags.

Property Documentation

◆ AnimationSupported

bool TilePlus.TpAnimatedTile.AnimationSupported

get

This tile supports animation if true.

Implements TilePlus.ITilePlus.

◆ IsOneShotWaitingToRewind

override bool TilePlus.TpAnimatedTile.IsOneShotWaitingToRewind

get

Is the animation waiting to rewind?

Implements TilePlus.ITilePlus.

The documentation for this class was generated from the following file:

/Users/jms/Documents/Tpt_55/TPT55/Assets/Plugins/TilePlus/Runtime/Tiles/Animated/AnimatedTile/TpAnimatedTile.cs

Public Member Functions

Public Attributes

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ActivateAnimation()

◆ GetTileAnimationData()

◆ GetTileData()

◆ LoopEndedCallback()

◆ PauseAnimation()

◆ StartUp()

Member Data Documentation

◆ m_AnimatedSprites

◆ m_AnimationSpeed

◆ m_OneShot

◆ m_PlayOnStart

◆ m_RewindAfterOneShot

◆ m_UpdatePhysics

Property Documentation

◆ AnimationSupported

◆ IsOneShotWaitingToRewind