Skip to content

Commit

Permalink
docs(usernotice): remove reference of SubMysteryGift being both submy…
Browse files Browse the repository at this point in the history
…sterygift and anonsubmysterygift as it not anymore
  • Loading branch information
Larandar authored and RAnders00 committed Oct 26, 2024
1 parent 3616daf commit 416cfd5
Showing 1 changed file with 0 additions and 8 deletions.
8 changes: 0 additions & 8 deletions src/message/commands/usernotice.rs
Original file line number Diff line number Diff line change
Expand Up @@ -209,15 +209,7 @@ pub enum UserNoticeEvent {

/// This event precedes a wave of `subgift`/`anonsubgift` messages.
/// (`<User> is gifting <mass_gift_count> Tier 1 Subs to <Channel>'s community! They've gifted a total of <sender_total_gifts> in the channel!`)
///
/// This event combines `submysterygift` and `anonsubmysterygift`. In case of
/// `anonsubmysterygift` the sending user of the `USERNOTICE` carries no useful information,
/// it can be e.g. the channel owner or a service user like `AnAnonymousGifter`. You should
/// always check for `is_sender_anonymous` before using the sender of the `USERNOTICE`.
SubMysteryGift {
/// Indicates whether the user sending this `USERNOTICE` is a dummy or a real gifter.
/// If this is `true` the gift comes from an anonymous user, and the user sending the
/// `USERNOTICE` carries no useful information and should be ignored.
/// Number of gifts the sender just gifted.
mass_gift_count: u64,
/// Total number of gifts the sender has gifted in this channel. This includes the
Expand Down

0 comments on commit 416cfd5

Please sign in to comment.