Class ValueProperty<T>

Type Parameters

T extends Tensor

Hierarchy (View Summary)

Property<T, ValuePropertyFunction>
- ValueProperty
  - ConstantProperty

Implements

IModifiableProperty<T, ValuePropertyFunction>

Index

Constructors

Properties

function modifiers value valueType

Accessors

componentCount fieldCount fields isOne isZero

Methods

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

Constructors

constructor

new ValueProperty<T extends Tensor>(
value: T,
modifiers?: IModifier<T>[],
): ValueProperty<T>
Type Parameters
- T extends Tensor
Parameters
- value: T
- modifiers: IModifier<T>[] = []
Returns ValueProperty<T>
Overrides Property.constructor
- Defined in fxr.ts:33470

Properties

function

function: ValuePropertyFunction

modifiers

modifiers: IModifier<T>[]

value

value: T

valueType

valueType: ValueTypeOfTensor<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:33380

fieldCount

get fieldCount(): number
Returns number
Implementation of IModifiableProperty.fieldCount

Overrides Property.fieldCount
- Defined in fxr.ts:33482

fields

get fields(): NumericalField[]
Returns NumericalField[]
Implementation of IModifiableProperty.fields

Overrides Property.fields
- Defined in fxr.ts:33489

isOne

get isOne(): boolean
Returns boolean
- Defined in fxr.ts:33480

isZero

get isZero(): boolean
Returns boolean
- Defined in fxr.ts:33479

Methods

add

add(summand: number | T): ValueProperty<T>
Parameters
- summand: number | T
Returns ValueProperty<T>
Implementation of IModifiableProperty.add

Overrides Property.add
- Defined in fxr.ts:33562

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

clone

clone(): ValueProperty<T>
Returns ValueProperty<T>
Implementation of IModifiableProperty.clone

Overrides Property.clone
- Defined in fxr.ts:33579

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>
Implementation of IModifiableProperty.for

Inherited from Property.for
- Defined in fxr.ts:33414

max

max(): T
Returns T
Implementation of IModifiableProperty.max

Overrides Property.max
- Defined in fxr.ts:33598

min

min(): T
Returns T
Implementation of IModifiableProperty.min

Overrides Property.min
- Defined in fxr.ts:33594

minify

minify(): ValueProperty<T>
Returns ValueProperty<T>
Implementation of IModifiableProperty.minify

Overrides Property.minify
- Defined in fxr.ts:33602

scale

scale(factor: number | T): ValueProperty<T>
Parameters
- factor: number | T
Returns ValueProperty<T>
Implementation of IModifiableProperty.scale

Overrides Property.scale
- Defined in fxr.ts:33548

separateComponents

separateComponents(): ValueProperty<number>[]
Returns ValueProperty<number>[]
Implementation of IModifiableProperty.separateComponents

Overrides Property.separateComponents
- Defined in fxr.ts:33583

serialize

serialize(options?: FXRSerializeOptions): any
Parameters
- Optionaloptions: FXRSerializeOptions
Returns any
Implementation of IModifiableProperty.serialize

Overrides Property.serialize
- Defined in fxr.ts:33537

toJSON

toJSON(): any
Returns any
Implementation of IModifiableProperty.toJSON

Inherited from Property.toJSON
- Defined in fxr.ts:33447

valueAt

valueAt(arg: number): T
Parameters
- arg: number
Returns T
Implementation of IModifiableProperty.valueAt

Overrides Property.valueAt
- Defined in fxr.ts:33575

withModifiers

withModifiers(...modifiers: IModifier<T>[]): ValueProperty<T>
Parameters
- ...modifiers: IModifier<T>[]
Returns ValueProperty<T>
Inherited from Property.withModifiers
- Defined in fxr.ts:33382

`Static`fromFields

fromFields<T extends Tensor>(
    valueType: ValueTypeOfTensor<T>,
    func: ValuePropertyFunction,
    modifiers: IModifier<T>[],
    fieldValues: number[],
): ValueProperty<T>
Type Parameters
- T extends Tensor
Parameters
- valueType: ValueTypeOfTensor<T>
- func: ValuePropertyFunction
- modifiers: IModifier<T>[]
- fieldValues: number[]
Returns ValueProperty<T>
- Defined in fxr.ts:33499

`Static`fromJSON

fromJSON<T extends Tensor>(
obj: T | { modifiers?: any[]; value: T },
): ValueProperty<T>
Type Parameters
- T extends Tensor
Parameters
- obj: T | { modifiers?: any[]; value: T }
Returns ValueProperty<T>
Overrides Property.fromJSON
- Defined in fxr.ts:33523