Emergency 20 Dokumentation  4.2.0
em5::TutorialStep Class Referenceabstract

EMERGENCY 5 tutorial step base class. More...

#include <TutorialStep.h>

Inheritance diagram for em5::TutorialStep:
em5::TutorialStepIntro em5::TutorialStepOutro em5::TutorialStepStation1 em5::TutorialStepStation2 em5::TutorialStepStation3

Public Member Functions

 TutorialStep (Tutorial &tutorial)
 Default constructor. More...
 
virtual ~TutorialStep ()
 Destructor. More...
 
virtual void startup ()
 Startup call for the tutorial step. More...
 
virtual bool update (const qsf::Time &timePassed)=0
 Updates the tutorial step. More...
 
virtual void shutdown ()
 Shutdown call for the tutorial step. More...
 
virtual const std::string getLayerId () const
 
virtual const std::string getEraseLayerId () const
 
virtual const qsf::EntitygetFocusEntity ()
 

Protected Member Functions

TutorialgetTutorial ()
 
qsf::EntityacquireTaggedEntity (const std::string &tag)
 
qsf::CameraComponentgetCameraComponent () const
 
qsf::CameraControlComponentgetCameraControlComponent () const
 
void clearObjectives ()
 
void changeEventName (const std::string &eventName)
 
ObjectivecreateObjective (uint32 objectiveId, const std::string &objectiveText)
 
void markObjectiveAsAccomplished (const uint32 objectiveId)
 
bool hasSupervisorEnded (const qsf::Time &timePassed)
 
void cancelSupervisorMessage ()
 
bool hasWaitTimeEnded (qsf::Time &remainingWaitTime, const qsf::Time &timePassed)
 
bool hasPauseBetweenSubStepsEnded (const qsf::Time &timePassed) const
 
void showTextWindow (bool show) const
 
void clearTextWindow () const
 
void showObjectiveWindow (bool show) const
 
bool hasCameraStoppedAutomaticMovement ()
 
void flyToCamera (const qsf::Entity &targetCameraEntity, float maximumSpeed=200.0f)
 
void flyToEntity (const qsf::Entity &targetEntity, bool jumpDirectly=false)
 
void startFollowEntity (const qsf::Entity &targetEntity, float distance=25.0f)
 
void stopFollowEntity ()
 
bool isEntitySelected (uint64 entityId)
 
void clearSelection ()
 
void showUserInterface (bool show) const
 
void showSupervisorMessage (const std::string &textId)
 
void showOrderAreaMarker (qsf::Entity *orderAreaEntity, bool show)
 
void makeEntitySelectable (qsf::Entity &entity, bool selectable)
 
void setupUnitAfterSpawn (qsf::Entity &unitVehicle)
 

Protected Attributes

uint64 mOnlyCommandAllowed
 
qsf::EntitymOnlyCommandTargetAllowed
 

Detailed Description

EMERGENCY 5 tutorial step base class.

Constructor & Destructor Documentation

em5::TutorialStep::TutorialStep ( Tutorial tutorial)
explicit

Default constructor.

virtual em5::TutorialStep::~TutorialStep ( )
virtual

Destructor.

Member Function Documentation

qsf::Entity* em5::TutorialStep::acquireTaggedEntity ( const std::string &  tag)
protected
void em5::TutorialStep::cancelSupervisorMessage ( )
protected
void em5::TutorialStep::changeEventName ( const std::string &  eventName)
protected
void em5::TutorialStep::clearObjectives ( )
protected
void em5::TutorialStep::clearSelection ( )
protected
void em5::TutorialStep::clearTextWindow ( ) const
protected
Objective& em5::TutorialStep::createObjective ( uint32  objectiveId,
const std::string &  objectiveText 
)
protected
void em5::TutorialStep::flyToCamera ( const qsf::Entity targetCameraEntity,
float  maximumSpeed = 200.0f 
)
protected
void em5::TutorialStep::flyToEntity ( const qsf::Entity targetEntity,
bool  jumpDirectly = false 
)
protected
qsf::CameraComponent* em5::TutorialStep::getCameraComponent ( ) const
protected
qsf::CameraControlComponent* em5::TutorialStep::getCameraControlComponent ( ) const
protected
virtual const std::string em5::TutorialStep::getEraseLayerId ( ) const
virtual
virtual const qsf::Entity* em5::TutorialStep::getFocusEntity ( )
virtual

Reimplemented in em5::TutorialStepStation3.

virtual const std::string em5::TutorialStep::getLayerId ( ) const
virtual
Tutorial & em5::TutorialStep::getTutorial ( )
inlineprotected
bool em5::TutorialStep::hasCameraStoppedAutomaticMovement ( )
protected
bool em5::TutorialStep::hasPauseBetweenSubStepsEnded ( const qsf::Time timePassed) const
protected
bool em5::TutorialStep::hasSupervisorEnded ( const qsf::Time timePassed)
protected
bool em5::TutorialStep::hasWaitTimeEnded ( qsf::Time remainingWaitTime,
const qsf::Time timePassed 
)
protected
bool em5::TutorialStep::isEntitySelected ( uint64  entityId)
protected
void em5::TutorialStep::makeEntitySelectable ( qsf::Entity entity,
bool  selectable 
)
protected
void em5::TutorialStep::markObjectiveAsAccomplished ( const uint32  objectiveId)
protected
void em5::TutorialStep::setupUnitAfterSpawn ( qsf::Entity unitVehicle)
protected
void em5::TutorialStep::showObjectiveWindow ( bool  show) const
protected
void em5::TutorialStep::showOrderAreaMarker ( qsf::Entity orderAreaEntity,
bool  show 
)
protected
void em5::TutorialStep::showSupervisorMessage ( const std::string &  textId)
protected
void em5::TutorialStep::showTextWindow ( bool  show) const
protected
void em5::TutorialStep::showUserInterface ( bool  show) const
protected
virtual void em5::TutorialStep::shutdown ( )
virtual
void em5::TutorialStep::startFollowEntity ( const qsf::Entity targetEntity,
float  distance = 25.0f 
)
protected
virtual void em5::TutorialStep::startup ( )
virtual
void em5::TutorialStep::stopFollowEntity ( )
protected
virtual bool em5::TutorialStep::update ( const qsf::Time timePassed)
pure virtual

Updates the tutorial step.

Parameters
[in]timePassedThe time passed since the last update call
Returns
"True" when step has finished otherwise false

Implemented in em5::TutorialStepStation1, em5::TutorialStepStation2, em5::TutorialStepIntro, em5::TutorialStepOutro, and em5::TutorialStepStation3.

Member Data Documentation

uint64 em5::TutorialStep::mOnlyCommandAllowed
protected
qsf::Entity* em5::TutorialStep::mOnlyCommandTargetAllowed
protected

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