> ## 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 {
  	gameMode: string;
  	gameType: {
  		id: number;
  		value: string;
  	};
  	matchType: string;
  }
  ```

  ```json example.json theme={null}
  {
  	"gameMode": "Unknown",
  	"gameType": {
  		"id": 138115,
  		"value": ""
  	},
  	"matchType": "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 {
  	gameMode: string;
  	gameType: {
  		id: number;
  		value: string;
  	};
  	matchType: string;
  	matchId: string;
  	map: {
  		id: number;
  		name: {
  			id: number;
  			value: string;
  		};
  		timeOfDay: {
  			id: number;
  			value: string;
  		};
  	};
  	isRoundBased: boolean;
  	currentRoundIndex: number;
  	rounds: Array<{
  		index: number;
  		roundsUntilNextSegment: number;
  		segmentSize: number;
  		segmentIndex: number;
  		team0: {
  			role: string;
  			state: number;
  		};
  		team1: {
  			role: string;
  			state: number;
  		};
  	}>;
  }
  ```

  ```json example.json theme={null}
  {
  	"gameMode": "HOSTAGE",
  	"gameType": {
  		"id": 138115,
  		"value": ""
  	},
  	"matchType": "QUICK PLAY",
  	"matchId": "6a8e725c-e563-4d3d-a4a4-4b03f6da0d8b",
  	"map": {
  		"id": 0,
  		"name": {
  			"id": 208094,
  			"value": ""
  		},
  		"timeOfDay": {
  			"id": 177839,
  			"value": ""
  		}
  	},
  	"isRoundBased": true,
  	"currentRoundIndex": 0,
  	"rounds": [
  		{
  			"index": 0,
  			"roundsUntilNextSegment": 1,
  			"segmentSize": 2,
  			"segmentIndex": 0,
  			"team0": {
  				"role": "attacker",
  				"state": 0
  			},
  			"team1": {
  				"role": "defender",
  				"state": 0
  			}
  		},
  		{
  			"index": 1,
  			"roundsUntilNextSegment": 0,
  			"segmentSize": 2,
  			"segmentIndex": 0,
  			"team0": {
  				"role": "attacker",
  				"state": 0
  			},
  			"team1": {
  				"role": "defender",
  				"state": 0
  			}
  		},
  		{
  			"index": 2,
  			"roundsUntilNextSegment": 1,
  			"segmentSize": 2,
  			"segmentIndex": 1,
  			"team0": {
  				"role": "defender",
  				"state": 0
  			},
  			"team1": {
  				"role": "attacker",
  				"state": 0
  			}
  		},
  		{
  			"index": 3,
  			"roundsUntilNextSegment": 0,
  			"segmentSize": 2,
  			"segmentIndex": 1,
  			"team0": {
  				"role": "defender",
  				"state": 0
  			},
  			"team1": {
  				"role": "attacker",
  				"state": 0
  			}
  		},
  		{
  			"index": 4,
  			"roundsUntilNextSegment": 0,
  			"segmentSize": 1,
  			"segmentIndex": 2,
  			"team0": {
  				"role": "invalid",
  				"state": 0
  			},
  			"team1": {
  				"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;
  		};
  		timeOfDay: {
  			id: number;
  			value: string;
  		};
  	};
  }
  ```

  ```json example.json theme={null}
  {
  	"map": {
  		"id": 0,
  		"name": {
  			"id": 208094,
  			"value": ""
  		},
  		"timeOfDay": {
  			"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 {
  	playerId: number;
  	username: string;
  	profileId: string;
  	isBot: boolean;
  	isEnemy: boolean;
  	isSquadMember: boolean;
  	isLocalPlayer: boolean;
  	side: string;
  	team: number;
  	isPrivacyUsername: boolean;
  	hasAvatarHidden: boolean;
  	hasCommendStreak: boolean;
  	pingId: number;
  	matchStats: {
  		kills: number;
  		deaths: number;
  		assists: number;
  		gameModeActions: number;
  		score: number;
  	};
  	lifeState: string;
  	ping: number;
  	startingSide: string;
  }
  ```

  ```json example.json theme={null}
  {
  	"playerId": 1,
  	"username": "KingGeorge",
  	"profileId": "f67508fb-fd32-414e-8c8c-e1dff7b2eb92",
  	"isBot": false,
  	"isEnemy": false,
  	"isSquadMember": false,
  	"isLocalPlayer": true,
  	"side": "attacker",
  	"team": 0,
  	"isPrivacyUsername": false,
  	"hasAvatarHidden": false,
  	"hasCommendStreak": true,
  	"pingId": 0,
  	"matchStats": {
  		"kills": 0,
  		"deaths": 0,
  		"assists": 0,
  		"gameModeActions": 0,
  		"score": 0
  	},
  	"lifeState": "dead",
  	"ping": 0,
  	"startingSide": "attacker"
  }
  ```
</CodeGroup>

### player\_left

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

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

### player\_ping\_id\_changed

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

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

### player\_operator\_changed

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

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

### player\_life\_state\_changed

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

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

### player\_location\_changed

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

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

### player\_team\_changed

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

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

### player\_side\_changed

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

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

### player\_ping\_updated

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

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

### player\_score\_changed

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

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

### player\_kills\_changed

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

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

### player\_deaths\_changed

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

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

### player\_assists\_changed

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

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

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

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

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

### player\_died

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

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

### player\_downed

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

  ```json example.json theme={null}
  {
  	"playerId": 1,
  	"instigatorPlayerId": 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;
  	operatorName: {
  		id: number;
  		value: string;
  	};
  }
  ```

  ```json example.json theme={null}
  {
  	"team": 0,
  	"index": 0,
  	"side": "attacker",
  	"operatorName": {
  		"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 {
  	roundData: {
  		index: number;
  		roundsUntilNextSegment: number;
  		segmentSize: number;
  		segmentIndex: number;
  		team0: {
  			role: string;
  			state: number;
  		};
  		team1: {
  			role: string;
  			state: number;
  		};
  	};
  	damageEvents: Array<{
  		instigatorPlayerId: number;
  		receiverPlayerId: number;
  		damageAmount: number;
  		remainingHealth: number;
  		preDamageHealth: number;
  		maxHealth: number;
  		damageType: string;
  		damageTeamType: string;
  		damageHitZone: string;
  		damageSourceId: number;
  		damageItemId: number;
  		damageItemInstanceId: number;
  		damageTime: number;
  	}>;
  	players: Array<{
  		playerId: number;
  		finalHealth: number;
  		finalLifeState: string;
  		operatorName: {
  			id: number;
  			value: string;
  		};
  	}>;
  }
  ```

  ```json example.json theme={null}
  {
  	"roundData": {
  		"index": 0,
  		"roundsUntilNextSegment": 1,
  		"segmentSize": 2,
  		"segmentIndex": 0,
  		"team0": {
  			"role": "attacker",
  			"state": 3
  		},
  		"team1": {
  			"role": "defender",
  			"state": 2
  		}
  	},
  	"damageEvents": [
  		{
  			"instigatorPlayerId": 1,
  			"receiverPlayerId": 6,
  			"damageAmount": 61,
  			"remainingHealth": 84,
  			"preDamageHealth": 145,
  			"maxHealth": 145,
  			"damageType": "bullet",
  			"damageTeamType": "unknown",
  			"damageHitZone": "head",
  			"damageSourceId": 1,
  			"damageItemId": 238373640207,
  			"damageItemInstanceId": 238373640207,
  			"damageTime": 1743115498894
  		}
  	],
  	"players": [
  		{
  			"playerId": 1,
  			"finalHealth": 100,
  			"finalLifeState": "normal",
  			"operatorName": {
  				"id": 62246,
  				"value": ""
  			}
  		}
  	]
  }
  ```
</CodeGroup>

### defuser\_dropped

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

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

### defuser\_picked\_up

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

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

### defuser\_planted

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

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

### defuser\_sabotaged

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

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