|
| 1 | +--- |
| 2 | +id: wukong |
| 3 | +image: "/img/embed/games/wukong.jpg" |
| 4 | +title: Black Myth: Wukong Game events |
| 5 | +hide_title: true |
| 6 | +draft: true |
| 7 | +sidebar_label: Black Myth: Wukong |
| 8 | +sidebar_position: 0 |
| 9 | +sidebar_custom_props: |
| 10 | + tags: |
| 11 | + overwolf_platform: true |
| 12 | + electron_platform: true |
| 13 | +--- |
| 14 | + |
| 15 | +<!-- GENERATED USING /scripts/generate.js --> |
| 16 | + |
| 17 | +<head> |
| 18 | + <meta name="keywords" content="API for Black Myth: Wukong, Black Myth: Wukong API, SDK for Black Myth: Wukong, Black Myth: Wukong SDK"/> |
| 19 | +</head> |
| 20 | + |
| 21 | +<GameInfo gameId={24504} page="docs" /> |
| 22 | + |
| 23 | +Please read the [overwolf.games.events](/api/live-game-data) documentation page to learn how to use Overwolf game events. |
| 24 | + |
| 25 | +## Sample Apps |
| 26 | +* [Black Myth: Wukong game events sample app](https://github.com/overwolf/events-sample-app) |
| 27 | + |
| 28 | +## Available Features |
| 29 | + |
| 30 | +* [gep_internal](#gep_internal) |
| 31 | +* [game_info](#game_info) |
| 32 | +* [match_info](#match_info) |
| 33 | + |
| 34 | +## Game event status |
| 35 | + |
| 36 | +It is highly recommended to communicate errors and warnings to app users. |
| 37 | + |
| 38 | +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). |
| 39 | + |
| 40 | +## `gep_internal` |
| 41 | + |
| 42 | +### Info Updates |
| 43 | + |
| 44 | +key | Category | Values | Notes | Since GEP Ver. | |
| 45 | +------------ | ------------| ------------------------- | --------------------- | ------------- | |
| 46 | +gep_internal | gep_internal| Local + Public version number|See [notes](#gep_internal-note)| 259.0 | |
| 47 | + |
| 48 | +#### *gep_internal* note |
| 49 | + |
| 50 | +Data Example: |
| 51 | + |
| 52 | +```json |
| 53 | +{"info":{"gep_internal":{"version_info":"{"local_version":"244.0.0","public_version":"258.0.0","is_updated":true}"}},"feature":"gep_internal"} |
| 54 | +``` |
| 55 | + |
| 56 | +## `game_info` |
| 57 | + |
| 58 | +### Info Updates |
| 59 | + |
| 60 | +key | Category | Values | Notes | Since GEP Ver. | |
| 61 | +------------ | ------------| ------------------------- | --------------------- | ------------- | |
| 62 | +scene | game_info | The current scene-state |See [notes](#scene-note) | 259.0 | |
| 63 | + |
| 64 | +#### *scene* note |
| 65 | + |
| 66 | +Possible Scene values: |
| 67 | + |
| 68 | +* lobby |
| 69 | +* ingame |
| 70 | +* death |
| 71 | + |
| 72 | +Data Example: |
| 73 | + |
| 74 | +```json |
| 75 | +{"feature": "game_info", "category": "game_info", "key": "scene", "data": "lobby"} |
| 76 | +``` |
| 77 | + |
| 78 | +## `match_info` |
| 79 | + |
| 80 | +### Events |
| 81 | + |
| 82 | +Event | Event Data | Fired When | Notes | Since GEP Ver. | |
| 83 | +------------| -------------| --------------| -------------------------------------- | ---------------| |
| 84 | +knockout | nulll | When the local player is knockout| See [notes](#knockout-note) |259.0| |
| 85 | +level_up | nulll | When the local player level up| See [notes](#level_up-note) |259.0| |
| 86 | +match_start | nulll | In the beginning of each match| See [notes](#match_start-note) |259.0| |
| 87 | +match_end | nulll | At the end of each match| See [notes](#match_end-note) |259.0| |
| 88 | +death | nulll | When the local player dies| See [notes](#death-note) |259.0| |
| 89 | + |
| 90 | +#### *knockout* note |
| 91 | + |
| 92 | +Data Example: |
| 93 | + |
| 94 | +```json |
| 95 | +{"events":[{"name":"knockout","data":null}]} |
| 96 | +``` |
| 97 | + |
| 98 | +#### *level_up* note |
| 99 | + |
| 100 | +Data Example: |
| 101 | + |
| 102 | +```json |
| 103 | +{"events":[{"name":"level_up","data":null}]} |
| 104 | +``` |
| 105 | + |
| 106 | +#### *match_start* note |
| 107 | + |
| 108 | +Data Example: |
| 109 | + |
| 110 | +```json |
| 111 | +{"events":[{"name":"match_start","data":null}]} |
| 112 | +``` |
| 113 | + |
| 114 | +#### *match_end* note |
| 115 | + |
| 116 | +Data Example: |
| 117 | + |
| 118 | +```json |
| 119 | +{"events":[{"name":"match_end","data":null}]} |
| 120 | +``` |
| 121 | + |
| 122 | +#### *death* note |
| 123 | + |
| 124 | +Data Example: |
| 125 | + |
| 126 | +```json |
| 127 | +{"events":[{"name":"death","data":null}]} |
| 128 | +``` |
0 commit comments