# RoomsPlugin.h File Reference

Adds networking to AllGamesRoomsContainer. Lets you create, join, search, and destroy matchmaking rooms for players. More...

`#include "RakNetTypes.h"`
`#include "PluginInterface2.h"`
`#include "DS_OrderedList.h"`
`#include "Export.h"`
`#include "ConnectionGraph.h"`
`#include "RoomsContainer.h"`
`#include "PacketPriority.h"`
`#include "BitStream.h"`

## Classes

struct | RakNet::RoomsPluginFunc
| Base class for rooms functionality. More...
struct | RakNet::CreateRoom_Func
| Create a room. Each user can be in at most one room, so will fail if the user is already in a room. More...
struct | RakNet::EnterRoom_Func
| Joins a room if possible. If not, creates a room. More...
struct | RakNet::JoinByFilter_Func
| Joins a room given the filter parameters and desired room member mode. More...
struct | RakNet::LeaveRoom_Func
| Leaves a room. You can leave at any time, even if the room is locked. More...
struct | RakNet::GetInvitesToParticipant_Func
struct | RakNet::SendInvite_Func
| Sends an invitation to someone. More...
struct | RakNet::AcceptInvite_Func
| Accept an invitation from a user to a room. More...
struct | RakNet::StartSpectating_Func
| Begin spectating. Spectators are considered room members that are not playing the game, only watching. More...
struct | RakNet::StopSpectating_Func
| Stop spectating. This will rejoin the room as a player, using a reserved slot if we were invited, and a public slot if not or if there are no reserved slots. More...
struct | RakNet::GrantModerator_Func
| Give moderator to another player. Moderators cannot be spectators. More...
struct | RakNet::ChangeSlotCounts_Func
| Change the allowed slot counts for the room. Setting fewer slot counts than the number of players does not kick out players, though it may prevent changing spectator status. More...
struct | RakNet::SetCustomRoomProperties_Func
| Sets a table of user-defined room properties. More...
struct | RakNet::GetRoomProperties_Func
| Given a named room, return the properties of that room, including member list. More...
struct | RakNet::ChangeRoomName_Func
| Change the name of the room. More...
struct | RakNet::SetHiddenFromSearches_Func
| Set or unset the room hidden from searches. If a room is hidden from searches, it can only be joined through invitations. More...
struct | RakNet::SetDestroyOnModeratorLeave_Func
| Sets or unsets to destroy the room when the moderator leaves the room. More...
struct | RakNet::SetReadyStatus_Func
| Sets or unsets the user as flagged 'ready'. More...
struct | RakNet::GetReadyStatus_Func
| Gets the ready states for every user in the room, excluding spectators. More...
struct | RakNet::SetRoomLockState_Func
| Lock or unlock the room. More...
struct | RakNet::GetRoomLockState_Func
| Gets the lock state of the room. More...
struct | RakNet::AreAllMembersReady_Func
| If all members have been set to ready using SetReadyStatus_Func, this operation will set allReady to true. More...
struct | RakNet::KickMember_Func
| Kick a member out of the room. This will also automatically ban that member from rejoining as long as the moderator does not change, or the member is unbanned. More...
struct | RakNet::UnbanMember_Func
| Allow a member previously kicked out of the room to rejoin. More...
struct | RakNet::GetBanReason_Func
| For a given room, get the reason parameter of KickMember_Func when we were kicked out. More...
struct | RakNet::AddUserToQuickJoin_Func
| Enter quick join mode. More...
struct | RakNet::RemoveUserFromQuickJoin_Func
| Leave quick join mode. More...
struct | RakNet::IsInQuickJoin_Func
| Returns if you are waiting in quick join mode. More...
struct | RakNet::SearchByFilter_Func
| Return all rooms that pass the roomQuery filter. More...
struct | RakNet::ChangeHandle_Func
| Change your handle. More...
struct | RakNet::Chat_Func
| Send a chat message. More...
struct | RakNet::Bitstream_Func
| Send an arbitrary binary message. More...
struct | RakNet::RoomsPluginNotification
| Base class for notification callbacks. More...
struct | RakNet::QuickJoinExpired_Notification
| The quick join duration has expired without joining or creating any rooms. More...
struct | RakNet::QuickJoinEnteredRoom_Notification
| Quick join succeeded, and you are now in a room. More...
struct | RakNet::RoomMemberStartedSpectating_Notification
| Another room member has started spectating. More...
struct | RakNet::RoomMemberStoppedSpectating_Notification
| Another room member has stopped spectating. More...
struct | RakNet::ModeratorChanged_Notification
| The room has a new moderator (possibly you). More...
struct | RakNet::SlotCountsSet_Notification
| The slot counts in the room has changed. More...
struct | RakNet::CustomRoomPropertiesSet_Notification
| The custom properties for the room has changed. More...
struct | RakNet::RoomNameSet_Notification
| The name of the room has been changed. More...
struct | RakNet::HiddenFromSearchesSet_Notification
| The room is now hidden, or no longer hidden, from searches. More...
struct | RakNet::RoomMemberReadyStatusSet_Notification
| Another room member has changed their ready status. More...
struct | RakNet::RoomLockStateSet_Notification
| The room is now, or is no longer, locked. More...
struct | RakNet::RoomMemberKicked_Notification
| A room member has been kicked out of the room (possibly you). More...
struct | RakNet::RoomMemberHandleSet_Notification
| A room member has changed their handle. More...
struct | RakNet::RoomMemberLeftRoom_Notification
struct | RakNet::RoomMemberJoinedRoom_Notification
| A room member has joined the room. More...
struct | RakNet::RoomInvitationSent_Notification
| You have received an invitation to a room. More...
struct | RakNet::RoomInvitationWithdrawn_Notification
| A previous room invitation is no longer valid (possibly due to moderator change, or the room no longer exists). More...
struct | RakNet::RoomDestroyedOnModeratorLeft_Notification
| The moderator has left the room, and everyone left is a spectator, or the room was set to be destroyed when the moderator left You are no longer in the room. More...
struct | RakNet::Chat_Notification
| You got a chat message from another user. More...
struct | RakNet::Bitstream_Notification
| You got a generic bitstream message from another user. More...
class | RakNet::RoomsPlugin
| Used to create rooms for players where they can matchmake. More...

## Namespaces

namespace | RakNet
| Forward declaration.

## Detailed Description

Adds networking to AllGamesRoomsContainer. Lets you create, join, search, and destroy matchmaking rooms for players.

This file is part of RakNet Copyright 2003 Jenkins Software LLC

Usage of RakNet is subject to the appropriate license agreement.