A plugin bundle lists all the files and information needed to get one feature plugin working both in the editor and the runtime. More...

#include <Plugins.h>

Public Member Functions
plResult	ReadBundleFromDDL (plOpenDdlReader &ref_ddl)
	Reads the bundle description, but not the state.

void	WriteStateToDDL (plOpenDdlWriter &ref_ddl, const char *szOwnName) const
	Writes only the bundle's state to a DDL file.

void	ReadStateFromDDL (plOpenDdlReader &ref_ddl, const char *szOwnName)
	Reads only the bundle's state from a DDL file.

bool	IsStateEqual (const plPluginBundle &rhs) const
	Checks whether two bundles have the same state.

Public Attributes
bool	m_bSelected = false
	whether this bundle is supposed to be used.

bool	m_bLoadCopy = false
	Whether the engine should load a copy of the runtime DLL, so that the original can be replaced and potentially reloaded.

bool	m_bMissing = false

plTimestamp	m_LastModificationTime

bool	m_bMandatory = false
	if set, the bundle is always used and not even displayed in the UI

plString	m_sDisplayName
	The string for displaying the bundle in UI.

plString	m_sIconName
	The name of the icon for the plugin.

plString	m_sBannerName
	The name of the banner image used above the description.

plString	m_sDescription
	A proper description what this bundle is for, so that users know when to use it.

plHybridArray< plString, 1 >	m_EditorPlugins
	List of all the DLLs (without extension) to load into the editor process.

plHybridArray< plString, 1 >	m_EditorEnginePlugins
	List of all the DLLs to load into the editor's engine process.

plHybridArray< plString, 1 >	m_RuntimePlugins
	List of all the DLLs to load into the runtime. These will also get packaged.

plHybridArray< plString, 1 >	m_PackageDependencies
	Additional files to include in packages. E.g. indirect DLL dependencies.

plHybridArray< plString, 1 >	m_RequiredBundles
	The file names (without path or extension) of other bundles that are required for this bundle to work.

plHybridArray< plString, 1 >	m_ExclusiveFeatures
	If two bundles have the same string in this list, they can't be activated at the same time. So for example only one bundle with the feature 'Sound' or 'Physics' may be activated simultaneously. Only enforced by the UI.

plHybridArray< plString, 1 >	m_EnabledInTemplates
	In which project templates this plugin should be active by default.

Detailed Description

A plugin bundle lists all the files and information needed to get one feature plugin working both in the editor and the runtime.

So it lists the editor DLLs, the runtime DLLs, all the additional transitive dependencies that need to be packaged, and so on.

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

Code/Editor/EditorFramework/EditorApp/Configuration/Plugins.h
Code/Editor/EditorFramework/EditorApp/Configuration/EditorPlugins.cpp

Public Member Functions

Public Attributes

Detailed Description