C# Class GoTweenConfig, GoKit

Datei anzeigen Open project: prime31/GoKit Class Usage Examples

Public Properties

Property	Type	Description
delay	float
easeCurve	UnityEngine.AnimationCurve
easeType	GoEaseType
id	int
isFrom	bool
isPaused	bool
iterations	int
loopType	GoLoopType
onBeginHandler	Action
onCompleteHandler	Action
onInitHandler	Action
onIterationEndHandler	Action
onIterationStartHandler	Action
onUpdateHandler	Action
propertyUpdateType	GoUpdateType
timeScale	float

Public Methods

Method	Description
addTweenProperty ( AbstractTweenProperty, tweenProp ) : GoTweenConfig,	adds a TweenProperty to the list
anchorMax ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig,	anchorMax tween
anchorMin ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig,	anchorMin tween
anchoredPosition ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig,	anchoredPosition tween
anchoredPosition3D ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig,	anchoredPosition3D tween
clearEvents ( ) : GoTweenConfig,	clears out all the TweenProperties
clearProperties ( ) : GoTweenConfig,	clears out all the TweenProperties
clone ( ) : GoTweenConfig,	clones the instance
colorProp ( string propertyName, Color endValue, bool isRelative = false ) : GoTweenConfig,	generic color tween
eulerAngles ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig,	eulerAngle tween
floatProp ( string propertyName, float endValue, bool isRelative = false ) : GoTweenConfig,	generic float tween
intProp ( string propertyName, int endValue, bool isRelative = false ) : GoTweenConfig,	generic integer tween
localEulerAngles ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig,	local eulerAngle tween
localPosition ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig,	localPosition tween
localRotation ( Quaternion endValue, bool isRelative = false ) : GoTweenConfig,	localRotation tween as Quaternion
localRotation ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig,	localRotation tween
materialColor ( Color endValue, string colorName = "_Color", bool isRelative = false ) : GoTweenConfig,	material color tween
materialFloat ( float endValue, string propertyName, bool isRelative = false ) : GoTweenConfig,	material float tween
materialVector ( Vector4 endValue, string propertyName, bool isRelative = false ) : GoTweenConfig,	material vector tween
offsetMax ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig,	offsetMax tween
offsetMin ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig,	offsetMin tween
onBegin ( Action onBegin ) : GoTweenConfig,	sets the onBegin handler for the Tween
onComplete ( Action onComplete ) : GoTweenConfig,	sets the onComplete handler for the Tween
onInit ( Action onInit ) : GoTweenConfig,	sets the onInit handler for the Tween
onIterationEnd ( Action onIterationEnd ) : GoTweenConfig,	sets the onIterationEnd handler for the Tween
onIterationStart ( Action onIterationStart ) : GoTweenConfig,	sets the onIterationStart handler for the Tween
onUpdate ( Action onUpdate ) : GoTweenConfig,	sets the onUpdate handler for the Tween
pivot ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig,	pivot tween
position ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig,	position tween
positionPath ( GoSpline, path, bool isRelative = false, GoLookAtType lookAtType = GoLookAtType.None, Transform lookTarget = null ) : GoTweenConfig,	position path tween
rotation ( Quaternion endValue, bool isRelative = false ) : GoTweenConfig,	rotation tween as Quaternion
rotation ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig	rotation tween
scale ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig	scale tween
scale ( float endValue, bool isRelative = false ) : GoTweenConfig	uniform scale tween (x, y and z scale to the same value)
scalePath ( GoSpline path, bool isRelative = false ) : GoTweenConfig	scale through a series of Vector3s
setDelay ( float seconds ) : GoTweenConfig	sets the delay for the tween
setEaseCurve ( AnimationCurve easeCurve ) : GoTweenConfig	sets the ease curve for the Tween
setEaseType ( GoEaseType easeType ) : GoTweenConfig	sets the ease type for the Tween
setId ( int id ) : GoTweenConfig	sets the id for the Tween. Multiple Tweens can have the same id and you can retrieve them with the Go class
setIsFrom ( ) : GoTweenConfig	sets if this Tween should be a "from" Tween. From Tweens use the current property as the endValue and the endValue as the start value
setIsTo ( ) : GoTweenConfig	sets if this Tween should be a "to" Tween.
setIterations ( int iterations ) : GoTweenConfig	sets the number of iterations. setting to -1 will loop infinitely
setIterations ( int iterations, GoLoopType loopType ) : GoTweenConfig	sets the number of iterations and the loop type. setting to -1 will loop infinitely
setTimeScale ( float timeScale ) : GoTweenConfig	sets the timeScale to be used by the Tween
setUpdateType ( GoUpdateType setUpdateType ) : GoTweenConfig	sets the update type for the Tween
shake ( Vector3 shakeMagnitude, GoShakeType shakeType = GoShakeType.Position, int frameMod = 1, bool useLocalProperties = false ) : GoTweenConfig	shake tween
sizeDelta ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig	sizeDelta tween
startPaused ( ) : GoTweenConfig	sets whether the Tween should start paused
vector2Prop ( string propertyName, Vector2 endValue, bool isRelative = false ) : GoTweenConfig	generic vector2 tween
vector3PathProp ( string propertyName, GoSpline path, bool isRelative = false ) : GoTweenConfig	generic vector3 path tween
vector3Prop ( string propertyName, Vector3 endValue, bool isRelative = false ) : GoTweenConfig	generic vector3 tween
vector3XProp ( string propertyName, float endValue, bool isRelative = false ) : GoTweenConfig	generic vector3.x tween
vector3YProp ( string propertyName, float endValue, bool isRelative = false ) : GoTweenConfig	generic vector3.y tween
vector3ZProp ( string propertyName, float endValue, bool isRelative = false ) : GoTweenConfig	generic vector3.z tween
vector4Prop ( string propertyName, Vector4 endValue, bool isRelative = false ) : GoTweenConfig	generic vector4 tween

