The live SDK views

context.sdk is the activity view. It is a read-only window into the same data the generated modules come from, bound to the activity that is running now. Use it to look things up at run time. Most missions only need device_channels, device_transitions, squad_modes and atom_kinds from it.

Every value here is re-read on each access. A handle kept across a data change errors with “stale” instead of returning old data.

Collections

Every collection in this page has the same shape:

local slots = context.sdk.slots
for row = 1, slots.count do
    local slot = slots:at(row)
    -- use slot
end

• count is the number of rows.
• at(row) returns row row, counting from 1.
• Some collections also have resolve(name_or_id) or by_id(n).

There is no pairs in the sandbox, so always walk with a number loop like this.

context.sdk members

Identity

Activity binding

These describe how the activity was matched to its scenario. They are for tools, not missions.

Row collections

The squad, scene and slot handles are the same objects context:squad, context:scene and context:slot return. See Lua API reference.

Vocabularies

Deep views

Message rows

context.sdk.activity_messages lists the activity messages the client and host exchange. A script cannot send raw messages. The rows tell you which messages exist and which Lua surface handles them.

A field row has row, global_row, message_row, ordinal, path, name, type, source, struct_offset, struct_offset_abs, type_code, bias, bits, bits_min, bits_max, width_or_count_offset, repeat, nested_handle, owner_handle, depth, flags, presence_bit, coined_name, documented_row, repeated_block, data_only, confidence and exposure, with _code forms for the named enums.

BAP service rows

context.sdk.bap_services lists the outer network services. It is data only. A script can never send one. The collection itself has schema, and the fixed flags query_only = true and script_sendable = false.

A row has row, id, service_id, request_service_id, response_service_id, notification_service_id, service_role, security, response_mode, acceptance_policy, body_shape, response_body_shape, body_exact_bytes, body_prefix_bytes, alternate_body_prefix_bytes, response_body_exact_bytes, typed_payload_limit, body_codec, body_codec_path, response_body_codec, response_body_codec_path, route, route_path, activity_message_envelope, inner_message_namespace, lifecycle_scope, protocol_scope and the size fields complete_encrypted_frame_overhead_bytes and complete_encrypted_frame_max_bytes.

Bounded lanes

Some client lists have a fixed size. A bounded list cannot grow past it.

local lane = context.sdk.bounded_lanes.nav_nodes   -- name, capacity, kind
local list = lane:list()
list:append(7)          -- a count list takes int32 values
local first = list:at(1)

An object reference list takes slot handles in append and returns slot handles from at. No current effect takes these lists yet. They are ready for typed bodies that need them.

The catalog view

context.sdk.catalog is the whole native catalog, not just this activity.

Collections: activities, scenarios, bubbles, states, objects, occurrences, slots, texts, capabilities, gates, refusals, actor_classes, rsat_descriptors, rsat_schemas, rsat_fields, squads, squad_members, squad_anchors, authored_scene_resources, authored_scene_squad_edges, activity_binding_locators.

Every catalog row has row. A text field x also has x_string_offset and x_string_length. A range field x is read as x_first_index and x_count.

Field names come from mission_script_catalog_sdk_bridge.cpp. A 64-bit value is a decimal string. A byte field is lowercase hex.

The manifest view

context.sdk.manifest describes the scenario shards and how activities bind to them.

Every manifest row has row. Field names come from mission_script_manifest_sdk_bridge.cpp.

The world view

context.sdk.world is the generated world of this scenario: every placed object, trigger volume, spatial table and name. It is the best way to find where something is.

Every world row has id, a stable text world/<scenario hex>/<kind>/<row>, and row. A field that points at another row is nil when there is no row. A vector field is a handle with x, y, z, w and count.

Placement and geometry collections

A trigger volume’s vertices and triangles are collections. A vertex has value, a triangle has a, b and c.

A <prefix>_name field is the best known name, or nil. The same prefix also has _name_provenance, _name_provenance_code, _name_candidate_count, _name_source_tag, _name_source_class and _name_strongest_tier_overflow.

Structure collections

The rest are for tools: embedded_placement_links, container_placement_lists, container_placement_owners, container_placement_configs, container_placement_components, type23_placement_links, type23_placement_candidates, static_spatial_tables, static_spatial_owners, trigger_volume_tables, trigger_volume_owners, trigger_volume_incoming_references, trigger_volume_vertices, trigger_volume_triangles, names, tag_names, name_candidates, inline_name_candidates, authored_squad_config_contexts, authored_squad_placement_contexts, authored_squad_point_contexts, authored_squad_point_placement_matches, authored_squad_edge_contexts. Their full field lists are in mission_script_world_sdk_fields.cpp and mission_script_lua_world_rows.cpp.

Example: list the trigger volumes whose box holds a point

The box corners are stored as the package has them. Compare them with a position you read from the same data, for example a squad anchor.

local function volumes_at(context, x, y, z)
    local found = {}
    local volumes = context.sdk.world.trigger_volumes
    for row = 1, volumes.count do
        local volume = volumes:at(row)
        local low, high = volume.minimum, volume.maximum
        if low ~= nil and high ~= nil
            and x >= low.x and x <= high.x
            and y >= low.y and y <= high.y
            and z >= low.z and z <= high.z then
            found[#found + 1] = volume.config_name or volume.id
        end
    end
    return found
end

A walk over a large collection costs instructions. A callback has a budget of five million Lua instructions. Do such searches rarely, and store the answer in a variable.

A script cannot print. To see a result, store it in a variable and read it on the “Mission state” page. See Finding things in game.