Class TweenMember

Tweens the value of a field or property via reflection. (Requires DOTween library.)

Inheritance
Object
GraphElement<FlowGraph>
Unit<FlowGraph>
Unit
MemberUnit
TweenMember
Inherited Members
Namespace: Ludiq.Bolt
Syntax
public sealed class TweenMember : MemberUnit, IUnit, IGraphElementWithDebugData, IGraphElement, IGraphChild, IObservableDisposable, IDisposable, INotifiedCollectionChild<IGraph>, ICollectionChild<IGraph>, IPrewarmable, IIdentifiable, INotifyPropertyChanged, ISerializationCallbackReceiver

Constructors

TweenMember()

Declaration
public TweenMember()

TweenMember(Member, BoltType)

Declaration
public TweenMember(Member member, BoltType boltTargetType = null)
Parameters
Type Name Description
Member member
BoltType boltTargetType

Properties

advanced

Whether or not to show advanced options for this tween.

Declaration
[DoNotSerialize]
[Inspectable]
public bool advanced { get; set; }
Property Value
Type Description
Boolean

autokill

Whether or not this tween should be auto-killed.

Declaration
[DoNotSerialize]
public ValueInput autokill { get; }
Property Value
Type Description
ValueInput

canDefine

Declaration
public override bool canDefine { get; }
Property Value
Type Description
Boolean
Overrides

duration

The duration of the tween to perform.

Declaration
[DoNotSerialize]
public ValueInput duration { get; }
Property Value
Type Description
ValueInput

ease

The duration of the tween to perform.

Declaration
[DoNotSerialize]
public ValueInput ease { get; }
Property Value
Type Description
ValueInput

easingMode

The kind of easing to use for this tween.

Declaration
[DoNotSerialize]
[Inspectable]
public TweenMember.EasingMode easingMode { get; set; }
Property Value
Type Description
TweenMember.EasingMode

enter

The entry point to start the tween.

Declaration
[DoNotSerialize]
[UnitPortDisplay(showLabel = false, showDocumentation = false)]
public ControlInput enter { get; }
Property Value
Type Description
ControlInput

exit

The action to execute immediately after the tween has been started.

Declaration
[DoNotSerialize]
[UnitPortDisplay(order = 0)]
public ControlOutput exit { get; }
Property Value
Type Description
ControlOutput

id

Whether or not this tween should relative.

Declaration
[DoNotSerialize]
public ValueInput id { get; }
Property Value
Type Description
ValueInput

loops

Number of times to loop the tween.

Declaration
[DoNotSerialize]
public ValueInput loops { get; }
Property Value
Type Description
ValueInput

loopType

How to loop the tween.

Declaration
[DoNotSerialize]
public ValueInput loopType { get; }
Property Value
Type Description
ValueInput

onComplete

The action to execute when the tween is fully completed, after all loops.

Declaration
[DoNotSerialize]
[UnitPortDisplay("Complete", order = 8)]
public ControlOutput onComplete { get; }
Property Value
Type Description
ControlOutput

onKill

The action to execute when the tween is killed.

Declaration
[DoNotSerialize]
[UnitPortDisplay("Kill", order = 7)]
public ControlOutput onKill { get; }
Property Value
Type Description
ControlOutput

onPause

The action to execute when the tween state changes from playing to paused. If the tween has autokill set to false, this is also called when the tween reaches completion.

Declaration
[DoNotSerialize]
[UnitPortDisplay("Pause", order = 3)]
public ControlOutput onPause { get; }
Property Value
Type Description
ControlOutput

onPlay

The action to execute when the tween is set to a playing state, or resumed from a paused state.

Declaration
[DoNotSerialize]
[UnitPortDisplay("Play", order = 2)]
public ControlOutput onPlay { get; }
Property Value
Type Description
ControlOutput

onRewind

The action to execute when the twewen is rewinded manually. Also fires when the tween reaches the start position when playing backwards. Not fired again on a tween that is already rewinded is asked to rewind.

Declaration
[DoNotSerialize]
[UnitPortDisplay("Rewind", order = 4)]
public ControlOutput onRewind { get; }
Property Value
Type Description
ControlOutput

onStart

The action to execute when the tween actually starts.

Declaration
[DoNotSerialize]
[UnitPortDisplay("Start", order = 1)]
public ControlOutput onStart { get; }
Property Value
Type Description
ControlOutput

onStepComplete

The action to execute when a tween completes a single loop cycle.

Declaration
[DoNotSerialize]
[UnitPortDisplay("Step", order = 6)]
public ControlOutput onStepComplete { get; }
Property Value
Type Description
ControlOutput

recyclable

Whether or not this tween is recyclable.

Declaration
[DoNotSerialize]
public ValueInput recyclable { get; }
Property Value
Type Description
ValueInput

relative

Whether or not this tween should relative.

Declaration
[DoNotSerialize]
public ValueInput relative { get; }
Property Value
Type Description
ValueInput

timescaleIndependent

Whether the tween should be timescale independent.

Declaration
[DoNotSerialize]
[UnitPortDisplay("Unscaled")]
public ValueInput timescaleIndependent { get; }
Property Value
Type Description
ValueInput

tween

The tween that is created after this unit has been entered.

Declaration
[DoNotSerialize]
[UnitPortDisplay(showLabel = false, primary = true)]
public ValueOutput tween { get; }
Property Value
Type Description
ValueOutput

update

The action to execute every time the tween gets updated.

Declaration
[DoNotSerialize]
[UnitPortDisplay(order = 5)]
public ControlOutput update { get; }
Property Value
Type Description
ControlOutput

updateType

The type of update event to execute for this tween.

Declaration
[DoNotSerialize]
public ValueInput updateType { get; }
Property Value
Type Description
ValueInput

value

The value to tween towards.

Declaration
[UnitPortDisplay("Target")]
[DoNotSerialize]
public ValueInput value { get; }
Property Value
Type Description
ValueInput

Methods

Definition()

Declaration
protected override void Definition()
Overrides

IsMemberValid(Member)

Declaration
protected override bool IsMemberValid(Member member)
Parameters
Type Name Description
Member member
Returns
Type Description
Boolean
Overrides

IsTweenable(Member)

Declaration
public static bool IsTweenable(Member member)
Parameters
Type Name Description
Member member
Returns
Type Description
Boolean

Extension Methods