Urho3D::MainPluginApplication Class Reference

Similar to PluginApplication, but can act as entry point. More...

#include <Urho3D/Plugins/PluginApplication.h>

Inheritance diagram for Urho3D::MainPluginApplication:

Public Member Functions
	MainPluginApplication (Context *context)
bool	IsMain () const final
Public Member Functions inherited from Urho3D::PluginApplication
	PluginApplication (Context *context)
void	SetPluginName (const ea::string &name)
virtual ea::string	GetDefaultCategory () const
	Return default object category for the plugin.
void	Dispose ()
	Prepare object for destruction.
void	LoadPlugin ()
	Load plugin into the context and the engine subsystems.
void	UnloadPlugin ()
	Unload plugin from the context and the engine subsystems.
void	StartApplication (bool isMain)
	Start application.
void	StopApplication ()
	Stop application.
void	SuspendApplication (Archive &output, unsigned version)
	Suspend application. It's highly recommended to release all plugin-related objects here.
void	ResumeApplication (Archive *input, unsigned version)
	Resume application. Archive may be null if it wasn't serialized before.
const ea::string &	GetPluginName ()
	Return plugin name. Should be the same as dynamic library name when plugin is linked dynamically.
bool	IsLoaded () const
	Return whether the plugin is loaded.
bool	IsStarted () const
	Return whether the application is started.
template<typename T >
ObjectReflection *	AddFactoryReflection ()
	Register a factory for an object type that would be automatically unregistered on unload.
template<typename T >
ObjectReflection *	AddFactoryReflection (ea::string_view category)
template<typename T >
void	RegisterObject ()
	Register an object that would be automatically unregistered on unload.
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 bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
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.

Private Member Functions
	URHO3D_OBJECT (MainPluginApplication, PluginApplication)

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::PluginApplication
static void	RegisterPluginApplication (const ea::string &name, PluginApplicationFactory factory)
	Register plugin application class to be visible in all future instances of PluginManager.
template<class T >
static void	RegisterPluginApplication (const ea::string &name)
template<class T >
static void	RegisterPluginApplication ()
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}
Protected Member Functions inherited from Urho3D::PluginApplication
virtual void	Load ()
	Called on LoadPlugin().
virtual void	Unload ()
	Called on UnloadPlugin().
virtual void	Start (bool isMain)
	Called on StartApplication().
virtual void	Stop ()
	Called on StopApplication().
virtual void	Suspend (Archive &output)
	Called on SuspendApplication().
virtual void	Resume (Archive *input, bool differentVersion)
	Called on ResumeApplication().
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Similar to PluginApplication, but can act as entry point.

Member Function Documentation

IsMain()

bool Urho3D::MainPluginApplication::IsMain ( ) const

inlinefinalvirtual

Implement PluginApplication.

Reimplemented from Urho3D::PluginApplication.

---

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

• Urho3D/Plugins/PluginApplication.h
• Urho3D/Plugins/PluginApplication.cpp