Skip to content

game.storage ​

Per-script storage. Names are 1..80 ASCII letters/digits/_/-/. and must not be . or ... Payloads are limited to 2 MiB.

Native global — no require.

read ​

function · read(name: string): string?, ErrorMessage?

Per-script storage. Names are 1..80 ASCII letters/digits/_/-/. and must not be . or ... Payloads are limited to 2 MiB.

Parameters

NameTypeSummary
namestring—

Returns

TypeSummary
string?, ErrorMessage?—

write ​

function · write(name: string, data: string): boolean, ErrorMessage?

Returns false, error on failure.

Parameters

NameTypeSummary
namestring—
datastring—

Returns

TypeSummary
boolean, ErrorMessage?—

remove ​

function · remove(name: string): boolean, ErrorMessage?

Returns false, error on failure.

Parameters

NameTypeSummary
namestring—

Returns

TypeSummary
boolean, ErrorMessage?—

path ​

function · path(name: string): string

Empty when the name or host is unavailable.

Parameters

NameTypeSummary
namestring—

Returns

TypeSummary
string—

save_as ​

function · save_as(data: string, name?: string): boolean, ErrorMessage?

Starts a Save dialog on a worker thread. TEST host returns false.

Parameters

NameTypeSummary
datastring—
namestring—

Returns

TypeSummary
boolean, ErrorMessage?—

open_as ​

function · open_as(): boolean, ErrorMessage?

Starts an Open dialog on a worker thread. TEST host returns false.

Returns

TypeSummary
boolean, ErrorMessage?—

dialog ​

function · dialog(): { state: 'idle'|'pending'|'ok'|'cancel'|'error', kind?: 'idle'|'save'|'open', path?: string, data?: string, error?: string }

Consumes a finished dialog.

Returns

TypeSummary
{ state: 'idle'|'pending'|'ok'|'cancel'|'error', kind?: 'idle'|'save'|'open', path?: string, data?: string, error?: string }—

Arcane SDK catalog generated from scripts/sdk