Skip to content

sdk.session

Credential-free session recovery. The native layer invokes Tibia's official retained-credential reconnect slot. This module adds an opt-in retry policy; it never accepts account, password, authenticator, session-key, character, or packet parameters.

lua
local M = require("sdk.session")

state

function · state(): GameSessionStatus?, ErrorMessage?

Return a sanitized snapshot of the official login/game-session state.

Returns

TypeSummary
GameSessionStatus|nilstate
string|nilerr

status

alias · status(): GameSessionStatus?, ErrorMessage?

Same as state.

Alias

Same as state.

Returns

TypeSummary
GameSessionStatus?, ErrorMessage?

reconnect

function · reconnect(): Result?, string?

Queue the official retained-credential reconnect action. Success means accepted/queued locally; wait for WorldEntered or in_world.

Returns

TypeSummary
boolean|nilok
string|nilstatus_or_error

start

function · start(options)

Enable opt-in automatic recovery after this process has observed a real in-world session. Calling start at the login screen never auto-logs in.

Parameters

NameTypeSummary
options?AutoReconnectOptions

Returns

TypeSummary
boolean|nilok
string|nilerr

stop

function · stop(): boolean

Disable automatic reconnect and release its tick subscription.

Returns

TypeSummary
boolean

resume

function · resume(): Result?, ErrorMessage?

Acknowledge the current LoginError and permit another bounded attempt.

Returns

TypeSummary
boolean|nilok
string|nilerr

auto_state

function · auto_state(): AutoReconnectStatus

Return policy diagnostics without any native pointers or account material.

Returns

TypeSummary
AutoReconnectStatus

enable_auto_reconnect

alias · enable_auto_reconnect(options?: AutoReconnectOptions): Result?, ErrorMessage?

Same as start.

Alias

Same as start.

Parameters

NameTypeSummary
optionsAutoReconnectOptions

Returns

TypeSummary
Result?, ErrorMessage?

disable_auto_reconnect

alias · disable_auto_reconnect(): boolean

Same as stop.

Alias

Same as stop.

Returns

TypeSummary
boolean

Arcane SDK catalog generated from scripts/sdk