FloatOption

Summary

Constructors

FloatOption()
FloatOption(guid: Guid)

Properties

Name Type
name string
value float
min float
max float
step float

Methods

Method Returns
Clone() FloatOption

Static members

Name Type
FloatOption.typeInfo TypeInformation

Constructors

FloatOption

FloatOption()

Creates a new FloatOption frostbite instance.

FloatOption

FloatOption(guid: Guid)

Creates a new FloatOption frostbite instance and assigns it the provided Guid.

Parameters

Name Type Description
guid Guid The Guid to assign to the newly created instance.

Properties

name

string

value

float

min

float

max

float

step

float

Methods

Clone

Clone(): FloatOption

Creates a shallow-copy clone of this structure, which is essentially the equivalent of creating a new structure of the same type and assigning the values of this structure to all of its properties. Any properties that contain structure types (eg. Vec3) will be cloned when assigning, while properties that contain instance types (eg. DataContainer) will be referencing the same instance.

Returns

Type Description
FloatOption The newly created structure.

Static members

typeInfo

TypeInformation

The type information for the FloatOption type.

Last modified April 26, 2020: Update frostbite type documentation (8b14351)