C# Класс AbstractGoTween, wepwep

base class shared by the Tween and TweenChain classes to allow a seemless API when controlling either of them

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
id	int

Защищенные свойства (Protected)

Свойство	Тип	Описание
_completedIterations	int
_deltaIterations	int
_didBegin	bool
_didInit	bool
_didIterateLastFrame	bool
_didIterateThisFrame	bool
_elapsedTime	float
_fireIterationEnd	bool
_fireIterationStart	bool
_isLoopingBackOnPingPong	bool
_onBegin	Action
_onComplete	Action
_onInit	Action
_onIterationEnd	Action
_onIterationStart	Action
_onUpdate	Action
_totalElapsedTime	float

Открытые методы

Метод	Описание
allTweenProperties ( ) : List	returns a list of all the TweenProperties contained in the tween and all its children (if it is a TweenChain or a TweenFlow) technically, this should be marked as internal
complete ( ) : void	completes the tween. sets the playhead to it's final position as if the tween completed normally. takes into account if the tween was playing forward or reversed.
containsTweenProperty ( AbstractTweenProperty, property ) : bool	returns true if the tween contains the same type (or propertyName) property in its property list technically, this should be marked as internal
destroy ( ) : void	removes the Tween from action and cleans up its state
goTo ( float time ) : void	goes to the specified time clamping it from 0 to the total duration of the tween. if the tween is not playing it can optionally be force updated to the time specified. delays are not taken into effect. (must be implemented by inherited classes.)
goToAndPlay ( float time ) : void	goes to the time and starts playback skipping any delays
isValid ( ) : bool	subclasses should return true if they are a valid and ready to be added to the list of running tweens or false if not ready. technically, this should be marked as internal
pause ( ) : void	pauses playback
play ( ) : void	resumes playback
playBackwards ( ) : void	plays the tween backwards. if it is already playing backwards has no effect
playForward ( ) : void	plays the tween forward. if it is already playing forward has no effect
removeTweenProperty ( AbstractTweenProperty, property ) : bool	attempts to remove the tween property returning true if successful technically, this should be marked as internal
restart ( bool skipDelay = true ) : void	rewinds the tween to the beginning (or end, depending on isReversed) and starts playback, optionally skipping delay (only relevant for Tweens).
reverse ( ) : void	reverses playback. if going forward it will be going backward after this and vice versa.
rewind ( ) : void	rewinds the tween to the beginning (or end, depending on isReversed) and pauses playback.
setOnBeginHandler ( Action onBegin ) : void
setOnCompleteHandler ( Action onComplete ) : void
setOnInitHandler ( Action onInit ) : void
setOnUpdateHandler ( Action onUpdate ) : void
setonIterationEndHandler ( Action onIterationEnd ) : void
setonIterationStartHandler ( Action onIterationStart ) : void
update ( float deltaTime ) : bool	tick method. if it returns true it indicates the tween is complete. note: at it's base, AbstractGoTween does not fire events, it is up to the implementer to do so. see GoTween and AbstractGoTweenCollection for examples.
waitForCompletion ( ) : IEnumerator	waits for either completion or destruction. call in a Coroutine and yield on the return

Защищенные методы

Метод	Описание
onBegin ( ) : void	called whenever the tween is updated and the playhead is at the start (or end, depending on isReversed) of the tween.
onComplete ( ) : void	called when the tween completes playing.
onInit ( ) : void	called once per tween when it is first updated
onIterationEnd ( ) : void	called once per iteration at the end of the iteration.
onIterationStart ( ) : void	called once per iteration at the start of the iteration.
onUpdate ( ) : void	called once per update, after the update has occured.
reset ( ) : void	resets the tween to the beginning, taking isReversed into account.

Описание методов

allTweenProperties() публичный абстрактный Метод

returns a list of all the TweenProperties contained in the tween and all its children (if it is a TweenChain or a TweenFlow) technically, this should be marked as internal

public abstract allTweenProperties ( ) : List
Результат	List

complete() публичный Метод

completes the tween. sets the playhead to it's final position as if the tween completed normally. takes into account if the tween was playing forward or reversed.

public complete ( ) : void
Результат	void

containsTweenProperty() публичный абстрактный Метод

returns true if the tween contains the same type (or propertyName) property in its property list technically, this should be marked as internal

public abstract containsTweenProperty ( AbstractTweenProperty, property ) : bool
property	AbstractTweenProperty,
Результат	bool

destroy() публичный Метод

removes the Tween from action and cleans up its state

public destroy ( ) : void
Результат	void

goTo() публичный абстрактный Метод

goes to the specified time clamping it from 0 to the total duration of the tween. if the tween is not playing it can optionally be force updated to the time specified. delays are not taken into effect. (must be implemented by inherited classes.)

public abstract goTo ( float time ) : void
time	float
Результат	void

goToAndPlay() публичный Метод

goes to the time and starts playback skipping any delays

public goToAndPlay ( float time ) : void
time	float
Результат	void

isValid() публичный абстрактный Метод

