Public Attributes
const char *	VoltModVersion

const char *	BuildStamp

bool(*	Load )(IPluginContext host, char error, size_t errorSize)

void(*	Unload )()

const char (	Status )()

Detailed Description

What a plugin library exports. VoltModVersion stays first: the host reads it before anything else.

Definition at line 16 of file PluginDescriptor.hpp.

Member Data Documentation

const char* VoltMod::PluginDescriptor::BuildStamp

The short commit the plugin was built from.

Definition at line 22 of file PluginDescriptor.hpp.

bool(* VoltMod::PluginDescriptor::Load) (IPluginContext *host, char *error, size_t errorSize)

Attach to host. On false, write why into error, which holds errorSize bytes.

Definition at line 25 of file PluginDescriptor.hpp.

const char *(* VoltMod::PluginDescriptor::Status) ()

This plugin's status as JSON it owns, valid until the next call.

Definition at line 31 of file PluginDescriptor.hpp.

void(* VoltMod::PluginDescriptor::Unload) ()

Release everything Load took. The host frees the library only after this returns.

Definition at line 28 of file PluginDescriptor.hpp.

const char* VoltMod::PluginDescriptor::VoltModVersion

The VoltMod release the plugin was built with; the host loads only its own.

Definition at line 19 of file PluginDescriptor.hpp.

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