ScummVM API documentation
Common::DelayedEventSource Class Reference
Inheritance diagram for Common::DelayedEventSource:
Common::EventSource

Public Member Functions

bool pollEvent (Event &event) override
 
bool allowMapping () const override
 
void scheduleEvent (const Event &ev, uint32 delayMillis)
 

Member Function Documentation

◆ pollEvent()

bool Common::DelayedEventSource::pollEvent ( Event event)
overridevirtual

Query an event from the source.

Parameters
eventReference to the event struct where the event should be stored.
Return values
trueIf an event was polled, false otherwise.

Implements Common::EventSource.

◆ allowMapping()

bool Common::DelayedEventSource::allowMapping ( ) const
overridevirtual

Check whether events from this source are allowed to be mapped.

Possible event sources not allowing mapping are: the event recorder/player and/or the EventManager, which allows user events to be pushed.

By default, mapping is allowed for every event source.

Reimplemented from Common::EventSource.

◆ scheduleEvent()

void Common::DelayedEventSource::scheduleEvent ( const Event ev,
uint32  delayMillis 
)

Schedule an event to be produced after the specified delay


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