Class SequenceProperty<T, F>

Index

Constructors

constructor

Properties

function keyframes loop modifiers

Accessors

componentCount duration fieldCount fields valueType

Methods

add clamp clone for max min minify scale separateComponents serialize sortKeyframes toJSON valueAt withModifiers fromFields fromJSON

Constructors

constructor

new SequenceProperty<T extends Tensor, F extends SequencePropertyFunction>(
    func: F,
    loop?: boolean,
    keyframes?: KeyframeOfFunction<T, F>[],
    modifiers?: IModifier<T>[],
): SequenceProperty<T, F>
Type Parameters
- T extends Tensor
- F extends SequencePropertyFunction
Parameters
- func: F
- loop: boolean = false
- keyframes: KeyframeOfFunction<T, F>[] = []
- modifiers: IModifier<T>[] = []
Returns SequenceProperty<T, F>
Overrides Property.constructor
- Defined in fxr.ts:33407

Properties

function

function: F

keyframes

keyframes: KeyframeOfFunction<T, F>[] = []

loop

loop: boolean = false

modifiers

modifiers: IModifier<T>[]

Accessors

componentCount

get componentCount(): 1 | 2 | 3 | 4
Returns 1 | 2 | 3 | 4
Implementation of IModifiableProperty.componentCount
Inherited from Property.componentCount
- Defined in fxr.ts:33173

duration

get duration(): number
Returns number
- Defined in fxr.ts:33744
set duration(value: number): void
Parameters
- value: number
Returns void
- Defined in fxr.ts:33745

fieldCount

get fieldCount(): number
Returns number
Implementation of IModifiableProperty.fieldCount
Overrides Property.fieldCount
- Defined in fxr.ts:33428

fields

get fields(): NumericalField[]
Returns NumericalField[]
Implementation of IModifiableProperty.fields
Overrides Property.fields
- Defined in fxr.ts:33439

valueType

get valueType(): ValueTypeOfTensor<T>
Returns ValueTypeOfTensor<T>
Implementation of IModifiableProperty.valueType
Overrides Property.valueType
- Defined in fxr.ts:33416

Methods

add

add(summand: number | T): SequenceProperty<T, F>
Parameters
- summand: number | T
Returns SequenceProperty<T, F>
Implementation of IModifiableProperty.add
Overrides Property.add
- Defined in fxr.ts:33639

clamp

clamp(min: T, max: T): Property<T, PropertyFunction>
Parameters
- min: T
- max: T
Returns Property<T, PropertyFunction>
Inherited from Property.clamp
- Defined in fxr.ts:33236

clone

clone(): SequenceProperty<T, F>
Returns SequenceProperty<T, F>
Implementation of IModifiableProperty.clone
Overrides Property.clone
- Defined in fxr.ts:33681

for

for(game: Game): Property<T, F>
Returns an equal property that works with the given game.

If the property has multiple modifiers, there is a chance that the output of this method will not be perfectly equal, but it should still be close.
Parameters
- game: Game
  The game to ensure that the property works with.
Returns Property<T, F>
Implementation of IModifiableProperty.for
Inherited from Property.for
- Defined in fxr.ts:33207

max

max(): T
Returns T
Implementation of IModifiableProperty.max
Overrides Property.max
- Defined in fxr.ts:33715

min

min(): T
Returns T
Implementation of IModifiableProperty.min
Overrides Property.min
- Defined in fxr.ts:33706

minify

minify(): Property<T, PropertyFunction>
Returns Property<T, PropertyFunction>
Implementation of IModifiableProperty.minify
Overrides Property.minify
- Defined in fxr.ts:33724

scale

scale(factor: number | T): SequenceProperty<T, F>
Parameters
- factor: number | T
Returns SequenceProperty<T, F>
Implementation of IModifiableProperty.scale
Overrides Property.scale
- Defined in fxr.ts:33624

separateComponents

