# PointsService

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Deprecated, Not creatable, Service
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/PointsService/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/PointsService

**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.

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

## Methods

### AwardPoints

```luau
PointsService:AwardPoints(userId: number, amount: number): ...any
```

- Tags: Deprecated, Yields, Capabilities: Basic

**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.

Attempts to award the user with the specified [`Player.UserId`](https://rapi.sleaze.dev/classes/Player.md) the specified number of points.

### GetAwardablePoints

```luau
PointsService:GetAwardablePoints(): number
```

- Tags: Deprecated, Capabilities: Basic

**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.

Returns the number of points the current game has available to award to players.

### GetGamePointBalance

```luau
PointsService:GetGamePointBalance(userId: number): number
```

- Tags: Deprecated, Yields, Capabilities: Basic

**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.

Returns the total number of points a player has in the current game.

### GetPointBalance

```luau
PointsService:GetPointBalance(userId: number): number
```

- Tags: Deprecated, Yields, Capabilities: Basic

**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.

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

## Events

### PointsAwarded

```luau
PointsService.PointsAwarded: RBXScriptSignal<(userId: number, pointsAwarded: number, userBalanceInGame: number, userTotalBalance: number)>
```

- Tags: Capabilities: Basic

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 members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`