afxAudioBank.h

Classes:

class
Detailed Description

 1
 2
 3//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
 4// Arcane-FX for MIT Licensed Open Source version of Torque 3D from GarageGames
 5// Copyright (C) 2015 Faust Logic, Inc.
 6//
 7// Permission is hereby granted, free of charge, to any person obtaining a copy
 8// of this software and associated documentation files (the "Software"), to
 9// deal in the Software without restriction, including without limitation the
10// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
11// sell copies of the Software, and to permit persons to whom the Software is
12// furnished to do so, subject to the following conditions:
13//
14// The above copyright notice and this permission notice shall be included in
15// all copies or substantial portions of the Software.
16//
17// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
23// IN THE SOFTWARE.
24//
25//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
26
27#ifndef _AFX_AUDIO_BANK_H_
28#define _AFX_AUDIO_BANK_H_
29
30class SFXDescription;
31
32class afxAudioBank: public SimDataBlock
33{
34private:
35   typedef SimDataBlock Parent;
36
37public:
38   SFXDescription*    mDescriptionObject;
39   U32                mDescriptionObjectID;
40   StringTableEntry   mPath;
41   StringTableEntry   mFilenames[32];
42   bool               mPreload;
43   S32                play_index;
44
45public:
46   /*C*/              afxAudioBank();
47   /*C*/              afxAudioBank(const afxAudioBank&, bool = false);
48   /*D*/              ~afxAudioBank();
49
50   static void        initPersistFields();
51
52   virtual bool       onAdd();
53   virtual void       packData(BitStream* stream);
54   virtual void       unpackData(BitStream* stream);
55
56   bool               preload(bool server, String &errorStr);
57
58   afxAudioBank*      cloneAndPerformSubstitutions(const SimObject*, S32 index=0);
59   virtual void       onPerformSubstitutions();
60   virtual bool       allowSubstitutions() const { return true; }
61
62   DECLARE_CONOBJECT(afxAudioBank);
63   DECLARE_CATEGORY("AFX");
64};
65
66//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
67
68#endif  // _AFX_AUDIO_BANK_H_
69