Sand Raiders of Sophie

All of the game events emitted by 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.

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.

type.ts

interface LoggedInEvent {
	account_id: string;
	display_name: string;
	platform_id: string;
	playfab_id: string;
}

game_state_changed

Retained Menu

The expedition status. menu means no expedition is active.

type.ts

interface GameStateChangedEvent {
	state:
		| "menu"
		| "waiting_for_players"
		| "matchmaking"
		| "match_found"
		| "in_progress"
		| "loot_division"
		| "extracted"
		| "all_left"
		| "aborted"
		| "failed"
		| "decayed"
		| "invalid";
}

party_changed

Retained Menu

type.ts

interface PartyChangedEvent {
	join_code: string;
}

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.

type.ts

interface PartyMemberJoinedEvent {
	account_id: string;
	display_name: string;
	platform_id: string;
	playfab_id: string;
	character_id: number;
	is_captain: boolean;
}

party_member_left

Transient Releases: party_member_joined

type.ts

interface PartyMemberLeftEvent {
	account_id: string;
}

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.

type.ts

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;
	}>;
}

storage_item_changed

Transient

type.ts

interface StorageItemChangedEvent {
	definition: string;
	amount: number;
	delta: number;
}

tech_tree_changed

Retained Menu

is_available means researchable right now, so an already-unlocked node reports it false.

type.ts

interface TechTreeChangedEvent {
	unlocked: number;
	total: number;
	nodes: Array<{
		id: string;
		name: string;
		tier: number;
		is_unlocked: boolean;
		is_available: boolean;
	}>;
}

tech_tree_item_unlocked

Transient

type.ts

interface TechTreeItemUnlockedEvent {
	id: string;
	name: string;
	tier: number;
}

walker_changed

Retained Menu

The walker the account has built. walker_id matches trampler_acquired.master_server_id.

type.ts

interface WalkerChangedEvent {
	walker_id: number;
	blueprint_unique_id: string;
	blueprint_file: string;
	first_name_index: number;
	second_name_index: number;
}

match_started

Retained Match

server_start_time is when the match began, not when you joined it.

type.ts

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;
		};
	}>;
}

match_ended

Transient Releases: all match-level events

type.ts

interface MatchEndedEvent {
}

world_time_changed

Retained Match

type.ts

interface WorldTimeChangedEvent {
	hour: number;
}

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.

type.ts

interface PlayerJoinedEvent {
	player_id: number;
	username: string;
	platform_id: string;
	playfab_id: string;
}

extraction_added

Retained Match Key: extraction_id

Extractions can arrive throughout the match, not all at match_started.

type.ts

interface ExtractionAddedEvent {
	extraction_id: number;
	radius: number;
	position: {
		x: number;
		y: number;
		z: number;
	};
}

extraction_removed

Transient Releases: extraction_added

type.ts

interface ExtractionRemovedEvent {
	extraction_id: number;
}

storm_changed

Retained Match

Emitted on stage and state transitions only.

type.ts

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;
	};
}

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.

type.ts

interface InventoryChangedEvent {
	player_id: number;
	slots_used: number;
	slots: Array<{
		slot: number;
		definition: string;
		amount: number;
	}>;
}

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.

type.ts

interface InventorySlotChangedEvent {
	player_id: number;
	slot: number;
	definition: string;
	amount: number;
	delta: number;
}

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.

type.ts

interface InventoryEquippedChangedEvent {
	player_id: number;
	slot: number;
	definition: string;
}

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.

type.ts

interface TramplerAcquiredEvent {
	trampler_id: number;
	master_server_id: number;
	blueprint: string;
	creator_player_id: number;
	first_name_index: number;
	second_name_index: number;
}

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.

type.ts

interface TramplerChangedEvent {
	trampler_id: number;
	position: {
		x: number;
		y: number;
		z: number;
	};
	yaw: number;
	speed: number;
	velocity: {
		x: number;
		y: number;
		z: number;
	};
}

trampler_lost

Transient Releases: trampler_acquired, trampler_changed

type.ts

interface TramplerLostEvent {
	trampler_id: number;
}