Skip to content

Commit ae4983d

Browse files
committed
📝 Docs
1 parent 2922472 commit ae4983d

File tree

3 files changed

+28
-5
lines changed

3 files changed

+28
-5
lines changed

discord/channel.py

+3
Original file line numberDiff line numberDiff line change
@@ -3266,6 +3266,9 @@ class VoiceChannelEffectSendEvent:
32663266
32673267
.. versionadded:: 2.4
32683268
3269+
.. versionchanged:: 2.7
3270+
Added the `sound` attribute.
3271+
32693272
Attributes
32703273
----------
32713274
animation_type: :class:`int`

discord/soundboard.py

+14-5
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ class PartialSoundboardSound(Hashable):
6161
The sound's volume.
6262
emoji: :class:`PartialEmoji`
6363
The sound's emoji.
64+
65+
.. versionadded:: 2.7
6466
"""
6567

6668
__slots__ = ("id", "volume", "emoji", "_http", "_state")
@@ -127,13 +129,16 @@ class SoundboardSound(PartialSoundboardSound):
127129
name: :class:`str`
128130
The sound's name.
129131
available: :class:`bool`
130-
Whether the sound is available.
132+
Whether the sound is available. Could be ``False`` if the sound is not available.
133+
This happens for example when the guild lost the boost level required to use the sound.
131134
emoji: :class:`PartialEmoji`
132135
The sound's emoji.
133-
guild: :class:`Guild`
134-
The guild the sound belongs to.
135-
owner: :class:`Member`
136-
The sound's owner.
136+
guild: :class:`Guild` | :class:`None`
137+
The guild the sound belongs to. Could be ``None`` if the sound is a default sound.
138+
owner: :class:`User`
139+
The sound's owner. Could be ``None`` if the sound is a default sound.
140+
141+
.. versionadded:: 2.7
137142
"""
138143

139144
__slots__ = (
@@ -195,6 +200,8 @@ def edit(
195200
) -> Coroutine[Any, Any, SoundboardSound]:
196201
"""Edits the sound.
197202
203+
.. versionadded:: 2.7
204+
198205
Parameters
199206
----------
200207
name: :class:`str`
@@ -245,6 +252,8 @@ def edit(
245252
def delete(self, *, reason: str | None = None) -> Coroutine[Any, Any, None]:
246253
"""Deletes the sound.
247254
255+
.. versionadded:: 2.7
256+
248257
Parameters
249258
----------
250259
reason: :class:`str`

docs/api/events.rst

+11
Original file line numberDiff line numberDiff line change
@@ -1377,3 +1377,14 @@ Voice Channel Status Update
13771377

13781378
:param payload: The raw voice channel status update payload.
13791379
:type payload: :class:`RawVoiceChannelStatusUpdateEvent`
1380+
1381+
Voice Channel Effects
1382+
---------------------
1383+
.. function:: on_voice_channel_effect_send(event)
1384+
1385+
Called when a voice channel effect is sent.
1386+
1387+
.. versionadded:: 2.7
1388+
1389+
:param event: The voice channel effect event.
1390+
:type event: :class:`VoiceChannelEffectSendEvent`

0 commit comments

Comments
 (0)