Ancestors Legacy

Ancestors Legacy game events.

Please read the overwolf.games.events documentation page to learn how to use Overwolf game events. 

Game ID

  • 21236

Available Features

  • map_info_event
  • players_info_event
  • villages_info_event
  • GameStarted
  • GameStopped
  • ResourceUpdate
  • DominationPointsUpdate
  • BuildingResearchedTech
  • BuildingFinished
  • SquadRecruited
  • SquadResearchedTech
  • SquadDied
  • VillageCaptured
  • WeatherUpdate
  • PlayerWon
  • PlayerLost
  • PlayerQuit
  • PlayerReplacedWithAI

Sample App

Info Updates

The Game Events Provider keeps an info DB with various information about the game state.
Updates about this information can be received as events by registering an event listener using overwolf.games.events.onInfoUpdates2()
It is also possible to get the current available information using overwolf.games.events.getInfo()

Feature Information
map_info_event
Key Category Values Notes Since Version
map_info_event map_info_event
{
    "MapName": "string",
    "ServerName": "string",
    "GameMode": string,
    "CTPScore": int,
    "StartingResources": int,
    "StartingTier": int,
    "TimeLimit": int,
    "StartingWeather": string,
    "MaxSquads": int,
    "GameEnvironment": string
}
  • “MapName” – english map name
  • “ServerName” – server name
  • “GameMode”: Annihilation / Domination
  • “StartingResources”: Percentage of base resources
  • “TimeLimit”: NoLimit – 60:00 minutes
  • “StartingWeather”: Sun/Rain / HeavyRain / Snow / HeavySnow / Fog
  • “MaxSquads”: 1-10
  • “GameEnvironment”: PVP / PVE
   117.1
players_info_event
Key Category Values Notes Since Version
players_info_event players_info_event

Array of players objects.

{
  “Players”: [ { Player1 } , …, { PlayerN } ]
}

“Player” object structure:

{
  "SteamID": "string",
  "PlayerName": "string",
  "PlayerIndex": int,
  "TeamIndex": int,
  "PlayerNation": "string",
  "AIType": "string",
  "bIsSpectator": bool,
  "LeverRep": "string",
  "NationLevels":
      {
        "Vikings": int,
        "Slavs": int,
        "AngloSaxons": int,
        "Germans": int
       }
}
  • “SteamID” – steamID or “INVALID” for AI
  • “PlayerName” – player name
  • “PlayerIndex” – player index
  • “PlayerNation” – [Vikings | Slavs | AngloSaxons | Germans]
  • “AIType” – [None (for real players) | Easy | Medium | Hard | Insane]
  • “bIsSpectator” – “true” if the player is spectating the match
  • “LeverRep” – [Bad | Neutral | Good]
  • “NationLevels” – player level for each nation
   117.1
 villages_info_event
Key Category Values Notes Since Version
villages_info_event villages_info_event

Array of villages objects.

{
  "Villages": [ { village A } , … , { village N } ]
}

“Village” object structure:

 
   “ID”:“string”,
   “Name”:string,
   “ResourceGenerators”:
 
       
         “Type”:“string”,
         “Name”:“string”,
         “bIsBig”:bool
      },
       
         
      }
   ]
}
  • “ID” – Villages identifiers (from the mini-map)
    • Possible values – “A” – “H”
  • “Name” – Resource generator name
  • “bIsBig” – Resource generator size (true – big, false – small)
   117.1

 

Events

Feature Information
GameStarted  
Event Event Data Fired when Notes Since Version
GameStarted

null

All players joined the match and press any key to start the match.    117.1
 GameStopped
Event Event Data Fired when Notes Since Version
GameStopped
{
 "bSPMap": bool,
 "WinnerTeamIndex": int
}
  • “bSPMap” – true for single player map
  • “WinnerTeamIndex” – Index of winner team
Game ended    117.1
 ResourceUpdate
Event Event Data Fired when Notes Since Version
 ResourceUpdate

 Current resources, for a certain player.

{
 "Wood": "int",
 "Food": "int",
 "Iron": "int",
 "PlayerIndex": "int"
}
 
Resources updated
   117.1
 DominationPointsUpdate
Event Event Data Fired when Notes Since Version
 DominationPointsUpdate  
{
“Team_0” : real ,
… ,
“Team_N” : real
}
 Every second    117.1
 BuildingResearchedTech
Event Event Data Fired when Notes Since Version
 BuildingResearchedTech  
{
"Name" : string ,
"Class" : string ,
“TechClass” : string ,
“PlayerIndex” : int
}
  • “Class” – Class of the building that researched technology
  • “TechClass” – Technology class that has been researched
 When tech class is updated    117.1
 BuildingFinished
Event Event Data Fired when Notes Since Version
 BuildingFinished  
{
  "Name": string,
  "Class": string,
  "PlayerIndex": int
}
  • “Name” – Building name
  • “Class” – Class name
  • “PlayerIndex” – player index
 Building was finished    117.1
 SquadRecruited  
Event Event Data Fired when Notes Since Version
 SquadRecruited  
{
  "Name": string,
  "Class": string,
  "PlayerIndex": int
}
  • “Name” – Squad name
  • “Class” –  Class name
 Squad was recruited    117.1
 SquadResearchedTech  
Event Event Data Fired when Notes Since Version
 SquadResearchedTech  
{
  "Name": "string",
  "Class": "string",
  "TechClass": "string",
  "PlayerIndex": "int"
}
  • “Name” – Squad name
  • “Class” – Class name
  • “TechClass” – Tech class name
  • “PlayerIndex” – player index
     117.1
SquadDied
Event Event Data Fired when Notes Since Version
SquadDied  
{
  "Name": string,
  "Class": string,
  "PlayerIndex": "int"
}
  • “Name” – 
 Squad died    117.1
VillageCaptured
Event Event Data Fired when Notes Since Version
VillageCaptured
{
   "Name": string,
   "ID": string,
   "PlayerIndex": int
}
  • “Name” – Building name
  • “ID” – Village id
  • “PlayerIndex” – player index
 Village was captured    117.1
WeatherUpdate
Event Event Data Fired when Notes Since Version
WeatherUpdate  
{
  "New": string
}

“New” – New weather name

 Weather was changed  Possible weather values:
Sun/Rain / HeavyRain / Snow / HeavySnow / Fog
 117.1
PlayerWon
Event Event Data Fired when Notes Since Version
 PlayerWon  
{
  "PlayerIndex": "int"
}
 Player won    117.1
PlayerLost
Event Event Data Fired when Notes Since Version
 PlayerLost  
{
  "PlayerIndex": "int"
}
 Player lost    117.1
PlayerQuit
Event Event Data Fired when Notes Since Version
 PlayerQuit  
{
  "PlayerIndex": "int"
}
 Player quit    117.1
PlayerReplacedWithAI
Event Event Data Fired when Notes Since Version
 PlayerReplacedWithAI  
{
  "PlayerIndex": "int",
  "AIType": string
}
 Player was replaced with AI Possible values:
Easy/Medium/Hard/Insane
 117.1