Skip to content

badges

roblox.badges

This module contains classes intended to parse and deal with data from Roblox badge information endpoints.

Badge (BaseBadge)

Represents a badge from the API.

Attributes:

Name Type Description
id int

The badge Id.

name str

The name of the badge.

description str

The badge description.

display_name str

The localized name of the badge.

display_description str

The localized badge description.

enabled bool

Whether or not the badge is enabled.

icon BaseAsset

The badge icon.

display_icon BaseAsset

The localized badge icon.

created datetime

When the badge was created.

updated datetime

When the badge was updated.

statistics BadgeStatistics

Badge award statistics.

awarding_universe PartialUniverse

The universe the badge is being awarded from.

Source code in roblox/badges.py
class Badge(BaseBadge):
    """
    Represents a badge from the API.

    Attributes:
        id: The badge Id.
        name: The name of the badge.
        description: The badge description.
        display_name: The localized name of the badge.
        display_description: The localized badge description.
        enabled: Whether or not the badge is enabled.
        icon: The badge icon.
        display_icon: The localized badge icon.
        created: When the badge was created.
        updated: When the badge was updated.
        statistics: Badge award statistics.
        awarding_universe: The universe the badge is being awarded from.
    """

    def __init__(self, client: Client, data: dict):
        """
        Arguments:
            client: The Client to be used when getting information on badges.
            data: The data from the endpoint.
        """
        self.id: int = data["id"]

        super().__init__(client=client, badge_id=self.id)

        self.name: str = data["name"]
        self.description: str = data["description"]
        self.display_name: str = data["displayName"]
        self.display_description: str = data["displayDescription"]
        self.enabled: bool = data["enabled"]
        self.icon: BaseAsset = BaseAsset(client=client, asset_id=data["iconImageId"])
        self.display_icon: BaseAsset = BaseAsset(client=client, asset_id=data["displayIconImageId"])
        self.created: datetime = parse(data["created"])
        self.updated: datetime = parse(data["updated"])

        self.statistics: BadgeStatistics = BadgeStatistics(data=data["statistics"])
        self.awarding_universe: PartialUniverse = PartialUniverse(client=client, data=data["awardingUniverse"])

    def __repr__(self):
        return f"<{self.__class__.__name__} id={self.id} name={self.name!r}>"

__init__(self, client: Client, data: dict) special

Parameters:

Name Type Description Default
client Client

The Client to be used when getting information on badges.

required
data dict

The data from the endpoint.

required
Source code in roblox/badges.py
def __init__(self, client: Client, data: dict):
    """
    Arguments:
        client: The Client to be used when getting information on badges.
        data: The data from the endpoint.
    """
    self.id: int = data["id"]

    super().__init__(client=client, badge_id=self.id)

    self.name: str = data["name"]
    self.description: str = data["description"]
    self.display_name: str = data["displayName"]
    self.display_description: str = data["displayDescription"]
    self.enabled: bool = data["enabled"]
    self.icon: BaseAsset = BaseAsset(client=client, asset_id=data["iconImageId"])
    self.display_icon: BaseAsset = BaseAsset(client=client, asset_id=data["displayIconImageId"])
    self.created: datetime = parse(data["created"])
    self.updated: datetime = parse(data["updated"])

    self.statistics: BadgeStatistics = BadgeStatistics(data=data["statistics"])
    self.awarding_universe: PartialUniverse = PartialUniverse(client=client, data=data["awardingUniverse"])

__repr__(self) special

Source code in roblox/badges.py
def __repr__(self):
    return f"<{self.__class__.__name__} id={self.id} name={self.name!r}>"

BadgeStatistics

Attributes:

Name Type Description
past_day_awarded_count int

How many instances of this badge were awarded in the last day.

awarded_count int

How many instances of this badge have been awarded.

win_rate_percentage int

Percentage of players who have joined the parent universe have been awarded this badge.

Source code in roblox/badges.py
class BadgeStatistics:
    """
    Attributes:
        past_day_awarded_count: How many instances of this badge were awarded in the last day.
        awarded_count: How many instances of this badge have been awarded.
        win_rate_percentage: Percentage of players who have joined the parent universe have been awarded this badge.
    """

    def __init__(self, data: dict):
        """
        Arguments:
            data: The raw input data.
        """
        self.past_day_awarded_count: int = data["pastDayAwardedCount"]
        self.awarded_count: int = data["awardedCount"]
        self.win_rate_percentage: int = data["winRatePercentage"]

    def __repr__(self):
        return f"<{self.__class__.__name__} awarded_count={self.awarded_count}>"

__init__(self, data: dict) special

Parameters:

Name Type Description Default
data dict

The raw input data.

required
Source code in roblox/badges.py
def __init__(self, data: dict):
    """
    Arguments:
        data: The raw input data.
    """
    self.past_day_awarded_count: int = data["pastDayAwardedCount"]
    self.awarded_count: int = data["awardedCount"]
    self.win_rate_percentage: int = data["winRatePercentage"]

__repr__(self) special

Source code in roblox/badges.py
def __repr__(self):
    return f"<{self.__class__.__name__} awarded_count={self.awarded_count}>"