SmartFoxServer 3 C++ Client API 3.1.0-beta
Client API for SmartFoxServer 3
Loading...
Searching...
No Matches
sfs3::entities::MMOItemVariable Class Reference

A custom value attached to an MMOItem, kept in sync with the server for as long as the item stays inside the area of interest of the current user. More...

#include <MMOItemVariable.h>

Inheritance diagram for sfs3::entities::MMOItemVariable:
[legend]

Public Member Functions

std::string toString () override
Public Member Functions inherited from sfs3::entities::Variable
std::string name ()
virtual const VarDatavalue ()
 Returns the value of this variable, whatever its type.
virtual std::optional< bool > boolValue ()
virtual std::optional< uint8_t > byteValue ()
virtual std::optional< int16_t > shortValue ()
virtual std::optional< int32_t > intValue ()
virtual std::optional< int64_t > longValue ()
virtual std::optional< float > floatValue ()
virtual std::optional< double > doubleValue ()
virtual std::optional< std::string > stringValue ()
virtual std::shared_ptr< SFSObjectsfsObjectValue ()
virtual std::shared_ptr< SFSArraysfsArrayValue ()
virtual std::optional< SFSVector2vector2Value ()
virtual std::optional< SFSVector3vector3Value ()
virtual void setNull ()
 Clears the value of this variable.
virtual void setValue (VarData value)
 Sets the value of this variable.
virtual bool isNull ()

Detailed Description

A custom value attached to an MMOItem, kept in sync with the server for as long as the item stays inside the area of interest of the current user.

MMOItem Variables behave exactly like User Variables and support the same data types, but they can be created, updated and deleted on the server side only: there is no request to set one from the client.

See also
MMOItem

Member Function Documentation

◆ toString()

std::string sfs3::entities::MMOItemVariable::toString ( )
overridevirtual
Returns
the name, the type and the value of this variable as text, for logging and debugging

Reimplemented from sfs3::entities::Variable.


The documentation for this class was generated from the following files:
  • entities/MMOItemVariable.h
  • entities/MMOItemVariable.cpp