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
A non-zero integer to apply. Positive awards points; negative deducts them.
The magnitude cannot exceed 1,000,000 per call.
string
Optional reason recorded with the transaction (shown in the points history).
string
default:"manual"
Optional category to group the transaction under. One of
"manual",
"system", "event", or "adjustment". Any other value falls back to
"manual".Returns
table | nil
The transaction result on success, or
nil if the request was rejected
(e.g. a zero or out-of-range amount) or the backend was unreachable.Examples
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 user’s reputation summary on success, or
nil on failure.