PropertyTweener

Documentation

Overview

Package PropertyTweener provides methods for working with PropertyTweener object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsPropertyTweener() Instance
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsRelative() [1]gdclass.PropertyTweener
  • func (self Instance) AsTweener() Tweener.Instance
  • func (self Instance) From(value any) [1]gdclass.PropertyTweener
  • func (self Instance) FromCurrent() [1]gdclass.PropertyTweener
  • func (self Instance) SetCustomInterpolator(interpolator_method func(Float.X) Float.X) [1]gdclass.PropertyTweener
  • func (self Instance) SetDelay(delay Float.X) [1]gdclass.PropertyTweener
  • func (self Instance) SetEase(ease gdclass.TweenEaseType) [1]gdclass.PropertyTweener
  • func (self Instance) SetTrans(trans gdclass.TweenTransitionType) [1]gdclass.PropertyTweener
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsPropertyTweener() Instance
}

type Instance

type Instance [1]gdclass.PropertyTweener

[PropertyTweener] is used to interpolate a property in an object. See [method Tween.tween_property] for more usage information. [b]Note:[/b] [method Tween.tween_property] is the only correct way to create [PropertyTweener]. Any [PropertyTweener] created manually will not function correctly.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsPropertyTweener

func (self Instance) AsPropertyTweener() Instance

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsRelative

func (self Instance) AsRelative() [1]gdclass.PropertyTweener

When called, the final value will be used as a relative value instead. [b]Example:[/b] [codeblock] var tween = get_tree().create_tween() tween.tween_property(self, "position", Vector2.RIGHT * 100, 1).as_relative() #the node will move by 100 pixels to the right [/codeblock]

func (Instance) AsTweener

func (self Instance) AsTweener() Tweener.Instance

func (Instance) From

func (self Instance) From(value any) [1]gdclass.PropertyTweener

Sets a custom initial value to the [PropertyTweener]. [b]Example:[/b] [codeblock] var tween = get_tree().create_tween() tween.tween_property(self, "position", Vector2(200, 100), 1).from(Vector2(100, 100)) #this will move the node from position (100, 100) to (200, 100) [/codeblock]

func (Instance) FromCurrent

func (self Instance) FromCurrent() [1]gdclass.PropertyTweener

Makes the [PropertyTweener] use the current property value (i.e. at the time of creating this [PropertyTweener]) as a starting point. This is equivalent of using [method from] with the current value. These two calls will do the same: [codeblock] tween.tween_property(self, "position", Vector2(200, 100), 1).from(position) tween.tween_property(self, "position", Vector2(200, 100), 1).from_current() [/codeblock]

func (Instance) SetCustomInterpolator

func (self Instance) SetCustomInterpolator(interpolator_method func(Float.X) Float.X) [1]gdclass.PropertyTweener

Allows interpolating the value with a custom easing function. The provided [param interpolator_method] will be called with a value ranging from [code]0.0[/code] to [code]1.0[/code] and is expected to return a value within the same range (values outside the range can be used for overshoot). The return value of the method is then used for interpolation between initial and final value. Note that the parameter passed to the method is still subject to the tweener's own easing. [b]Example:[/b] [codeblock] @export var curve: Curve

func _ready():

var tween = create_tween()
# Interpolate the value using a custom curve.
tween.tween_property(self, "position:x", 300, 1).as_relative().set_custom_interpolator(tween_curve)

func tween_curve(v):

return curve.sample_baked(v)

[/codeblock]

func (Instance) SetDelay

func (self Instance) SetDelay(delay Float.X) [1]gdclass.PropertyTweener

Sets the time in seconds after which the [PropertyTweener] will start interpolating. By default there's no delay.

func (Instance) SetEase

func (self Instance) SetEase(ease gdclass.TweenEaseType) [1]gdclass.PropertyTweener

Sets the type of used easing from [enum Tween.EaseType]. If not set, the default easing is used from the [Tween] that contains this Tweener.

func (Instance) SetTrans

func (self Instance) SetTrans(trans gdclass.TweenTransitionType) [1]gdclass.PropertyTweener

Sets the type of used transition from [enum Tween.TransitionType]. If not set, the default transition is used from the [Tween] that contains this Tweener.

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value