PointsService
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

Instances of this class cannot be created with Instance.new.

It is a singleton that may be acquired with GetService.

Memory category	Instances

Tags: [NotCreatable, Service, Deprecated]

Member index 5

History		Member
462		AwardPoints(userId: int64, amount: int): Tuple
462		GetAwardablePoints(): int
462		GetGamePointBalance(userId: int64): int
462		GetPointBalance(userId: int64): int
462		PointsAwarded(userId: int64, pointsAwarded: int, userBalanceInGame: int, userTotalBalance: int)
63 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
635		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
635		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
616		UniqueId: UniqueId
553		archivable: bool
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
486		GetDescendants(): Array
486		GetFullName(): string
641		GetStyled(name: string): Variant
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
580		IsPropertyModified(name: string): bool
573		Remove(): null
576		RemoveTag(tag: string): null
580		ResetPropertyToDefault(name: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

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.

History 22
Hide member changes

462 Change ThreadSafety of PointsAwarded from to Unsafe
462 Change ThreadSafety of GetPointBalance from to Unsafe
462 Change ThreadSafety of GetGamePointBalance from to Unsafe
462 Change ThreadSafety of GetAwardablePoints from to Unsafe
462 Change ThreadSafety of AwardPoints from to Unsafe
359 Change Tags of GetGamePointBalance from [Yields] to [Yields, Deprecated]
359 Change Tags of AwardPoints from [Yields] to [Yields, Deprecated]
359 Change Tags of PointsService from [NotCreatable, Service] to [NotCreatable, Service, Deprecated]
325 Change Parameters of PointsAwarded from (userId: int, pointsAwarded: int, userBalanceInGame: int, userTotalBalance: int) to (userId: int64, pointsAwarded: int, userBalanceInGame: int, userTotalBalance: int)
325 Change Parameters of AwardPoints from (userId: int, amount: int) to (userId: int64, amount: int)
322 Change Parameters of GetPointBalance from (userId: int) to (userId: int64)
322 Change Parameters of GetGamePointBalance from (userId: int) to (userId: int64)
208 Change Tags of GetPointBalance from [Yields] to [Yields, Deprecated]
208 Change Tags of GetAwardablePoints from [] to [Deprecated]
172 Change Tags of GetAwardablePoints from [Yields] to []
147 Change Parameters of PointsAwarded from (userId: int, userBalanceInGame: int, userTotalBalance: int) to (userId: int, pointsAwarded: int, userBalanceInGame: int, userTotalBalance: int)
143 Add PointsAwarded
143 Add GetPointBalance
143 Add GetGamePointBalance
143 Add GetAwardablePoints
143 Add AwardPoints
143 Add PointsService

Members 5

AwardPoints
CreatorHub

Parameters (2)
userId	int64
amount	int
Returns (1)
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.

1
2

local userId, amount, total = game:GetService("PointsService"):AwardPoints(1, 5)
print("The user was awarded " ..amount.. " points. They have now have a total of " ..total.. " points in this game.")

It exists only for backward compatibility, and should not be used for new work.

It will block the calling thread until completion.

Thread safety	Unsafe

History 4

462 Change ThreadSafety of AwardPoints from to Unsafe
359 Change Tags of AwardPoints from [Yields] to [Yields, Deprecated]
325 Change Parameters of AwardPoints from (userId: int, amount: int) to (userId: int64, amount: int)
143 Add AwardPoints

Tags: [Yields, Deprecated]

GetAwardablePoints
CreatorHub

Parameters (0)
No parameters.
Returns (1)
int

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

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 4

462 Change ThreadSafety of GetAwardablePoints from to Unsafe
208 Change Tags of GetAwardablePoints from [] to [Deprecated]
172 Change Tags of GetAwardablePoints from [Yields] to []
143 Add GetAwardablePoints

Tags: [Deprecated]

GetGamePointBalance
CreatorHub

Parameters (1)
userId	int64
Returns (1)
int

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

It exists only for backward compatibility, and should not be used for new work.

It will block the calling thread until completion.

Thread safety	Unsafe

History 4

462 Change ThreadSafety of GetGamePointBalance from to Unsafe
359 Change Tags of GetGamePointBalance from [Yields] to [Yields, Deprecated]
322 Change Parameters of GetGamePointBalance from (userId: int) to (userId: int64)
143 Add GetGamePointBalance

Tags: [Yields, Deprecated]

GetPointBalance
CreatorHub

Parameters (1)
userId	int64
Returns (1)
int

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

It exists only for backward compatibility, and should not be used for new work.

It will block the calling thread until completion.

Thread safety	Unsafe

History 4

462 Change ThreadSafety of GetPointBalance from to Unsafe
322 Change Parameters of GetPointBalance from (userId: int) to (userId: int64)
208 Change Tags of GetPointBalance from [Yields] to [Yields, Deprecated]
143 Add GetPointBalance

Tags: [Yields, Deprecated]

PointsAwarded
CreatorHub

Parameters (4)
userId	int64
pointsAwarded	int
userBalanceInGame	int
userTotalBalance	int

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.

local function pointsAwarded(userId, pointsAwarded, userBalanceInGame, userTotalBalance)
	print("User: " .. userId .. " has now earned " .. userBalanceInGame .. " (+" .. pointsAwarded ..") points in the current game, now making their total balance " .. userTotalBalance)
end

game:GetService("PointsService").PointsAwarded:Connect(pointsAwarded)

Thread safety	Unsafe

History 4

462 Change ThreadSafety of PointsAwarded from to Unsafe
325 Change Parameters of PointsAwarded from (userId: int, pointsAwarded: int, userBalanceInGame: int, userTotalBalance: int) to (userId: int64, pointsAwarded: int, userBalanceInGame: int, userTotalBalance: int)
147 Change Parameters of PointsAwarded from (userId: int, userBalanceInGame: int, userTotalBalance: int) to (userId: int, pointsAwarded: int, userBalanceInGame: int, userTotalBalance: int)
143 Add PointsAwarded

Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PointsService
CreatorHub

Member index 5

Description

History 22
Hide member changes

Members 5

AwardPoints
CreatorHub

History 4

GetAwardablePoints
CreatorHub

History 4

GetGamePointBalance
CreatorHub

History 4

GetPointBalance
CreatorHub

History 4

PointsAwarded
CreatorHub

History 4

Settings