Skip to content

plugins

roblox.plugins

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

Plugin (BasePlugin)

Represents a Roblox plugin. It is intended to parse data from https://develop.roblox.com/v1/plugins.

Attributes:

Name Type Description
id int

The ID of the plugin.

name str

The name of the plugin.

description str

The plugin's description.

comments_enabled bool

Whether comments are enabled or disabled.

version_id int

The plugin's current version ID.

created datetime

When the plugin was created.

updated datetime

When the plugin was updated.

Source code in roblox/plugins.py
class Plugin(BasePlugin):
    """
    Represents a Roblox plugin.
    It is intended to parse data from https://develop.roblox.com/v1/plugins.

    Attributes:
        id: The ID of the plugin.
        name: The name of the plugin.
        description: The plugin's description.
        comments_enabled: Whether comments are enabled or disabled.
        version_id: The plugin's current version ID.
        created: When the plugin was created.
        updated: When the plugin was updated.
    """

    def __init__(self, client: Client, data: dict):
        """
        Attributes:
            client: The Client object, which is passed to all objects this Client generates.
            data: data to make the magic happen.
        """
        super().__init__(client=client, plugin_id=data["id"])

        self.id: int = data["id"]
        self.name: str = data["name"]
        self.description: str = data["description"]
        self.comments_enabled: bool = data["commentsEnabled"]
        self.version_id: int = data["versionId"]
        self.created: datetime = parse(data["created"])
        self.updated: datetime = parse(data["updated"])

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

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

Attributes:

Name Type Description
client

The Client object, which is passed to all objects this Client generates.

data

data to make the magic happen.

Source code in roblox/plugins.py
def __init__(self, client: Client, data: dict):
    """
    Attributes:
        client: The Client object, which is passed to all objects this Client generates.
        data: data to make the magic happen.
    """
    super().__init__(client=client, plugin_id=data["id"])

    self.id: int = data["id"]
    self.name: str = data["name"]
    self.description: str = data["description"]
    self.comments_enabled: bool = data["commentsEnabled"]
    self.version_id: int = data["versionId"]
    self.created: datetime = parse(data["created"])
    self.updated: datetime = parse(data["updated"])

__repr__(self) special

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