RBWCM-SDK Documentation - v1.1.0
    Preparing search index...

    Enumeration RankedEvent

    List of all real-time competitive events broadcasted by the RBWCM Backend. Each member of this enum represents a specific game or system update.

    RankedEventPayloads for the data structure associated with each event.

    Index

    Enumeration Members

    GameCancelled GameScored GameScoreUndone GameStarted GameStartPick KickFromQueue MapBanned MapBanStarted MapVoted PickSuccess PlayerRankChanged QueueJoined QueueLeft SeasonStarted UserBanned UserDiscordIdChanged UserIGNChanged UserRegistered UserRestored UserSoftDeleted UserStriked UserUnbanned UserUnstriked

    Enumeration Members

    GameCancelled: "game.cancelled"

    Triggered when a game is forcibly terminated. Payload: GameCancelledPayload

    GameScored: "game.scored"

    Triggered when a match result is recorded. Payload: GameScoredPayload

    GameScoreUndone: "game.scoreUndone"

    Triggered when a previous score update is reverted by staff. Payload: GameScoreUndonePayload

    GameStarted: "game.started"

    Triggered when all players have been picked/assigned and the game starts. Payload: GameStartedPayload

    GameStartPick: "game.startPick"

    Triggered when a game enters the player selection phase. Payload: GameStartPickPayload

    KickFromQueue: "queue.kickFromQueue"

    Triggered when a staff member removes a player from the queue. Payload: KickFromQueuePayload

    MapBanned: "mapban.banned"

    Triggered when a map is removed from the rotation by a captain. Payload: MapBannedPayload

    MapBanStarted: "mapban.started"

    Triggered when the map ban phase begins. Payload: MapBanStartedPayload

    MapVoted: "map.vote"

    Triggered when a player casts a vote for a map. Payload: MapVotedPayload

    PickSuccess: "draft.pickSuccess"

    Triggered when a captain successfully picks a player from the pool. Payload: PickSuccessPayload

    PlayerRankChanged: "player.rankChanged"

    Triggered when a player's rating or rank changes. Payload: PlayerRankChangedPayload

    QueueJoined: "queue.joined"

    Triggered when a user successfully enters a queue. Payload: QueueJoinedPayload

    QueueLeft: "queue.left"

    Triggered when a user leaves their current queue. Payload: QueueLeftPayload

    SeasonStarted: "season.started"

    Triggered when a new competitive season is initialized. Payload: SeasonStartedPayload

    UserBanned: "user.banned"

    Triggered when a user is restricted from ranked play. Payload: UserBannedPayload

    UserDiscordIdChanged: "user.discordIdChanged"

    Triggered when a user updates their linked Discord account. Payload: UserDiscordIdChangedPayload

    UserIGNChanged: "user.ignChanged"

    Triggered when a user updates their In-Game Name (IGN). Payload: UserIGNChangedPayload

    UserRegistered: "user.registered"

    Triggered when a new user registers to the Ranked System. Payload: UserRegisteredPayload

    UserRestored: "user.restored"

    Triggered when a previously soft-deleted user is restored. Payload: UserRestoredPayload

    UserSoftDeleted: "user.softDeleted"

    Triggered when a user is soft-deleted from the database. Payload: UserSoftDeletedPayload

    UserStriked: "user.striked"

    Triggered when a competitive strike is issued to a player. Payload: UserStrikedPayload

    UserUnbanned: "user.unbanned"

    Triggered when a user's restriction is lifted. Payload: UserUnbannedPayload

    UserUnstriked: "user.unstriked"

    Triggered when a competitive strike is removed. Payload: UserUnstrikedPayload

    Settings

    Member Visibility

    On This Page

    Enumeration Members