Cavestory Mod API
Classes | Enumerations | Functions
CaveNet_ExportedTypes.h File Reference
#include <CaveNet_Config.h>
#include <CaveNet_EnumData.h>
#include <SortedBinList.h>
#include <List.h>
#include <CSMAPI_begincode.h>
#include <CSMAPI_endcode.h>

Go to the source code of this file.

Classes

struct  IPaddress
 
class  CaveNet::DataStructures::SortableClient
 A sortable client class, to be used with SortedBinList. More...
 
class  CaveNet::DataStructures::PSSortableClient
 A pointer-safe sortable client. More...
 
class  CaveNet::DataStructures::NetScoreType
 Score type. More...
 
class  CaveNet::DataStructures::NetScoreInstance
 
class  CaveNet::DataStructures::NetFlagChangeData
 
class  CaveNet::DataStructures::NetTeam
 Player teams. More...
 
struct  CaveNet::DataStructures::NetTeam::NetTeamSpawnWeapon
 Stores information for spawning weapons. More...
 
struct  CaveNet::DataStructures::NetTeam::NetTeamConfig
 Controls NetTeam configuration. More...
 
struct  CaveNet::DataStructures::NetClient_MapTileChange
 Stores changed map tile information. More...
 
struct  CaveNet::DataStructures::NetStats
 Stores statistics of a connection. More...
 
class  CaveNet::DataStructures::NetPing
 Uniform ping calculation. More...
 
class  CaveNet::DataStructures::GhostInfo
 Stores ghosting information for a single NPC. More...
 
struct  CaveNet::DataStructures::AI_Controls
 AI Controls. More...
 
class  CaveNet::DataStructures::AI_ActionBase
 AI Player's action base. More...
 
class  CaveNet::DataStructures::AI_Brain
 AI Player's brain. More...
 
class  CaveNet::DataStructures::NetClient
 Networking client. More...
 
struct  CaveNet::DataStructures::NetClient::ClientColor
 
struct  CaveNet::DataStructures::NetClient::CLIENT_CACHE
 
struct  CaveNet::DataStructures::NetPlayerFrameInfo
 Movement prediction information. More...
 
class  CaveNet::DataStructures::NetPlayer
 A networking player. More...
 
class  CaveNet::DataStructures::NetClientIterator
 Clientgroup iterator. More...
 
class  CaveNet::DataStructures::NetClientVector
 Stores multiple clients. More...
 

Enumerations

enum  CaveNet::DataStructures::FlagOperation { CaveNet::DataStructures::FLAG_OVERWRITE , CaveNet::DataStructures::FLAG_SET , CaveNet::DataStructures::FLAG_CLEAR }
 Enumerations. More...
 
enum  CaveNet::DataStructures::ClientState { CaveNet::DataStructures::CLIENT_NOT_CONNECTED = 0 , CaveNet::DataStructures::CLIENT_CONNECTING , CaveNet::DataStructures::CLIENT_DOWNLOADING , CaveNet::DataStructures::CLIENT_CONNECTED }
 todo: ClientState More...
 
enum  CaveNet::DataStructures::GUI_Type { CaveNet::DataStructures::GUI_NONE = 0 , CaveNet::DataStructures::GUI_CAMP , CaveNet::DataStructures::GUI_MAP , CaveNet::DataStructures::GUI_COUNT }
 todo: GUI_Type More...
 
enum  CaveNet::DataStructures::NetDownloadTypes {
  CaveNet::DataStructures::NET_DOWNLOAD_GENERIC = 0 , CaveNet::DataStructures::NET_DOWNLOAD_MAP , CaveNet::DataStructures::NET_DOWNLOAD_TILESET , CaveNet::DataStructures::NET_DOWNLOAD_CHARACTER ,
  CaveNet::DataStructures::NET_DOWNLOAD_IMAGE , CaveNet::DataStructures::NET_DOWNLOAD_MAX
}
 todo: NetDownloadTypes More...
 
enum  CaveNet::DataStructures::UserCommands {
  CaveNet::DataStructures::USER_COMMAND_RESPAWN_PLAYER , CaveNet::DataStructures::USER_COMMAND_FETCH_PLAYER , CaveNet::DataStructures::USER_COMMAND_FIND_PLAYER , CaveNet::DataStructures::USER_COMMAND_SPECTATE_PLAYER ,
  CaveNet::DataStructures::USER_COMMAND_KICK_PLAYER , CaveNet::DataStructures::USER_COMMAND_SPLITSCREEN_READY , CaveNet::DataStructures::USER_COMMAND_SET_CONFIG_VALUE , CaveNet::DataStructures::USER_COMMAND_MOD_FROM_SERVER ,
  CaveNet::DataStructures::USER_COMMAND_MOD_FROM_CLIENT , CaveNet::DataStructures::USER_COMMAND_RESERVED_9 , CaveNet::DataStructures::USER_COMMAND_RESERVED_10 , CaveNet::DataStructures::__USER_COMMAND__COUNT__
}
 Commands that can be sent to the server. More...
 

Functions

CAVESTORY_MOD_API void CaveNet_CreateTeam (int iTeamId, bool bClientSide, void *pOut)
 Create a team object. More...
 
CAVESTORY_MOD_API unsigned int CaveNet_Client_GetGlobalTimerOffset ()
 Get the global timer. More...
 
