> ## 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 Rainbow Six Siege.

# Tom Clancy's Rainbow Six® Siege

<Info>`overlayed.siege.readyForGameEvents()` must be called before any events will be emitted.</Info>

### started\_queuing

<CodeGroup>
  ```ts type.ts theme={null}
  interface StartedQueuingEvent {
  	game_mode: string;
  	game_type: {
  		id: number;
  		value: string;
  	};
  	match_type: string;
  }
  ```

  ```json example.json theme={null}
  {
  	"game_mode": "Unknown",
  	"game_type": {
  		"id": 138115,
  		"value": ""
  	},
  	"match_type": "QUICK PLAY"
  }
  ```
</CodeGroup>

### stopped\_queuing

<CodeGroup>
  ```ts type.ts theme={null}
  interface StoppedQueuingEvent {
  };
  ```

  ```json example.json theme={null}
  {}
  ```
</CodeGroup>

### match\_started

<CodeGroup>
  ```ts type.ts theme={null}
  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;
  		};
  	}>;
  }
  ```

  ```json example.json theme={null}
  {
  	"game_mode": "HOSTAGE",
  	"game_type": {
  		"id": 138115,
  		"value": ""
  	},
  	"match_type": "QUICK PLAY",
  	"match_id": "6a8e725c-e563-4d3d-a4a4-4b03f6da0d8b",
  	"map": {
  		"id": 0,
  		"name": {
  			"id": 208094,
  			"value": ""
  		},
  		"time_of_day": {
  			"id": 177839,
  			"value": ""
  		}
  	},
  	"is_round_based": true,
  	"current_round_index": 0,
  	"rounds": [
  		{
  			"index": 0,
  			"rounds_until_next_segment": 1,
  			"segment_size": 2,
  			"segment_index": 0,
  			"team_0": {
  				"role": "attacker",
  				"state": 0
  			},
  			"team_1": {
  				"role": "defender",
  				"state": 0
  			}
  		},
  		{
  			"index": 1,
  			"rounds_until_next_segment": 0,
  			"segment_size": 2,
  			"segment_index": 0,
  			"team_0": {
  				"role": "attacker",
  				"state": 0
  			},
  			"team_1": {
  				"role": "defender",
  				"state": 0
  			}
  		},
  		{
  			"index": 2,
  			"rounds_until_next_segment": 1,
  			"segment_size": 2,
  			"segment_index": 1,
  			"team_0": {
  				"role": "defender",
  				"state": 0
  			},
  			"team_1": {
  				"role": "attacker",
  				"state": 0
  			}
  		},
  		{
  			"index": 3,
  			"rounds_until_next_segment": 0,
  			"segment_size": 2,
  			"segment_index": 1,
  			"team_0": {
  				"role": "defender",
  				"state": 0
  			},
  			"team_1": {
  				"role": "attacker",
  				"state": 0
  			}
  		},
  		{
  			"index": 4,
  			"rounds_until_next_segment": 0,
  			"segment_size": 1,
  			"segment_index": 2,
  			"team_0": {
  				"role": "invalid",
  				"state": 0
  			},
  			"team_1": {
  				"role": "invalid",
  				"state": 0
  			}
  		}
  	]
  }
  ```
</CodeGroup>

### match\_ended

<CodeGroup>
  ```ts type.ts theme={null}
  interface MatchEndedEvent {
  }
  ```

  ```json example.json theme={null}
  {}
  ```
</CodeGroup>

### map\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface MapChangedEvent {
  	map: {
  		id: number;
  		name: {
  			id: number;
  			value: string;
  		};
  		time_of_day: {
  			id: number;
  			value: string;
  		};
  	};
  }
  ```

  ```json example.json theme={null}
  {
  	"map": {
  		"id": 0,
  		"name": {
  			"id": 208094,
  			"value": ""
  		},
  		"time_of_day": {
  			"id": 177839,
  			"value": ""
  		}
  	}
  }
  ```
</CodeGroup>

### phase\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PhaseChangedEvent {
  	phase: string;
  }
  ```

  ```json example.json theme={null}
  {
  	"phase": "intro"
  }
  ```
</CodeGroup>

### player\_joined

<CodeGroup>
  ```ts type.ts theme={null}
  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;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"username": "KingGeorge",
  	"profile_id": "f67508fb-fd32-414e-8c8c-e1dff7b2eb92",
  	"is_bot": false,
  	"is_enemy": false,
  	"is_squad_member": false,
  	"is_local_player": true,
  	"side": "attacker",
  	"team": 0,
  	"is_privacy_username": false,
  	"has_avatar_hidden": false,
  	"has_commend_streak": true,
  	"ping_id": 0,
  	"match_stats": {
  		"kills": 0,
  		"deaths": 0,
  		"assists": 0,
  		"game_mode_actions": 0,
  		"score": 0
  	},
  	"life_state": "dead",
  	"ping": 0,
  	"starting_side": "attacker"
  }
  ```
</CodeGroup>

### player\_left

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerLeftEvent {
  	player_id: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1
  }
  ```
</CodeGroup>

### player\_ping\_id\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerPingIdChangedEvent {
  	player_id: number;
  	ping_id: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"ping_id": 5
  }
  ```
</CodeGroup>

