Variable.h File Reference

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

#include "entities/SFSArray.h"
#include "entities/SFSDataWrapper.h"
#include "entities/SFSObject.h"
#include "entities/SFSVector2.h"
#include "entities/SFSVector3.h"
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <utility>
#include <variant>

Classes
class	sfs3::entities::Variable
	The base of every variable kind: User, Room, Buddy and MMOItem Variables. More...
class	sfs3::entities::UserVariable
	A custom value attached to a user, kept in sync between client and server. More...
class	sfs3::entities::RoomVariable
	A custom value attached to a Room, kept in sync between client and server. More...
class	sfs3::entities::BuddyVariable
	A custom value attached to a buddy in a buddy list, kept in sync between client and server. More...

Typedefs
using	sfs3::entities::VarData
	The value a variable can hold.

Detailed Description

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

Typedef Documentation

VarData

using sfs3::entities::VarData

Initial value:

std::variant<std::monostate,
                               bool,
                               uint8_t,
                               int16_t,
                               int32_t,
                               int64_t,
                               float,
                               double,
                               std::string,
                               std::shared_ptr<SFSObject>,
                               std::shared_ptr<SFSArray>,
                               SFSVector2,
                               SFSVector3>

The value a variable can hold.

A variable holds one of these types, or nothing at all: std::monostate is the empty state, which the server reads as a null value.

See also

Variable