diff --git a/roblox/account.py b/roblox/account.py index 4915882b..3871064b 100644 --- a/roblox/account.py +++ b/roblox/account.py @@ -66,7 +66,7 @@ async def set_birthday( } ) - async def get_description(self) -> string: + async def get_description(self) -> str: """ Gets the authenticated user's description. @@ -81,14 +81,14 @@ async def get_description(self) -> string: async def set_description( self, - description: string, + description: str, ): """ Updates the authenticated user's description. This endpoint *may* require your token, and requires an unlocked PIN. Arguments: - description: A string object that represents the description to update the Client's account to. + description: A string containing the authenticated user's new description. """ await self._client.requests.post( url=self._client.url_generator.get_url("accountinformation", "v1/description"), diff --git a/roblox/assets.py b/roblox/assets.py index 27dd1c31..b2bb876c 100644 --- a/roblox/assets.py +++ b/roblox/assets.py @@ -95,8 +95,8 @@ class AssetType: Represents a Roblox asset type. Attributes: - id: Id of the Asset - name: Name of the Asset + id: Id of the Asset. + name: Name of the Asset. """ def __init__(self, type_id: int): @@ -119,27 +119,27 @@ class EconomyAsset(BaseAsset): It is intended to parse data from https://economy.roblox.com/v2/assets/ASSETID/details. Attributes: - id: Id of the Asset - product_id: Product id of the asset - name: Name of the Asset - description: Description of the Asset - type: Type of the Asset - creator_type: Type of creator can be user or group see enum - creator: creator can be a user or group object - icon_image: BaseAsset - created: When the asset was created - updated: When the asset was updated for the las time - price: price of the asset - sales: amount of sales of the asset - is_new: if the asset it new - is_for_sale: if the asset is for sale - is_public_domain: if the asset is public domain - is_limited: if the asset is a limited item - is_limited_unique: if the asset is a unique limited item - remaining: How many items there are remaining if it is limited - minimum_membership_level: Minimum membership level required to buy item - content_rating_type_id: Unknown - sale_availability_locations: Unknown + id: The asset's ID. + product_id: The asset's product ID. + name: The asset's name. + description: A description of the asset. + type: Specifies the type of the asset. + creator_type: Specifies whether the creator is a user or a group. + creator: The user or group that created the asset. + icon_image: A [BaseAsset][roblox.bases.baseasset.BaseAsset] representing the asset's icon. + created: When the asset was created. + updated: When the asset was last updated. + price: How much the asset costs. + sales: The amount of times this asset has been sold. + is_new: If the asset is new. + is_for_sale: If the asset is for sale. + is_public_domain: If the asset is public domain. + is_limited: If the asset is a limited item. + is_limited_unique: If the asset is a unique limited item. + remaining: How many items there are remaining if it is limited. + minimum_membership_level: Minimum membership level required to buy the asset. + content_rating_type_id: Unknown. + sale_availability_locations: Unknown. """ def __init__(self, client: Client, data: dict): diff --git a/roblox/badges.py b/roblox/badges.py index be367fa5..a75f9a79 100644 --- a/roblox/badges.py +++ b/roblox/badges.py @@ -44,16 +44,16 @@ class Badge(BaseBadge): Represents a badge from the API. Attributes: - id: The badge Id. + id: The badge's 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. + icon: The badge's icon. display_icon: The localized badge icon. created: When the badge was created. - updated: When the badge was updated. + updated: When the badge was last updated. statistics: Badge award statistics. awarding_universe: The universe the badge is being awarded from. """ diff --git a/roblox/bases/baseplace.py b/roblox/bases/baseplace.py index 396c6d68..2cab6df4 100644 --- a/roblox/bases/baseplace.py +++ b/roblox/bases/baseplace.py @@ -43,7 +43,7 @@ async def get_instances(self, start_index: int = 0): For more items, add 10 to the start index and repeat until no more items are available. !!! warning - This function has been deprecated. The Roblox endpoint used by this function has been removed. Please update any code using this method to use + This function has been deprecated. The Roblox endpoint used by this function has been removed. Please update any code using this method to use [get_servers][roblox.bases.baseplace.BasePlace.get_servers] or [get_private_servers][roblox.bases.baseplace.BasePlace.get_private_servers]. Arguments: start_index: Where to start in the server index. diff --git a/roblox/client.py b/roblox/client.py index 5090408d..d13953b8 100644 --- a/roblox/client.py +++ b/roblox/client.py @@ -76,7 +76,7 @@ def __repr__(self): def set_token(self, token: Optional[str] = None) -> None: """ Authenticates the client with the passed .ROBLOSECURITY token. - This method does not send any requests and will not throw if the token is invalid. + This method does not send any requests and will not throw an exception if the token is invalid. Arguments: token: A .ROBLOSECURITY token to authenticate the client with. diff --git a/roblox/jobs.py b/roblox/jobs.py index 13927154..c2347786 100644 --- a/roblox/jobs.py +++ b/roblox/jobs.py @@ -157,7 +157,7 @@ class ServerPlayer(BaseUser): Represents a player in a server. Attributes: - id: The player's user id. + id: The player's user ID. name: The player's username. display_name: The player's display name. player_token: The player's token. @@ -182,7 +182,7 @@ class Server(BaseItem): Represents a public server. Attributes: - id: The server's job id. + id: The server's job ID. max_players: The maximum number of players that can be in the server at once. playing: The amount of players in the server. player_tokens: A list of thumbnail tokens for all the players in the server. @@ -218,7 +218,7 @@ class PrivateServer(Server): Represents a private server. Attributes: - id: The private server's job id. + id: The private server's job ID. vip_server_id: The private server's vipServerId. max_players: The maximum number of players that can be in the server at once. playing: The amount of players in the server. @@ -228,7 +228,7 @@ class PrivateServer(Server): ping: The server's ping. name: The private server's name. access_code: The private server's access code. - owner: A PartialUser object representing the owner of the private server. + owner: The user that owns the private server. """ def __init__(self, client: Client, data: dict): diff --git a/roblox/partials/partialbadge.py b/roblox/partials/partialbadge.py index 14122e47..ec7261fa 100644 --- a/roblox/partials/partialbadge.py +++ b/roblox/partials/partialbadge.py @@ -21,8 +21,8 @@ class PartialBadge(BaseBadge): Attributes: _data: The data we get back from the endpoint. - _client: The cCient object, which is passed to all objects this Client generates. - id: The universe ID. + _client: The Client object, which is passed to all objects this Client generates. + id: The badge's ID. awarded: The date when the badge was awarded. """ diff --git a/roblox/partials/partialgroup.py b/roblox/partials/partialgroup.py index 19360de0..0e48b5c2 100644 --- a/roblox/partials/partialgroup.py +++ b/roblox/partials/partialgroup.py @@ -20,7 +20,7 @@ class AssetPartialGroup(BaseGroup): Attributes: _client: The Client object, which is passed to all objects this Client generates. - id: The group's name. + id: The group's ID. creator: The group's owner. name: The group's name. has_verified_badge: If the group has a verified badge. diff --git a/roblox/partials/partialuniverse.py b/roblox/partials/partialuniverse.py index 71f012f7..7fb12662 100644 --- a/roblox/partials/partialuniverse.py +++ b/roblox/partials/partialuniverse.py @@ -19,7 +19,7 @@ class PartialUniverse(BaseUniverse): Attributes:. _client: The Client object, which is passed to all objects this Client generates. - id: The universe ID. + id: The universe's ID. name: The name of the universe. root_place: The universe's root place. """ @@ -47,7 +47,7 @@ class ChatPartialUniverse(BaseUniverse): Attributes: _data: The data we get back from the endpoint. _client: The client object, which is passed to all objects this client generates. - id: The universe ID. + id: The universe's ID. root_place: The universe's root place. """ diff --git a/roblox/shout.py b/roblox/shout.py index dac9d73b..ac5d390b 100644 --- a/roblox/shout.py +++ b/roblox/shout.py @@ -23,7 +23,7 @@ class Shout: Attributes: body: The text of the shout. created: When the shout was created. - updated: When the shout was updated. + updated: When the shout was last updated. poster: Who posted the shout. """ diff --git a/roblox/universes.py b/roblox/universes.py index 437ef353..f95f5ee5 100644 --- a/roblox/universes.py +++ b/roblox/universes.py @@ -60,28 +60,28 @@ class Universe(BaseUniverse): Attributes: id: The ID of this specific universe - root_place: The thumbnail provider object. - name: The delivery provider object. - description: The description of the game. - creator_type: Is the creator a group or a user. - creator: creator information. - price: how much you need to pay to play the game. - allowed_gear_genres: Unknown - allowed_gear_categories: Unknown - is_genre_enforced: Unknown - copying_allowed: are you allowed to copy the game. - playing: amount of people currently playing the game. - visits: amount of visits to the game. - max_players: the maximum amount of players ber server. - created: when the game was created. - updated: when the game as been updated for the last time. - studio_access_to_apis_allowed: does studio have access to the apis. - create_vip_servers_allowed: can you create a vip server? - universe_avatar_type: type of avatars in the game. - genre: what genre the game is. - is_all_genre: if it is all genres? - is_favorited_by_user: if the authenticated user has it favorited. - favorited_count: the total amount of people who favorited the game. + root_place: The root place of the universe. + name: The name of the universe. + description: The description of the universe. + creator_type: Specifies whether the creator is a user or a group. + creator: The user or group that created the universe. + price: How much you need to pay to play the universe. + allowed_gear_genres: Unknown. + allowed_gear_categories: Unknown. + is_genre_enforced: Unknown. + copying_allowed: If you are allowed to copy the universe. + playing: The amount of people currently playing the universe. + visits: The amount of visits on the universe. + max_players: The maximum amount of players every server. + created: When the universe was created. + updated: When the universe was last updated. + studio_access_to_apis_allowed: Does studio have access to the apis. + create_vip_servers_allowed: If you can create a vip server. + universe_avatar_type: The type of avatars allowed in the universe. + genre: What genre the universe is. + is_all_genre: If the universe is all genres? + is_favorited_by_user: If the authenticated user favorited the universe. + favorited_count: The total amount of people who favorited the universe. """ def __init__(self, client: Client, data: dict): diff --git a/roblox/users.py b/roblox/users.py index 4b14f84f..7061a2b8 100644 --- a/roblox/users.py +++ b/roblox/users.py @@ -21,12 +21,12 @@ class User(BaseUser): Represents a single conversation. Attributes: - id: The id of the current user. - name: The name of the current user. - display_name: The display name of the current user. - external_app_display_name: The external app display name of the current user. + id: The ID of the user. + name: The name of the user. + display_name: The display name of the user. + external_app_display_name: The external app display name of the user. is_banned: If the user is banned. - description: The description the current user wrote for themself. + description: The description of the user. created: When the user created their account. has_verified_badge: If the user has a verified badge. """