Skip to main content

CompoundSignalContext

class CompoundSignalContextTSetterValueTValue extends TSetterValueTKeys extends keyof TValue = keyof TValueTOwner = void extends SignalContextTSetterValueTValueTOwner

Type Parameters

Extended by

Constructors​

constructor​

public override new CompoundSignalContextTSetterValueTValueTKeys extends stringnumbersymbol = keyof TValueTOwner = voidentries: TKeyskeyof TValueSignalanyanyTOwnerSignalContextanyanyTOwner[]parser: value: TSetterValue => TValueinitial: SignalValueTSetterValueinterpolation: InterpolationFunctionTValueany[]owner: TOwner = ...extensions: PartialSignalExtensionsTSetterValueTValue = {}: CompoundSignalContextTSetterValueTValueTKeysTOwner

Type Parameters

Parameters

Overwrites SignalContext.constructor

Properties​

signals​

readonly public signals: keyof TValueSignalanyanyTOwnerSignalContextanyanyTOwner[] = []

Methods​

dispose​

public dispose(): void
Inherited from SignalContext.dispose

get​

public get(): TValue
Inherited from SignalContext.get

getInitial​

public getInitial(): undefinedSignalValueTSetterValue

Get the initial value of this signal.

Inherited from SignalContext.getInitial

getter​

public override getter(): TValue
Overwrites SignalContext.getter

isInitial​

public override isInitial(): boolean

Check if the signal is currently using its initial value.

Examples

Overwrites SignalContext.isInitial

isTweening​

public isTweening(): boolean

Is the signal undergoing a tween?

Inherited from SignalContext.isTweening

parse​

public override parsevalue: TSetterValue: TValue

Parameters

Overwrites SignalContext.parse

raw​

public override raw(): TSetterValue

Get the raw value of this signal.

If the signal was provided with a factory function, the function itself will be returned, without invoking it.

This method can be used to create copies of signals.

Examples

Overwrites SignalContext.raw

reset​

public override reset(): TOwner

Reset the signal to its initial value (if one has been set).

Examples

Overwrites SignalContext.reset

save​

public override save(): TOwner

Compute the current value of the signal and immediately set it.

This method can be used to stop the signal from updating while keeping its current value.

Examples

Overwrites SignalContext.save

set​

public setvalue: typeof DEFAULTSignalValueTSetterValue: TOwner

Parameters

Inherited from SignalContext.set

setter​

public override settervalue: SignalValueTValue: TOwner

Parameters

Overwrites SignalContext.setter

toPromise​

public toPromise(): PromiseCompoundSignalContextTSetterValueTValueTKeysTOwner
Inherited from SignalContext.toPromise

toSignal​

public override toSignal(): CompoundSignalTSetterValueTValueTKeysTOwnerCompoundSignalContextTSetterValueTValueTKeysTOwner
Overwrites SignalContext.toSignal

tweener​

public tweenervalue: SignalValueTSetterValueduration: numbertimingFunction: TimingFunctioninterpolationFunction: InterpolationFunctionTValueany[]: ThreadGenerator

Parameters

Inherited from SignalContext.tweener

collectPromise​

static public collectPromiseTpromise: PromiseT: PromiseHandlenullT
static public collectPromiseTpromise: PromiseTinitialValue: T: PromiseHandleT

Type Parameters

Parameters

Inherited from SignalContext.collectPromise

consumePromises​

static public consumePromises(): PromisePromiseHandleany[]
Inherited from SignalContext.consumePromises

hasPromises​

static public hasPromises(): boolean
Inherited from SignalContext.hasPromises