Class ValueProperty<T>

Type Parameters

T extends ValueType

Hierarchy (View Summary, Expand)

Property<T, ValuePropertyFunction>
- ValueProperty
  - ConstantProperty

Implements

IModifiableProperty<T, ValuePropertyFunction>

Index

Constructors

constructor

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

Properties

function

function: ValuePropertyFunction

modifiers

modifiers: IModifier<T>[]

value

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

fieldCount

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

fields

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

isOne

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

isZero

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

Methods

add

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

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(): ValueProperty<T>
Returns ValueProperty<T>
Implementation of IModifiableProperty.clone
Overrides Property.clone
- Defined in fxr.ts:32473

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

max

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

min

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

minify

minify(): ValueProperty<T>
Returns ValueProperty<T>
Implementation of IModifiableProperty.minify
Overrides Property.minify
- Defined in fxr.ts:32496

scale

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

separateComponents

separateComponents(): ValueProperty<Scalar>[]
Returns ValueProperty<Scalar>[]
Implementation of IModifiableProperty.separateComponents
Overrides Property.separateComponents
- Defined in fxr.ts:32477

serialize

serialize(options?: FXRSerializeOptions): any
Parameters
- Optionaloptions: FXRSerializeOptions
Returns any
Implementation of IModifiableProperty.serialize
Overrides Property.serialize
- Defined in fxr.ts:32431

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

withModifiers

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

`Static`fromFields

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>
- Defined in fxr.ts:32393

`Static`fromJSON

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>
Overrides Property.fromJSON
- Defined in fxr.ts:32417

Class ValueProperty<T>

Type Parameters

Hierarchy (View Summary, Expand)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ValueProperty<T>

Properties

function

modifiers

value

valueType

Accessors

componentCount

Returns 1 | 2 | 3 | 4

fieldCount

Returns number

fields

Returns NumericalField[]

isOne

Returns boolean

isZero

Returns boolean

Methods

add

Parameters

Returns ValueProperty<T>

clamp

Parameters

Returns Property<T, PropertyFunction>

clone

Returns ValueProperty<T>

for

Parameters

Returns Property<T, ValuePropertyFunction>

max

Returns TypeMap.PropertyValue[T]

min

Returns TypeMap.PropertyValue[T]

minify

Returns ValueProperty<T>

scale

Parameters

Returns ValueProperty<T>

separateComponents

Returns ValueProperty<Scalar>[]

serialize

Parameters

Returns any

toJSON

Returns any

valueAt

Parameters

Returns TypeMap.PropertyValue[T]

withModifiers

Parameters

Returns ValueProperty<T>

StaticfromFields

Type Parameters

Parameters

Returns ValueProperty<T>

StaticfromJSON

Type Parameters

Parameters

Returns ConstantProperty<T>

Settings

On This Page

`Static`fromFields

`Static`fromJSON