Math

Functions

clamp()

clamp(num, min, max): number

Defined in: packages/isaacscript-common/src/functions/math.ts:10

Helper function to normalize a number, ensuring that it is within a certain range.

• If num is less than min, then it will be clamped to min.
• If num is greater than max, then it will be clamped to max.

Parameters

num

number

min

number

max

number

Returns

number

---

getAngleDifference()

getAngleDifference(angle1, angle2): float

Defined in: packages/isaacscript-common/src/functions/math.ts:14

Parameters

angle1

float

angle2

float

Returns

float

---

getCircleDiscretizedPoints()

getCircleDiscretizedPoints(centerPos, radius, numPoints, xMultiplier?, yMultiplier?, initialDirection?): readonly Readonly<Vector>[]

Defined in: packages/isaacscript-common/src/functions/math.ts:31

Helper function to get an array of equidistant points on the circumference around a circle. Useful for equally distributing things in a circle pattern.

Parameters

centerPos

Vector

A position that represents the center of the center to get the points from.

radius

float

The length of the radius of the circle.

numPoints

int

The number of points on the circumference of the circle to get.

xMultiplier?

number = 1

An optional multiplier to get the points around an oval. Default is 1.

yMultiplier?

number = 1

An optional multiplier to get the points around an oval. Default is 1.

initialDirection?

Direction = Direction.UP

By default, the first point on the circle will be on the top center, but this can be optionally changed by specifying this argument.

Returns

readonly Readonly<Vector>[]

---

inRectangle()

inRectangle(position, topLeft, bottomRight): boolean

Defined in: packages/isaacscript-common/src/functions/math.ts:59

Helper function to check if a given position is within a given rectangle.

This is an inclusive check, meaning that it will return true if the position is on the border of the rectangle.

Parameters

position

Vector

topLeft

Vector

bottomRight

Vector

Returns

boolean

---

isCircleIntersectingRectangle()

isCircleIntersectingRectangle(circleCenter, circleRadius, rectangleTopLeft, rectangleBottomRight): boolean

Defined in: packages/isaacscript-common/src/functions/math.ts:75

From: https://www.geeksforgeeks.org/check-if-any-point-overlaps-the-given-circle-and-rectangle/

Parameters

circleCenter

Vector

circleRadius

float

rectangleTopLeft

Vector

rectangleBottomRight

Vector

Returns

boolean

---

isEven()

isEven(num): boolean

Defined in: packages/isaacscript-common/src/functions/math.ts:98

Parameters

num

int

Returns

boolean

---

isOdd()

isOdd(num): boolean

Defined in: packages/isaacscript-common/src/functions/math.ts:103

Parameters

num

int

Returns

boolean

---

lerp()

lerp(a, b, pos): number

Defined in: packages/isaacscript-common/src/functions/math.ts:108

Parameters

a

number

b

number

pos

float

Returns

number

---

lerpAngleDegrees()

lerpAngleDegrees(aStart, aEnd, percent): number

Defined in: packages/isaacscript-common/src/functions/math.ts:112

Parameters

aStart

number

aEnd

number

percent

float

Returns

number

---

round()

round(num, numDecimalPlaces?): float

Defined in: packages/isaacscript-common/src/functions/math.ts:128

If rounding fails, this function returns 0.

From: https://lua-users.org/wiki/SimpleRound

Parameters

num

float

The number to round.

numDecimalPlaces?

number = 0

Optional. Default is 0.

Returns

float

---

sign()

sign(n): int

Defined in: packages/isaacscript-common/src/functions/math.ts:135

Parameters

n

number

Returns

int

1 if n is positive, -1 if n is negative, or 0 if n is 0.

---

splitNumber()

splitNumber(num, size, startAtZero?): readonly readonly [int, int][]

Defined in: packages/isaacscript-common/src/functions/math.ts:163

Breaks a number into chunks of a given size. This is similar to the String.split method, but for a number instead of a string.

For example, splitNumber(90, 25) would return an array with four elements:

• [1, 25]
• [26, 50]
• [51, 75]
• [76, 90]

Parameters

num

int

The number to split into chunks. This must be a positive integer.

size

int

The size of each chunk. This must be a positive integer.

startAtZero?

boolean = false

Whether to start at 0. Defaults to false. If true, the chunks will start at 0 instead of 1.

Returns

readonly readonly [int, int][]

---

tanh()

tanh(x): number

Defined in: packages/isaacscript-common/src/functions/math.ts:192

Parameters

x

number

Returns

number