CAVESTORY_MOD_API bool CaveNet_Client_IsInGui ()
 Check if we're in a GUI. More...
 
CAVESTORY_MOD_API bool CaveNet_Client_IsConnected ()
 Check if we're connected to a server. More...
 
CAVESTORY_MOD_API int CaveNet_Client_GetGhostId ()
 Get our ghost ID. More...
 
CAVESTORY_MOD_API CaveNet::DataStructures::NetClientCaveNet_Client_ClientGroup_GetClient (int index)
 Get a client object. More...
 
CAVESTORY_MOD_API CaveNet::DataStructures::NetClientCaveNet_Client_ClientGroup_GetClientByGhostId (int ghost_id)
 Get a client object by their ghost id. More...
 
CAVESTORY_MOD_API int CaveNet_Client_ClientGroup_GetClientCount ()
 Get the amount of clients currently cached. More...
 
CAVESTORY_MOD_API unsigned int CaveNet_Server_GetGlobalTimerOffset ()
 Get the server-side global timer. More...
 
CAVESTORY_MOD_API bool CaveNet_Server_IsHosting ()
 Check if we're hosting a server. More...
 
CAVESTORY_MOD_API bool CaveNet_Server_InLobby ()
 Check if we're in the lobby. More...
 
CAVESTORY_MOD_API void CaveNet_Server_EnterLobby ()
 Enter the lobby.
 
CAVESTORY_MOD_API CaveNet::DataStructures::NetClientCaveNet_Server_ClientGroup_AddBot (const char *pBotName=NULL, const char *pCharName=NULL, unsigned char iColorR=0, unsigned char iColorG=0, unsigned char iColorB=0, bool bRandomColor=false)
 Create a bot. More...
 
CAVESTORY_MOD_API CaveNet::DataStructures::NetClientCaveNet_Server_ClientGroup_GetClient (int index)
 Get a client object. More...
 
CAVESTORY_MOD_API CaveNet::DataStructures::NetClientCaveNet_Server_ClientGroup_GetClientByGhostId (int ghost_id)
 Get a client object by their ghost id. More...
 
CAVESTORY_MOD_API int CaveNet_Server_ClientGroup_GetClientCount ()
 Get the amount of clients currently cached. More...
 
CAVESTORY_MOD_API void CaveNet_Server_ClientGroup_TransmitSystemMessage (const char *pFormat,...)
 Transmit a system message. More...
 
CAVESTORY_MOD_API void CaveNet_Server_ClientGroup_ReviveAllDeadPlayers ()
 Revive all dead players.
 
CAVESTORY_MOD_API unsigned int CaveNet_GetGlobalTimerOffset ()
 Get the best global timer. More...
 
CAVESTORY_MOD_API void CaveNet_ProcessNet (int type=-1)
 Process networking. More...
 
CAVESTORY_MOD_API char * CaveNet_BuildDisconnectReasonString (char *pBuffer=NULL, unsigned int iBufferSize=0, CaveNet::NetDisconnectReason eDisconnectReason=CaveNet::NetDisconnectReason::NET_DISCONNECT_REASON_UNKNOWN, const char *pCustomReason=NULL, CaveNet::DataStructures::NetClient *pResponsibleClient=NULL)
 Build a disconnect reason string. More...
 

Enumeration Type Documentation

◆ ClientState

todo: ClientState

Enumerator
CLIENT_NOT_CONNECTED 

Not connected.

CLIENT_CONNECTING 

Connecting.

CLIENT_DOWNLOADING 

Downloading files.

CLIENT_CONNECTED 

Connected.

◆ FlagOperation

Enumerations.

todo: FlagOperation

Enumerator
FLAG_OVERWRITE 

Overwrite all flags.

FLAG_SET 

Set flags.

FLAG_CLEAR 

Clear flags.

◆ GUI_Type

todo: GUI_Type

Enumerator
GUI_NONE 

No GUI.

GUI_CAMP 

Inventory.

GUI_MAP 

Map system.

GUI_COUNT 

Max GUI types.

◆ NetDownloadTypes

todo: NetDownloadTypes

Enumerator
NET_DOWNLOAD_GENERIC 

Generic file.

NET_DOWNLOAD_MAP 

Map download.

NET_DOWNLOAD_TILESET 

Tileset download.

NET_DOWNLOAD_CHARACTER 

Character download.

NET_DOWNLOAD_IMAGE 

Image download.

NET_DOWNLOAD_MAX 

Max download types.

◆ UserCommands

Commands that can be sent to the server.

Enumerator
USER_COMMAND_RESPAWN_PLAYER 

Respawn a player.

USER_COMMAND_FETCH_PLAYER 

Teleport a player to us.

USER_COMMAND_FIND_PLAYER 

Teleport to a player.

USER_COMMAND_SPECTATE_PLAYER 

Spectate a player.

USER_COMMAND_KICK_PLAYER 

Kick a player.

USER_COMMAND_SPLITSCREEN_READY 

Splitscreen ready.

USER_COMMAND_SET_CONFIG_VALUE 

Set a configuration option's value.

USER_COMMAND_MOD_FROM_SERVER 

Receive / send mod-specific data over the network.

USER_COMMAND_MOD_FROM_CLIENT 

Receive / send mod-specific data over the network.

USER_COMMAND_RESERVED_9 

reserved

USER_COMMAND_RESERVED_10 

reserved

__USER_COMMAND__COUNT__ 

Number of user commands.