isaac-lua-definitions/isaac-typescript-definitions/typings/functions.d.ts

22 lines
800 B
TypeScript

declare type PtrHash = number & { __ptrHashBrand: unknown };
declare function Game(this: void): Game;
/**
* Comparing two API objects directly in mod code will not work, even if the Lua metadata points to
* the same pointer in memory. As a workaround, use this function to get a numerical hash of the
* object.
*
* A `PtrHash` object is simply a branded number for better type safety and code clarity.
*/
declare function GetPtrHash(
this: void,
pointer: Entity | RoomDescriptor | RoomDescriptorReadOnly,
): PtrHash;
/** Returns a random integer between 0 and 2^32. */
declare function Random(this: void): int;
/**
* Returns a random vector between (-1, -1) and (1, 1).
* Multiply this vector by a number for larger random vectors.
*/
declare function RandomVector(this: void): Vector;