Open 3D Engine AzCore API Reference 25.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Friends | List of all members
AZ::OrderedEventHandler< Params > Class Template Reference

A handler class that can connect to an Event that will be called in order based on priority. More...

#include <OrderedEvent.h>

Public Types

using Callback = AZStd::function< void(Params...)>
 

Public Member Functions

 OrderedEventHandler (std::nullptr_t)
 
 OrderedEventHandler (Callback callback, int32_t priority=0)
 
 OrderedEventHandler (const OrderedEventHandler &rhs)
 
 OrderedEventHandler (OrderedEventHandler &&rhs)
 
OrderedEventHandler & operator= (const OrderedEventHandler &rhs)
 
OrderedEventHandler & operator= (OrderedEventHandler &&rhs)
 
void Connect (OrderedEvent< Params... > &event)
 
void Disconnect ()
 Disconnects the handler from its connected event, does nothing if the event is not connected.
 
bool IsConnected () const
 

Friends

class OrderedEvent< Params... >
 

Detailed Description

template<typename... Params>
class AZ::OrderedEventHandler< Params >

A handler class that can connect to an Event that will be called in order based on priority.

Member Function Documentation

◆ Connect()

template<typename... Params>
void AZ::OrderedEventHandler< Params >::Connect ( OrderedEvent< Params... > &  event)

Connects the handler to the provided event.

Parameters
eventthe Event to connect to

◆ IsConnected()

template<typename... Params>
bool AZ::OrderedEventHandler< Params >::IsConnected ( ) const

Returns true if the Handler is currently connected to an event.

Returns
boolean true if this handler is connected to an event
The documentation for this class was generated from the following files: