PointsService

Supported Class Services Deprecated in Roblox Deprecated NotCreatable Service

This service controls the points award system used to showcase a player's achievements and participation throughout Roblox.

Description

The PointsService class controls points.

Points are an award system used to showcase a player's achievements and participation throughout Roblox. How points are awarded through this service is at the discretion of the game's developer.

Inheritance

Object → Instance → PointsService

Nova inheritance: Instance → PointsService

Methods

AwardPoints Supported Function Deprecated Attempts to award the user with the specified Player.UserId the specified number of points.

PointsService:AwardPoints(int userId, int amount): Tuple

This function attempts to award the user with the specified Player.UserId the specified number of points.

If successful, this function will return the UserId of the user the points were awarded to, the number of points awarded, the new total number of points the user has in the game and another value which appears to always be 0.

This function will cause an error if the specified UserId is not positive or if the number of points specified is 0.

The function can be used to award a negative number of points to a user however.

Roblox reference signature

PointsService:AwardPoints(userId: int64, amount: int): Tuple

Roblox documentation

GetAwardablePoints Supported Function Deprecated Returns the number of points the current game has available to award to players.

PointsService:GetAwardablePoints(): int

This function returns the number of points the current game has available to award to players.

Nova behaviour: Nova keeps this legacy member for compatibility. Roblox's modern deprecation wording may describe later Roblox behaviour; verify it against Nova before relying on the copied text.

Roblox documentation

GetGamePointBalance Supported Function Deprecated Returns the total number of points a player has in the current game.

PointsService:GetGamePointBalance(int userId): int

This function returns the total number of points a player has in the current game.

Roblox reference signature

PointsService:GetGamePointBalance(userId: int64): int

Roblox documentation

GetPointBalance Supported Function Deprecated Returns the total number of points the given player has across all games.

PointsService:GetPointBalance(int userId): int

Returns the total number of points the given player has across all games.

This function returns the total number of points the given player has across all games.

Roblox reference signature

PointsService:GetPointBalance(userId: int64): int

Nova behaviour: Nova keeps this legacy member for compatibility. Roblox's modern deprecation wording may describe later Roblox behaviour; verify it against Nova before relying on the copied text.

Roblox documentation

Events

PointsAwarded Supported Event Deprecated Fires when points have been successfully awarded to a player, while also passing along the updated balance of points the player has in the current ga…

PointsAwarded(int userId, int pointsAwarded, int userBalanceInGame, int userTotalBalance)

This event fires when points have been successfully awarded to a player, while also passing along the updated balance of points the player has in the current game and all games.

When a player is awarded points successfully the below example would print the userId and their new point balance. If, for example, the Roblox account was awarded thirty points (and had none to begin with)

User: 1 has now earned 30 (+30) points in the current game, now making their total balance

would be printed.

Roblox reference signature

PointsAwarded(userId: int64, pointsAwarded: int, userBalanceInGame: int, userTotalBalance: int)

Roblox documentation

Inherited members

Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.

Roblox reference: PointsService

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.