From 99c1f7638ecf0353bce43ef14c1fb8014c8c22af Mon Sep 17 00:00:00 2001 From: Kalaiselvi Murugesan Date: Thu, 2 May 2024 20:22:58 +0000 Subject: [PATCH] review changes --- .../en/docs/Guides/Client SDKs/_index.md | 32 +++++++++++++++++++ site/content/en/docs/Reference/gameserver.md | 1 - 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/site/content/en/docs/Guides/Client SDKs/_index.md b/site/content/en/docs/Guides/Client SDKs/_index.md index 0fd6ec46e0..4bd83dcc28 100644 --- a/site/content/en/docs/Guides/Client SDKs/_index.md +++ b/site/content/en/docs/Guides/Client SDKs/_index.md @@ -52,6 +52,7 @@ The SDKs will automatically discover and connect to the gRPC port specified in t If your game server requires using a REST client, it is advised to use the port from the environment variable, otherwise your game server will not be able to contact the SDK server if it is configured to use a non-default port. +{{% feature expiryVersion="1.41.0" %}} ## Function Reference While each of the SDKs are canonical to their languages, they all have the following @@ -80,6 +81,37 @@ Functions which changes GameServer state or settings are: 14. Alpha().AppendListValue() 15. Alpha().DeleteListValue() 16. Alpha().SetListCapacity() +{{% /feature %}} +{{% feature publishVersion="1.41.0" %}} +## Function Reference + +While each of the SDKs are canonical to their languages, they all have the following +functions that implement the core responsibilities of the SDK. + +For language specific documentation, have a look at the respective source (linked above), +and the {{< ghlink href="examples" >}}examples{{< /ghlink >}}. + +Calling any of state changing functions mentioned below does not guarantee that GameServer Custom Resource object would actually change its state right after the call. For instance, it could be moved to the `Shutdown` state elsewhere (for example, when a fleet scales down), which leads to no changes in `GameServer` object. You can verify the result of this call by waiting for the desired state in a callback to WatchGameServer() function. + +Functions which changes GameServer state or settings are: + +1. Ready() +2. Shutdown() +3. SetLabel() +4. SetAnnotation() +5. Allocate() +6. Reserve() +7. Alpha().SetCapacity() +8. Alpha().PlayerConnect() +9. Alpha().PlayerDisconnect() +10. Beta().SetCounterCount() +11. Beta().IncrementCounter() +12. Beta().DecrementCounter() +13. Beta().SetCounterCapacity() +14. Beta().AppendListValue() +15. Beta().DeleteListValue() +16. Beta().SetListCapacity() +{{% /feature %}} ### Lifecycle Management diff --git a/site/content/en/docs/Reference/gameserver.md b/site/content/en/docs/Reference/gameserver.md index 84522c06a8..82df105548 100644 --- a/site/content/en/docs/Reference/gameserver.md +++ b/site/content/en/docs/Reference/gameserver.md @@ -243,7 +243,6 @@ spec: - room1 - room2 - room3 - # # Pod template configuration # {{< k8s-api-version href="#podtemplate-v1-core" >}} template: