overlayed.tft.readyForGameEvents() must be called before any events will be emitted.
live_client_data
interface LiveClientDataEvent {
port: number;
}
match_started
interface MatchStartedEvent {
match_id: string;
game_mode: string;
map_number: number;
}
{
"match_id": "5412312873",
"game_mode": "TFT",
"map_number": 22
}
match_ended
interface MatchEndedEvent {
}
player_joined
interface PlayerJoinedEvent {
player_id: number;
summoner_name: `${string}#${string}`;
skin_id: string;
is_bot: boolean;
}
{
"player_id": 1,
"summoner_name": "johndoe#1234",
"skin_id": "0",
"is_bot": false
}
player_left
interface PlayerLeftEvent {
player_id: number;
}
stage_changed
interface StageChangedEvent {
stage: `${number}-${number}`;
name: "PVP" | "PVE" | "Carousel";
type: "PVP" | "Minions_1" | "Minions_2" | "Minions_3" | "Carousel" | "Augment_1" | "Augment_2";
native_name:
| "Encounter_Group"
| "Intro1"
| "Intro2"
| "Intro3"
| "Combat"
| "Carousel"
| "Krugs"
| "Wolves"
| "Combat_Set6_Standard_AugmentEarly"
| "Combat_Set6_Standard_AugmentMid"
| "Combat_Set6_Standard_AugmentLate";
}
{
"stage": "1-1",
"name": "PVE",
"type": "PVE",
"native_name": "Carousel"
}
battle_start
interface BattleStartEvent {
player_id: number;
// null when against AI
opponent_id: number | null;
}
{
"player_id": 1,
"opponent_id": 2
}
battle_end
interface BattleEndEvent {
player_id: number;
outcome: "victory" | "defeat";
streak: number;
}
{
"player_id": 1,
"outcome": "victory",
"streak": -2
}
unit_damage_changed
Only provided for local player.
interface UnitDamageChangedEvent {
unit: number;
name: string;
damage: number;
physical_damage: number;
magic_damage: number;
true_damage: number;
}
{
"unit": 1,
"name": "Aatrox",
"damage": 100,
"physical_damage": 100,
"magic_damage": 0,
"true_damage": 0
}
unit_level_changed
interface UnitLevelChangedEvent {
unit: number;
name: string;
level: number;
}
player_gold_changed
Only provided for local player.
interface PlayerGoldChangedEvent {
player_id: number;
gold: number;
}
{
"player_id": 1,
"gold": 100
}
player_died
interface PlayerDiedEvent {
player_id: number;
instigator_player_id: number;
}
{
"player_id": 1,
"instigator_player_id": 2
}
player_level_changed
interface PlayerLevelChangedEvent {
player_id: number;
level: number;
next_level_xp_required: number;
}
{
"player_id": 1,
"level": 1,
"next_level_xp_required": 100
}
player_xp_changed
Only provided for local player.
interface PlayerXpChangedEvent {
player_id: number;
xp: number;
}
{
"player_id": 1,
"xp": 100
}
player_health_changed
interface PlayerHealthChangedEvent {
player_id: number;
health: number;
}
{
"player_id": 1,
"health": 100
}
Planned Additions
- item_added
- item_used
- shop_changed
- bench_update
- unit_item_changed
- unit_position_changed