Urho3D::ModulePlugin Class Reference

Plugin that is loaded from a native or managed dynamic library. More...

#include <Urho3D/Plugins/ModulePlugin.h>

Inheritance diagram for Urho3D::ModulePlugin:

Public Member Functions
	ModulePlugin (Context *context)
bool	Load () override
bool	IsLoaded () const override
	Returns true if plugin is loaded and functional.
bool	IsOutOfDate () const override
	Returns true if plugin was modified on the disk and should be reloaded.
bool	WaitForCompleteFile (unsigned timeoutMs) const override
bool	PerformUnload () override
	Actually unloads the module. Called by PluginManager at the end of frame when IsUnloading is true.
Public Member Functions inherited from Urho3D::Plugin
	Plugin (Context *context)
void	SetName (const ea::string &name)
	Name must be set right after creating a plugin object.
const ea::string &	GetName () const
	Returns a name of the plugin. Name is usually a base name of plugin file.
unsigned	GetVersion () const
	Return current version of the plugin.
PluginApplication *	GetApplication () const
	Return plugin application, if available.
void	Unload ()
	Mark plugin for unloading. Plugin will be unloaded at the end of current frame.
bool	IsUnloading () const
	Returns whether the plugin is about to be unloaded.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Protected Member Functions
ea::string	NameToPath (const ea::string &name) const
	Converts name to a full plugin file path. Returns empty string on error.
ea::string	GetVersionModulePath (const ea::string &path)
	Return path to the current version of the module.

Protected Attributes
ea::string	path_
	Unversioned plugin module path.
DynamicModule	module_ {context_}
	Native module of this plugin.
unsigned	mtime_ {}
	Last modification time.
ModuleType	lastModuleType_ {}
	Last loaded module type.
Protected Attributes inherited from Urho3D::Plugin
ea::string	name_
	Base plugin file name.
bool	unloading_ {}
	Flag indicating that plugin should unload on the end of the frame.
unsigned	version_ {}
	Current plugin version.
SharedPtr< PluginApplication >	application_
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Private Member Functions
	URHO3D_OBJECT (ModulePlugin, Plugin)

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Detailed Description

Plugin that is loaded from a native or managed dynamic library.

Member Function Documentation

Load()

bool Urho3D::ModulePlugin::Load ( )

overridevirtual

Implement Plugin

Reimplemented from Urho3D::Plugin.

WaitForCompleteFile()

bool Urho3D::ModulePlugin::WaitForCompleteFile ( unsigned  timeoutMs ) const

overridevirtual

This function will block until plugin file is complete and ready to be loaded. Returns false if timeout exceeded, but file is still incomplete.

Reimplemented from Urho3D::Plugin.

---

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

• Urho3D/Plugins/ModulePlugin.h
• Urho3D/Plugins/ModulePlugin.cpp