VoltMod
C++23 framework for CS2 server plugins
Loading...
Searching...
No Matches
VoltMod::Plugin Class Reference

Everything a plugin owns for one load cycle. More...

#include <Plugin.hpp>

Public Member Functions

 Plugin (VoltMod::Runtime &runtime)
 
virtual ~Plugin ()=default
 
 Plugin (const Plugin &)=delete
 
Plugin & operator= (const Plugin &)=delete
 
virtual bool Load ()
 

Public Attributes

VoltMod::Runtime & Runtime
 

Detailed Description

Everything a plugin owns for one load cycle.

The framework constructs the derived class with a live Runtime, calls Load, and destroys it before that runtime. Release plugin-owned resources in member destructors.

Definition at line 14 of file Plugin.hpp.

Constructor & Destructor Documentation

◆ Plugin() [1/2]

VoltMod::Plugin::Plugin ( VoltMod::Runtime &  runtime)
inlineexplicit

Definition at line 17 of file Plugin.hpp.

◆ ~Plugin()

virtual VoltMod::Plugin::~Plugin ( )
virtualdefault

◆ Plugin() [2/2]

VoltMod::Plugin::Plugin ( const Plugin &  )
delete

Member Function Documentation

◆ Load()

virtual bool VoltMod::Plugin::Load ( )
inlinevirtual

Start work that can fail the load, after every member is built. Returning false aborts it.

Definition at line 27 of file Plugin.hpp.

◆ operator=()

Plugin & VoltMod::Plugin::operator= ( const Plugin &  )
delete

Member Data Documentation

◆ Runtime

VoltMod::Runtime& VoltMod::Plugin::Runtime

Framework services for this plugin's load cycle.

Definition at line 24 of file Plugin.hpp.


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