1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
//========= Copyright Valve Corporation, All rights reserved. ============//
//
// Purpose:
//
// $NoKeywords: $
//
//=============================================================================//
#include "cbase.h"
#include "player.h"
#include "mathlib/mathlib.h"
#include "env_speaker.h"
#include "ai_speech.h"
#include "stringregistry.h"
#include "gamerules.h"
#include "game.h"
#include <ctype.h>
#include "entitylist.h"
#include "vstdlib/random.h"
#include "engine/IEngineSound.h"
#include "ndebugoverlay.h"
#include "soundscape.h"
#include "AI_ResponseSystem.h"
// memdbgon must be the last include file in a .cpp file!!!
#include "tier0/memdbgon.h"
#define SF_SPEAKER_START_SILENT 1
#define SF_SPEAKER_EVERYWHERE 2
extern ISaveRestoreOps *responseSystemSaveRestoreOps;
#include "saverestore.h"
LINK_ENTITY_TO_CLASS( env_speaker, CSpeaker );
BEGIN_DATADESC( CSpeaker )
DEFINE_KEYFIELD( m_delayMin, FIELD_FLOAT, "delaymin" ),
DEFINE_KEYFIELD( m_delayMax, FIELD_FLOAT, "delaymax" ),
DEFINE_KEYFIELD( m_iszRuleScriptFile, FIELD_STRING, "rulescript" ),
DEFINE_KEYFIELD( m_iszConcept, FIELD_STRING, "concept" ),
// Needs to be set up in the Activate methods of derived classes
//DEFINE_CUSTOM_FIELD( m_pInstancedResponseSystem, responseSystemSaveRestoreOps ),
// Function Pointers
DEFINE_FUNCTION( SpeakerThink ),
DEFINE_INPUTFUNC( FIELD_VOID, "TurnOn", InputTurnOn ),
DEFINE_INPUTFUNC( FIELD_VOID, "TurnOff", InputTurnOff ),
DEFINE_INPUTFUNC( FIELD_VOID, "Toggle", InputToggle ),
END_DATADESC()
void CSpeaker::Spawn( void )
{
const char *soundfile = (const char *)STRING( m_iszRuleScriptFile );
if ( Q_strlen( soundfile ) < 1 )
{
Warning( "'speaker' entity with no Level/Sentence! at: %f, %f, %f\n", GetAbsOrigin().x, GetAbsOrigin().y, GetAbsOrigin().z );
SetNextThink( gpGlobals->curtime + 0.1f );
SetThink( &CSpeaker::SUB_Remove );
return;
}
// const char *concept = (const char *)STRING( m_iszConcept );
// if ( Q_strlen( concept ) < 1 )
// {
// Warning( "'speaker' entity using rule set %s with empty concept string\n", soundfile );
// }
SetSolid( SOLID_NONE );
SetMoveType( MOVETYPE_NONE );
SetThink(&CSpeaker::SpeakerThink);
SetNextThink( TICK_NEVER_THINK );
// allow on/off switching via 'use' function.
Precache( );
}
void CSpeaker::Precache( void )
{
if ( !FBitSet (m_spawnflags, SF_SPEAKER_START_SILENT ) )
{
// set first announcement time for random n second
SetNextThink( gpGlobals->curtime + random->RandomFloat(5.0, 15.0) );
}
if ( !m_pInstancedResponseSystem && Q_strlen( STRING(m_iszRuleScriptFile) ) > 0 )
{
m_pInstancedResponseSystem = PrecacheCustomResponseSystem( STRING( m_iszRuleScriptFile ) );
}
}
//-----------------------------------------------------------------------------
// Purpose: Need a custom save restore so we can restore the instanced response system by name
// after we've loaded the filename from disk...
// Input : &save -
//-----------------------------------------------------------------------------
int CSpeaker::Save( ISave &save )
{
int iret = BaseClass::Save( save );
if ( iret )
{
bool doSave = ( m_pInstancedResponseSystem && ( m_iszRuleScriptFile != NULL_STRING ) ) ? true : false;
save.WriteBool( &doSave );
if ( doSave )
{
save.StartBlock( "InstancedResponseSystem" );
{
SaveRestoreFieldInfo_t fieldInfo = { &m_pInstancedResponseSystem, 0, NULL };
responseSystemSaveRestoreOps->Save( fieldInfo, &save );
}
save.EndBlock();
}
}
return iret;
}
//-----------------------------------------------------------------------------
// Purpose:
// Input : &restore -
//-----------------------------------------------------------------------------
int CSpeaker::Restore( IRestore &restore )
{
int iret = BaseClass::Restore( restore );
if ( iret )
{
bool doRead = false;
restore.ReadBool( &doRead );
if ( doRead )
{
char szResponseSystemBlockName[SIZE_BLOCK_NAME_BUF];
restore.StartBlock( szResponseSystemBlockName );
if ( !Q_stricmp( szResponseSystemBlockName, "InstancedResponseSystem" ) )
{
if ( !m_pInstancedResponseSystem && Q_strlen( STRING(m_iszRuleScriptFile) ) > 0 )
{
m_pInstancedResponseSystem = PrecacheCustomResponseSystem( STRING( m_iszRuleScriptFile ) );
if ( m_pInstancedResponseSystem )
{
SaveRestoreFieldInfo_t fieldInfo =
{
&m_pInstancedResponseSystem,
0,
NULL
};
responseSystemSaveRestoreOps->Restore( fieldInfo, &restore );
}
}
}
restore.EndBlock();
}
}
return iret;
}
void CSpeaker::SpeakerThink( void )
{
// Wait for the talking characters to finish first.
if ( !g_AIFriendliesTalkSemaphore.IsAvailable( this ) || !g_AIFoesTalkSemaphore.IsAvailable( this ) )
{
float releaseTime = MAX( g_AIFriendliesTalkSemaphore.GetReleaseTime(), g_AIFoesTalkSemaphore.GetReleaseTime() );
// Add some slop (only up to one second)
releaseTime += random->RandomFloat( 0, 1 );
SetNextThink( releaseTime );
return;
}
DispatchResponse( m_iszConcept.ToCStr() );
SetNextThink( gpGlobals->curtime + random->RandomFloat(m_delayMin, m_delayMax) );
// time delay until it's ok to speak: used so that two NPCs don't talk at once
g_AIFriendliesTalkSemaphore.Acquire( 5, this );
g_AIFoesTalkSemaphore.Acquire( 5, this );
}
void CSpeaker::InputTurnOn( inputdata_t &inputdata )
{
// turn on announcements
SetNextThink( gpGlobals->curtime + 0.1 );
}
void CSpeaker::InputTurnOff( inputdata_t &inputdata )
{
// turn off announcements
SetNextThink( TICK_NEVER_THINK );
}
//
// If an announcement is pending, cancel it. If no announcement is pending, start one.
//
void CSpeaker::InputToggle( inputdata_t &inputdata )
{
int fActive = (GetNextThink() > 0.0 );
// fActive is true only if an announcement is pending
if ( fActive )
{
// turn off announcements
SetNextThink( TICK_NEVER_THINK );
}
else
{
// turn on announcements
SetNextThink( gpGlobals->curtime + 0.1f );
}
}
|