This repository has been archived by the owner on Sep 1, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'source' of https://github.com/overwolf/overwolf.github.io…
… into source
- Loading branch information
Showing
6 changed files
with
114 additions
and
0 deletions.
There are no files selected for viewing
100 changes: 100 additions & 0 deletions
100
pages/api/live-game-data/supported-games/the-first-descendant.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
--- | ||
id: the-first-descendant | ||
image: "/img/embed/games/the-first-descendant.jpg" | ||
title: The First Descendant Game events | ||
hide_title: true | ||
draft: true | ||
sidebar_label: The First Descendant | ||
sidebar_position: 0 | ||
sidebar_custom_props: | ||
tags: | ||
overwolf_platform: true | ||
electron_platform: true | ||
--- | ||
|
||
<!-- GENERATED USING /scripts/generate.js --> | ||
|
||
<head> | ||
<meta name="keywords" content="API for The First Descendant, The First Descendant API, SDK for The First Descendant, The First Descendant SDK"/> | ||
</head> | ||
|
||
<GameInfo gameId={24360} page="docs" /> | ||
|
||
Please read the [overwolf.games.events](/api/live-game-data) documentation page to learn how to use Overwolf game events. | ||
|
||
## Sample Apps | ||
* [The First Descendant game events sample app](https://github.com/overwolf/events-sample-app) | ||
|
||
## Available Features | ||
|
||
* [gep_internal](#gep_internal) | ||
* [game_info](#game_info) | ||
* [match_info](#match_info) | ||
|
||
## Game event status | ||
|
||
It is highly recommended to communicate errors and warnings to app users. | ||
|
||
Check the current game event status [here](/status/). Alternatively, you can easily check that status from your app itself, [using our API](/topics/using-events/how-to-check-events-status-from-app). | ||
|
||
## `gep_internal` | ||
|
||
### Info Updates | ||
|
||
key | Category | Values | Notes | Since GEP Ver. | | ||
------------ | ------------| ------------------------- | --------------------- | ------------- | | ||
gep_internal | gep_internal| Local + Public version number|See [notes](#gep_internal-note)| 252.0 | | ||
|
||
#### *gep_internal* note | ||
|
||
Data Example: | ||
|
||
```json | ||
{"info":{"gep_internal":{"version_info":"{"local_version":"244.0.0","public_version":"244.0.0","is_updated":true}"}},"feature":"gep_internal"} | ||
``` | ||
|
||
## `game_info` | ||
|
||
### Info Updates | ||
|
||
key | Category | Values | Notes | Since GEP Ver. | | ||
------------ | ------------| ------------------------- | --------------------- | ------------- | | ||
scene | game_info | The current scene-state |See [notes](#scene-note)| 252.0 | | ||
|
||
#### *scene* note | ||
|
||
Possible Scene values: | ||
|
||
* lobby | ||
* ingame | ||
|
||
Data Example: | ||
|
||
```json | ||
{"feature": "game_info", "category": "game_info", "key": "scene", "data": "lobby"} | ||
``` | ||
|
||
## `match_info` | ||
|
||
### Events | ||
|
||
Event | Event Data | Fired When | Notes | Since GEP Ver. | | ||
------------| -------------| --------------| -------------------------------------- | ---------------| | ||
match_start | nulll | In the beginning of each match| See [notes](#match_start-note) |244.0| | ||
match_end | nulll | At the end of each match| See [notes](#match_end-note) |244.0| | ||
|
||
#### *match_start* note | ||
|
||
Data Example: | ||
|
||
```json | ||
{"events":[{"name":"match_start","data":null}]} | ||
``` | ||
|
||
#### *match_end* note | ||
|
||
Data Example: | ||
|
||
```json | ||
{"events":[{"name":"match_end","data":null}]} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.