Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
PointsService
Inherits from: Instance → Object
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.
Inherits from: Instance
Memory category: Instances
Tags: NotCreatable, Service, Deprecated
Deprecated: This class was once used to control an ancient achievement system since removed and deprecated. It and its members should not be used in new work.
Methods
| Name | Type / Returns | Description |
|---|---|---|
| PointsService:AwardPoints | Tuple | Attempts to award the user with the specified Player.UserId the specified number of points. |
| PointsService:GetAwardablePoints | int | Returns the number of points the current game has available to award to players. |
| PointsService:GetGamePointBalance | int | Returns the total number of points a player has in the current game. |
| PointsService:GetPointBalance | int | Returns the total number of points the given player has across all games. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
PointsService:AwardPoints
Deprecated. This function was once part of the PointService class used to control an ancient achievement system since removed and deprecated. It should not be used in new work.
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| userId | int64 | ||
| amount | int |
Returns
| Type | Description |
|---|---|
| Tuple |
| Field | Value |
|---|---|
| tags | ["Yields","Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
Code samples: View on Creator Hub (PointsService-AwardPoints1, PointsService-AwardPoints).
PointsService:GetAwardablePoints
Deprecated. This function was once part of the PointService class used to control an ancient achievement system since removed and deprecated. It should not be used in new work.
This function returns the number of points the current game has available to award to players.
Returns
| Type | Description |
|---|---|
| int |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
PointsService:GetGamePointBalance
Deprecated. This function was once part of the PointService class used to control an ancient achievement system since removed and deprecated. It should not be used in new work.
This function returns the total number of points a player has in the current game.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| userId | int64 |
Returns
| Type | Description |
|---|---|
| int |
| Field | Value |
|---|---|
| tags | ["Yields","Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
PointsService:GetPointBalance
Deprecated. This function was once part of the PointService class used to control an ancient achievement system since removed and deprecated. It should not be used in new work.
This function returns the total number of points the given player has across all games.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| userId | int64 |
Returns
| Type | Description |
|---|---|
| int |
| Field | Value |
|---|---|
| tags | ["Yields","Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic"] |
Events
| Name | Type / Returns | Description |
|---|---|---|
| PointsService.PointsAwarded | 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. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |
PointsService.PointsAwarded
Deprecated. This function was once part of the PointService class used to control an ancient achievement system since removed and deprecated. It should not be used in new work.
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| userId | int64 | ||
| pointsAwarded | int | ||
| userBalanceInGame | int | ||
| userTotalBalance | int |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Basic"] |
Code samples: View on Creator Hub (PointsService-PointsAwarded1, PointsService-PointsAwarded).
Properties
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |