Emergency 20 Dokumentation  4.2.0
em5::AudioFeedbackHelper Class Reference

EMERGENCY 5 audio feedback helper class. More...

#include <AudioFeedbackHelper.h>

Static Public Member Functions

static void playCommandResponse (qsf::Entity &entity)
 Play command feedback for the given entity. More...
 
static void playCommandResponse (const OrderInfo *orderInfo)
 Play command feedback for the given order info. More...
 
static void playSelectResponse (qsf::Entity &entity)
 Play command feedback for the given entity. More...
 
static void playSelectResponse (const std::vector< qsf::Entity * > &entityList)
 Play command feedback for multiple entities. More...
 

Detailed Description

EMERGENCY 5 audio feedback helper class.

Member Function Documentation

static void em5::AudioFeedbackHelper::playCommandResponse ( qsf::Entity entity)
static

Play command feedback for the given entity.

Parameters
[in]entityThe entity, which defines audio index range and speaker index
static void em5::AudioFeedbackHelper::playCommandResponse ( const OrderInfo orderInfo)
static

Play command feedback for the given order info.

Parameters
[in]orderInfoOrder info pointer, may be a null pointer to play a completely unspecific command feedback
Note
  • If possible, prefer the method "playCommandResponse(qsf::Entity&)"
  • This one is used for ordering of units, when there is no entity created yet
static void em5::AudioFeedbackHelper::playSelectResponse ( qsf::Entity entity)
static

Play command feedback for the given entity.

Parameters
[in]entityThe entity, which defines audio index range and speaker index
static void em5::AudioFeedbackHelper::playSelectResponse ( const std::vector< qsf::Entity * > &  entityList)
static

Play command feedback for multiple entities.

Parameters
[in]entityListThe list of entities

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