PluginManager Class Reference

Collaboration diagram for PluginManager:

Protected Member Functions
void	RegisterPlugin (string plugin_class_name, bool reg_on_client, bool reg_on_server, bool reg_on_release=true)
	Register new PluginBase to PluginManager for storing and handling plugin.
void	RegisterPluginDebug (string plugin_class_name, bool reg_on_client, bool reg_on_server)
	Register new PluginBase to PluginManager for storing and handling plugin.
void	RegisterPluginDiag (string plugin_class_name, bool reg_on_client, bool reg_on_server)
bool	UnregisterPlugin (string plugin_class_name)

Private Member Functions
void	PluginManager ()
void	~PluginManager ()
void	Init ()
void	PluginsInit ()
void	MainOnUpdate (float delta_time)
PluginBase	GetPluginByType (typename plugin_type)
	Returns registred plugin by class type, better is to use global funtion GetPlugin(typename plugin_type)

Private Attributes
ref array< typename >	m_PluginRegister
ref map< typename, ref PluginBase >	m_PluginsPtrs

Detailed Description

Definition at line 1 of file PluginManager.c.

Constructor & Destructor Documentation

PluginManager()

void PluginManager::PluginManager ( )

inlineprivate

Definition at line 9 of file PluginManager.c.

  {
    m_PluginRegister = new array<typename>;
    m_PluginsPtrs = new map<typename, ref PluginBase>;
  }

References m_PluginRegister, and m_PluginsPtrs.

~PluginManager()

void PluginManager::~PluginManager ( )

inlineprivate

Definition at line 18 of file PluginManager.c.

  {
    int i;
    PluginBase plugin;
 
    for (i = 0; i < m_PluginsPtrs.Count(); ++i)
    {
      plugin = m_PluginsPtrs.GetElement(i);
      if (plugin != NULL)
      {
        plugin.OnDestroy();
        delete plugin;
      }
    }
 
    GetGame().GetUpdateQueue(CALL_CATEGORY_GAMEPLAY).Remove(this.MainOnUpdate);
  }

References CALL_CATEGORY_GAMEPLAY, GetGame(), m_PluginsPtrs, and MainOnUpdate().

Member Function Documentation

GetPluginByType()

PluginBase PluginManager::GetPluginByType ( typename plugin_type )

inlineprivate

Returns registred plugin by class type, better is to use global funtion GetPlugin(typename plugin_type)

Parameters

module_tpye

typename class type of plugin

Returns

PluginBase

PluginRepairing plugin = GetPluginManager().GetPluginByType(PluginRepairing);

Definition at line 151 of file PluginManager.c.

  {
    if (m_PluginsPtrs.Contains(plugin_type))
      return m_PluginsPtrs.Get(plugin_type);
 
    return null;
  }

References m_PluginsPtrs.

Referenced by GetPlugin(), and PluginsInit().

Init()

void PluginManager::Init ( )

inlineprivate

Definition at line 39 of file PluginManager.c.

  {
    //----------------------------------------------------------------------
    // Register modules
    //----------------------------------------------------------------------
    // Module Class Name                 Client  Server
    //----------------------------------------------------------------------
    RegisterPlugin("PluginHorticulture", true, true);
    RegisterPlugin("PluginRepairing", true, true);
    RegisterPlugin("PluginPlayerStatus", true, true);
    RegisterPlugin("PluginMessageManager", true, true);
    RegisterPlugin("PluginLifespan", true, true);
    RegisterPlugin("PluginVariables", true, true);
    RegisterPlugin("PluginObjectsInteractionManager", false, true);
    RegisterPlugin("PluginRecipesManager", true, true);
    RegisterPlugin("PluginTransmissionAgents", true, true);
    RegisterPlugin("PluginAdditionalInfo", true, true); //TODO clean up after Gamescom
    RegisterPlugin("PluginConfigEmotesProfile", true, true);
    RegisterPlugin("PluginPresenceNotifier", true, false);
    RegisterPlugin("PluginAdminLog", false, true);
 
    // Developer + Diag
    RegisterPluginDiag("PluginKeyBinding", true, false);
    RegisterPluginDiag("PluginDeveloper", true, true);
    RegisterPluginDiag("PluginDeveloperSync", true, true);
    RegisterPluginDiag("PluginDiagMenuClient", true, false);
    RegisterPluginDiag("PluginDiagMenuServer", false, true);
    RegisterPluginDiag("PluginPermanentCrossHair", true, false);
    RegisterPluginDiag("PluginRemotePlayerDebugClient", true, false);
    RegisterPluginDiag("PluginRemotePlayerDebugServer", false, true);
    RegisterPluginDiag("PluginUniversalTemperatureSourceClient", true, false);
    RegisterPluginDiag("PluginUniversalTemperatureSourceServer", false, true);
    RegisterPluginDiag("PluginDrawCheckerboard", true, false);
    RegisterPluginDiag("PluginItemDiagnostic", true, true);
    RegisterPluginDiag("PluginDayZCreatureAIDebug", true, true);
 
    // Only In Debug / Internal
    RegisterPluginDebug("PluginConfigViewer", true, true);
    RegisterPluginDebug("PluginLocalEnscriptHistory", true, true);
    RegisterPluginDebug("PluginLocalEnscriptHistoryServer", true, true);
 
    RegisterPluginDebug("PluginSceneManager", true, true);
    RegisterPluginDebug("PluginConfigScene", true, true);
    RegisterPluginDebug("PluginMissionConfig", true, true);
    RegisterPluginDebug("PluginConfigEmotesProfile", true, true);
    RegisterPluginDebug("PluginConfigDebugProfile", true, true);
    RegisterPluginDebug("PluginConfigDebugProfileFixed", true, true);
 
    RegisterPluginDebug("PluginDayzPlayerDebug", true, true);
    RegisterPluginDebug("PluginDayZInfectedDebug", true, true);
    RegisterPluginDebug("PluginDoorRuler", true, false);
    RegisterPluginDebug("PluginCharPlacement", true, false);
    //RegisterPluginDebug( "PluginSoundDebug",            false,  false );
    RegisterPluginDebug("PluginCameraTools", true, true);
    RegisterPluginDebug("PluginNutritionDumper", true, false);
 
    GetGame().GetUpdateQueue(CALL_CATEGORY_GAMEPLAY).Insert(MainOnUpdate);
  }

