diff options
| author | Rapptz <[email protected]> | 2019-07-10 05:00:13 -0400 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2019-07-10 05:00:13 -0400 |
| commit | ca2ee0655d5c1c17d04224f41a7005e9cfcd48b9 (patch) | |
| tree | a58c84a681ca54f14b87058b79bb63824657f389 | |
| parent | [commands] Fall back to using Message.mentions in converters (diff) | |
| download | discord.py-ca2ee0655d5c1c17d04224f41a7005e9cfcd48b9.tar.xz discord.py-ca2ee0655d5c1c17d04224f41a7005e9cfcd48b9.zip | |
Add versionadded for guild_subscriptions option.
| -rw-r--r-- | discord/client.py | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/discord/client.py b/discord/client.py index 731f4b31..eaf94df1 100644 --- a/discord/client.py +++ b/discord/client.py @@ -155,24 +155,26 @@ class Client: guild_subscriptions: :class:`bool` Whether to dispatching of presence or typing events. Defaults to ``True``. + .. versionadded:: 1.3 + .. warning:: If this is set to ``False`` then the following features will be disabled: - - No user related updates (:func:`on_user_update` will not dispatch) - - No presence related changes will be recorded (e.g. :attr:`Member.activities` or :attr:`Member.status`) - - If ``fetch_offline_members`` is set to ``False`` then the user cache will not exist. - This makes it difficult or impossible to do many things, for example: - - - Computing permissions - - Querying members in a voice channel via :attr:`VoiceChannel.members` will be empty. - - Most forms of receiving :class:`Member` will be - receiving :class:`User` instead, except for message events. - - :attr:`Guild.owner` will usually resolve to ``None``. - - :meth:`Guild.get_member` will usually be unavailable. - - Anything that involves using :class:`Member`. - - :attr:`users` will not be as populated. - - etc. + - No user related updates (:func:`on_user_update` will not dispatch) + - No presence related changes will be recorded (e.g. :attr:`Member.activities` or :attr:`Member.status`) + - If ``fetch_offline_members`` is set to ``False`` then the user cache will not exist. + This makes it difficult or impossible to do many things, for example: + + - Computing permissions + - Querying members in a voice channel via :attr:`VoiceChannel.members` will be empty. + - Most forms of receiving :class:`Member` will be + receiving :class:`User` instead, except for message events. + - :attr:`Guild.owner` will usually resolve to ``None``. + - :meth:`Guild.get_member` will usually be unavailable. + - Anything that involves using :class:`Member`. + - :attr:`users` will not be as populated. + - etc. In short, this makes it so the only member you can reliably query is the message author. Useful for bots that do not require any state. |