> ## Documentation Index > Fetch the complete documentation index at: https://docs.overlayed.gg/llms.txt > Use this file to discover all available pages before exploring further. > All of the game events emitted by Sand Raiders of Sophie. # Sand Raiders of Sophie `overlayed.sand.readyForGameEvents()` must be called before any events will be emitted. Each event is marked with its retention — see [Retained vs transient](/games/introduction#retained-vs-transient). ### logged\_in Retained Menu `account_id` and `player_joined.player_id` are different ids and never match. Use `platform_id` to tie the logged-in account to an in-match player. ```ts type.ts theme={null} interface LoggedInEvent { account_id: string; display_name: string; platform_id: string; playfab_id: string; } ``` ```json example.json theme={null} { "account_id": "1717066", "display_name": "GhettoAmmo", "platform_id": "76561198996870832", "playfab_id": "A77C293DA30BEDDE" } ``` ### game\_state\_changed Retained Menu The expedition status. `menu` means no expedition is active. ```ts type.ts theme={null} interface GameStateChangedEvent { state: | "menu" | "waiting_for_players" | "matchmaking" | "match_found" | "in_progress" | "loot_division" | "extracted" | "all_left" | "aborted" | "failed" | "decayed" | "invalid"; } ``` ```json example.json theme={null} { "state": "in_progress" } ``` ### party\_changed Retained Menu ```ts type.ts theme={null} interface PartyChangedEvent { join_code: string; } ``` ```json example.json theme={null} { "join_code": "K7QP2M" } ``` ### party\_member\_joined Retained Menu Key: account\_id One per party member, including the local player. `display_name` can arrive empty; a later event for the same `account_id` fills it in. ```ts type.ts theme={null} interface PartyMemberJoinedEvent { account_id: string; display_name: string; platform_id: string; playfab_id: string; character_id: number; is_captain: boolean; } ``` ```json example.json theme={null} { "account_id": "1717066", "display_name": "GhettoAmmo", "platform_id": "76561198996870832", "playfab_id": "A77C293DA30BEDDE", "character_id": 88421, "is_captain": true } ``` ### party\_member\_left Transient Releases: party\_member\_joined ```ts type.ts theme={null} interface PartyMemberLeftEvent { account_id: string; } ``` ```json example.json theme={null} { "account_id": "1717066" } ``` ### storage\_changed Retained Menu A full storage snapshot. `crowns`, `mechanical_parts`, `pneumatic_parts`, and `computing_modules` are totals for items that also appear in `items` — adding them to the `items` total double-counts. ```ts type.ts theme={null} interface StorageChangedEvent { slots_used: number; slots_total: number; crowns: number; mechanical_parts: number; pneumatic_parts: number; computing_modules: number; items: Array<{ definition: string; amount: number; }>; } ``` ```json example.json theme={null} { "slots_used": 12, "slots_total": 40, "crowns": 2500, "mechanical_parts": 8, "pneumatic_parts": 3, "computing_modules": 1, "items": [ { "definition": "item_coinCrown", "amount": 2500 }, { "definition": "item_resourceMetal_t1", "amount": 8 } ] } ``` ### storage\_item\_changed Transient ```ts type.ts theme={null} interface StorageItemChangedEvent { definition: string; amount: number; delta: number; } ``` ```json example.json theme={null} { "definition": "item_coinCrown", "amount": 2500, "delta": 500 } ``` ### tech\_tree\_changed Retained Menu `is_available` means researchable right now, so an already-unlocked node reports it `false`. ```ts type.ts theme={null} interface TechTreeChangedEvent { unlocked: number; total: number; nodes: Array<{ id: string; name: string; tier: number; is_unlocked: boolean; is_available: boolean; }>; } ``` ```json example.json theme={null} { "unlocked": 2, "total": 3, "nodes": [ { "id": "8f14e45f-ceea-467a-9575-0d1e1b0b2c33", "name": "Cannon T4", "tier": 3, "is_unlocked": true, "is_available": false }, { "id": "c4ca4238-a0b9-2382-0dcc-509a6f75849b", "name": "Hull T2", "tier": 1, "is_unlocked": false, "is_available": true } ] } ``` ### tech\_tree\_item\_unlocked Transient ```ts type.ts theme={null} interface TechTreeItemUnlockedEvent { id: string; name: string; tier: number; } ``` ```json example.json theme={null} { "id": "8f14e45f-ceea-467a-9575-0d1e1b0b2c33", "name": "Cannon T4", "tier": 3 } ``` ### walker\_changed Retained Menu The walker the account has built. `walker_id` matches `trampler_acquired.master_server_id`. ```ts type.ts theme={null} interface WalkerChangedEvent { walker_id: number; blueprint_unique_id: string; blueprint_file: string; first_name_index: number; second_name_index: number; } ``` ```json example.json theme={null} { "walker_id": 4471, "blueprint_unique_id": "b1d9e0f2-3c44-4a8e-9f21-77c0a5d6e881", "blueprint_file": "Dune Runner", "first_name_index": 12, "second_name_index": 3 } ``` ### match\_started Retained Match `server_start_time` is when the match began, not when you joined it. ```ts type.ts theme={null} interface MatchStartedEvent { match_id: number; game_mode: "storm_dive" | "voyage" | "invalid"; seed: number; server_start_time: number; world_bounds: { min_x: number; min_z: number; max_x: number; max_z: number; }; landmarks: Array<{ id: string; name: string; position: { x: number; y: number; z: number; }; }>; } ``` ```json example.json theme={null} { "match_id": 9001, "game_mode": "storm_dive", "seed": 12345, "server_start_time": 1700000000000, "world_bounds": { "min_x": -4096, "min_z": -4096, "max_x": 4096, "max_z": 4096 }, "landmarks": [ { "id": "fort_alpha", "name": "Fort Alpha", "position": { "x": 1024.5, "y": 62, "z": -337.25 } } ] } ``` ### match\_ended Transient Releases: all match-level events ```ts type.ts theme={null} interface MatchEndedEvent { } ``` ```json example.json theme={null} {} ``` ### world\_time\_changed Retained Match ```ts type.ts theme={null} interface WorldTimeChangedEvent { hour: number; } ``` ```json example.json theme={null} { "hour": 13 } ``` ### player\_joined Retained Match Key: platform\_id One per player on the player list, which keeps players after they disconnect — there is no leave event. `player_id` never equals `logged_in.account_id`; correlate on `platform_id`. ```ts type.ts theme={null} interface PlayerJoinedEvent { player_id: number; username: string; platform_id: string; playfab_id: string; } ``` ```json example.json theme={null} { "player_id": 1717066, "username": "GhettoAmmo", "platform_id": "76561198996870832", "playfab_id": "A77C293DA30BEDDE" } ``` ### extraction\_added Retained Match Key: extraction\_id Extractions can arrive throughout the match, not all at `match_started`. ```ts type.ts theme={null} interface ExtractionAddedEvent { extraction_id: number; radius: number; position: { x: number; y: number; z: number; }; } ``` ```json example.json theme={null} { "extraction_id": 3, "radius": 25.5, "position": { "x": 1024.5, "y": 62, "z": -337.25 } } ``` ### extraction\_removed Transient Releases: extraction\_added ```ts type.ts theme={null} interface ExtractionRemovedEvent { extraction_id: number; } ``` ```json example.json theme={null} { "extraction_id": 3 } ``` ### storm\_changed Retained Match Emitted on stage and state transitions only. ```ts type.ts theme={null} interface StormChangedEvent { stage: number; total_stages: number; state: "idle" | "delay" | "moving" | "invalid"; end_time: number; radius: number; center: { x: number; y: number; z: number; }; next_radius: number; next_center: { x: number; y: number; z: number; }; } ``` ```json example.json theme={null} { "stage": 1, "total_stages": 6, "state": "moving", "end_time": 1700000060000, "radius": 500, "center": { "x": 0, "y": 62, "z": 0 }, "next_radius": 250, "next_center": { "x": 128.5, "y": 62, "z": -64.25 } } ``` ### inventory\_changed Retained Match Key: player\_id What a player is carrying right now, one event per party member. Only the local player and their party are reported. `player_id` matches `player_joined.player_id`, not `logged_in.account_id`, which is the master server's id and a string. Slots 0-15 are the fixed ones — 0 is the hand, 1 and 2 are weapons, 3 is armor, 4 is the backpack, 5-9 are tools and 10-15 are the belt. Anything higher is a grid slot. Empty slots are omitted, so `slots_used` is the length of `slots`. `amount` is the stack size for a stack but the loaded rounds for a weapon, and `0` for a container the player is holding. What a carried container holds is not reported. ```ts type.ts theme={null} interface InventoryChangedEvent { player_id: number; slots_used: number; slots: Array<{ slot: number; definition: string; amount: number; }>; } ``` ```json example.json theme={null} { "player_id": 1717066, "slots_used": 3, "slots": [ { "slot": 1, "definition": "item_semiAutomaticPistol_decreasedMag", "amount": 5 }, { "slot": 5, "definition": "item_pistolAmmo", "amount": 45 }, { "slot": 6, "definition": "item_energyBar", "amount": 3 } ] } ``` ### inventory\_slot\_changed Transient One slot of one party member changed. A slot that swapped what it holds reports the new stack arriving rather than the old one growing, so `delta` equals `amount` in that case. An emptied slot reports an empty `definition`, an `amount` of `0`, and the negative of what it held. ```ts type.ts theme={null} interface InventorySlotChangedEvent { player_id: number; slot: number; definition: string; amount: number; delta: number; } ``` ```json example.json theme={null} { "player_id": 1717066, "slot": 5, "definition": "item_pistolAmmo", "amount": 45, "delta": 15 } ``` ### inventory\_equipped\_changed Retained Match Key: player\_id What a party member has in their hands. `slot` is the selected slot and `definition` is what sits in it, which is empty when the slot is. A `slot` of `255` means the game has not reported a selection yet. ```ts type.ts theme={null} interface InventoryEquippedChangedEvent { player_id: number; slot: number; definition: string; } ``` ```json example.json theme={null} { "player_id": 1717066, "slot": 1, "definition": "item_semiAutomaticPistol_decreasedMag" } ``` ### trampler\_acquired Retained Match Key: trampler\_id `master_server_id` matches `walker_changed.walker_id` when non-zero. `creator_player_id` is the blueprint's author, not the driver, and matches `player_joined.player_id`. ```ts type.ts theme={null} interface TramplerAcquiredEvent { trampler_id: number; master_server_id: number; blueprint: string; creator_player_id: number; first_name_index: number; second_name_index: number; } ``` ```json example.json theme={null} { "trampler_id": 12, "master_server_id": 4471, "blueprint": "EXPEDITION_WALKER", "creator_player_id": 1717066, "first_name_index": 12, "second_name_index": 3 } ``` ### trampler\_changed Retained Match Key: trampler\_id Emitted about every 10 seconds whether or not the trampler moved — a new event is not proof of motion. ```ts type.ts theme={null} interface TramplerChangedEvent { trampler_id: number; position: { x: number; y: number; z: number; }; yaw: number; speed: number; velocity: { x: number; y: number; z: number; }; } ``` ```json example.json theme={null} { "trampler_id": 12, "position": { "x": 1024.5, "y": 62, "z": -337.25 }, "yaw": 137.5, "speed": 8.25, "velocity": { "x": 8.25, "y": 0, "z": 0 } } ``` ### trampler\_lost Transient Releases: trampler\_acquired, trampler\_changed ```ts type.ts theme={null} interface TramplerLostEvent { trampler_id: number; } ``` ```json example.json theme={null} { "trampler_id": 12 } ```