Insality/defold-saver/saver.storage
Key-value storage over the Defold saver state: typed number, string, and boolean getters and setters.
- GitHub: Insality/defold-saver — pinned to
10- This repo publishes no stable release. Pick a tag from Insality/defold-saver tags and add its Source code (zip) URL — for the pinned tag,
https://github.com/Insality/defold-saver/archive/refs/tags/10.zip— togame.projectunder[project]dependencies, then Fetch Libraries in the Defold editor. - Run
bunx @defold-typescript/cli resolveto materialize its types. - Import it under a namespace alias of your choice:
import * as storage from "saver.storage"
- This repo publishes no stable release. Pick a tag from Insality/defold-saver tags and add its Source code (zip) URL — for the pinned tag,
Functions
reset_state()get(name: string, default_value?: string | number | boolean | undefined): string | number | boolean | undefinedget_number(name: string, default_value?: number | undefined): numberget_string(name: string, default_value?: string | undefined): stringget_boolean(name: string, default_value?: boolean | undefined): booleanset(id: string, value: string | number | boolean): boolean
reset_state()
get(name: string, default_value?: string | number | boolean | undefined): string | number | boolean | undefined
Get the value from the storage.
Parameters
name:string— The storage field namedefault_value?:string | number | boolean | undefined— The default value
Returns
string | number | boolean | undefined
get_number(name: string, default_value?: number | undefined): number
Get the number from the storage.
Parameters
name:string— The storage field namedefault_value?:number | undefined— The default value. If not set, then it will be 0.
Returns
number
get_string(name: string, default_value?: string | undefined): string
Get the string from the storage.
Parameters
name:string— The storage field namedefault_value?:string | undefined— The default value. If not set, then it will be an empty string.
Returns
string
get_boolean(name: string, default_value?: boolean | undefined): boolean
Get the boolean from the storage.
Parameters
name:string— The storage field namedefault_value?:boolean | undefined— The default value. If not set, then it will befalse.
Returns
boolean
set(id: string, value: string | number | boolean): boolean
Set the value to storage
Parameters
id:string— The record idvalue:string | number | boolean— value
Returns
boolean— @true if the value was set, nil otherwise
Types
saver_state
saver_state.storage: LuaTable<string, unknown>
Table with key-value data
saver_state.version: number
Current save version
saver_state.last_game_version: string
Last game version
saver_state.migration_version: number
Current migration version
saver_game_state
saver_game_state.saver: saver_state
Saver state
saver_game_state.storage: saver_storage_state
Storage state
saver_config
saver_config.save_folder: string | undefined
Save folder name. Default is project name without special characters
saver_config.save_name: string | undefined
Save file name, use ".json" or ".lua" extension to use these formats. Default is "game"
saver_config.saver_key: string | undefined
Saver key, where saver internal data will be stored. Default is "saver"
saver_config.storage_key: string | undefined
Storage key, where storage internal data will be stored. Deprecated. Default is "storage"
saver_config.autosave_timer: number | undefined
Autosave timer in seconds. Default is 3 seconds
saver_config.lua_require_as_string: boolean | undefined
If true, the require() function will load Lua files as strings instead of Lua tables. Default is false
saver_logger
saver_logger.trace: (logger: saver_logger, message: string, data: unknown | undefined) => void
saver_logger.debug: (logger: saver_logger, message: string, data: unknown | undefined) => void
saver_logger.info: (logger: saver_logger, message: string, data: unknown | undefined) => void
saver_logger.warn: (logger: saver_logger, message: string, data: unknown | undefined) => void
saver_logger.error: (logger: saver_logger, message: string, data: unknown | undefined) => void
saver_storage_state
saver_storage_state.storage: LuaTable<string, saver_storage_value>
The storage data