README.md

Utilities

Utilities

Table of contents

Enumerations

• DialogButtons
• DialogPosition
• MouseButton

Classes

• Dialog
• EventDispatcher
• Preload
• Timeout
• Timer

Interfaces

• DialogArgs
• PreloadArgs
• TimeToStringArgs
• TimerArgs
• TimerStartArgs

Type Aliases

• DialogButtonsArg
• FileInfoType
• InternationalizationConfig
• ManifestData
• PreloadData
• PreloadEvent
• SeparatedTime
• UnitDescription
• UpdateElement
• UpdateFormat

Functions

• boxBoxCollision
• calculateAngle
• calculateDistance
• circleCircleCollision
• circlePointCollision
• createEnum
• deepClone
• getObject
• getRandomFloat
• getRandomInt
• getSeveralRandomInts
• isArray
• isBoolean
• isFunction
• isInteger
• isNumber
• isString
• numberOfDigits
• pointBoxCollision
• range
• round
• saveObject
• shuffle
• timeToString
• toDegrees
• toRadians

Type Aliases

DialogButtonsArg

Ƭ DialogButtonsArg: DialogButtons | HTMLElement[]

Defined in

dialog/dialog.ts:13

---

FileInfoType

Ƭ FileInfoType: keyof typeof FileInfo

Defined in

preload/preload.ts:45

---

InternationalizationConfig

Ƭ InternationalizationConfig: Object

Type declaration

Name	Type
day	UnitDescription
hour	UnitDescription
minute	UnitDescription
second	UnitDescription

Defined in

time_to_string/time_to_string.ts:16

---

ManifestData

Ƭ ManifestData: { id: string ; path: string ; type?: FileInfoType }[]

Defined in

preload/preload.ts:8

---

PreloadData

Ƭ PreloadData: Object

Index signature

▪ [id: string]: any

Defined in

preload/preload.ts:4

---

PreloadEvent

Ƭ PreloadEvent: "complete" | "error" | "abort" | "progress" | "fileload"

Defined in

preload/preload.ts:14

---

SeparatedTime

Ƭ SeparatedTime: Object

Type declaration

Name	Type
days	number
hours	number
minutes	number
seconds	number

Defined in

time_to_string/time_to_string.ts:4

---

UnitDescription

Ƭ UnitDescription: Object

Type declaration

Name	Type
plural	string
single	string

Defined in

time_to_string/time_to_string.ts:11

---

UpdateElement

Ƭ UpdateElement: Object

Type declaration

Name	Type
element	HTMLElement
format?	UpdateFormat

Defined in

timer/timer.ts:11

---

UpdateFormat

Ƭ UpdateFormat: Omit<TimeToStringArgs, "time"> | (timer: Timer) => string

Defined in

timer/timer.ts:7

Functions

boxBoxCollision

▸ boxBoxCollision(oneX, oneY, oneWidth, oneHeight, twoX, twoY, twoWidth, twoHeight): boolean

Detects collision between 2 boxes.

Parameters

Name	Type
oneX	number
oneY	number
oneWidth	number
oneHeight	number
twoX	number
twoY	number
twoWidth	number
twoHeight	number

Returns

boolean

Defined in

collision_detection/collision_detection.ts:4

---

calculateAngle

▸ calculateAngle(aX, aY, bX, bY): number

Returns the angle between 2 points in radians. Positive in clockwise direction.

Parameters

Name	Type
aX	number
aY	number
bX	number
bY	number

Returns

number

Defined in

trigonometry/trigonometry.ts:5

---

calculateDistance

▸ calculateDistance(aX, aY, bX, bY): number

Distance between 2 points.

Parameters

Name	Type
aX	number
aY	number
bX	number
bY	number

Returns

number

Defined in

trigonometry/trigonometry.ts:17

---

circleCircleCollision

▸ circleCircleCollision(x1, y1, radius1, x2, y2, radius2): boolean

Detects collision between two circles.

Parameters

Name	Type
x1	number
y1	number
radius1	number
x2	number
y2	number
radius2	number

Returns

boolean

Defined in

collision_detection/collision_detection.ts:25

---

circlePointCollision

▸ circlePointCollision(circleX, circleY, circleRadius, pointX, pointY): boolean

Detects collision between a circle and a point.

Parameters

Name	Type
circleX	number
circleY	number
circleRadius	number
pointX	number
pointY	number

Returns

boolean

Defined in

collision_detection/collision_detection.ts:49

---

createEnum

▸ createEnum(values, start?): Object

Enum - A way to associate a string name to a number.

Parameters

Name	Type	Description
values	string[]	The enum names. Each name will have an associated number.
start?	number	Starting number for the first name. The number is incremented by one for the next name.

Returns

Object

Defined in

object/object.ts:16

---

deepClone

▸ deepClone(obj): any

Returns a deep clone/copy of the object.

Parameters

Name	Type
obj	any

