prj/cam/src/sound/vocore.h

   1 /*
   2 @Copyright Looking Glass Studios, Inc.
   3 1996,1997,1998,1999,2000 Unpublished Work.
   4 */
   5
   6 // $Header: r:/t2repos/thief2/src/sound/vocore.h,v 1.1 1998/09/16 00:17:12 mahk Exp $
   7 #pragma once
   8 #ifndef __VOCORE_H
   9 #define __VOCORE_H
  10 #include <comtools.h>
  11
  12 ////////////////////////////////////////////////////////////
  13 // CORE VOICE-OVER SYSTEM
  14 //
  15 // This is a tiny system for playing "voice overs" which are special
  16 // schemas that can be omitted if their context isn't right.
  17 //
  18
  19 typedef BOOL (LGAPI *tVOTestFunc)(void);
  20
  21 //
  22 // The voice-overs class
  23 //
  24
  25
  26 F_DECLARE_INTERFACE(IVoiceOverSys);
  27 #undef INTERFACE
  28 #define INTERFACE IVoiceOverSys
  29 DECLARE_INTERFACE_(IVoiceOverSys,IUnknown)
  30 {
  31    DECLARE_UNKNOWN_PURE();
  32
  33    //
  34    // Play a voiceover schema
  35    // May actually choose not to play, if the conditions for playing
  36    // the schema are not right.
  37    //
  38    // Returns a schema handle
  39    //
  40    STDMETHOD_(int,Play)(THIS_ int schema) PURE;
  41
  42    //
  43    // Observe whether a schema has been played.
  44    // Mark a schema as having been played, or not played already
  45    //
  46    STDMETHOD_(BOOL,AlreadyPlayed)(THIS_ int schema) PURE;
  47    STDMETHOD(SetAlreadyPlayed)(THIS_ int schema, BOOL played) PURE;
  48
  49    //
  50    // Set the game-specific callback that tests whether or not we
  51    // are "in combat."  Each call to Play() will call it.
  52    //
  53    STDMETHOD(SetCombatTest)(THIS_ tVOTestFunc func) PURE;
  54
  55 };
  56 #undef INTERFACE
  57
  58 EXTERN void VoiceOverCreate(void);
  59
  60 #endif // __VOCORE_H