v2025.6.2
All Bundles

FloatRef

Holds a float

Operations

Add

Adds to value

method : public : Add(value:Float) ~ Nil

Parameters

NameTypeDescription
valueFloatvalue to add to

Clone

Clones the object instance

method : public : Clone() ~ System.FloatRef

Return

TypeDescription
FloatRefcloned the object instance

Compare

Compares two objects

method : public : native : Compare(rhs:System.Compare) ~ Int

Parameters

NameTypeDescription
rhsComparecompare object

Return

TypeDescription
Int0 if equal, -1 if right-hand side i greater, 1 if left-hand side is greater

Div

Divide by value

method : public : Div(value:Float) ~ Nil

Parameters

NameTypeDescription
valueFloatvalue to divide by

FromArray

Creates an array of references from primitives

function : FromArray(input:Float[]) ~ FloatRef[]

Parameters

NameTypeDescription
inputFloatarray of primitives

Return

TypeDescription
FloatRefan array of references

Get

Get value

method : public : Get() ~ Float

Return

TypeDescription
Floatvalue

HashID

Returns a unique hash ID for a float

method : public : HashID() ~ Int

Return

TypeDescription
Inthash ID

Mul

Multiply to value

method : public : Mul(value:Float) ~ Nil

Parameters

NameTypeDescription
valueFloatvalue to multiply by

New

Default constructor

New()

New

Copy constructor

New(value:Float)

Parameters

NameTypeDescription
valueFloatfloat value

Set

Set value

method : public : Set(value:Float) ~ Nil

Parameters

NameTypeDescription
valueFloatfloat value

Sub

Subtract from value

method : public : Sub(value:Float) ~ Nil

Parameters

NameTypeDescription
valueFloatvalue to subtract by

ToArray

Creates an array of primitives from references

function : ToArray(input:FloatRef[]) ~ Float[]

Parameters

NameTypeDescription
inputFloatRefarray of references

Return

TypeDescription
Floatan array of primitives