Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JaylyDev committed Dec 18, 2023
1 parent 963a170 commit 8fb0a5b
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions scripts/offline-player/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ const player = OfflinePlayer.get('JaylyPlays');
## Properties
- [level](#level)
- [name](#name)
- [totalXpNeededForNextLevel](#totalXpNeededForNextLevel)
- [xpEarnedAtCurrentLevel](#xpEarnedAtCurrentLevel)
- [totalXpNeededForNextLevel](#totalxpneededfornextlevel)
- [xpEarnedAtCurrentLevel](#xpearnedatcurrentlevel)
- [gameMode](#gamemode)
- [lastPlayed](#lastplayed)

Expand Down Expand Up @@ -67,7 +67,7 @@ Type: *number*

## Methods
- [get](#get)
- [getSpawnPoint](#getspawnpoint)
- [get](#get-1)
- [getSpawnPoint](#getspawnpoint)
- [getTotalXp](#gettotalxp)
- [isOp](#isop)
Expand All @@ -87,14 +87,16 @@ Gets the player by the given ID, regardless if they are offline or online. This

#### **Returns** *OfflinePlayer*

### **get**

`
static get(name: string): OfflinePlayer;
`

Gets the player by the given name, regardless if they are offline or online. This will return an object even if the player does not exist. To this method, all players will exist.

#### **Deprecated**
Persistent storage of users should be by ID as names are no longer unique past a single session.
> [!CAUTION]
> Persistent storage of users should be by ID as names are no longer unique past a single session.
#### **Parameters**
- **name**: *string*
Expand Down Expand Up @@ -130,8 +132,8 @@ Returns true if this player has operator-level permissions.

#### **Returns** *boolean*

> [!CAUTION]
> This function is still in pre-release. Its signature may change or it may be removed in future releases.
> [!IMPORTANT]
> This function can only be used within Beta APIs.
### **getPlayer**
`
Expand Down

0 comments on commit 8fb0a5b

Please sign in to comment.