Stay organized with collections
Save and categorize content based on your preferences.
gpg::PlayerLevel
#include <player_level.h>
A single data structure containing data about player's level.
Summary
Public functions
|
LevelNumber() const
|
uint32_t
Returns the number for this level, e.g.
|
MaximumXP() const
|
uint64_t
Returns the maximum XP value represented by this level, exclusive.
|
MinimumXP() const
|
uint64_t
Returns the minimum XP value needed to attain this level, inclusive.
|
Valid() const
|
bool
Returns true when the returned player level is populated with data and is accompanied by a successful response status; false for an unpopulated user-created player or for a populated one accompanied by an unsuccessful response status.
|
operator=(const PlayerLevel & copy_from)
|
Assignment operator for assigning this player level's value from another player level.
|
operator=(PlayerLevel && move_from)
|
Assignment operator for assigning this player level's value from another player level.
|
Public functions
LevelNumber
uint32_t LevelNumber() const
Returns the number for this level, e.g.
"level 10".
MaximumXP
uint64_t MaximumXP() const
Returns the maximum XP value represented by this level, exclusive.
MinimumXP
uint64_t MinimumXP() const
Returns the minimum XP value needed to attain this level, inclusive.
PlayerLevel
PlayerLevel()
PlayerLevel
PlayerLevel(
std::shared_ptr< const PlayerLevelImpl > impl
)
Constructs a PlayerLevel from a shared_ptr to a PlayerLevelImpl.
This is used internally, and is not intended for use by consumers of this API.
PlayerLevel
PlayerLevel(
const PlayerLevel & copy_from
)
Copy constructor for copying an existing player level into a new one.
PlayerLevel
PlayerLevel(
PlayerLevel && move_from
)
Constructor for moving an existing player level into a new one.
r-value-reference version.
Valid
bool Valid() const
Returns true when the returned player level is populated with data and is accompanied by a successful response status; false for an unpopulated user-created player or for a populated one accompanied by an unsuccessful response status.
It must be true for the getter functions on this object to be usable.
operator=
PlayerLevel & operator=(
const PlayerLevel & copy_from
)
Assignment operator for assigning this player level's value from another player level.
operator=
PlayerLevel & operator=(
PlayerLevel && move_from
)
Assignment operator for assigning this player level's value from another player level.
r-value-reference version
~PlayerLevel
~PlayerLevel()
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-10-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-28 UTC."],[],[],null,["# gpg::PlayerLevel Class Reference\n\ngpg::PlayerLevel\n================\n\n`#include \u003cplayer_level.h\u003e`\n\nA single data structure containing data about player's level.\n\nSummary\n-------\n\n| ### Constructors and Destructors ||\n|---|---|\n| [PlayerLevel](#classgpg_1_1_player_level_1a5c5aa7ac12e8befff021dfede69cc74e)`()` ||\n| [PlayerLevel](#classgpg_1_1_player_level_1afa1e453e677bed09bd1b441493413bb3)`(std::shared_ptr\u003c const `[PlayerLevelImpl](/games/services/cpp/api/class/gpg/player-level#classgpg_1_1_player_level_1a7024c8d2bb0a3800d3d1c51a6abe8a81)` \u003e impl)` Constructs a [PlayerLevel](/games/services/cpp/api/class/gpg/player-level#classgpg_1_1_player_level) from a shared_ptr to a PlayerLevelImpl. ||\n| [PlayerLevel](#classgpg_1_1_player_level_1a04210c98ac60ed639e544243120b4af5)`(const `[PlayerLevel](/games/services/cpp/api/class/gpg/player-level#classgpg_1_1_player_level)` & copy_from)` Copy constructor for copying an existing player level into a new one. ||\n| [PlayerLevel](#classgpg_1_1_player_level_1aeebff567c41fcd3da2ac4fb64ffb0d06)`(`[PlayerLevel](/games/services/cpp/api/class/gpg/player-level#classgpg_1_1_player_level)` && move_from)` Constructor for moving an existing player level into a new one. ||\n| [~PlayerLevel](#classgpg_1_1_player_level_1af24508b4298f81e3d0536cd5613c9c6a)`()` ||\n\n| ### Public functions ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [LevelNumber](#classgpg_1_1_player_level_1a72a1a8a54abc33105a48ec0607b759aa)`() const ` | `uint32_t` Returns the number for this level, e.g. |\n| [MaximumXP](#classgpg_1_1_player_level_1a3bef587603a5792449b093e8ac4288bc)`() const ` | `uint64_t` Returns the maximum XP value represented by this level, exclusive. |\n| [MinimumXP](#classgpg_1_1_player_level_1aca921678a833699257117f51741366a2)`() const ` | `uint64_t` Returns the minimum XP value needed to attain this level, inclusive. |\n| [Valid](#classgpg_1_1_player_level_1a458b510e8e30ca8459598636c6b8acc9)`() const ` | `bool` Returns true when the returned player level is populated with data and is accompanied by a successful response status; false for an unpopulated user-created player or for a populated one accompanied by an unsuccessful response status. |\n| [operator=](#classgpg_1_1_player_level_1a7574b9a7ec930a71519b91399710113f)`(const `[PlayerLevel](/games/services/cpp/api/class/gpg/player-level#classgpg_1_1_player_level)` & copy_from)` | [PlayerLevel](/games/services/cpp/api/class/gpg/player-level#classgpg_1_1_player_level)` &` Assignment operator for assigning this player level's value from another player level. |\n| [operator=](#classgpg_1_1_player_level_1a0d82f9e3a4b9e49f12df76c3c2d5b02f)`(`[PlayerLevel](/games/services/cpp/api/class/gpg/player-level#classgpg_1_1_player_level)` && move_from)` | [PlayerLevel](/games/services/cpp/api/class/gpg/player-level#classgpg_1_1_player_level)` &` Assignment operator for assigning this player level's value from another player level. |\n\nPublic functions\n----------------\n\n### LevelNumber\n\n```c++\nuint32_t LevelNumber() const \n``` \nReturns the number for this level, e.g.\n\n\"level 10\". \n\n### MaximumXP\n\n```c++\nuint64_t MaximumXP() const \n``` \nReturns the maximum XP value represented by this level, exclusive. \n\n### MinimumXP\n\n```c++\nuint64_t MinimumXP() const \n``` \nReturns the minimum XP value needed to attain this level, inclusive. \n\n### PlayerLevel\n\n```c++\n PlayerLevel()\n``` \n\n### PlayerLevel\n\n```c++\n PlayerLevel(\n std::shared_ptr\u003c const PlayerLevelImpl \u003e impl\n)\n``` \nConstructs a [PlayerLevel](/games/services/cpp/api/class/gpg/player-level#classgpg_1_1_player_level) from a shared_ptr to a PlayerLevelImpl.\n\nThis is used internally, and is not intended for use by consumers of this API. \n\n### PlayerLevel\n\n```c++\n PlayerLevel(\n const PlayerLevel & copy_from\n)\n``` \nCopy constructor for copying an existing player level into a new one. \n\n### PlayerLevel\n\n```c++\n PlayerLevel(\n PlayerLevel && move_from\n)\n``` \nConstructor for moving an existing player level into a new one.\n\nr-value-reference version. \n\n### Valid\n\n```c++\nbool Valid() const \n``` \nReturns true when the returned player level is populated with data and is accompanied by a successful response status; false for an unpopulated user-created player or for a populated one accompanied by an unsuccessful response status.\n\nIt must be true for the getter functions on this object to be usable. \n\n### operator=\n\n```c++\nPlayerLevel & operator=(\n const PlayerLevel & copy_from\n)\n``` \nAssignment operator for assigning this player level's value from another player level. \n\n### operator=\n\n```c++\nPlayerLevel & operator=(\n PlayerLevel && move_from\n)\n``` \nAssignment operator for assigning this player level's value from another player level.\n\nr-value-reference version \n\n### \\~PlayerLevel\n\n```c++\n ~PlayerLevel()\n```"]]