Returns

any

Defined in

object/object.ts:6

---

getObject

▸ getObject(key): any

Returns an object that was obtained by parsing (with json) some data that was saved on localStorage.

Parameters

Name	Type
key	string

Returns

any

Defined in

local_storage/local_storage.ts:4

---

getRandomFloat

▸ getRandomFloat(min, max): number

Returns a random float number between min and max (inclusive).

Parameters

Name	Type
min	number
max	number

Returns

number

Defined in

number/number.ts:6

---

getRandomInt

▸ getRandomInt(min, max): number

Returns a random integer number between min and max (inclusive).

Parameters

Name	Type
min	number
max	number

Returns

number

Defined in

number/number.ts:17

---

getSeveralRandomInts

▸ getSeveralRandomInts(min, max, howMany): number[]

Returns several different random integers, in the range between min and max (inclusive).

Parameters

Name	Type
min	number
max	number
howMany	number

Returns

number[]

Defined in

number/number.ts:28

---

isArray

▸ isArray(element): boolean

Parameters

Name	Type
element	any

Returns

boolean

If it is an array or not.

Defined in

is_type/is_type.ts:4

---

isBoolean

▸ isBoolean(element): element is boolean

Parameters

Name	Type
element	any

Returns

element is boolean

If it is a boolean.

Defined in

is_type/is_type.ts:11

---

isFunction

▸ isFunction(element): element is Function

Parameters

Name	Type
element	any

Returns

element is Function

If it is a function.

Defined in

is_type/is_type.ts:23

---

isInteger

▸ isInteger(value): value is number

Parameters

Name	Type
value	any

Returns

value is number

If it is an integer.

Defined in

is_type/is_type.ts:33

---

isNumber

▸ isNumber(element): element is number

Parameters

Name	Type
element	any

Returns

element is number

If it is a number.

Defined in

is_type/is_type.ts:40

---

isString

▸ isString(element): element is string

Parameters

Name	Type
element	any

Returns

element is string

If it is a string.

Defined in

is_type/is_type.ts:51

---

numberOfDigits

▸ numberOfDigits(theNumber): number

Returns the number of digits in a number. It doesn't consider the minus signal, nor the dot (in floats) as a digit.

Parameters

Name	Type
theNumber	number

Returns

number

Defined in

number/number.ts:65

---

pointBoxCollision

▸ pointBoxCollision(pointX, pointY, boxX, boxY, boxWidth, boxHeight): boolean

Detects collision between a point and a box.

Parameters

Name	Type
pointX	number
pointY	number
boxX	number
boxY	number
boxWidth	number
boxHeight	number

Returns

boolean

Defined in

collision_detection/collision_detection.ts:72

---

range

▸ range(start, end): number[]

Create an array with all the numbers in-between the 'start' and 'end' (inclusive).

Parameters

Name	Type
start	number
end	number

Returns

number[]

Defined in

number/number.ts:89

---

round

▸ round(num, dec): number

Rounds a number to a specified decimal case.

Parameters

Name	Type
num	number
dec	number

Returns

number

Defined in

number/number.ts:78

---

saveObject

▸ saveObject(key, value): void

Saves in the localStorage a json string representation of the value.

Parameters

Name	Type
key	string
value	any

Returns

void

Defined in

local_storage/local_storage.ts:13

---

shuffle

▸ shuffle(array): any[]

Shuffle an array.

Parameters

Name	Type
array	any[]

Returns

any[]

Defined in

array/array.ts:4

---

timeToString

▸ timeToString(args): string

Converts a time (in milliseconds) to a string (with the number of days/hours...). The units available are: day/hour/minute/second.

There's 4 possible display formats.

• daytime: dd hh:mm:ss or hh:mm:ss (where d=day, h=hour, m=minute, s=second)

• partial_daytime: ss, mm:ss, hh:mm:ss or "dd hh:mm:ss", depending on the time value.

• string: (d) days (h) hours (m) minutes (s) seconds

• short_string: (d)d (h)h (m)m (s)s

The number of units can limit the number of units shown in the string/short_string formats (days/hours, or hours/minutes or minutes/seconds, and not days/hours/minutes for example (for a units with value 2)).

The display string can be internationalized with the internationalization argument (when using the string or short_string).

Defaults: units: undefined (shows all non-zero if format is type string or short_string) format: string

Parameters

Name	Type
args	TimeToStringArgs

Returns

string

Defined in

time_to_string/time_to_string.ts:75

---

toDegrees

▸ toDegrees(radians): number

Converts a number in radians to degrees and returns it.

Parameters

Name	Type
radians	number

Returns

number

Defined in

trigonometry/trigonometry.ts:32

---

toRadians

▸ toRadians(degrees): number

Converts a number in degrees to radians and returns it.

Parameters

Name	Type
degrees	number

Returns

number

Defined in

trigonometry/trigonometry.ts:39