sdkLua module

Import sdk with local sdk = require("sdk"). sdk.version is the installed library version. sdk.entities provides the entities helper, and sdk.ui_sdk provides the ui_sdk helper.

The functions below call the corresponding game functions with the same parameters, results, and limits. See the game reference for full contracts and examples.

Character and worldCopy Anchor Link

sdk.local_position()Copy Anchor Link

Parameters and result: No parameters; {x, y, z} or nil, error.

sdk.local_health_fraction()Copy Anchor Link

Parameters and result: No parameters; health fraction or nil, error.

sdk.local_level()Copy Anchor Link

Parameters and result: No parameters; integer level or nil, error.

sdk.local_name()Copy Anchor Link

Parameters and result: No parameters; UTF-8 name or nil, error.

sdk.local_character_class()Copy Anchor Link

Parameters and result: No parameters; class code or nil, error.

sdk.local_pc_data_id()Copy Anchor Link

Parameters and result: No parameters; character data ID or nil, error.

sdk.local_resource_text()Copy Anchor Link

Parameters and result: No parameters; displayed {health, mana} strings or nil, error.

sdk.local_displayed_resources()Copy Anchor Link

Parameters and result: No parameters; numeric health and mana pairs or nil, error.

sdk.current_level_name()Copy Anchor Link

Parameters and result: No parameters; loaded level name or nil, error.

sdk.current_map_id()Copy Anchor Link

Parameters and result: No parameters; map ID or nil, error.

sdk.current_area_id()Copy Anchor Link

Parameters and result: No parameters; area ID or nil, error.

local sdk = require("sdk")
local level, err = sdk.local_level()
if level then log.info("Level " .. level) else log.warn(err) end

Movement and travelCopy Anchor Link

sdk.clear_target()Copy Anchor Link

Parameters and result: No parameters; true when the clear request is sent, or nil, error.

sdk.request_path(x, y, z)Copy Anchor Link

Parameters and result: Finite world coordinates; true when requested, or nil, error.

sdk.path_destination()Copy Anchor Link

Parameters and result: No parameters; {x, y, z} or nil, error.

sdk.destination_marker()Copy Anchor Link

Parameters and result: No parameters; {id, x, y, z} or nil, error.

sdk.popup_message_text()Copy Anchor Link

Parameters and result: No parameters; visible message text or nil, error.

sdk.is_teleport_unlocked(id)Copy Anchor Link

Parameters and result: Destination ID; true, false, or nil, error.

sdk.unlocked_dungeon_waypoints()Copy Anchor Link

Parameters and result: No parameters; ordered ID array or nil, error.

local marker = sdk.destination_marker()
if marker then
    local ok, err = sdk.request_path(marker.x, marker.y, marker.z)
    if not ok then log.warn(err) end
end

Items, shortcuts, and questsCopy Anchor Link

sdk.use_item(uid)Copy Anchor Link

Parameters and result: Positive item UID; true on accepted request, or nil, error.

sdk.shortcut_press(slot)Copy Anchor Link

Parameters and result: Slot 0–59; true when sent, or nil, error.

sdk.shortcut_release(slot)Copy Anchor Link

Parameters and result: Slot 0–59; true when sent, or nil, error.

sdk.place_skill(skill_id, slot, combo_index)Copy Anchor Link

Parameters and result: Positive skill ID, slot 0–255, combo 0–3; true or nil, error.

sdk.active_quest_ids()Copy Anchor Link

Parameters and result: No parameters; ordered ID array or nil, error.

sdk.available_quest_ids()Copy Anchor Link

Parameters and result: No parameters; ordered ID array or nil, error.

sdk.completed_quest_ids()Copy Anchor Link

Parameters and result: No parameters; ordered ID array or nil, error.

sdk.claim_quest(id)Copy Anchor Link

Parameters and result: Quest ID; true when requested, or nil, error.

sdk.execute_quest(id, track_id)Copy Anchor Link

Parameters and result: Quest and track IDs; true when requested, or nil, error.

sdk.submit_quest(quest_uid, reward_index)Copy Anchor Link

Parameters and result: Active quest UID and reward index; true when requested, or nil, error.

local quests, err = sdk.active_quest_ids()
if quests then
    log.info("Active quests: " .. #quests)
else
    log.warn(err)
end