cluaupp 1.5.2 → 2.0.0-beta.2

package/api/roblox/luau-builtins.d.luau

@@ -0,0 +1,185 @@
+-- Luau standard library surface used by the Cluaupp checker (the Roblox definitions file only
+-- declares the engine layer). Same syntax as luau-lsp definition files; parsed by
+-- src/api/surface/build.ts. Keep signatures in sync with https://luau.org/library.
+
+declare function print(...: any)
+declare function error(message: any, level: number?): never
+declare function assert<T>(value: T, message: string?): T
+declare function tostring(value: any): string
+declare function tonumber(value: any, base: number?): number?
+declare function typeof(value: any): string
+declare function type(value: any): string
+declare function select(index: any, ...: any): any
+declare function pairs(t: { [any]: any }): any
+declare function ipairs(t: { any }): any
+declare function next(t: { [any]: any }, index: any?): any
+declare function pcall(f: any, ...: any): (boolean, any)
+declare function xpcall(f: any, handler: any, ...: any): (boolean, any)
+declare function require(module: any): any
+declare function setmetatable(t: any, mt: any): any
+declare function getmetatable(t: any): any
+declare function rawget(t: any, k: any): any
+declare function rawset(t: any, k: any, v: any): any
+declare function rawequal(a: any, b: any): boolean
+declare function rawlen(t: any): number
+declare function unpack(t: { any }, i: number?, j: number?): ...any
+declare function newproxy(addMetatable: boolean?): any
+declare function gcinfo(): number
+
+declare math: {
+	pi: number,
+	huge: number,
+	abs: (x: number) -> number,
+	acos: (x: number) -> number,
+	asin: (x: number) -> number,
+	atan: (x: number) -> number,
+	atan2: (y: number, x: number) -> number,
+	ceil: (x: number) -> number,
+	clamp: (x: number, min: number, max: number) -> number,
+	cos: (x: number) -> number,
+	cosh: (x: number) -> number,
+	deg: (x: number) -> number,
+	exp: (x: number) -> number,
+	floor: (x: number) -> number,
+	fmod: (x: number, y: number) -> number,
+	frexp: (x: number) -> (number, number),
+	ldexp: (s: number, e: number) -> number,
+	log: (x: number, base: number?) -> number,
+	log10: (x: number) -> number,
+	map: (x: number, inmin: number, inmax: number, outmin: number, outmax: number) -> number,
+	max: (x: number, ...number) -> number,
+	min: (x: number, ...number) -> number,
+	modf: (x: number) -> (number, number),
+	noise: (x: number, y: number?, z: number?) -> number,
+	pow: (x: number, y: number) -> number,
+	rad: (x: number) -> number,
+	random: (m: number?, n: number?) -> number,
+	randomseed: (seed: number) -> (),
+	round: (x: number) -> number,
+	sign: (x: number) -> number,
+	sin: (x: number) -> number,
+	sinh: (x: number) -> number,
+	sqrt: (x: number) -> number,
+	tan: (x: number) -> number,
+	tanh: (x: number) -> number,
+}
+
+declare string: {
+	byte: (s: string, i: number?, j: number?) -> ...number,
+	char: (...number) -> string,
+	find: (s: string, pattern: string, init: number?, plain: boolean?) -> (number?, number?),
+	format: (format: string, ...any) -> string,
+	gmatch: (s: string, pattern: string) -> any,
+	gsub: (s: string, pattern: string, repl: any, n: number?) -> (string, number),
+	len: (s: string) -> number,
+	lower: (s: string) -> string,
+	match: (s: string, pattern: string, init: number?) -> string?,
+	pack: (format: string, ...any) -> string,
+	packsize: (format: string) -> number,
+	rep: (s: string, n: number, sep: string?) -> string,
+	reverse: (s: string) -> string,
+	split: (s: string, separator: string?) -> { string },
+	sub: (s: string, i: number, j: number?) -> string,
+	unpack: (format: string, s: string, init: number?) -> ...any,
+	upper: (s: string) -> string,
+}
+
+declare table: {
+	clear: (t: { [any]: any }) -> (),
+	clone: <T>(t: T) -> T,
+	concat: (t: { any }, sep: string?, i: number?, j: number?) -> string,
+	create: (count: number, value: any?) -> { any },
+	find: (t: { any }, value: any, init: number?) -> number?,
+	freeze: <T>(t: T) -> T,
+	insert: (t: { any }, ...any) -> (),
+	isfrozen: (t: { [any]: any }) -> boolean,
+	maxn: (t: { any }) -> number,
+	move: (src: { any }, a: number, b: number, t: number, dst: { any }?) -> { any },
+	pack: (...any) -> { [any]: any },
+	remove: (t: { any }, i: number?) -> any,
+	sort: (t: { any }, comp: any?) -> (),
+	unpack: (t: { any }, i: number?, j: number?) -> ...any,
+}
+
+declare coroutine: {
+	close: (co: thread) -> (boolean, any),
+	create: (f: any) -> thread,
+	isyieldable: () -> boolean,
+	resume: (co: thread, ...any) -> (boolean, ...any),
+	running: () -> thread,
+	status: (co: thread) -> string,
+	wrap: (f: any) -> any,
+	yield: (...any) -> ...any,
+}
+
+declare bit32: {
+	arshift: (n: number, i: number) -> number,
+	band: (...number) -> number,
+	bnot: (n: number) -> number,
+	bor: (...number) -> number,
+	btest: (...number) -> boolean,
+	bxor: (...number) -> number,
+	byteswap: (n: number) -> number,
+	countlz: (n: number) -> number,
+	countrz: (n: number) -> number,
+	extract: (n: number, f: number, w: number?) -> number,
+	lrotate: (n: number, i: number) -> number,
+	lshift: (n: number, i: number) -> number,
+	replace: (n: number, r: number, f: number, w: number?) -> number,
+	rrotate: (n: number, i: number) -> number,
+	rshift: (n: number, i: number) -> number,
+}
+
+declare buffer: {
+	create: (size: number) -> buffer,
+	fromstring: (str: string) -> buffer,
+	tostring: (b: buffer) -> string,
+	len: (b: buffer) -> number,
+	copy: (target: buffer, targetOffset: number, source: buffer, sourceOffset: number?, count: number?) -> (),
+	fill: (b: buffer, offset: number, value: number, count: number?) -> (),
+	readi8: (b: buffer, offset: number) -> number,
+	readu8: (b: buffer, offset: number) -> number,
+	readi16: (b: buffer, offset: number) -> number,
+	readu16: (b: buffer, offset: number) -> number,
+	readi32: (b: buffer, offset: number) -> number,
+	readu32: (b: buffer, offset: number) -> number,
+	readf32: (b: buffer, offset: number) -> number,
+	readf64: (b: buffer, offset: number) -> number,
+	writei8: (b: buffer, offset: number, value: number) -> (),
+	writeu8: (b: buffer, offset: number, value: number) -> (),
+	writei16: (b: buffer, offset: number, value: number) -> (),
+	writeu16: (b: buffer, offset: number, value: number) -> (),
+	writei32: (b: buffer, offset: number, value: number) -> (),
+	writeu32: (b: buffer, offset: number, value: number) -> (),
+	writef32: (b: buffer, offset: number, value: number) -> (),
+	writef64: (b: buffer, offset: number, value: number) -> (),
+	readstring: (b: buffer, offset: number, count: number) -> string,
+	writestring: (b: buffer, offset: number, value: string, count: number?) -> (),
+	readbits: (b: buffer, bitOffset: number, bitCount: number) -> number,
+	writebits: (b: buffer, bitOffset: number, bitCount: number, value: number) -> (),
+}
+
+declare os: {
+	clock: () -> number,
+	date: (format: string?, time: number?) -> any,
+	difftime: (t2: number, t1: number?) -> number,
+	time: (time: any?) -> number,
+}
+
+declare vector: {
+	zero: Vector3,
+	one: Vector3,
+	create: (x: number, y: number, z: number) -> Vector3,
+	magnitude: (v: Vector3) -> number,
+	normalize: (v: Vector3) -> Vector3,
+	cross: (a: Vector3, b: Vector3) -> Vector3,
+	dot: (a: Vector3, b: Vector3) -> number,
+	angle: (a: Vector3, b: Vector3, axis: Vector3?) -> number,
+	floor: (v: Vector3) -> Vector3,
+	ceil: (v: Vector3) -> Vector3,
+	abs: (v: Vector3) -> Vector3,
+	sign: (v: Vector3) -> Vector3,
+	clamp: (v: Vector3, min: Vector3, max: Vector3) -> Vector3,
+	max: (v: Vector3, ...Vector3) -> Vector3,
+	min: (v: Vector3, ...Vector3) -> Vector3,
+}