/AWS1/CL_GMLGAMEPROPERTY¶
This key-value pair can store custom data about a game session. For example, you might
use a GameProperty to track a game session's map, level of difficulty, or
remaining time. The difficulty level could be specified like this: {"Key":
"difficulty", "Value":"Novice"}.
You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can't delete game properties from a game session.
For examples of working with game properties, see Create a game session with properties.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_key TYPE /AWS1/GMLGAMEPROPERTYKEY /AWS1/GMLGAMEPROPERTYKEY¶
The game property identifier.
Avoid using periods (".") in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations.
If you use SearchGameSessions API, there is a limit of 500 game property keys across all game sessions and all fleets per region. If the limit is exceeded, there will potentially be game session entries missing from SearchGameSessions API results.
iv_value TYPE /AWS1/GMLGAMEPROPERTYVALUE /AWS1/GMLGAMEPROPERTYVALUE¶
The game property value.
Queryable Attributes¶
Key¶
The game property identifier.
Avoid using periods (".") in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations.
If you use SearchGameSessions API, there is a limit of 500 game property keys across all game sessions and all fleets per region. If the limit is exceeded, there will potentially be game session entries missing from SearchGameSessions API results.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEY() |
Getter for KEY, with configurable default |
ASK_KEY() |
Getter for KEY w/ exceptions if field has no value |
HAS_KEY() |
Determine if KEY has a value |
Value¶
The game property value.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VALUE() |
Getter for VALUE, with configurable default |
ASK_VALUE() |
Getter for VALUE w/ exceptions if field has no value |
HAS_VALUE() |
Determine if VALUE has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_GAMEPROPERTYLIST¶
TYPES TT_GAMEPROPERTYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_GMLGAMEPROPERTY WITH DEFAULT KEY
.