separateComponents(): SequenceProperty<number, F>[]
Returns SequenceProperty<number, F>[]
Implementation of IModifiableProperty.separateComponents
Overrides Property.separateComponents
- Defined in fxr.ts:33690

serialize

serialize(
options?: FXRSerializeOptions,
): { function: string; keyframes: any[]; loop: boolean; modifiers?: any[] }
Parameters
- Optionaloptions: FXRSerializeOptions
Returns { function: string; keyframes: any[]; loop: boolean; modifiers?: any[] }
Implementation of IModifiableProperty.serialize
Overrides Property.serialize
- Defined in fxr.ts:33563

sortKeyframes

sortKeyframes(): SequenceProperty<T, F>
Returns SequenceProperty<T, F>
- Defined in fxr.ts:33423

toJSON

toJSON(): any
Returns any
Implementation of IModifiableProperty.toJSON
Inherited from Property.toJSON
- Defined in fxr.ts:33240

valueAt

valueAt(arg: number): T
Parameters
- arg: number
Returns T
Implementation of IModifiableProperty.valueAt
Overrides Property.valueAt
- Defined in fxr.ts:33653

withModifiers

withModifiers(...modifiers: IModifier<T>[]): SequenceProperty<T, F>
Parameters
- ...modifiers: IModifier<T>[]
Returns SequenceProperty<T, F>
Inherited from Property.withModifiers
- Defined in fxr.ts:33175

`Static`fromFields

fromFields<T extends Tensor, F extends SequencePropertyFunction>(
    valueType: ValueTypeOfTensor<T>,
    func: F,
    loop: boolean,
    modifiers: IModifier<T>[],
    fieldValues: number[],
): SequenceProperty<T, F>
Type Parameters
- T extends Tensor
- F extends SequencePropertyFunction
Parameters
- valueType: ValueTypeOfTensor<T>
- func: F
- loop: boolean
- modifiers: IModifier<T>[]
- fieldValues: number[]
Returns SequenceProperty<T, F>
- Defined in fxr.ts:33504

`Static`fromJSON

fromJSON<T extends Tensor>(
    obj: {
        function: string;
        keyframes?: AnyKeyframe<T>[];
        loop?: boolean;
        modifiers?: any[];
    },
): SequenceProperty<T, any>
Type Parameters
- T extends Tensor
Parameters
- obj: {
      function: string;
      keyframes?: AnyKeyframe<T>[];
      loop?: boolean;
      modifiers?: any[];
  }
Returns SequenceProperty<T, any>
Overrides Property.fromJSON
- Defined in fxr.ts:33549

Class SequenceProperty<T, F>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SequenceProperty<T, F>

Properties

function

keyframes

loop

modifiers

Accessors

componentCount

Returns 1 | 2 | 3 | 4

duration

Returns number

Parameters

Returns void

fieldCount

Returns number

fields

Returns NumericalField[]

valueType

Returns ValueTypeOfTensor<T>

Methods

add

Parameters

Returns SequenceProperty<T, F>

clamp

Parameters

Returns Property<T, PropertyFunction>

clone

Returns SequenceProperty<T, F>

for

Parameters

Returns Property<T, F>

max

Returns T

min

Returns T

minify

Returns Property<T, PropertyFunction>

scale

Parameters

Returns SequenceProperty<T, F>

separateComponents

Returns SequenceProperty<number, F>[]

serialize

Parameters

Returns { function: string; keyframes: any[]; loop: boolean; modifiers?: any[] }

sortKeyframes

Returns SequenceProperty<T, F>

toJSON

Returns any

valueAt

Parameters

Returns T

withModifiers

Parameters

Returns SequenceProperty<T, F>

StaticfromFields

Type Parameters

Parameters

Returns SequenceProperty<T, F>

StaticfromJSON

Type Parameters

Parameters

Returns SequenceProperty<T, any>

Settings

On This Page

`Static`fromFields

`Static`fromJSON