#include <IPluginEvents.hpp>

Inheritance diagram for VoltMod::IPluginEvents:

Public Types
using	FrameFn = void()(void context)

using	ServerStartupFn = void()(void context, std::string_view mapName)

using	ClientConnectingFn = bool()(void context, int slot, int64_t steamId, std::string_view name, char *reason, size_t reasonSize)

using	ClientConnectedFn = void()(void context, int slot, int64_t steamId, std::string_view name, std::string_view address)

using	ClientDisconnectedFn = void()(void context, int slot)

using	ClientFullyConnectedFn = void()(void context, int slot)

using	ClientSettingsChangedFn = void()(void context, int slot)

using	ConsoleCommandFn = bool()(void context, std::string_view name, std::string_view arguments, int slot)

using	CheckTransmitFn = void()(void context, CCheckTransmitInfo **infoList, int infoCount)

using	BuildGameSessionManifestFn = void()(void context, IEntityResourceManifest *manifest)

using	PlayerCommandFn = void()(void context, int slot, const PlayerInput &input)

using	ButtonPressFn = void()(void context, int slot, std::string_view buttonId)

Public Member Functions
virtual uint64_t	OnFrame (FrameFn callback, void *context)=0

virtual uint64_t	OnServerStartup (ServerStartupFn callback, void *context)=0

virtual uint64_t	OnClientConnecting (ClientConnectingFn callback, void *context)=0

virtual uint64_t	OnClientConnected (ClientConnectedFn callback, void *context)=0

virtual uint64_t	OnClientDisconnected (ClientDisconnectedFn callback, void *context)=0

virtual uint64_t	OnClientFullyConnected (ClientFullyConnectedFn callback, void *context)=0

virtual uint64_t	OnClientSettingsChanged (ClientSettingsChangedFn callback, void *context)=0

virtual uint64_t	OnConsoleCommand (ConsoleCommandFn callback, void *context)=0

virtual uint64_t	OnCheckTransmit (CheckTransmitFn callback, void *context)=0

virtual uint64_t	OnBuildGameSessionManifest (BuildGameSessionManifestFn callback, void *context)=0

virtual uint64_t	OnPlayerCommand (PlayerCommandFn callback, void *context)=0

virtual uint64_t	OnPlayerCommandDone (PlayerCommandFn callback, void *context)=0

virtual uint64_t	OnButtonPress (ButtonPressFn callback, void *context)=0

virtual void	Unsubscribe (uint64_t token)=0

Protected Member Functions
	~IPluginEvents ()=default

Detailed Description

Engine events, raised on every plugin in load order. Game thread only; a callback must not throw across the module boundary.

Definition at line 14 of file IPluginEvents.hpp.

Member Typedef Documentation

◆ BuildGameSessionManifestFn

using VoltMod::IPluginEvents::BuildGameSessionManifestFn = void (*)(void* context, IEntityResourceManifest* manifest)

The next map's resource manifest, which only takes resources during this call.

Definition at line 31 of file IPluginEvents.hpp.

◆ ButtonPressFn

using VoltMod::IPluginEvents::ButtonPressFn = void (*)(void* context, int slot, std::string_view buttonId)

A custom HUD button press, raised on the frame after it arrived. buttonId is client text.

Definition at line 35 of file IPluginEvents.hpp.

◆ CheckTransmitFn

using VoltMod::IPluginEvents::CheckTransmitFn = void (*)(void* context, CCheckTransmitInfo** infoList, int infoCount)

Definition at line 29 of file IPluginEvents.hpp.

◆ ClientConnectedFn

using VoltMod::IPluginEvents::ClientConnectedFn = void (*)(void* context, int slot, int64_t steamId, std::string_view name, std::string_view address)

Definition at line 22 of file IPluginEvents.hpp.

◆ ClientConnectingFn

using VoltMod::IPluginEvents::ClientConnectingFn = bool (*)(void* context, int slot, int64_t steamId, std::string_view name, char* reason, size_t reasonSize)

True refuses the player: later plugins are not asked, and the engine shows reason, which the callback fills with at most reasonSize bytes including the terminator.

Definition at line 20 of file IPluginEvents.hpp.