Emergency 20 Dokumentation  4.2.0
em5::FreeplayEventGenerator Class Reference

EMERGENCY 5 freeplay event generation class. More...

#include <FreeplayEventGenerator.h>

Inheritance diagram for em5::FreeplayEventGenerator:

Public Types

typedef boost::function< bool(uint32)> EventIndexAllowedCallback
 

Public Member Functions

 FreeplayEventGenerator ()
 Default constructor. More...
 
 ~FreeplayEventGenerator ()
 Destructor. More...
 
void startup ()
 
void shutdown ()
 
void updateEventGeneration (const qsf::Time &timePassed)
 
FreeplayEventtriggerEvent (FreeplayEventFactory &factory, const FreeplayEventTriggerInfo &triggerInfo)
 
float getUpperLimit () const
 Get the maximum event density. More...
 
void setUpperLimit (float density)
 Set the maximum event density that should not be exceeded. More...
 
void setWaitTimeBetweenEvents (float mininumWaitTime, float maximumWaitTime)
 Set the minimum and maximum wait time between events (in seconds) More...
 
void setStartWaitTime (float mininumWaitTime, float maximumWaitTime)
 Set the minimum and maximum start wait time before first event (in seconds) More...
 
uint32 getUpperEventLimit () const
 Returns the maximum number of events that can be active at the same time. More...
 
void setUpperEventLimit (uint32 maximumEventCount)
 Set the maximum number of events that can be active at the same time. More...
 
uint32 getMaxEventLimit () const
 
bool isUsingForcedEventOrder () const
 
void switchToForcedEventOrder (bool useForcedOrder, int32 lastEventIndex=-1)
 
int32 getEventFactoryIndexById (uint32 factoryId) const
 
void setTriggerFailReason (const std::string &reason)
 
void serialize (qsf::BinarySerializer &serializer)
 

Friends

class FreeplaySystem
 
class FreeplayGameMode
 

Detailed Description

EMERGENCY 5 freeplay event generation class.

Member Typedef Documentation

Constructor & Destructor Documentation

em5::FreeplayEventGenerator::FreeplayEventGenerator ( )

Default constructor.

em5::FreeplayEventGenerator::~FreeplayEventGenerator ( )

Destructor.

Member Function Documentation

int32 em5::FreeplayEventGenerator::getEventFactoryIndexById ( uint32  factoryId) const
uint32 em5::FreeplayEventGenerator::getMaxEventLimit ( ) const
uint32 em5::FreeplayEventGenerator::getUpperEventLimit ( ) const

Returns the maximum number of events that can be active at the same time.

float em5::FreeplayEventGenerator::getUpperLimit ( ) const

Get the maximum event density.

bool em5::FreeplayEventGenerator::isUsingForcedEventOrder ( ) const
void em5::FreeplayEventGenerator::serialize ( qsf::BinarySerializer serializer)
void em5::FreeplayEventGenerator::setStartWaitTime ( float  mininumWaitTime,
float  maximumWaitTime 
)

Set the minimum and maximum start wait time before first event (in seconds)

void em5::FreeplayEventGenerator::setTriggerFailReason ( const std::string &  reason)
void em5::FreeplayEventGenerator::setUpperEventLimit ( uint32  maximumEventCount)

Set the maximum number of events that can be active at the same time.

void em5::FreeplayEventGenerator::setUpperLimit ( float  density)

Set the maximum event density that should not be exceeded.

void em5::FreeplayEventGenerator::setWaitTimeBetweenEvents ( float  mininumWaitTime,
float  maximumWaitTime 
)

Set the minimum and maximum wait time between events (in seconds)

void em5::FreeplayEventGenerator::shutdown ( )
void em5::FreeplayEventGenerator::startup ( )
void em5::FreeplayEventGenerator::switchToForcedEventOrder ( bool  useForcedOrder,
int32  lastEventIndex = -1 
)
FreeplayEvent* em5::FreeplayEventGenerator::triggerEvent ( FreeplayEventFactory factory,
const FreeplayEventTriggerInfo triggerInfo 
)
void em5::FreeplayEventGenerator::updateEventGeneration ( const qsf::Time timePassed)

Friends And Related Function Documentation

friend class FreeplayGameMode
friend
friend class FreeplaySystem
friend

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