Action manager. More...

#include <Urho3D/Actions/ActionManager.h>

Inheritance diagram for Urho3D::ActionManager:

Classes
struct	HashElement

Public Member Functions
	ActionManager (Context *context)

	ActionManager (Context *context, bool autoupdate)

void	CompleteAllActions ()

void	CancelAllActions ()

void	CompleteAllActionsOnTarget (Object *target)

void	CancelAllActionsFromTarget (Object *target)

void	CancelAction (Actions::ActionState *actionState)

unsigned	GetNumActions (Object *target) const

Actions::ActionState *	AddAction (Actions::BaseAction action, Object target, bool paused=false)
	Add action to the action manager.

void	Update (float dt)

Actions::FiniteTimeAction *	GetEmptyAction ()

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.

Public Member Functions inherited from Urho3D::ObjectReflectionRegistry
	ObjectReflectionRegistry (Context *context)

ObjectReflection *	Reflect (const TypeInfo *typeInfo)
	Return existing or new reflection for given type.

ObjectReflection *	ReflectCustomType (ea::unique_ptr< TypeInfo > typeInfo)

template<class T >
ObjectReflection *	Reflect ()

template<class T >
ObjectReflection *	AddReflection (ea::string_view category="")
	Add new object reflection with or without object creation factory and assign it to the category.

template<class T >
ObjectReflection *	AddFactoryReflection (ea::string_view category="")

template<class T >
ObjectReflection *	AddAbstractReflection (ea::string_view category="")

ObjectReflection *	GetReflection (StringHash typeNameHash)
	Return existing reflection for given type.

const ObjectReflection *	GetReflection (StringHash typeNameHash) const

bool	IsReflected (StringHash typeNameHash) const

template<class T >
ObjectReflection *	GetReflection ()

template<class T >
const ObjectReflection *	GetReflection () const

template<class T >
bool	IsReflected () const

void	SetReflectionCategory (const TypeInfo *typeInfo, ea::string_view category)
	Assign object reflection to the category.

template<class T >
void	SetReflectionCategory (ea::string_view category)

void	RemoveReflection (StringHash typeNameHash)
	Remove reflection.

template<class T >
void	RemoveReflection ()

SharedPtr< Object >	CreateObject (StringHash typeNameHash)
	Create an object by type. Return pointer to it or null if no reflection is found.

const ea::unordered_map< StringHash, SharedPtr< ObjectReflection > > &	GetObjectReflections () const
	Return reflections of all objects.

const ea::unordered_map< ea::string, ea::vector< StringHash > > &	GetObjectCategories () const
	Return categories of reflected objects.

template<class T >
void	RemoveAttribute (StringHash nameHash)

template<class T >
void	UpdateAttributeDefaultValue (StringHash nameHash, const Variant &defaultValue)

Private Member Functions
void	HandleUpdate (StringHash eventType, VariantMap &eventData)

Private Attributes
SharedPtr< Object >	currentTarget_ {}

bool	currentTargetSalvaged_ {}

ea::unordered_map< Object *, HashElement >	targets_

ea::vector< Object * >	tmpKeysArray_

SharedPtr< Actions::FiniteTimeAction >	emptyAction_

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

Public Attributes inherited from Urho3D::ObjectReflectionRegistry
Signal< void(ObjectReflection *), ObjectReflectionRegistry >	OnReflectionRemoved

Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Action manager.

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

Urho3D/Actions/ActionManager.h
Urho3D/Actions/ActionManager.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description