### player\_operator\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerOperatorChangedEvent {
  	player_id: number;
  	operator_name: {
  		id: number;
  		value: string;
  	};
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"operator_name": {
  		"id": 282399,
  		"value": ""
  	}
  }
  ```
</CodeGroup>

### player\_life\_state\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerLifeStateChangedEvent {
  	player_id: number;
  	life_state: string;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"life_state": "low_health"
  }
  ```
</CodeGroup>

### player\_location\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerLocationChangedEvent {
  	player_id: number;
  	location_name: string;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"location_name": "1F BBQ"
  }
  ```
</CodeGroup>

### player\_team\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerTeamChangedEvent {
  	player_id: number;
  	team: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"team": 0
  }
  ```
</CodeGroup>

### player\_side\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerSideChangedEvent {
  	player_id: number;
  	side: string;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"side": "attacker"
  }
  ```
</CodeGroup>

### player\_ping\_updated

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerPingUpdatedEvent {
  	player_id: number;
  	ping: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"ping": 36
  }
  ```
</CodeGroup>

### player\_score\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerScoreChangedEvent {
  	player_id: number;
  	score: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"score": 120
  }
  ```
</CodeGroup>

### player\_kills\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerKillsChangedEvent {
  	player_id: number;
  	kills: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"kills": 8
  }
  ```
</CodeGroup>

### player\_deaths\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerDeathsChangedEvent {
  	player_id: number;
  	deaths: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"deaths": 2
  }
  ```
</CodeGroup>

### player\_assists\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerAssistsChangedEvent {
  	player_id: number;
  	assists: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"assists": 4
  }
  ```
</CodeGroup>

### player\_game\_mode\_actions\_changed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerGameModeActionsChangedEvent {
  	player_id: number;
  	game_mode_actions: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"game_mode_actions": 2
  }
  ```
</CodeGroup>

### player\_died

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerDiedEvent {
  	player_id: number;
  	instigator_player_id: number;
  	headshot: boolean;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"instigator_player_id": 6
  }
  ```
</CodeGroup>

### player\_downed

<CodeGroup>
  ```ts type.ts theme={null}
  interface PlayerDownedEvent {
  	player_id: number;
  	instigator_player_id: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"instigator_player_id": 6
  }
  ```
</CodeGroup>

### operator\_ban\_voting\_started

<CodeGroup>
  ```ts type.ts theme={null}
  interface OperatorBanVotingStartedEvent {
  	team: number;
  	index: number;
  	side: string;
  }
  ```

  ```json example.json theme={null}
  {
  	"team": 0,
  	"index": 0,
  	"side": "attacker"
  }
  ```
</CodeGroup>

### operator\_banned

<CodeGroup>
  ```ts type.ts theme={null}
  interface OperatorBannedEvent {
  	team: number;
  	index: number;
  	side: string;
  	operator_name: {
  		id: number;
  		value: string;
  	};
  }
  ```

  ```json example.json theme={null}
  {
  	"team": 0,
  	"index": 0,
  	"side": "attacker",
  	"operator_name": {
  		"id": 62246,
  		"value": ""
  	}
  }
  ```
</CodeGroup>

### operator\_ban\_cleared

<CodeGroup>
  ```ts type.ts theme={null}
  interface OperatorBanClearedEvent {
  	team: number;
  	index: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"team": 0,
  	"index": 0
  }
  ```
</CodeGroup>

### round\_ended

<CodeGroup>
  ```ts type.ts theme={null}
  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;
  		};
  	}>;
  }
  ```

  ```json example.json theme={null}
  {
  	"round_data": {
  		"index": 0,
  		"rounds_until_next_segment": 1,
  		"segment_size": 2,
  		"segment_index": 0,
  		"team_0": {
  			"role": "attacker",
  			"state": 3
  		},
  		"team_1": {
  			"role": "defender",
  			"state": 2
  		}
  	},
  	"damage_events": [
  		{
  			"instigator_player_id": 1,
  			"receiver_player_id": 6,
  			"damage_amount": 61,
  			"remaining_health": 84,
  			"pre_damage_health": 145,
  			"max_health": 145,
  			"damage_type": "bullet",
  			"damage_team_type": "unknown",
  			"damage_hit_zone": "head",
  			"damage_source_id": 1,
  			"damage_item_id": 238373640207,
  			"damage_item_instance_id": 238373640207,
  			"damage_time": 1743115498894
  		}
  	],
  	"players": [
  		{
  			"player_id": 1,
  			"final_health": 100,
  			"final_life_state": "normal",
  			"operator_name": {
  				"id": 62246,
  				"value": ""
  			}
  		}
  	]
  }
  ```
</CodeGroup>

### defuser\_dropped

<CodeGroup>
  ```ts type.ts theme={null}
  interface DefuserDroppedEvent {
  	player_id: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1
  }
  ```
</CodeGroup>

### defuser\_picked\_up

<CodeGroup>
  ```ts type.ts theme={null}
  interface DefuserPickedUpEvent {
  	player_id: number;
  	initial: boolean;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1,
  	"initial": true
  }
  ```
</CodeGroup>

### defuser\_planted

<CodeGroup>
  ```ts type.ts theme={null}
  interface DefuserPlantedEvent {
  	player_id: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1
  }
  ```
</CodeGroup>

### defuser\_sabotaged

<CodeGroup>
  ```ts type.ts theme={null}
  interface DefuserSabotagedEvent {
  	player_id: number;
  }
  ```

  ```json example.json theme={null}
  {
  	"player_id": 1
  }
  ```
</CodeGroup>