Sessão
Um armazenamento chave-valor que sobrevive às mudanças de cena enquanto o jogo corre (pontuação, definições, escolhas). Os valores são números, booleanos ou texto. Não é gravado em disco.
Namespace: caffeine.session · Dryad prefix: caffeine_session_
set#
Lua: caffeine.session.set · Dryad: caffeine_session_set
set(key, value)
Guarda um valor.
| Parâmetros | Tipo | Descrição |
|---|---|---|
key | string | Nome do valor. |
value | number | boolean | string | nil | O valor a guardar; nil remove a chave. |
Devolve: nada
Exemplo
caffeine.session.set("coins", 12)
get#
Lua: caffeine.session.get · Dryad: caffeine_session_get
get(key) -> any
Lê um valor.
| Parâmetros | Tipo | Descrição |
|---|---|---|
key | string | Nome do valor. |
Devolve: number | boolean | string | nil. O valor guardado, ou nil quando a chave não existe.
Exemplo
local coins = caffeine.session.get("coins") or 0
has#
Lua: caffeine.session.has · Dryad: caffeine_session_has
has(key) -> boolean
Indica se uma chave existe.
| Parâmetros | Tipo | Descrição |
|---|---|---|
key | string | Nome do valor. |
Devolve: boolean. true quando a chave existe.
Exemplo
if caffeine.session.has("checkpoint") then end
remove#
Lua: caffeine.session.remove · Dryad: caffeine_session_remove
remove(key) -> boolean
Apaga uma chave.
| Parâmetros | Tipo | Descrição |
|---|---|---|
key | string | Nome do valor. |
Devolve: boolean. true quando a chave existia.
Exemplo
caffeine.session.remove("checkpoint")
clear#
Lua: caffeine.session.clear · Dryad: caffeine_session_clear
clear()
Apaga todas as chaves.
Devolve: nada
Exemplo
caffeine.session.clear() -- new game