Class SteppedProperty<T>

function

keyframes

loop

modifiers

valueType

componentCount

• get componentCount(): 1 | 2 | 3 | 4

  Returns 1 | 2 | 3 | 4

duration

• get duration(): number

  Returns number

• set duration(value: number): void

  Parameters

  • value: number

  Returns void

fieldCount

• get fieldCount(): number

  Returns number

fields

• get fields(): NumericalField[]

  Returns NumericalField[]

add

• add(summand: number | TypeMap.PropertyValue[T]): SteppedProperty<T>

  Parameters

  • summand: number | TypeMap.PropertyValue[T]

  Returns SteppedProperty<T>

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>

clone

• clone(): SequenceProperty<T, Stepped>

  Returns SequenceProperty<T, Stepped>

for

• for(game: Game): Property<T, Stepped>

  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, Stepped>

max

• max(): TypeMap.PropertyValue[T]

  Returns TypeMap.PropertyValue[T]

min

• min(): TypeMap.PropertyValue[T]

  Returns TypeMap.PropertyValue[T]

minify

• minify(): Property<T, PropertyFunction>

  Returns Property<T, PropertyFunction>

scale

• scale(factor: number | TypeMap.PropertyValue[T]): SteppedProperty<T>

  Parameters

  • factor: number | TypeMap.PropertyValue[T]

  Returns SteppedProperty<T>

separateComponents

• separateComponents(): SequenceProperty<Scalar, Stepped>[]

  Returns SequenceProperty<Scalar, Stepped>[]

serialize

• serialize(
      options?: FXRSerializeOptions,
  ): { function: string; keyframes: any[]; loop: boolean; modifiers?: any[] }

  Parameters

  • Optionaloptions: FXRSerializeOptions

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

sortKeyframes

• sortKeyframes(): SteppedProperty<T>

  Returns SteppedProperty<T>

toJSON

• toJSON(): any

  Returns any

valueAt

• valueAt(arg: number): TypeMap.PropertyValue[T]

  Parameters

  • arg: number

  Returns TypeMap.PropertyValue[T]

withModifiers

• withModifiers(...modifiers: IModifier<T>[]): SteppedProperty<T>

  Parameters

  • ...modifiers: IModifier<T>[]

  Returns SteppedProperty<T>

StaticfromFields

• 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>

StaticfromJSON

• 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>