Guild Emojis¶
guild_emojis
¶
GuildEmojiCacheAddon
¶
Bases: Addon
flowchart TD
scurrypy.ext.cache.guild_emojis.GuildEmojiCacheAddon[GuildEmojiCacheAddon]
scurrypy.bases.addon.Addon[Addon]
scurrypy.bases.addon.Addon --> scurrypy.ext.cache.guild_emojis.GuildEmojiCacheAddon
click scurrypy.ext.cache.guild_emojis.GuildEmojiCacheAddon href "" "scurrypy.ext.cache.guild_emojis.GuildEmojiCacheAddon"
click scurrypy.bases.addon.Addon href "" "scurrypy.bases.addon.Addon"
Defines caching guild emojis and lookup.
Important
This cache requires Intents.GUILD_EXPRESSIONS to keep up-to-date.
bot = client
instance-attribute
¶
guild_emojis: dict[Snowflake, dict[Snowflake, EmojiModel]] = {}
instance-attribute
¶
guild_emoji_index: dict[Snowflake, EmojiModel] = {}
instance-attribute
¶
on_guild_create
async
¶
Append new guild emojis to cache. Also add emojis to index.
Raises:
-
MissingField–missing emoji ID
Parameters:
-
event(GuildCreateEvent) –the GUILD_CREATE event
on_guild_delete
async
¶
Remove guild emojis from cache. Also remove emojis from index
Raises:
-
MissingField–missing emoji ID
Parameters:
-
event(GuildDeleteEvent) –the GUILD_DELETE event
on_emojis_update
async
¶
Refresh guild emojis with new list. Also refresh the index
Raises:
-
MissingField–missing emoji ID
Parameters:
-
event(GuildEmojisUpdateEvent) –the GUILD_EMOJIS_UPDATE event
get_emoji
¶
Get an emoji from the cache.
Parameters:
-
emoji_id(Snowflake) –ID of the emoji
Returns:
-
EmojiModel | None–the Emoji object if found, else None