Class SequenceProperty<T, F>

Index

Constructors

constructor

Properties

function keyframes loop modifiers valueType

Accessors

componentCount duration fieldCount fields

Methods

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

Constructors

constructor

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

Properties

function

function: F

keyframes

keyframes: TypeMap.Keyframe<T>[F][] = []

loop

loop: boolean = false

modifiers

modifiers: IModifier<T>[]

valueType

valueType: 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:32275

duration

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

fieldCount

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

fields

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

Methods

add

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

clamp

clamp(
min: TypeMap.PropertyValue[T],
max: TypeMap.PropertyValue[T],
): Property<T, PropertyFunction>
Parameters
- min: TypeMap.PropertyValue[T]
- max: TypeMap.PropertyValue[T]
Returns Property<T, PropertyFunction>
Inherited from Property.clamp
- Defined in fxr.ts:32338

clone

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

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:32309

max

max(): TypeMap.PropertyValue[T]
Returns TypeMap.PropertyValue[T]
Implementation of IModifiableProperty.max
Overrides Property.max
- Defined in fxr.ts:32813

min

min(): TypeMap.PropertyValue[T]
Returns TypeMap.PropertyValue[T]
Implementation of IModifiableProperty.min
Overrides Property.min
- Defined in fxr.ts:32804

minify

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

scale

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

separateComponents

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

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:32659

sortKeyframes

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

toJSON

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

valueAt

valueAt(arg: number): TypeMap.PropertyValue[T]
Parameters
- arg: number
Returns TypeMap.PropertyValue[T]
Implementation of IModifiableProperty.valueAt
Overrides Property.valueAt
- Defined in fxr.ts:32749

withModifiers

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

`Static`fromFields

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

`Static`fromJSON

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

Class SequenceProperty<T, F>

Type Parameters

Hierarchy (View Summary, Expand)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SequenceProperty<T, F>

Properties

function

keyframes

loop

modifiers

valueType

Accessors

componentCount

Returns 1 | 2 | 3 | 4

duration

Returns number

Parameters

Returns void

fieldCount

Returns number

fields

Returns NumericalField[]

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 TypeMap.PropertyValue[T]

min

Returns TypeMap.PropertyValue[T]

minify

Returns Property<T, PropertyFunction>

scale

Parameters

Returns SequenceProperty<T, F>

separateComponents

Returns SequenceProperty<Scalar, F>[]

serialize

Parameters

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

sortKeyframes

Returns SequenceProperty<T, F>

toJSON

Returns any

valueAt

Parameters

Returns TypeMap.PropertyValue[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