arsa  2.7
Public Member Functions | Static Public Member Functions | List of all members
Effekseer::Server Class Referenceabstract

A server to edit effect from client such an editor. More...

#include <Effekseer.h>

Public Member Functions

 Server ()
 
virtual ~Server ()
 
virtual bool Start (uint16_t port)=0
 start a server More...
 
virtual void Stop ()=0
 stop a server More...
 
virtual void Register (const EFK_CHAR *key, Effect *effect)=0
 register an effect as a target to edit. a key to search an effect an effect to be edit More...
 
virtual void Unregister (Effect *effect)=0
 unregister an effect an effect registered More...
 
virtual void Update (Manager **managers=nullptr, int32_t managerCount=0, ReloadingThreadType reloadingThreadType=ReloadingThreadType::Main)=0
 update a server and reload effects all managers which is playing effects. the number of manager More...
 
virtual void SetMaterialPath (const EFK_CHAR *materialPath)=0
 Specify root path to load materials. More...
 
virtual void Regist (const EFK_CHAR *key, Effect *effect)=0
 deprecated More...
 
virtual void Unregist (Effect *effect)=0
 deprecated More...
 

Static Public Member Functions

static ServerCreate ()
 create a server instance More...
 

Detailed Description

A server to edit effect from client such an editor.

Definition at line 3906 of file Effekseer.h.

Constructor & Destructor Documentation

◆ Server()

Effekseer::Server::Server ( )
inline

Definition at line 3910 of file Effekseer.h.

3910 {}

◆ ~Server()

virtual Effekseer::Server::~Server ( )
inlinevirtual

Definition at line 3911 of file Effekseer.h.

3911 {}

Member Function Documentation

◆ Create()

static Server* Effekseer::Server::Create ( )
static

create a server instance

◆ Regist()

virtual void Effekseer::Server::Regist ( const EFK_CHAR key,
Effect effect 
)
pure virtual

deprecated

◆ Register()

virtual void Effekseer::Server::Register ( const EFK_CHAR key,
Effect effect 
)
pure virtual

register an effect as a target to edit. a key to search an effect an effect to be edit

◆ SetMaterialPath()

virtual void Effekseer::Server::SetMaterialPath ( const EFK_CHAR materialPath)
pure virtual

Specify root path to load materials.

◆ Start()

virtual bool Effekseer::Server::Start ( uint16_t  port)
pure virtual

start a server

◆ Stop()

virtual void Effekseer::Server::Stop ( )
pure virtual

stop a server

◆ Unregist()

virtual void Effekseer::Server::Unregist ( Effect effect)
pure virtual

deprecated

◆ Unregister()

virtual void Effekseer::Server::Unregister ( Effect effect)
pure virtual

unregister an effect an effect registered

◆ Update()

virtual void Effekseer::Server::Update ( Manager **  managers = nullptr,
int32_t  managerCount = 0,
ReloadingThreadType  reloadingThreadType = ReloadingThreadType::Main 
)
pure virtual

update a server and reload effects all managers which is playing effects. the number of manager


The documentation for this class was generated from the following file: