Emergency 20 Dokumentation  4.2.0
em5::TutorialStepOutro Class Reference

EMERGENCY 5 tutorial step outro. More...

#include <TutorialStepOutro.h>

Inheritance diagram for em5::TutorialStepOutro:
em5::TutorialStep

Public Member Functions

 TutorialStepOutro (Tutorial &tutorial)
 Default constructor. More...
 
virtual ~TutorialStepOutro ()
 Destructor. More...
 
virtual void startup () override
 Startup call for the tutorial step. More...
 
virtual bool update (const qsf::Time &timePassed) override
 Updates the tutorial step. More...
 
virtual void shutdown () override
 Shutdown call for the tutorial step. More...
 
- Public Member Functions inherited from em5::TutorialStep
 TutorialStep (Tutorial &tutorial)
 Default constructor. More...
 
virtual ~TutorialStep ()
 Destructor. More...
 
virtual const std::string getLayerId () const
 
virtual const std::string getEraseLayerId () const
 
virtual const qsf::EntitygetFocusEntity ()
 

Additional Inherited Members

- Protected Member Functions inherited from em5::TutorialStep
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 inherited from em5::TutorialStep
uint64 mOnlyCommandAllowed
 
qsf::EntitymOnlyCommandTargetAllowed
 

Detailed Description

EMERGENCY 5 tutorial step outro.

Constructor & Destructor Documentation

em5::TutorialStepOutro::TutorialStepOutro ( Tutorial tutorial)

Default constructor.

virtual em5::TutorialStepOutro::~TutorialStepOutro ( )
virtual

Destructor.

Member Function Documentation

virtual void em5::TutorialStepOutro::shutdown ( )
overridevirtual

Shutdown call for the tutorial step.

Reimplemented from em5::TutorialStep.

virtual void em5::TutorialStepOutro::startup ( )
overridevirtual

Startup call for the tutorial step.

Reimplemented from em5::TutorialStep.

virtual bool em5::TutorialStepOutro::update ( const qsf::Time timePassed)
overridevirtual

Updates the tutorial step.

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

Implements em5::TutorialStep.


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