d9/d0d/server__callbacks_8h_source.html

  // =================================================== //

  // THIS IS NOT A C++ HEADER! Only a dummy for Doxygen. //

  // =================================================== //


namespace Server2Script {


/*

Callbacks

---------


The game recognizes the following callbacks.

You can register them either by using a global function of the same name

or by manually invoking `server.setCallback()`. Note that some callbacks allow

multiple handler functions (`setCallback()` adds another) while other can only

have a single handler function (`setCallback()` replaces the previous).

*/


void main();


void frameStep(float dt_millis);


void playerAdded(int uid);


void playerDeleted(int uid, int crashed);


int streamAdded(int uid, StreamRegister@ reg);


int playerChat(int uid, const string &in msg);


void gameCmd(int uid, const string &in cmd);


void curlStatus(curlStatusType type, int n1, int n2, string displayname, string message);


   //addtogroup Server2Script   //addtogroup ScriptSideAPIs

} // namespace Server2Script

Server2Script::playerChat
int playerChat(int uid, const string &in msg)
ONLY ONE AT A TIME ~ executed when player sends a chat message; Returns broadcastType which determine...

Server2Script::frameStep
void frameStep(float dt_millis)
executed periodically, the parameter is delta time (time since last execution) in milliseconds.

Server2Script::playerDeleted
void playerDeleted(int uid, int crashed)
executed when player leaves.

Server2Script::gameCmd
void gameCmd(int uid, const string &in cmd)
ONLY ONE AT A TIME ~ invoked when a script running on client calls game.sendGameCmd()

Server2Script::curlStatus
void curlStatus(curlStatusType type, int n1, int n2, string displayname, string message)
Reports status of background CURL request - use `game.curlRequestAsync()` to invoke one.

Server2Script::main
void main()
Required; Script setup function - invoked once when script is loaded.

Server2Script::playerAdded
void playerAdded(int uid)
executed when player joins.

Server2Script::streamAdded
int streamAdded(int uid, StreamRegister@ reg)
executed when player spawns an actor; Returns broadcastType which determines how the message is treat...

Server2Script
Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation.
Definition ScriptSideAPIs.h:46