aiohypixel.resources.guilds

Documentation

Guild achievements and permissions models.

class aiohypixel.resources.guilds.GuildAchievementTier(tier, amount)

Represents a guild achievement tier on the Hypixel Network.

amount = None

Amount of times the achievement has to be completed for this tier to be completed.

classmethod from_api_response(resp)

Processes the raw API response into a GuildAchievementTier object.

Parameters

resp (NewType()(APIResponse, Dict[str, Any])) – The API response to process.

Returns

The processed GuildAchievementTier object.

tier = None

Tier position.

class aiohypixel.resources.guilds.TieredGuildAchievement(code_name, name, description, tiers)

Represents a tiered guild achievement on the Hypixel Network.

code_name = None

Code name returned by the API.

description = None

Short description for the achievement.

classmethod from_api_response(resp)

Processes the raw API response into a TieredGuildAchievement object.

Parameters

resp (NewType()(APIResponse, Dict[str, Any])) – The API response to process.

Returns

The processed TieredGuildAchievement object.

name = None

Pretty name for this achievement.

tiers = None

List of tiers for this achievement.

class aiohypixel.resources.guilds.GuildAchievements(last_updated_at, one_time, tiered)

Represents the guild achievements on the Hypixel Network.

classmethod from_api_response(resp)

Processes the raw API response into a GuildAchievements object.

Parameters

resp (NewType()(APIResponse, Dict[str, Any])) – The API response to process.

Returns

The processed GuildAchievements object.

last_updated_at = None

Time this resource was last modified.

tiered = None

Collection of tiered guild achievements.

class aiohypixel.resources.guilds.GuildPermission(language, name, description, item)

Represents a guild permission on the Hypixel Network.

description = None

Short description for the permission.

classmethod from_api_response(resp)

Processes the raw API response into a GuildPermission object.

Parameters

resp (NewType()(APIResponse, Dict[str, Any])) – The API response to process.

Returns

The processed GuildPermission object.

item = None

Name of the item to use for the permission in the in-game UI.

language = None

Language code for this permission.

name = None

Permission name.

class aiohypixel.resources.guilds.GuildPermissions(last_updated_at, permissions)

Represents the guild permissions on the Hypixel Network.

classmethod from_api_response(resp)

Processes the raw API response into a GuildPermissions object.

Parameters

resp (NewType()(APIResponse, Dict[str, Any])) – The API response to process.

Returns

The processed GuildPermissions object.

last_updated_at = None

Time this resource was last modified.

permissions = None

Collection of guild permissions.

Inheritance Diagram

Inheritance diagram of aiohypixel.resources.guilds