Skip to main content

getUserPoints

Returns a user’s current points balance.

Parameters

Player | table | number
required
The entity requesting the balance. See the actor object.
Player | number | string
required
The user whose balance to read. Accepts a Player instance or a raw UserId.

Returns

number | nil
The user’s points balance, or nil if the request failed or the backend was unreachable.

Example


updateUserPoints

Adds to (or subtracts from) a user’s points balance.

Parameters

Player | table | number
required
Who is granting/removing the points. See the actor object.
Player | number | string
required
The user whose balance to change. Accepts a Player instance or a raw UserId.
number
required
The amount to apply. Use a negative number to deduct points.
string
Optional reason recorded with the transaction.
string
Optional category to group the transaction under.

Returns

table | nil
The transaction result from the dashboard on success, or nil on failure.

Example


getReputation

Returns a user’s reputation record.

Parameters

Player | table | number
required
The entity requesting the reputation. See the actor object.
Player | number | string
required
The user whose reputation to read. Accepts a Player instance or a raw UserId.

Returns

table | nil
The reputation payload from the dashboard on success, or nil on failure.

Example