PlayerLevel
Stay organized with collections
Save and categorize content based on your preferences.
Data object representing a level a player can obtain in the metagame.
A PlayerLevel
has three components: a numeric value, and a range of XP totals
it represents. A player is considered a given level if they have at least
getMinXp()
and less than
getMaxXp()
.
Inherited Constant Summary
From interface android.os.Parcelable
| int |
CONTENTS_FILE_DESCRIPTOR |
|
| int |
PARCELABLE_WRITE_RETURN_VALUE |
|
Public Method Summary
| boolean |
|
| int |
|
| long |
getMaxXp
() Returns the maximum XP value represented by this level, exclusive.
|
| long |
getMinXp
() Returns the minimum XP value needed to attain this level, inclusive.
|
| int |
|
| String
|
|
| void |
|
Inherited Method Summary
From class java.lang.Object
From interface android.os.Parcelable
| abstract int |
describeContents
()
|
| abstract void |
writeToParcel
( Parcel
arg0,
int arg1)
|
Public Methods
public boolean
equals
( Object
obj)
public int
getLevelNumber
()
Returns
- The level number for this level.
public long
getMaxXp
()
Returns the maximum XP value represented by this level, exclusive.
public long
getMinXp
()
Returns the minimum XP value needed to attain this level, inclusive.
public void
writeToParcel
( Parcel
out, int
flags)
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 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-31 UTC."],[[["\u003cp\u003e\u003ccode\u003ePlayerLevel\u003c/code\u003e is a data object representing a level a player can achieve in a game's metagame.\u003c/p\u003e\n"],["\u003cp\u003eA player's level is determined by their XP total falling within a specific range defined by \u003ccode\u003egetMinXp()\u003c/code\u003e and \u003ccode\u003egetMaxXp()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePlayerLevel\u003c/code\u003e includes methods to access the level number, minimum XP, and maximum XP for a given level.\u003c/p\u003e\n"],["\u003cp\u003eThis class implements \u003ccode\u003eParcelable\u003c/code\u003e, allowing it to be passed between components or processes.\u003c/p\u003e\n"]]],[],null,["# PlayerLevel\n\npublic final class **PlayerLevel** extends [Object](//developer.android.com/reference/java/lang/Object.html) \nimplements [Parcelable](//developer.android.com/reference/android/os/Parcelable.html) \nData object representing a level a player can obtain in the metagame.\n\nA `PlayerLevel` has three components: a numeric value, and a range of XP totals\nit represents. A player is considered a given level if they have **at least**\n`getMinXp()` and **less than** `getMaxXp()`. \n\n### Inherited Constant Summary\n\nFrom interface android.os.Parcelable \n\n|-----|-------------------------------|---|\n| int | CONTENTS_FILE_DESCRIPTOR | |\n| int | PARCELABLE_WRITE_RETURN_VALUE | |\n\n### Field Summary\n\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|---|\n| public static final [Creator](//developer.android.com/reference/android/os/Parcelable.Creator.html)\\\u003c[PlayerLevel](/android/reference/com/google/android/gms/games/PlayerLevel)\\\u003e | [CREATOR](/android/reference/com/google/android/gms/games/PlayerLevel#CREATOR) | |\n\n### Public Method Summary\n\n|-------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| boolean | [equals](/android/reference/com/google/android/gms/games/PlayerLevel#equals(java.lang.Object))([Object](//developer.android.com/reference/java/lang/Object.html) obj) |\n| int | [getLevelNumber](/android/reference/com/google/android/gms/games/PlayerLevel#getLevelNumber())() Returns the number for this level, e.g. |\n| long | [getMaxXp](/android/reference/com/google/android/gms/games/PlayerLevel#getMaxXp())() Returns the maximum XP value represented by this level, exclusive. |\n| long | [getMinXp](/android/reference/com/google/android/gms/games/PlayerLevel#getMinXp())() Returns the minimum XP value needed to attain this level, inclusive. |\n| int | [hashCode](/android/reference/com/google/android/gms/games/PlayerLevel#hashCode())() |\n| [String](//developer.android.com/reference/java/lang/String.html) | [toString](/android/reference/com/google/android/gms/games/PlayerLevel#toString())() |\n| void | [writeToParcel](/android/reference/com/google/android/gms/games/PlayerLevel#writeToParcel(android.os.Parcel,%20int))([Parcel](//developer.android.com/reference/android/os/Parcel.html) out, int flags) |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [Object](//developer.android.com/reference/java/lang/Object.html) | clone() |\n| boolean | equals([Object](//developer.android.com/reference/java/lang/Object.html) arg0) |\n| void | finalize() |\n| final [Class](//developer.android.com/reference/java/lang/Class.html)\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| [String](//developer.android.com/reference/java/lang/String.html) | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nFrom interface android.os.Parcelable \n\n|---------------|--------------------------------------------------------------------------------------------------|\n| abstract int | describeContents() |\n| abstract void | writeToParcel([Parcel](//developer.android.com/reference/android/os/Parcel.html) arg0, int arg1) |\n\nFields\n------\n\n#### public static final [Creator](//developer.android.com/reference/android/os/Parcelable.Creator.html)\\\u003c[PlayerLevel](/android/reference/com/google/android/gms/games/PlayerLevel)\\\u003e\n**CREATOR**\n\nPublic Methods\n--------------\n\n#### public boolean **equals** ([Object](//developer.android.com/reference/java/lang/Object.html) obj)\n\n#### public int **getLevelNumber** ()\n\nReturns the number for this level, e.g. \"level 10\".\n\nThis is the level that this object represents. For a player to be considered as\nbeing of this level, the value given by [PlayerLevelInfo.getCurrentXpTotal()](/android/reference/com/google/android/gms/games/PlayerLevelInfo#getCurrentXpTotal()) must fall in the range \\[[getMinXp()](/android/reference/com/google/android/gms/games/PlayerLevel#getMinXp()),\n[getMaxXp()](/android/reference/com/google/android/gms/games/PlayerLevel#getMaxXp())). \n\n##### Returns\n\n- The level number for this level. \n\n#### public long **getMaxXp** ()\n\nReturns the maximum XP value represented by this level, exclusive. \n\n#### public long **getMinXp** ()\n\nReturns the minimum XP value needed to attain this level, inclusive. \n\n#### public int **hashCode** ()\n\n#### public [String](//developer.android.com/reference/java/lang/String.html) **toString** ()\n\n#### public void **writeToParcel** ([Parcel](//developer.android.com/reference/android/os/Parcel.html) out, int flags)"]]
