overlayed.siege.readyForGameEvents() must be called before any events will be emitted.started_queuing
interface StartedQueuingEvent {
gameMode: string;
gameType: {
id: number;
value: string;
};
matchType: string;
}
{
"gameMode": "Unknown",
"gameType": {
"id": 138115,
"value": ""
},
"matchType": "QUICK PLAY"
}
stopped_queuing
interface StoppedQueuingEvent {
};
{}
match_started
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;
};
}>;
}
{
"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
}
}
]
}
match_ended
interface MatchEndedEvent {
}
{}
map_changed
interface MapChangedEvent {
map: {
id: number;
name: {
id: number;
value: string;
};
timeOfDay: {
id: number;
value: string;
};
};
}
{
"map": {
"id": 0,
"name": {
"id": 208094,
"value": ""
},
"timeOfDay": {
"id": 177839,
"value": ""
}
}
}
phase_changed
interface PhaseChangedEvent {
phase: string;
}
{
"phase": "intro"
}
player_joined
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;
}
{
"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"
}
player_left
interface PlayerLeftEvent {
playerId: number;
}
{
"playerId": 1
}
player_ping_id_changed
interface PlayerPingIdChangedEvent {
playerId: number;
pingId: number;
}
{
"playerId": 1,
"pingId": 5
}
player_operator_changed
interface PlayerOperatorChangedEvent {
playerId: number;
operatorName: {
id: number;
value: string;
};
}
{
"playerId": 1,
"operatorName": {
"id": 282399,
"value": ""
}
}
player_life_state_changed
interface PlayerLifeStateChangedEvent {
playerId: number;
lifeState: string;
}
{
"playerId": 1,
"lifeState": "low_health"
}
player_location_changed
interface PlayerLocationChangedEvent {
playerId: number;
locationName: string;
}
{
"playerId": 1,
"locationName": "1F BBQ"
}
player_team_changed
interface PlayerTeamChangedEvent {
playerId: number;
team: number;
}
{
"playerId": 1,
"team": 0
}
player_side_changed
interface PlayerSideChangedEvent {
playerId: number;
side: string;
}
{
"playerId": 1,
"side": "attacker"
}
player_ping_updated
interface PlayerPingUpdatedEvent {
playerId: number;
ping: number;
}
{
"playerId": 1,
"ping": 36
}
player_score_changed
interface PlayerScoreChangedEvent {
playerId: number;
score: number;
}
{
"playerId": 1,
"score": 120
}
player_kills_changed
interface PlayerKillsChangedEvent {
playerId: number;
kills: number;
}
{
"playerId": 1,
"kills": 8
}
player_deaths_changed
interface PlayerDeathsChangedEvent {
playerId: number;
deaths: number;
}
{
"playerId": 1,
"deaths": 2
}
player_assists_changed
interface PlayerAssistsChangedEvent {
playerId: number;
assists: number;
}
{
"playerId": 1,
"assists": 4
}
player_game_mode_actions_changed
interface PlayerGameModeActionsChangedEvent {
playerId: number;
gameModeActions: number;
}
{
"playerId": 1,
"gameModeActions": 2
}
player_died
interface PlayerDiedEvent {
playerId: number;
instigatorPlayerId: number;
headshot: boolean;
}
{
"playerId": 1,
"instigatorPlayerId": 6
}
player_downed
interface PlayerDownedEvent {
playerId: number;
instigatorPlayerId: number;
}
{
"playerId": 1,
"instigatorPlayerId": 6
}
operator_ban_voting_started
interface OperatorBanVotingStartedEvent {
team: number;
index: number;
side: string;
}
{
"team": 0,
"index": 0,
"side": "attacker"
}
operator_banned
interface OperatorBannedEvent {
team: number;
index: number;
side: string;
operatorName: {
id: number;
value: string;
};
}
{
"team": 0,
"index": 0,
"side": "attacker",
"operatorName": {
"id": 62246,
"value": ""
}
}
operator_ban_cleared
interface OperatorBanClearedEvent {
team: number;
index: number;
}
{
"team": 0,
"index": 0
}
round_ended
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;
};
}>;
}
{
"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": ""
}
}
]
}
defuser_dropped
interface DefuserDroppedEvent {
playerId: number;
}
{
"playerId": 1
}
defuser_picked_up
interface DefuserPickedUpEvent {
playerId: number;
initial: boolean;
}
{
"playerId": 1,
"initial": true
}
defuser_planted
interface DefuserPlantedEvent {
playerId: number;
}
{
"playerId": 1
}
defuser_sabotaged
interface DefuserSabotagedEvent {
playerId: number;
}
{
"playerId": 1
}

