Number2

A Number2 contains 3 number values (X & Y). It can represent different things in 2D space, like points or positions.

Constructors

Number2 ( number x, number y )

Creates a Number2 with values x and y.

local myNumber2 = Number2(1, 2)

Functions

Number2 Copy ( )

Returns a copy of the Number2.

local n1 = Number2(1, 0, 0)
local n2 = n1 -- n2 is not a copy but a direct reference to n1
n2.X = 10
print(n1.X) -- now n1.X == 10

-- using Copy:
local n1 = Number2(1, 0, 0)
local n2 = n1:Copy() -- n2 is a copy of n1, they're not the same Number2
n2.X = 10
print(n1.X) -- n1.X is still 1
nil Lerp ( Number2 from, Number2 to, number ratio )

Sets this Number2 to the linear interpolation between two given Number2 at a given ratio.

Number2 Normalize ( )

Normalizes the Number2 so that its magnitude becomes 1.0, and return it.

nil Set ( Number2 xy )
nil Set ( number x, number y )

Sets this Number2's components to the given values.

Properties

Number2 Down

Shortcut to unit vector Number2(0, -1).

This is a property of the global Number2, to be called as Number2.Down.

number Height

Same as Y property.

Number2 Left

Shortcut to unit vector Number2(-1, 0).

This is a property of the global Number2, to be called as Number2.Left.

number Length

Magnitude of the Number2.

Number2 One

Shortcut to Number2(1, 1).

This is a property of the global Number2, to be called as Number2.One.

Number2 Right

Shortcut to unit vector Number2(1, 0).

This is a property of the global Number2, to be called as Number2.Right.

number SquaredLength

Squared magnitude of the Number2.

Number2 Up

Shortcut to unit vector Number2(0, 1).

This is a property of the global Number2, to be called as Number2.Up.

number Width

Same as X property.

number X

X value of the Number2.

myNumber2.X = 42
print(myNumber2.X)
number Y

Y value of the Number2.

myNumber2.Y = 42
print(myNumber2.Y)
Number2 Zero

Shortcut to Number2(0, 0).

This is a property of the global Number2, to be called as Number2.Zero.