Skip to content
Roblox API Reference

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.
  • Deprecated
  • Not creatable
  • Service
Memory category
Instances
Own members
5
Inherited members
75
Subclasses
0
Siblings
608

Properties23

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Methods46

Inherited fromObject3
  • Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Inherited fromInstance39
Defined byPointsService4
  • PointsService:AwardPoints(userId: number, amount: number): ...any
    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 the specified number of points.
    • Deprecated
    • Yields
    • Capabilities: Basic
    Parameters
    Parameter
    userId: number
    amount: number
    Returns
    Type
    ...any
  • PointsService:GetAwardablePoints(): number
    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.
    • Deprecated
    • Capabilities: Basic
    Returns
    Type
    number
  • PointsService:GetGamePointBalance(userId: number): number
    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.
    • Deprecated
    • Yields
    • Capabilities: Basic
    Parameters
    Parameter
    userId: number
    Returns
    Type
    number
  • PointsService:GetPointBalance(userId: number): number
    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.
    • Deprecated
    • Yields
    • Capabilities: Basic
    Parameters
    Parameter
    userId: number
    Returns
    Type
    number

Events11

Inherited fromObject1
Inherited fromInstance9
Defined byPointsService1
  • PointsService.PointsAwarded: RBXScriptSignal<(userId: number,pointsAwarded: number,userBalanceInGame: number,userTotalBalance: number,)>
    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.
    • Capabilities: Basic
    Parameters
    Parameter
    userId: number
    pointsAwarded: number
    userBalanceInGame: number
    userTotalBalance: number