Class ConstantProperty<T>

function

modifiers

value

valueType

componentCount

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

  Returns 1 | 2 | 3 | 4

fieldCount

• get fieldCount(): number

  Returns number

fields

• get fields(): NumericalField[]

  Returns NumericalField[]

isOne

• get isOne(): boolean

  Returns boolean

isZero

• get isZero(): boolean

  Returns boolean

add

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

  Parameters

  • summand: number | TypeMap.PropertyValue[T]

  Returns ConstantProperty<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(): ValueProperty<T>

  Returns ValueProperty<T>

for

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

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

max

• max(): TypeMap.PropertyValue[T]

  Returns TypeMap.PropertyValue[T]

min

• min(): TypeMap.PropertyValue[T]

  Returns TypeMap.PropertyValue[T]

minify

• minify(): ValueProperty<T>

  Returns ValueProperty<T>

scale

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

  Parameters

  • factor: number | TypeMap.PropertyValue[T]

  Returns ConstantProperty<T>

separateComponents

• separateComponents(): ValueProperty<Scalar>[]

  Returns ValueProperty<Scalar>[]

serialize

• serialize(options?: FXRSerializeOptions): any

  Parameters

  • Optionaloptions: FXRSerializeOptions

  Returns any

toJSON

• toJSON(): any

  Returns any

valueAt

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

  Parameters

  • arg: number

  Returns TypeMap.PropertyValue[T]

withModifiers

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

  Parameters

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

  Returns ConstantProperty<T>

StaticfromFields

• fromFields<T extends ValueType>(
      valueType: T,
      func: ValuePropertyFunction,
      modifiers: IModifier<T>[],
      fieldValues: number[],
  ): ValueProperty<T>

  Type Parameters

  • T extends ValueType

  Parameters

  • valueType: T
  • func: ValuePropertyFunction
  • modifiers: IModifier<T>[]
  • fieldValues: number[]

  Returns ValueProperty<T>

StaticfromJSON

• fromJSON<T extends ValueType>(
      obj: PropertyValue | { modifiers?: any[]; value: PropertyValue },
  ): ConstantProperty<T>

  Type Parameters

  • T extends ValueType

  Parameters

  • obj: PropertyValue | { modifiers?: any[]; value: PropertyValue }

  Returns ConstantProperty<T>