PropertyTweener

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.PropertyTweener
Namespace	Electron2D
Kind	class
Category	Animation and Tweening

Overview

Tweens a public property or field on an object.

Syntax

public sealed class Electron2D.PropertyTweener : Electron2D.Tweener

Godot 4.7 C# profile compatibility

Profile: Electron2D 0.1.0 2D
Status: Partial / Not verified
Out of profile: yes
Godot reference: PropertyTweener

Tween step that captures a public property or field value and writes eased values until completion.

Remarks

A property tweener captures the initial value when it first starts, computes a supported value delta and writes eased values until its duration completes.

Thread Safety

This type is not synchronized. Configure and process it on the main scene thread.

Since

This type is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Tween.TweenProperty(Electron2D.Object,Electron2D.NodePath,Electron2D.Variant,System.Double)

Members

Member	Kind	Summary
SetDelay(System.Double)	Method	Sets a delay before this property tweener starts.
SetEase(Electron2D.Tween.EaseType)	Method	Sets the ease mode for this property tweener.
SetTrans(Electron2D.Tween.TransitionType)	Method	Sets the transition curve for this property tweener.

Member Details

SetDelay(System.Double)

Kind: Method

public Electron2D.PropertyTweener SetDelay(System.Double)(System.Double delay)

Summary

Sets a delay before this property tweener starts.

Remarks

Delay time is consumed before the initial property value is captured.

Parameters

• delay: The finite non-negative delay in seconds.

Returns

This property tweener.

Exceptions

• System.ArgumentOutOfRangeException: Thrown when delay is negative or not finite.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PropertyTweener

SetEase(Electron2D.Tween.EaseType)

Kind: Method

public Electron2D.PropertyTweener SetEase(Electron2D.Tween.EaseType)(Electron2D.Tween.EaseType ease)

Summary

Sets the ease mode for this property tweener.

Remarks

This setting overrides the default ease mode copied from the owner tween when the property tweener was created.

Parameters

• ease: The ease mode to use.

Returns

This property tweener.

Exceptions

• System.ArgumentOutOfRangeException: Thrown when ease is outside the supported enum range.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PropertyTweener.SetTrans(Electron2D.Tween.TransitionType)

SetTrans(Electron2D.Tween.TransitionType)

Kind: Method

public Electron2D.PropertyTweener SetTrans(Electron2D.Tween.TransitionType)(Electron2D.Tween.TransitionType trans)

Summary

Sets the transition curve for this property tweener.

Remarks

This setting overrides the default transition copied from the owner tween when the property tweener was created.

Parameters

• trans: The transition curve to use.

Returns

This property tweener.

Exceptions

• System.ArgumentOutOfRangeException: Thrown when trans is outside the supported enum range.

Thread Safety

This method is not synchronized. Call it on the main scene thread.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PropertyTweener.SetEase(Electron2D.Tween.EaseType)