A message packet with an info for an animator. More...

Inheritance diagram for TilePlus.AnimatorControlPacket:

Collaboration diagram for TilePlus.AnimatorControlPacket:

Public Member Functions
	AnimatorControlPacket (int hash, string stateName="", int layerIndex=-1, Object? sourceInstance=null)
	Initializes a new instance of the class with state info.
	AnimatorControlPacket (bool despawn, Object? sourceInstance=null)
	Initializes a new instance for despawning.
override string	ToString ()
Public Member Functions inherited from TilePlus.MessagePacket< T >
virtual void	Reset ()
	Reset the SourceInstance. Override for additional resets of variables holding references.

Public Attributes
readonly bool	m_Despawn
	When used with TpZoneAnimator, signals the tile to despawn the prefab. Does not make sense to use this if the prefab was spawned from the Tile having it's gameObject field populated rather than the tile's m_Prefab field.
readonly int	m_Hash
	An integer.
readonly string	m_StateName
	optional state name
readonly int	m_LayerIndex
	optional layer index

Additional Inherited Members
Protected Member Functions inherited from TilePlus.MessagePacket< T >
	MessagePacket (Object? sourceInstance)
	Source Instance for this packet. Can be null.
Properties inherited from TilePlus.MessagePacket< T >
Object?	SourceInstance `[get, set]`
	The instance that's the source of the message. Can be null.
ulong	Id `[get, set]`
	The ID of this packet. Packet recepients can test this to see if they're being sent the same message repeatedly. Note that 0 is not used except internally.

Detailed Description

A message packet with an info for an animator.

Constructor & Destructor Documentation

◆ AnimatorControlPacket() [1/2]

TilePlus.AnimatorControlPacket.AnimatorControlPacket	(	int	hash,
		string	stateName = "",
		int	layerIndex = -1,
		Object?	sourceInstance = null )

Initializes a new instance of the class with state info.

Parameters

hash
stateName
layerIndex
sourceInstance	Source of message or null

◆ AnimatorControlPacket() [2/2]

TilePlus.AnimatorControlPacket.AnimatorControlPacket	(	bool	despawn,
		Object?	sourceInstance = null )

Initializes a new instance for despawning.

Parameters

despawn
sourceInstance	Source of message or null

Member Function Documentation

◆ ToString()

override string TilePlus.AnimatorControlPacket.ToString ( )

Member Data Documentation

◆ m_Despawn

readonly bool TilePlus.AnimatorControlPacket.m_Despawn

When used with TpZoneAnimator, signals the tile to despawn the prefab. Does not make sense to use this if the prefab was spawned from the Tile having it's gameObject field populated rather than the tile's m_Prefab field.

◆ m_Hash

readonly int TilePlus.AnimatorControlPacket.m_Hash

An integer.

◆ m_LayerIndex

readonly int TilePlus.AnimatorControlPacket.m_LayerIndex

optional layer index

◆ m_StateName

readonly string TilePlus.AnimatorControlPacket.m_StateName

optional state name

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

/Users/jms/Documents/Tpt_55/TPT55/Assets/Plugins/TilePlus/Runtime/StaticLib/ClassesEnums/MessagingClasses.cs

Public Member Functions

Public Attributes

Additional Inherited Members