Skip to main content
overlayed.siege.readyForGameEvents() must be called before any events will be emitted.

started_queuing

interface StartedQueuingEvent {
	game_mode: string;
	game_type: {
		id: number;
		value: string;
	};
	match_type: string;
}

stopped_queuing

interface StoppedQueuingEvent {
};

match_started

interface MatchStartedEvent {
	game_mode: string;
	game_type: {
		id: number;
		value: string;
	};
	match_type: string;
	match_id: string;
	map: {
		id: number;
		name: {
			id: number;
			value: string;
		};
		time_of_day: {
			id: number;
			value: string;
		};
	};
	is_round_based: boolean;
	current_round_index: number;
	rounds: Array<{
		index: number;
		rounds_until_next_segment: number;
		segment_size: number;
		segment_index: number;
		team_0: {
			role: string;
			state: number;
		};
		team_1: {
			role: string;
			state: number;
		};
	}>;
}

match_ended

interface MatchEndedEvent {
}

map_changed

interface MapChangedEvent {
	map: {
		id: number;
		name: {
			id: number;
			value: string;
		};
		time_of_day: {
			id: number;
			value: string;
		};
	};
}

phase_changed

interface PhaseChangedEvent {
	phase: string;
}

player_joined

interface PlayerJoinedEvent {
	player_id: number;
	username: string;
	profile_id: string;
	is_bot: boolean;
	is_enemy: boolean;
	is_squad_member: boolean;
	is_local_player: boolean;
	side: string;
	team: number;
	is_privacy_username: boolean;
	has_avatar_hidden: boolean;
	has_commend_streak: boolean;
	ping_id: number;
	match_stats: {
		kills: number;
		deaths: number;
		assists: number;
		game_mode_actions: number;
		score: number;
	};
	life_state: string;
	ping: number;
	starting_side: string;
}

player_left

interface PlayerLeftEvent {
	player_id: number;
}

player_ping_id_changed

interface PlayerPingIdChangedEvent {
	player_id: number;
	ping_id: number;
}

player_operator_changed

interface PlayerOperatorChangedEvent {
	player_id: number;
	operator_name: {
		id: number;
		value: string;
	};
}

player_life_state_changed

interface PlayerLifeStateChangedEvent {
	player_id: number;
	life_state: string;
}

player_location_changed

interface PlayerLocationChangedEvent {
	player_id: number;
	location_name: string;
}

player_team_changed

interface PlayerTeamChangedEvent {
	player_id: number;
	team: number;
}

player_side_changed

interface PlayerSideChangedEvent {
	player_id: number;
	side: string;
}

player_ping_updated

interface PlayerPingUpdatedEvent {
	player_id: number;
	ping: number;
}

player_score_changed

interface PlayerScoreChangedEvent {
	player_id: number;
	score: number;
}

player_kills_changed

interface PlayerKillsChangedEvent {
	player_id: number;
	kills: number;
}

player_deaths_changed

interface PlayerDeathsChangedEvent {
	player_id: number;
	deaths: number;
}

player_assists_changed

interface PlayerAssistsChangedEvent {
	player_id: number;
	assists: number;
}

player_game_mode_actions_changed

interface PlayerGameModeActionsChangedEvent {
	player_id: number;
	game_mode_actions: number;
}

player_died

interface PlayerDiedEvent {
	player_id: number;
	instigator_player_id: number;
	headshot: boolean;
}

player_downed

interface PlayerDownedEvent {
	player_id: number;
	instigator_player_id: number;
}

operator_ban_voting_started

interface OperatorBanVotingStartedEvent {
	team: number;
	index: number;
	side: string;
}

operator_banned

interface OperatorBannedEvent {
	team: number;
	index: number;
	side: string;
	operator_name: {
		id: number;
		value: string;
	};
}

operator_ban_cleared

interface OperatorBanClearedEvent {
	team: number;
	index: number;
}

round_ended

interface RoundEndedEvent {
	round_data: {
		index: number;
		rounds_until_next_segment: number;
		segment_size: number;
		segment_index: number;
		team_0: {
			role: string;
			state: number;
		};
		team_1: {
			role: string;
			state: number;
		};
	};
	damage_events: Array<{
		instigator_player_id: number;
		receiver_player_id: number;
		damage_amount: number;
		remaining_health: number;
		pre_damage_health: number;
		max_health: number;
		damage_type: string;
		damage_team_type: string;
		damage_hit_zone: string;
		damage_source_id: number;
		damage_item_id: number;
		damage_item_instance_id: number;
		damage_time: number;
	}>;
	players: Array<{
		player_id: number;
		final_health: number;
		final_life_state: string;
		operator_name: {
			id: number;
			value: string;
		};
	}>;
}

defuser_dropped

interface DefuserDroppedEvent {
	player_id: number;
}

defuser_picked_up

interface DefuserPickedUpEvent {
	player_id: number;
	initial: boolean;
}

defuser_planted

interface DefuserPlantedEvent {
	player_id: number;
}

defuser_sabotaged

interface DefuserSabotagedEvent {
	player_id: number;
}