Method Details

addTweenProperty() public method

adds a TweenProperty to the list

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

anchorMax() public method

anchorMax tween

public anchorMax ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Vector2
isRelative	bool
return	GoTweenConfig,

anchorMin() public method

anchorMin tween

public anchorMin ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Vector2
isRelative	bool
return	GoTweenConfig,

anchoredPosition() public method

anchoredPosition tween

public anchoredPosition ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Vector2
isRelative	bool
return	GoTweenConfig,

anchoredPosition3D() public method

anchoredPosition3D tween

public anchoredPosition3D ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Vector3
isRelative	bool
return	GoTweenConfig,

clearEvents() public method

clears out all the TweenProperties

public clearEvents ( ) : GoTweenConfig,
return	GoTweenConfig,

clearProperties() public method

clears out all the TweenProperties

public clearProperties ( ) : GoTweenConfig,
return	GoTweenConfig,

clone() public method

clones the instance

public clone ( ) : GoTweenConfig,
return	GoTweenConfig,

colorProp() public method

generic color tween

public colorProp ( string propertyName, Color endValue, bool isRelative = false ) : GoTweenConfig,
propertyName	string
endValue	Color
isRelative	bool
return	GoTweenConfig,

eulerAngles() public method

eulerAngle tween

public eulerAngles ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Vector3
isRelative	bool
return	GoTweenConfig,

floatProp() public method

generic float tween

public floatProp ( string propertyName, float endValue, bool isRelative = false ) : GoTweenConfig,
propertyName	string
endValue	float
isRelative	bool
return	GoTweenConfig,

intProp() public method

generic integer tween

public intProp ( string propertyName, int endValue, bool isRelative = false ) : GoTweenConfig,
propertyName	string
endValue	int
isRelative	bool
return	GoTweenConfig,

localEulerAngles() public method

local eulerAngle tween

public localEulerAngles ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Vector3
isRelative	bool
return	GoTweenConfig,

localPosition() public method

localPosition tween

public localPosition ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Vector3
isRelative	bool
return	GoTweenConfig,

localRotation() public method

localRotation tween as Quaternion

