AZ::IEventScheduler Class Reference

This is an AZ::Interface<> for managing scheduled events. Users should not require any direct interaction with this interface, ScheduledEvent is a self contained abstraction. More...

#include <IEventScheduler.h>

Public Types
using	ScheduledEventHandlePtr = AZStd::unique_ptr< ScheduledEventHandle >

Public Member Functions
	AZ_RTTI (IEventScheduler, "{D8146217-6F93-47EB-9037-53BBFE429666}")
virtual ScheduledEventHandle *	AddEvent (ScheduledEvent *scheduledEvent, TimeMs durationMs)=0
virtual void	AddCallback (const AZStd::function< void()> &callback, const Name &eventName, TimeMs durationMs)=0
	AZ_DISABLE_COPY_MOVE (IEventScheduler)

Detailed Description

This is an AZ::Interface<> for managing scheduled events. Users should not require any direct interaction with this interface, ScheduledEvent is a self contained abstraction.

Member Function Documentation

AddCallback()

virtual void AZ::IEventScheduler::AddCallback ( const AZStd::function< void()> &  callback, const Name &  eventName, TimeMs  durationMs  )

pure virtual

Schedules a callback to run in durationMs. Actual duration is not guaranteed but will not be less than the value provided.

Parameters

callback	a callback to invoke after durationMs
eventName	a text descriptor of the callback
durationMs	a millisecond interval to run the scheduled callback

AddEvent()

virtual ScheduledEventHandle * AZ::IEventScheduler::AddEvent ( ScheduledEvent *  scheduledEvent, TimeMs  durationMs  )

pure virtual

Adds a scheduled event to run in durationMs. Actual duration is not guaranteed but will not be less than the value provided.

Parameters

scheduledEvent	a scheduled event to add
durationMs	a millisecond interval to run the scheduled event

Returns

pointer to the handle for this scheduled event, IEventScheduler maintains ownership

---

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

• Code/Framework/AzCore/AzCore/EBus/IEventScheduler.h