Caffeine

Sessão

Reference Game Última atualização: Lua 5 · Dryad 5

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.

Todos os namespaces

Namespace: caffeine.session · Dryad prefix: caffeine_session_

set#

Lua: caffeine.session.set · Dryad: caffeine_session_set

text
set(key, value)

Guarda um valor.

ParâmetrosTipoDescrição
keystringNome do valor.
valuenumber | boolean | string | nilO valor a guardar; nil remove a chave.

Devolve: nada

Exemplo

lua
caffeine.session.set("coins", 12)

get#

Lua: caffeine.session.get · Dryad: caffeine_session_get

text
get(key) -> any

Lê um valor.

ParâmetrosTipoDescrição
keystringNome do valor.

Devolve: number | boolean | string | nil. O valor guardado, ou nil quando a chave não existe.

Exemplo

lua
local coins = caffeine.session.get("coins") or 0

has#

Lua: caffeine.session.has · Dryad: caffeine_session_has

text
has(key) -> boolean

Indica se uma chave existe.

ParâmetrosTipoDescrição
keystringNome do valor.

Devolve: boolean. true quando a chave existe.

Exemplo

lua
if caffeine.session.has("checkpoint") then end

remove#

Lua: caffeine.session.remove · Dryad: caffeine_session_remove

text
remove(key) -> boolean

Apaga uma chave.

ParâmetrosTipoDescrição
keystringNome do valor.

Devolve: boolean. true quando a chave existia.

Exemplo

lua
caffeine.session.remove("checkpoint")

clear#

Lua: caffeine.session.clear · Dryad: caffeine_session_clear

text
clear()

Apaga todas as chaves.

Devolve: nada

Exemplo

lua
caffeine.session.clear() -- new game