Player Tracking guide, and GameServer reference. #1569
Conversation
markmandel
added
kind/feature
|
Build Succeeded 👏 Build Id: 456b50ba-8cb2-4841-be9c-bd01f4164b1b The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
examples/gameserver.yaml
Outdated
| # [Stage:Alpha] | ||
| # [FeatureFlag:PlayerTracking] | ||
| # Players provides the configuration for player tracking features. | ||
| players: |
There was a problem hiding this comment.
Since this won't work as-is on a default installation, it might be better to have it commented out by default. Otherwise, someone might try to apply this example to a 1.6 install and it will fail.
There was a problem hiding this comment.
100% agree. Good call.
| # [Stage:Alpha] | ||
| # [FeatureFlag:PlayerTracking] | ||
| # Players provides the configuration for player tracking features. | ||
| players: |
There was a problem hiding this comment.
same here: should fields that only work with defaulted-off feature flags be commented out in the reference examples?
| * Check if a specific player is connected, call [`SDK.Alpha().IsPlayerConnected(playerID)`]({{< ref "/docs/Guides/Client SDKs/_index.md#alpha-isplayerconnected-playerid" >}}) | ||
| * Retrieve the full list of connected players, call [`SDK.Alpha().GetConnectedPlayers()`]({{< ref "/docs/Guides/Client SDKs/_index.md#alpha-getconnectedplayers" >}}) | ||
|
|
||
| ## Next Step |
There was a problem hiding this comment.
Even though there is only one link, I think this should be plural, like on https://0ec2b41-dot-preview-dot-agones-images.appspot.com/site/docs/installation/creating-cluster/gke/
|
|
||
| From the SDK, the game server binary can also retrieve the current player capacity | ||
| via [`SDK.Alpha().GetPlayerCapacity()`]({{< ref "/docs/Guides/Client SDKs/_index.md#alpha-getplayercapacity" >}}). | ||
|
|
There was a problem hiding this comment.
Making a note here, to make sure I make the change:
#1570 (comment)
It might be worth clarifying that this capacity is not enforced as that is not a responsibility of Agones
There was a problem hiding this comment.
@steven-supersolid added notes here regarding both capacity changes, and also connect/disconnect.
There was a problem hiding this comment.
Great. This feature is really cool BTW and should enable us to remove some game code!
Includes the guide for player tracking, explaining how the SDK commands can be used for player user journeys. Included is also updates to the GameServer references. Also included a small fix in the comments wherein we were still referencing the webhook from the previous design. Work on googleforgames#1033
markmandel
force-pushed
the
docs/tracking-page
branch
from
0ec2b41 to
de30928
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: markmandel, roberthbailey The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Build Failed 😱 Build Id: fa9ba126-7957-427b-bf4e-f5c08443d516 To get permission to view the Cloud Build view, join the agones-discuss Google Group. |
|
Looks like this is your new test: |
|
Build Succeeded 👏 Build Id: 4025652c-08ac-48c8-bea9-afbcd6a61297 The following development artifacts have been built, and will exist for the next 30 days:
A preview of the website (the last 30 builds are retained): To install this version:
|
Includes the guide for player tracking, explaining how the SDK commands can be used for player user journeys. Included is also updates to the GameServer references. Also included a small fix in the comments wherein we were still referencing the webhook from the previous design. Work on googleforgames#1033
Includes the guide for player tracking, explaining how the SDK commands can be used for player user journeys. Included is also updates to the GameServer references. Also included a small fix in the comments wherein we were still referencing the webhook from the previous design. Work on googleforgames#1033
What type of PR is this?
/kind feature
What this PR does / Why we need it:
Includes the guide for player tracking, explaining how the SDK commands can be used for player user journeys.
Included is also updates to the GameServer references.
Also included a small fix in the comments wherein we were still referencing the webhook from the previous design.
Which issue(s) this PR fixes:
Work on #1033
Special notes for your reviewer:
None