subclasses should return true if they are a valid and ready to be added to the list of running tweens or false if not ready. technically, this should be marked as internal

public abstract isValid ( ) : bool
Результат	bool

onBegin() защищенный Метод

called whenever the tween is updated and the playhead is at the start (or end, depending on isReversed) of the tween.

protected onBegin ( ) : void
Результат	void

onComplete() защищенный Метод

called when the tween completes playing.

protected onComplete ( ) : void
Результат	void

onInit() защищенный Метод

called once per tween when it is first updated

protected onInit ( ) : void
Результат	void

onIterationEnd() защищенный Метод

called once per iteration at the end of the iteration.

protected onIterationEnd ( ) : void
Результат	void

onIterationStart() защищенный Метод

called once per iteration at the start of the iteration.

protected onIterationStart ( ) : void
Результат	void

onUpdate() защищенный Метод

called once per update, after the update has occured.

protected onUpdate ( ) : void
Результат	void

pause() публичный Метод

pauses playback

public pause ( ) : void
Результат	void

play() публичный Метод

resumes playback

public play ( ) : void
Результат	void

playBackwards() публичный Метод

plays the tween backwards. if it is already playing backwards has no effect

public playBackwards ( ) : void
Результат	void

playForward() публичный Метод

plays the tween forward. if it is already playing forward has no effect

public playForward ( ) : void
Результат	void

removeTweenProperty() публичный абстрактный Метод

attempts to remove the tween property returning true if successful technically, this should be marked as internal

public abstract removeTweenProperty ( AbstractTweenProperty, property ) : bool
property	AbstractTweenProperty,
Результат	bool

reset() защищенный Метод

resets the tween to the beginning, taking isReversed into account.

protected reset ( ) : void
Результат	void

restart() публичный Метод

rewinds the tween to the beginning (or end, depending on isReversed) and starts playback, optionally skipping delay (only relevant for Tweens).

public restart ( bool skipDelay = true ) : void
skipDelay	bool
Результат	void

reverse() публичный Метод

reverses playback. if going forward it will be going backward after this and vice versa.

public reverse ( ) : void
Результат	void

rewind() публичный Метод

rewinds the tween to the beginning (or end, depending on isReversed) and pauses playback.

public rewind ( ) : void
Результат	void

setOnBeginHandler() публичный Метод

public setOnBeginHandler ( Action onBegin ) : void
onBegin	Action
Результат	void

setOnCompleteHandler() публичный Метод

public setOnCompleteHandler ( Action onComplete ) : void
onComplete	Action
Результат	void

setOnInitHandler() публичный Метод

public setOnInitHandler ( Action onInit ) : void
onInit	Action
Результат	void

setOnUpdateHandler() публичный Метод

public setOnUpdateHandler ( Action onUpdate ) : void
onUpdate	Action
Результат	void

setonIterationEndHandler() публичный Метод

public setonIterationEndHandler ( Action onIterationEnd ) : void
onIterationEnd	Action
Результат	void

setonIterationStartHandler() публичный Метод

public setonIterationStartHandler ( Action onIterationStart ) : void
onIterationStart	Action
Результат	void

update() публичный Метод

tick method. if it returns true it indicates the tween is complete. note: at it's base, AbstractGoTween does not fire events, it is up to the implementer to do so. see GoTween and AbstractGoTweenCollection for examples.

public update ( float deltaTime ) : bool
deltaTime	float
Результат	bool

waitForCompletion() публичный Метод

waits for either completion or destruction. call in a Coroutine and yield on the return

public waitForCompletion ( ) : IEnumerator
Результат	IEnumerator

Описание свойств

_completedIterations защищенное свойство

protected int _completedIterations
Результат	int

_deltaIterations защищенное свойство

protected int _deltaIterations
Результат	int

_didBegin защищенное свойство

protected bool _didBegin
Результат	bool

_didInit защищенное свойство

protected bool _didInit
Результат	bool

_didIterateLastFrame защищенное свойство

protected bool _didIterateLastFrame
Результат	bool

_didIterateThisFrame защищенное свойство

protected bool _didIterateThisFrame
Результат	bool

_elapsedTime защищенное свойство

protected float _elapsedTime
Результат	float

_fireIterationEnd защищенное свойство

protected bool _fireIterationEnd
Результат	bool

_fireIterationStart защищенное свойство

protected bool _fireIterationStart
Результат	bool

_isLoopingBackOnPingPong защищенное свойство

protected bool _isLoopingBackOnPingPong
Результат	bool

_onBegin защищенное свойство

protected Action _onBegin
Результат	Action

_onComplete защищенное свойство

protected Action _onComplete
Результат	Action

_onInit защищенное свойство

protected Action _onInit
Результат	Action

_onIterationEnd защищенное свойство

protected Action _onIterationEnd
Результат	Action

_onIterationStart защищенное свойство

protected Action _onIterationStart
Результат	Action

_onUpdate защищенное свойство

protected Action _onUpdate
Результат	Action

_totalElapsedTime защищенное свойство

protected float _totalElapsedTime
Результат	float

id публичное свойство

public int id
Результат	int