public localRotation ( Quaternion endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Quaternion
isRelative	bool
return	GoTweenConfig,

localRotation() public method

localRotation tween

public localRotation ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Vector3
isRelative	bool
return	GoTweenConfig,

materialColor() public method

material color tween

public materialColor ( Color endValue, string colorName = "_Color", bool isRelative = false ) : GoTweenConfig,
endValue	Color
colorName	string
isRelative	bool
return	GoTweenConfig,

materialFloat() public method

material float tween

public materialFloat ( float endValue, string propertyName, bool isRelative = false ) : GoTweenConfig,
endValue	float
propertyName	string
isRelative	bool
return	GoTweenConfig,

materialVector() public method

material vector tween

public materialVector ( Vector4 endValue, string propertyName, bool isRelative = false ) : GoTweenConfig,
endValue	Vector4
propertyName	string
isRelative	bool
return	GoTweenConfig,

offsetMax() public method

offsetMax tween

public offsetMax ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Vector2
isRelative	bool
return	GoTweenConfig,

offsetMin() public method

offsetMin tween

public offsetMin ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Vector2
isRelative	bool
return	GoTweenConfig,

onBegin() public method

sets the onBegin handler for the Tween

public onBegin ( Action onBegin ) : GoTweenConfig,
onBegin	Action
return	GoTweenConfig,

onComplete() public method

sets the onComplete handler for the Tween

public onComplete ( Action onComplete ) : GoTweenConfig,
onComplete	Action
return	GoTweenConfig,

onInit() public method

sets the onInit handler for the Tween

public onInit ( Action onInit ) : GoTweenConfig,
onInit	Action
return	GoTweenConfig,

onIterationEnd() public method

sets the onIterationEnd handler for the Tween

public onIterationEnd ( Action onIterationEnd ) : GoTweenConfig,
onIterationEnd	Action
return	GoTweenConfig,

onIterationStart() public method

sets the onIterationStart handler for the Tween

public onIterationStart ( Action onIterationStart ) : GoTweenConfig,
onIterationStart	Action
return	GoTweenConfig,

onUpdate() public method

sets the onUpdate handler for the Tween

public onUpdate ( Action onUpdate ) : GoTweenConfig,
onUpdate	Action
return	GoTweenConfig,

pivot() public method

pivot tween

public pivot ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Vector2
isRelative	bool
return	GoTweenConfig,

position() public method

position tween

public position ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Vector3
isRelative	bool
return	GoTweenConfig,

positionPath() public method

position path tween

public positionPath ( GoSpline, path, bool isRelative = false, GoLookAtType lookAtType = GoLookAtType.None, Transform lookTarget = null ) : GoTweenConfig,
path	GoSpline,
isRelative	bool
lookAtType	GoLookAtType
lookTarget	Transform
return	GoTweenConfig,

rotation() public method

rotation tween as Quaternion

public rotation ( Quaternion endValue, bool isRelative = false ) : GoTweenConfig,
endValue	Quaternion
isRelative	bool
return	GoTweenConfig,

rotation() public method

rotation tween

public rotation ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig
endValue	Vector3
isRelative	bool
return	GoTweenConfig

scale() public method

scale tween

public scale ( Vector3 endValue, bool isRelative = false ) : GoTweenConfig
endValue	Vector3
isRelative	bool
return	GoTweenConfig

scale() public method

uniform scale tween (x, y and z scale to the same value)

public scale ( float endValue, bool isRelative = false ) : GoTweenConfig
endValue	float
isRelative	bool
return	GoTweenConfig

scalePath() public method

scale through a series of Vector3s

public scalePath ( GoSpline path, bool isRelative = false ) : GoTweenConfig
path	GoSpline
isRelative	bool
return	GoTweenConfig

setDelay() public method

sets the delay for the tween

public setDelay ( float seconds ) : GoTweenConfig
seconds	float
return	GoTweenConfig

setEaseCurve() public method

sets the ease curve for the Tween

public setEaseCurve ( AnimationCurve easeCurve ) : GoTweenConfig
easeCurve	AnimationCurve
return	GoTweenConfig

setEaseType() public method

sets the ease type for the Tween

public setEaseType ( GoEaseType easeType ) : GoTweenConfig
easeType	GoEaseType
return	GoTweenConfig

setId() public method

sets the id for the Tween. Multiple Tweens can have the same id and you can retrieve them with the Go class

public setId ( int id ) : GoTweenConfig
id	int
return	GoTweenConfig

setIsFrom() public method

sets if this Tween should be a "from" Tween. From Tweens use the current property as the endValue and the endValue as the start value

public setIsFrom ( ) : GoTweenConfig
return	GoTweenConfig

setIsTo() public method

sets if this Tween should be a "to" Tween.

public setIsTo ( ) : GoTweenConfig
return	GoTweenConfig

setIterations() public method

sets the number of iterations. setting to -1 will loop infinitely

public setIterations ( int iterations ) : GoTweenConfig
iterations	int
return	GoTweenConfig

setIterations() public method

sets the number of iterations and the loop type. setting to -1 will loop infinitely

public setIterations ( int iterations, GoLoopType loopType ) : GoTweenConfig
iterations	int
loopType	GoLoopType
return	GoTweenConfig

setTimeScale() public method

sets the timeScale to be used by the Tween

public setTimeScale ( float timeScale ) : GoTweenConfig
timeScale	float
return	GoTweenConfig

setUpdateType() public method

sets the update type for the Tween

public setUpdateType ( GoUpdateType setUpdateType ) : GoTweenConfig
setUpdateType	GoUpdateType
return	GoTweenConfig

shake() public method

shake tween

public shake ( Vector3 shakeMagnitude, GoShakeType shakeType = GoShakeType.Position, int frameMod = 1, bool useLocalProperties = false ) : GoTweenConfig
shakeMagnitude	Vector3
shakeType	GoShakeType
frameMod	int
useLocalProperties	bool
return	GoTweenConfig

sizeDelta() public method

sizeDelta tween

public sizeDelta ( Vector2 endValue, bool isRelative = false ) : GoTweenConfig
endValue	Vector2
isRelative	bool
return	GoTweenConfig

startPaused() public method

sets whether the Tween should start paused

public startPaused ( ) : GoTweenConfig
return	GoTweenConfig

vector2Prop() public method

generic vector2 tween

public vector2Prop ( string propertyName, Vector2 endValue, bool isRelative = false ) : GoTweenConfig
propertyName	string
endValue	Vector2
isRelative	bool
return	GoTweenConfig

vector3PathProp() public method

generic vector3 path tween

public vector3PathProp ( string propertyName, GoSpline path, bool isRelative = false ) : GoTweenConfig
propertyName	string
path	GoSpline
isRelative	bool
return	GoTweenConfig

vector3Prop() public method

generic vector3 tween

public vector3Prop ( string propertyName, Vector3 endValue, bool isRelative = false ) : GoTweenConfig
propertyName	string
endValue	Vector3
isRelative	bool
return	GoTweenConfig

vector3XProp() public method

generic vector3.x tween

public vector3XProp ( string propertyName, float endValue, bool isRelative = false ) : GoTweenConfig
propertyName	string
endValue	float
isRelative	bool
return	GoTweenConfig

vector3YProp() public method

generic vector3.y tween

public vector3YProp ( string propertyName, float endValue, bool isRelative = false ) : GoTweenConfig
propertyName	string
endValue	float
isRelative	bool
return	GoTweenConfig

vector3ZProp() public method

generic vector3.z tween

public vector3ZProp ( string propertyName, float endValue, bool isRelative = false ) : GoTweenConfig
propertyName	string
endValue	float
isRelative	bool
return	GoTweenConfig

vector4Prop() public method

generic vector4 tween

public vector4Prop ( string propertyName, Vector4 endValue, bool isRelative = false ) : GoTweenConfig
propertyName	string
endValue	Vector4
isRelative	bool
return	GoTweenConfig

Property Details

delay public_oe property

public float delay
return	float

easeCurve public_oe property

public AnimationCurve,UnityEngine easeCurve
return	UnityEngine.AnimationCurve

easeType public_oe property

public GoEaseType easeType
return	GoEaseType

id public_oe property

public int id
return	int

isFrom public_oe property

public bool isFrom
return	bool

isPaused public_oe property

public bool isPaused
return	bool

iterations public_oe property

public int iterations
return	int

loopType public_oe property

public GoLoopType loopType
return	GoLoopType

onBeginHandler public_oe property

public Action onBeginHandler
return	Action

onCompleteHandler public_oe property

public Action onCompleteHandler
return	Action

onInitHandler public_oe property

public Action onInitHandler
return	Action

onIterationEndHandler public_oe property

public Action onIterationEndHandler
return	Action

onIterationStartHandler public_oe property

public Action onIterationStartHandler
return	Action

onUpdateHandler public_oe property

public Action onUpdateHandler
return	Action

propertyUpdateType public_oe property

public GoUpdateType propertyUpdateType
return	GoUpdateType

timeScale public_oe property

public float timeScale
return	float