Math

Math is a highly lightweight utility, served as an addition to Roblox's traditional Math library.

Installation

$3

``
npm i @rbxts/math
`

$3

`
yarn add @rbxts/math
`

$3

`
pnpm add @rbxts/math
`

Math API

$3

`ts
function Map(
number: number,
minimumA: number,
maximumA: number,
minimumB: number,
maximumB: number,
): T;
`

Map the specified number using two ranges.

$3

`ts
function Lerp(minimum: number, maximum: number, alpha: number): T;
`

Interpolate between two specified numbers with a given alpha number.

$3

`ts
function LerpClamp(minimum: number, maximum: number, alpha: number): T;
`

Interpolate between two specified numbers with a given alpha number, which is clamped.

$3

`ts
function InverseClamp(minimum: number, maximum: number, alpha: number): T;
`

Inverse lerp between two specified numbers to return its alpha number.

$3

`ts
function LawOfCosines(numberA: number, numberB: number, numberC: number): T;
`

Solve for the opposite angle from numberC.

$3

`ts
function Round(number: number, precision: number): T;
`

Round the specified number relative to the given precision factor, utilizing math.round.

$3

`ts
function RoundUp(number: number, precision: number): T;
`

Round the specified number relative to the given precision factor, utilizing math.ceil.

$3

`ts
function RoundDown(number: number, precision: number): T;
`

Round the specified number relative to the given precision factor, utilizing math.floor.

$3

`ts
function EulersNumber(): T;
`

Return eulers number.

$3

`ts
function EulersConstant(): T;
`

Return eulers constant.

$3

`ts
function GammaCoefficient(): T;
`

Return the gamma coefficient.

$3

`ts
function GammaQuad(): T;
`

Return the gamma quad.

$3

`ts
function GammaSet(): T;
`

Return the gamma set.

$3

`ts
function E(): T;
`

Return E.

$3

`ts
function Tau(): T;
`

Return tau.

$3

`ts
function AperysConstant(): T;
`

Return apery's constant.

$3

`ts
function BelphegorsPrimeNumber(): T;
`

Return belphegor's prime number.

Example

`ts
// Services
import { Workspace } from "@rbxts/services";

// Modules
import { LerpClamp } from "@rbxts/math";

// Functions
const Part = new Instance("Part");
Part.Name = "Part";
Part.Position = new Vector3(0, 5, 0);
Part.Size = new Vector3(5, 1, 5);
Part.Parent = Workspace;

const partPositionClamped = LerpClamp(Part.Position.X + 1, Part.Position.Y + 1, Part.Position.Z + 1);

print(partPositionClamped);
``