Skip to content

Commit d8748df

Browse files
authored
Add table for all implemented SDK for Unreal (agones-dev#2074)
* Add table for all implemented SDK for Unreal * fix bad formatting and move to top
1 parent 094ec10 commit d8748df

1 file changed

Lines changed: 34 additions & 45 deletions

File tree

  • site/content/en/docs/Guides/Client SDKs

site/content/en/docs/Guides/Client SDKs/unreal.md

Lines changed: 34 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,40 @@ The Unreal SDK is functional, but not yet feature complete.
1414

1515
Check the [Client SDK Documentation]({{< relref "_index.md" >}}) for more details on each of the SDK functions and how to run the SDK locally.
1616

17+
## SDK Functionality
18+
19+
| Area | Action | Implemented |
20+
|----------------------|--------------------------|-------------------------------|
21+
| Lifecycle | Ready | ✔️ |
22+
| Lifecycle | Health | ✔️ |
23+
| Lifecycle | Reserve | ✔️ |
24+
| Lifecycle | Allocate | ✔️ |
25+
| Lifecycle | Shutdown | ✔️ |
26+
| Configuration | GameServer | ✔️ |
27+
| Configuration | Watch ||
28+
| Metadata | SetAnnotation | ✔️ |
29+
| Metadata | SetLabel | ✔️ |
30+
| Player Tracking | GetConnectedPlayers | ✔️ |
31+
| Player Tracking | GetPlayerCapacity | ✔️ |
32+
| Player Tracking | GetPlayerCount | ✔️ |
33+
| Player Tracking | IsPlayerConnected | ✔️ |
34+
| Player Tracking | PlayerConnect | ✔️ |
35+
| Player Tracking | PlayerDisconnect | ✔️ |
36+
| Player Tracking | SetPlayerCapacity | ✔️ |
37+
38+
Additional methods have been added for ease of use (both of which are enabled by default):
39+
40+
- Connect
41+
- will call `/gameserver` till a succesful response is returned and then call `/ready`.
42+
- disabled by setting `bDisableAutoConnect` to `true`.
43+
- An event is broadcast with the `GameServer` data once the `/gameserver` call succeeds.
44+
- Health
45+
- calls `/health` endpoint on supplied rate
46+
- enabled by default with 10 second rate
47+
- disabled by default by setting `HealthRateSeconds` to `0`.
48+
49+
Both of the above are automatically kicked off in the `BeginPlay` of the component.
50+
1751
## Download
1852

1953
Download the source from the [Releases Page](https://github.com/googleforgames/agones/releases)
@@ -114,51 +148,6 @@ HealthRateSeconds=5.0
114148
bDisableAutoConnect=true
115149
```
116150
117-
## SDK Functionality
118-
119-
Additional methods have been added for ease of use (both of which are enabled by default):
120-
121-
- Connect
122-
- will call `/gameserver` till a succesful response is returned and then call `/ready`.
123-
- disabled by setting `bDisableAutoConnect` to `true`.
124-
- An event is broadcast with the `GameServer` data once the `/gameserver` call succeeds.
125-
- Health
126-
- calls `/health` endpoint on supplied rate
127-
- enabled by default with 10 second rate
128-
- disabled by default by setting `HealthRateSeconds` to `0`.
129-
130-
Both of the above are automatically kicked off in the `BeginPlay` of the component.
131-
132-
This Agones SDK wraps the REST API and supports the following actions:
133-
134-
Stable
135-
- Lifecycle
136-
- Ready
137-
- Health
138-
- Reserve
139-
- Allocate
140-
- Shutdown
141-
- Configuration
142-
- GameServer
143-
- Metadata
144-
- SetAnnotation
145-
- SetLabel
146-
147-
Alpha
148-
- Player Tracking
149-
- GetConnectedPlayers
150-
- GetPlayerCapacity
151-
- GetPlayerCount
152-
- IsPlayerConnected
153-
- PlayerConnect
154-
- PlayerDisconnect
155-
- SetPlayerCapacity
156-
157-
Unimplemented
158-
- WatchGameServer
159-
160-
Current the only missing functionality is the `WatchGameServer` functionality. We welcome collaborators to help implement this, if people need it before we get around to implementing it ourselves.
161-
162151
## Unreal Hooks
163152
164153
Within the Unreal [GameMode](https://docs.unrealengine.com/en-US/API/Runtime/Engine/GameFramework/AGameMode/index.html) and [GameSession](https://docs.unrealengine.com/en-US/API/Runtime/Engine/GameFramework/AGameSession/index.html) exist a number of useful existing

0 commit comments

Comments
 (0)