TilePlus Version 5
Unity3D Tilemap Extension
Loading...
Searching...
No Matches
TilePlus.TpTweenSequence Class Referencesealed

Describes a sequence for use with TpTweener. More...

Public Member Functions

bool AddTo (TpTween tween)
 Add a tween to the sequence.
bool SetSize (int size)
 Resize the tween list for this sequence.
void ClearPrevious ()
 Clear the previous tween ref.
TpTween? GetTweenWithId (long id)
 Find a tween in the sequence by its id.
void ResetSequence ()
 reset
void Rewind ()
 For looping: Rewind the loop.
void ReleaseTweens (IEnumerable< TpTween > tweens, bool final=false)
 Return all tweens to pool.
override string ToString ()

Properties

long Id [get, set]
 Identifier. 0 means 'invalid' as it's never used as an Id.
bool IsGameObjectSequence [get, set]
 Can't mix tile and GameObject tweens.
string SName = "" [get, set]
 Name of the sequence.
int NumLoops = -1 [get, set]
 How many loops? -1 means forever.
float SequenceStartTime [get, set]
 Start time of the sequence: Diags only.
TilePlusBase? ParentTile [get, set]
 the tile which created this sequence.
int CurrentLoopCount = 0 [get, set]
 loop count: set internally
Action< TpTweenSequence, bool >? OnFinished [get, set]
 Callback when finished. The bool param is true if the sequence is actually ending or false if the loop is about to repeat.
Action< TpTweenSequence, TpTween >? OnNextTween [get, set]
 Callback when this sequence advances to the next state.
List< TpTween > SequencedTweens [get]
 List of tweens in this sequence.
bool IsLooping [get]
 Is this sequence looping?
bool IsEmpty [get]
 Is this sequence empty?
bool IsRunning [get, set]
 Is this sequence running?
TpTween? PreviousTween [get]
 Get a ref to the previous tween.
TpTween? CurrentTween [get, set]
 Get a ref to the current tween and make the current tween into the previous tween.

Detailed Description

Describes a sequence for use with TpTweener.

Member Function Documentation

◆ AddTo()

bool TilePlus.TpTweenSequence.AddTo ( TpTween tween)

Add a tween to the sequence.

Parameters
tweentween to add
Returns
false if any error

◆ ClearPrevious()

void TilePlus.TpTweenSequence.ClearPrevious ( )

Clear the previous tween ref.

◆ GetTweenWithId()

TpTween? TilePlus.TpTweenSequence.GetTweenWithId ( long id)

Find a tween in the sequence by its id.

Parameters
idID of the tween
Returns
Tween or null if not found.

◆ ReleaseTweens()

void TilePlus.TpTweenSequence.ReleaseTweens ( IEnumerable< TpTween > tweens,
bool final = false )

Return all tweens to pool.

Parameters
tweensarray of tweens
finalonly set true for final release ie when seq is returned to the pool.

inheritdoc/>

◆ ResetSequence()

void TilePlus.TpTweenSequence.ResetSequence ( )

reset

◆ Rewind()

void TilePlus.TpTweenSequence.Rewind ( )

For looping: Rewind the loop.

◆ SetSize()

bool TilePlus.TpTweenSequence.SetSize ( int size)

Resize the tween list for this sequence.

Parameters
sizeNew size
Returns
flase if the list of tweens was never initialized.

◆ ToString()

override string TilePlus.TpTweenSequence.ToString ( )

Property Documentation

◆ CurrentLoopCount

int TilePlus.TpTweenSequence.CurrentLoopCount = 0
getset

loop count: set internally

◆ CurrentTween

TpTween? TilePlus.TpTweenSequence.CurrentTween
getset

Get a ref to the current tween and make the current tween into the previous tween.

◆ Id

long TilePlus.TpTweenSequence.Id
getset

Identifier. 0 means 'invalid' as it's never used as an Id.

◆ IsEmpty

bool TilePlus.TpTweenSequence.IsEmpty
get

Is this sequence empty?

◆ IsGameObjectSequence

bool TilePlus.TpTweenSequence.IsGameObjectSequence
getset

Can't mix tile and GameObject tweens.

◆ IsLooping

bool TilePlus.TpTweenSequence.IsLooping
get

Is this sequence looping?

◆ IsRunning

bool TilePlus.TpTweenSequence.IsRunning
getset

Is this sequence running?

◆ NumLoops

int TilePlus.TpTweenSequence.NumLoops = -1
getset

How many loops? -1 means forever.

◆ OnFinished

Action<TpTweenSequence, bool>? TilePlus.TpTweenSequence.OnFinished
getset

Callback when finished. The bool param is true if the sequence is actually ending or false if the loop is about to repeat.

◆ OnNextTween

Action<TpTweenSequence,TpTween>? TilePlus.TpTweenSequence.OnNextTween
getset

Callback when this sequence advances to the next state.

◆ ParentTile

TilePlusBase? TilePlus.TpTweenSequence.ParentTile
getset

the tile which created this sequence.

◆ PreviousTween

TpTween? TilePlus.TpTweenSequence.PreviousTween
get

Get a ref to the previous tween.

◆ SequencedTweens

List<TpTween> TilePlus.TpTweenSequence.SequencedTweens
get

List of tweens in this sequence.

◆ SequenceStartTime

float TilePlus.TpTweenSequence.SequenceStartTime
getset

Start time of the sequence: Diags only.

◆ SName

string TilePlus.TpTweenSequence.SName = ""
getset

Name of the sequence.

The documentation for this class was generated from the following file:
  • /Users/jms/Documents/Tpt_55/TPT55/Assets/Plugins/TilePlus/Runtime/Services/Tweener/TpTweenSequence.cs