____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.
(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

CSound Class Reference

#include <sound.h>

List of all members.

Public Member Functions

 CSound ()
 ~CSound ()

Public Attributes

unsigned char Range
 Range is a multiplier for DistanceSilent.
unsigned char Number
 single, group, or table of sounds.
union {
   CSample *   OneSound
 if it's only a simple sound
   CSample **   OneGroup
 when it's a simple group
   struct {
      CSound *   First
 first group: selected sound
      CSound *   Second
 second group: annoyed sound
   }   TwoGroups
 when it's a double group
Sound


Detailed Description

Sound definition.

Definition at line 78 of file sound.h.


Constructor & Destructor Documentation

CSound::CSound (  )  [inline]

Definition at line 80 of file sound.h.

References Sound.

CSound::~CSound (  ) 

Definition at line 529 of file sound.cpp.

References Number, ONE_SOUND, Sound, and TWO_GROUPS.


Member Data Documentation

unsigned char CSound::Range

Range is a multiplier for DistanceSilent.

Range is a multiplier for DistanceSilent. 255 means infinite range of the sound.

Definition at line 90 of file sound.h.

Referenced by PlayGameSound(), PlayMissileSound(), PlayUnitSound(), RegisterTwoGroups(), and SetSoundRange().

unsigned char CSound::Number

single, group, or table of sounds.

Definition at line 91 of file sound.h.

Referenced by ChooseSample(), SimpleChooseSample(), and ~CSound().

if it's only a simple sound

Definition at line 93 of file sound.h.

Referenced by ChooseSample(), RegisterSound(), and SimpleChooseSample().

when it's a simple group

Definition at line 94 of file sound.h.

Referenced by ChooseSample(), RegisterSound(), and SimpleChooseSample().

first group: selected sound

Definition at line 96 of file sound.h.

second group: annoyed sound

Definition at line 97 of file sound.h.

struct { ... } CSound::TwoGroups

when it's a double group

Referenced by ChooseSample(), and RegisterTwoGroups().

union { ... } CSound::Sound


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

Generated on Sat Feb 21 00:28:24 2009 for Bos Wars by  doxygen 1.5.6