matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Add versionadded for guild_subscriptions option.

Browse Source
This commit is contained in:
Rapptz 2019-07-10 05:00:13 -04:00
parent 2e6882bd8c
commit ca2ee0655d
1 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
discord/client.py
View File

@ -155,24 +155,26 @@ class Client:
guild_subscriptions: :class:`bool` guild_subscriptions: :class:`bool`
Whether to dispatching of presence or typing events. Defaults to ``True``. Whether to dispatching of presence or typing events. Defaults to ``True``.
.. versionadded:: 1.3
.. warning:: .. warning::
If this is set to ``False`` then the following features will be disabled: 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 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`) - 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. - 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: This makes it difficult or impossible to do many things, for example:
- Computing permissions - Computing permissions
- Querying members in a voice channel via :attr:`VoiceChannel.members` will be empty. - Querying members in a voice channel via :attr:`VoiceChannel.members` will be empty.
- Most forms of receiving :class:`Member` will be - Most forms of receiving :class:`Member` will be
receiving :class:`User` instead, except for message events. receiving :class:`User` instead, except for message events.
- :attr:`Guild.owner` will usually resolve to ``None``. - :attr:`Guild.owner` will usually resolve to ``None``.
- :meth:`Guild.get_member` will usually be unavailable. - :meth:`Guild.get_member` will usually be unavailable.
- Anything that involves using :class:`Member`. - Anything that involves using :class:`Member`.
- :attr:`users` will not be as populated. - :attr:`users` will not be as populated.
- etc. - etc.
In short, this makes it so the only member you can reliably query is the 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. message author. Useful for bots that do not require any state.