C# Class GoTween, GoKit

Inheritance: AbstractGoTween

Datei anzeigen Open project: prime31/GoKit Class Usage Examples

Public Methods

Method	Description
GoTween ( object target, float duration, GoTweenConfig, config, Action onComplete = null ) : System	initializes a new instance and sets up the details according to the config parameter
addTweenProperty ( AbstractTweenProperty, tweenProp ) : void	adds the tween property if it passes validation and initializes the property
allTweenProperties ( ) : List
clearTweenProperties ( ) : void
complete ( ) : void	completes the tween. sets the object to it's final position as if the tween completed normally. takes into effect if the tween was playing forward or reversed.
containsTweenProperty ( AbstractTweenProperty, property ) : bool
destroy ( ) : void	removes the tween and cleans up its state
goTo ( float time, bool skipDelay ) : void	goes to the specified time clamping it from 0 to the total duration of the tween. if the tween is not playing it will be force updated to the time specified.
isValid ( ) : bool	we are valid if we have a target and at least one TweenProperty
removeTweenProperty ( AbstractTweenProperty, property ) : bool
update ( float deltaTime ) : bool	tick method. if it returns true it indicates the tween is complete

Protected Methods

Method	Description
onInit ( ) : void	called only once the first update of a tween.

Method Details

GoTween() public method

initializes a new instance and sets up the details according to the config parameter

public GoTween ( object target, float duration, GoTweenConfig, config, Action onComplete = null ) : System
target	object
duration	float
config	GoTweenConfig,
onComplete	Action
return	System

addTweenProperty() public method

adds the tween property if it passes validation and initializes the property

public addTweenProperty ( AbstractTweenProperty, tweenProp ) : void
tweenProp	AbstractTweenProperty,
return	void

allTweenProperties() public method

public allTweenProperties ( ) : List
return	List

clearTweenProperties() public method

public clearTweenProperties ( ) : void
return	void

complete() public method

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

public complete ( ) : void
return	void

containsTweenProperty() public method

public containsTweenProperty ( AbstractTweenProperty, property ) : bool
property	AbstractTweenProperty,
return	bool

destroy() public method

removes the tween and cleans up its state

public destroy ( ) : void
return	void

goTo() public method

goes to the specified time clamping it from 0 to the total duration of the tween. if the tween is not playing it will be force updated to the time specified.

public goTo ( float time, bool skipDelay ) : void
time	float
skipDelay	bool
return	void

isValid() public method

we are valid if we have a target and at least one TweenProperty

public isValid ( ) : bool
return	bool

onInit() protected method

called only once the first update of a tween.

protected onInit ( ) : void
return	void

removeTweenProperty() public method

public removeTweenProperty ( AbstractTweenProperty, property ) : bool
property	AbstractTweenProperty,
return	bool

update() public method

tick method. if it returns true it indicates the tween is complete

public update ( float deltaTime ) : bool
deltaTime	float
return	bool