References CALL_CATEGORY_GAMEPLAY, GetGame(), MainOnUpdate(), RegisterPlugin(), RegisterPluginDebug(), and RegisterPluginDiag().

MainOnUpdate()

void PluginManager::MainOnUpdate ( float delta_time )

inlineprivate

Definition at line 130 of file PluginManager.c.

  {
    for (int i = 0; i < m_PluginsPtrs.Count(); ++i)
    {
      PluginBase plugin = m_PluginsPtrs.GetElement(i);
      if (plugin != NULL)
        plugin.OnUpdate(delta_time);
    }
  }

References m_PluginsPtrs.

Referenced by Init(), and ~PluginManager().

PluginsInit()

void PluginManager::PluginsInit ( )

inlineprivate

Definition at line 101 of file PluginManager.c.

  {
    int i = 0;
    int regCount = m_PluginRegister.Count();
 
    array<PluginBase> pluginPtrs = {};
    pluginPtrs.Reserve(regCount);
 
    foreach (typename pluginType : m_PluginRegister)
    {
      PluginBase moduleExist = GetPluginByType(pluginType);
      if (moduleExist)
        m_PluginsPtrs.Remove(pluginType);
 
      PluginBase moduleNew = PluginBase.Cast(pluginType.Spawn());
      m_PluginsPtrs.Set(pluginType, moduleNew);
      pluginPtrs.Insert(moduleNew);
    }
 
    foreach (PluginBase plugin : pluginPtrs)
    {
      if (plugin)
        plugin.OnInit();
    }
  }

References GetPluginByType(), m_PluginRegister, and m_PluginsPtrs.

RegisterPlugin()

void PluginManager::RegisterPlugin ( string plugin_class_name, bool reg_on_client, bool reg_on_server, bool reg_on_release = true )

inlineprotected

Register new PluginBase to PluginManager for storing and handling plugin.

Parameters

module_tpye

typename class type of plugin

Returns

void

class PluginRepairing extends PluginBase
{
...
}
 
RegisterPlugin(PluginRepairing);

Definition at line 175 of file PluginManager.c.

  {
    if (!reg_on_client)
    {
      if (GetGame().IsMultiplayer() && GetGame().IsClient())
        return;
    }
 
    if (!reg_on_server)
    {
      if (GetGame().IsMultiplayer())
      {
        if (GetGame().IsServer())
          return;
      }
    }
 
    if (!reg_on_release)
    {
      if (!GetGame().IsDebug())
        return;
    }
 
    m_PluginRegister.Insert(plugin_class_name.ToType());
  }

References GetGame(), and m_PluginRegister.

Referenced by Init(), RegisterPluginDebug(), and RegisterPluginDiag().

RegisterPluginDebug()

void PluginManager::RegisterPluginDebug ( string plugin_class_name, bool reg_on_client, bool reg_on_server )

inlineprotected

Register new PluginBase to PluginManager for storing and handling plugin.

Parameters

module_tpye

typename class type of plugin

Returns

void

class PluginRepairing extends PluginBase
{
...
}
 
RegisterPlugin(PluginRepairing);

Definition at line 217 of file PluginManager.c.

  {
    RegisterPlugin(plugin_class_name, reg_on_client, reg_on_server, false);
  }

References RegisterPlugin().

Referenced by Init().

RegisterPluginDiag()

void PluginManager::RegisterPluginDiag ( string plugin_class_name, bool reg_on_client, bool reg_on_server )

inlineprotected

Definition at line 224 of file PluginManager.c.

  {
#ifdef DIAG_DEVELOPER
    RegisterPlugin(plugin_class_name, reg_on_client, reg_on_server, true);
#else
    return;
#endif
  }

References RegisterPlugin().

Referenced by Init().

UnregisterPlugin()

bool PluginManager::UnregisterPlugin ( string plugin_class_name )

inlineprotected

Definition at line 236 of file PluginManager.c.

  {
    typename plugin_type = plugin_class_name.ToType();
 
    if (m_PluginRegister.Find(plugin_type) != -1)
    {
      m_PluginRegister.RemoveItem(plugin_type);
      return true;
    }
 
    return false;
  }

References m_PluginRegister.

Member Data Documentation

m_PluginRegister

ref array<typename> PluginManager::m_PluginRegister

private

Definition at line 3 of file PluginManager.c.

Referenced by PluginManager(), PluginsInit(), RegisterPlugin(), and UnregisterPlugin().

m_PluginsPtrs

ref map<typename, ref PluginBase> PluginManager::m_PluginsPtrs

private

Definition at line 4 of file PluginManager.c.

Referenced by GetPluginByType(), MainOnUpdate(), PluginManager(), PluginsInit(), and ~PluginManager().

---

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

• scripts/4_World/Plugins/PluginManager.c