RaTweening.RaTweenSequence.EntryData Struct Reference

This struct represents an entry within a sequence. Holding the data what tween to play and their sequence settings More...

Public Member Functions
EntryData	SetStaggerType (StaggerType staggerType)
	Sets the StaggerType of the current Entry More...
EntryData	SetStagger (float stagger)
	Sets the Stagger of the current Entry More...
EntryData	Clone ()
	Creates an Entry Data containing a clone of the tween within and with the same settings of the Entry Data More...

Static Public Member Functions
static EntryData	Create (RaTweenBase tween, float stagger=1f, StaggerType staggerType=StaggerType.FinalLoopExclDelay)
	Creates an EntryData containing the given tween and its specified settings ‍Note: The stagger has no effect when the tween is the last in the sequence Note: The OnComplete is called when all tweens are finished, even if the last tween has a stagger lower than 1. More...
static EntryData	Create (Action callback)
	Creates an EntryData containing a callback to fire ‍Note: This has a duration of 0;

Public Attributes
readonly RaTweenBase	Tween
	The Tween to play in the sequence
readonly Action	Callback
	The Callback to fire within the sequence

Properties
bool	IsTween [get]
	Returns true if the EntryData represents a Tween ‍Note: An EntryData can either be a IsTween or a IsCallback
bool	IsCallback [get]
	Returns True if the EntryData Represents a Callback ‍Note: An EntryData can either be a IsCallback or a IsTween
float	Stagger [get]
	The amount of % (value between 0 - 1) must be finished of this tween before the next tween of the sequence should be started
StaggerType	StaggerType [get]
	The selected StaggerType which defines what the stagger parameter represents
bool	IsEmpty [get]
	Returns true if there is a tween inside the entry data
bool	IsValidForAppend [get]
	Returns true if the entry is valid for appending to the RaTweenSequence This is based on it not being empty and the RaTweenBase.CanBeModified returning true

Detailed Description

This struct represents an entry within a sequence. Holding the data what tween to play and their sequence settings

Member Function Documentation

Clone()

EntryData RaTweening.RaTweenSequence.EntryData.Clone

(

)

Creates an Entry Data containing a clone of the tween within and with the same settings of the Entry Data

Returns

The New Clone instance

Create()

static EntryData RaTweening.RaTweenSequence.EntryData.Create ( RaTweenBase  tween, float  stagger = 1f, StaggerType  staggerType = StaggerType.FinalLoopExclDelay  )

static

Creates an EntryData containing the given tween and its specified settings

‍Note: The stagger has no effect when the tween is the last in the sequence
Note: The OnComplete is called when all tweens are finished, even if the last tween has a stagger lower than 1.

Parameters

stagger	The amount of % (value between 0 - 1) must be finished of this tween before the next tween of the sequence should be started. Default: 1
staggerType	The selected StaggerType which defines what the stagger parameter represents. Default: StaggerType.FinalLoopExclDelay

SetStagger()

EntryData RaTweening.RaTweenSequence.EntryData.SetStagger

(

float

stagger

)

Sets the Stagger of the current Entry

Parameters

stagger

The amount of % (value between 0 - 1) must be finished of this tween before the next tween of the sequence should be started. Default: 1

SetStaggerType()

EntryData RaTweening.RaTweenSequence.EntryData.SetStaggerType

(

StaggerType

staggerType

)

Sets the StaggerType of the current Entry

Parameters

staggerType

The selected StaggerType which defines what the stagger parameter represents. Default: StaggerType.FinalLoopExclDelay