Room.h File Reference

Doxygen only documents namespace-scope entities (enums, aliases, constants, free functions) in a header that carries this block. More...

#include "entities/User.h"
#include "entities/Variable.h"
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <vector>

Classes
class	sfs3::entities::Room
	A Room in a Zone. More...

Enumerations
enum class	sfs3::entities::RoomType { Regular , SFSGame , MMO }
	The kind of a Room. More...

Variables
const std::string	sfs3::entities::DEFAULT_ROOM_GROUP_ID = "default"
	The Group a Room belongs to when no other Group is given at creation time.

Detailed Description

Doxygen only documents namespace-scope entities (enums, aliases, constants, free functions) in a header that carries this block.

Enumeration Type Documentation

RoomType

enum class sfs3::entities::RoomType

strong

The kind of a Room.

Read it with sfs3::entities::Room::getType() to know which concrete type a Room is, then cast the Room to it.

Enumerator
Regular	A plain Room.
SFSGame	A Game Room, which also has spectators.
MMO	An MMORoom, which has an area of interest and a proximity list. See also MMORoom