Class Property<T, F>Abstract

constructor

• new Property<T extends ValueType, F extends PropertyFunction>(
      valueType: T,
      func: F,
      modifiers?: IModifier<T>[],
  ): Property<T, F>

  Type Parameters

  • T extends ValueType
  • F extends PropertyFunction

  Parameters

  • valueType: T
  • func: F
  • modifiers: IModifier<T>[] = []

  Returns Property<T, F>

AbstractfieldCount

Abstractfields

function

modifiers

valueType

componentCount

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

  Returns 1 | 2 | 3 | 4

Abstractadd

• add(summand: PropertyValue): this

  Parameters

  • summand: PropertyValue

  Returns this

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>

Abstractclone

• clone(): Property<T, F>

  Returns Property<T, F>

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>

Abstractmax

• max(): TypeMap.PropertyValue[T]

  Returns TypeMap.PropertyValue[T]

Abstractmin

• min(): TypeMap.PropertyValue[T]

  Returns TypeMap.PropertyValue[T]

Abstractminify

• minify(): Property<T, PropertyFunction>

  Returns Property<T, PropertyFunction>

Abstractscale

• scale(factor: PropertyValue): this

  Parameters

  • factor: PropertyValue

  Returns this

AbstractseparateComponents

• separateComponents(): Property<Scalar, F>[]

  Returns Property<Scalar, F>[]

Abstractserialize

• serialize(options?: FXRSerializeOptions): any

  Parameters

  • Optionaloptions: FXRSerializeOptions

  Returns any

toJSON

• toJSON(): any

  Returns any

AbstractvalueAt

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

  Parameters

  • arg: number

  Returns TypeMap.PropertyValue[T]

withModifiers

• withModifiers(...modifiers: IModifier<T>[]): Property<T, F>

  Parameters

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

  Returns Property<T, F>

StaticfromJSON

• fromJSON<T extends ValueType>(
      obj: any,
  ):
      | Property<any, any>
      | SequenceProperty<T, any>
      | ComponentSequenceProperty<T>
      | ConstantProperty<T>

  Type Parameters

  • T extends ValueType

  Parameters

  • obj: any

  Returns
      | Property<any, any>
      | SequenceProperty<T, any>
      | ComponentSequenceProperty<T>
      | ConstantProperty<T>