crash

Performs the same steps as if a crash had just occured but allows the program to continue. The generated dump can be read by crash.load_previous

Crashes occuring before the path is set will be stored to a default engine location.

Parameters

• path: string — file path to use

The crash dump will be removed from disk upon a successful load, so loading is one-shot.

Returns

• handle: number | nil — handle to the loaded dump, or nil if no dump was found

releases a previously loaded crash dump

Parameters

• handle: number — handle to loaded crash dump

Store a user value that will get written to a crash dump when a crash occurs. This can be user id:s, breadcrumb data etc. There are 32 slots indexed from 0. Each slot stores at most 255 characters.

Parameters

• index: number — slot index. 0-indexed
• value: string — string value to store

The function returns a table containing entries with sub-tables that have fields 'name' and 'address' set for all loaded modules.

Parameters

• handle: number — crash dump handle

Returns

• modules: Record<string | number, unknown> — module table

reads user field from a loaded crash dump

Parameters

• handle: number — crash dump handle
• index: number — user data slot index

Returns

• value: string — user data value recorded in the crash dump

reads a system field from a loaded crash dump

Parameters

• handle: number — crash dump handle
• index: number — system field enum. Must be less than crash.SYSFIELD_MAX

Returns

• value: string | nil — value recorded in the crash dump, or nil if it didn't exist

read signal number from a crash report

Parameters

• handle: number — crash dump handle

Returns

• signal: number — signal number

A table is returned containing the addresses of the call stack.

Parameters

• handle: number — crash dump handle

Returns

• backtrace: Record<string | number, unknown> — table containing the backtrace

The format of read text blob is platform specific and not guaranteed but can be useful for manual inspection.

Parameters

• handle: number — crash dump handle

Returns

• blob: string — string with the platform specific data

engine version as release number

engine version as hash

device model as reported by sys.get_sys_info

device manufacturer as reported by sys.get_sys_info

system name as reported by sys.get_sys_info

system version as reported by sys.get_sys_info

system language as reported by sys.get_sys_info

system device language as reported by sys.get_sys_info

system territory as reported by sys.get_sys_info

android build fingerprint

The max number of sysfields.

The max number of user fields.

The max size of a single user field.