/AWS1/CL_GML=>UPDATEGAMESESSION()
¶
About UpdateGameSession¶
Updates the mutable properties of a game session.
To update a game session, specify the game session ID and the values you want to change.
If successful, the updated GameSession
object is returned.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_GAMESESSIONID
TYPE /AWS1/GMLARNSTRINGMODEL
/AWS1/GMLARNSTRINGMODEL
¶
A unique identifier for the game session to update.
Optional arguments:¶
IV_MAXIMUMPLAYERSESSIONCOUNT
TYPE /AWS1/GMLWHOLENUMBER
/AWS1/GMLWHOLENUMBER
¶
The maximum number of players that can be connected simultaneously to the game session.
IV_NAME
TYPE /AWS1/GMLNONZEROANDMAXSTRING
/AWS1/GMLNONZEROANDMAXSTRING
¶
A descriptive label that is associated with a game session. Session names do not need to be unique.
IV_PLAYERSESSCREATIONPOLICY
TYPE /AWS1/GMLPLAYERSESSCREATIONPLY
/AWS1/GMLPLAYERSESSCREATIONPLY
¶
A policy that determines whether the game session is accepting new players.
IV_PROTECTIONPOLICY
TYPE /AWS1/GMLPROTECTIONPOLICY
/AWS1/GMLPROTECTIONPOLICY
¶
Game session protection policy to apply to this game session only.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an
ACTIVE
status, it cannot be terminated during a scale-down event.
IT_GAMEPROPERTIES
TYPE /AWS1/CL_GMLGAMEPROPERTY=>TT_GAMEPROPERTYLIST
TT_GAMEPROPERTYLIST
¶
A set of key-value pairs that can store custom data in a game session. For example:
{"Key": "difficulty", "Value": "novice"}
. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.