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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
//========= Copyright Valve Corporation, All rights reserved. ============//
//
// Purpose:
//
// $NoKeywords: $
//=============================================================================//
#ifndef RECIPIENTFILTER_H
#define RECIPIENTFILTER_H
#ifdef _WIN32
#pragma once
#endif
#include "irecipientfilter.h"
#include "const.h"
#include "player.h"
#include "bitvec.h"
//-----------------------------------------------------------------------------
// Purpose: A generic filter for determining whom to send message/sounds etc. to and
// providing a bit of additional state information
//-----------------------------------------------------------------------------
class CRecipientFilter : public IRecipientFilter
{
public:
CRecipientFilter();
virtual ~CRecipientFilter();
virtual bool IsReliable( void ) const;
virtual bool IsInitMessage( void ) const;
virtual int GetRecipientCount( void ) const;
virtual int GetRecipientIndex( int slot ) const;
public:
void CopyFrom( const CRecipientFilter& src );
void Reset( void );
void MakeInitMessage( void );
void MakeReliable( void );
void AddAllPlayers( void );
void AddRecipientsByPVS( const Vector& origin );
void RemoveRecipientsByPVS( const Vector& origin );
void AddRecipientsByPAS( const Vector& origin );
void AddRecipient( const CBasePlayer *player );
void RemoveAllRecipients( void );
void RemoveRecipient( CBasePlayer *player );
void RemoveRecipientByPlayerIndex( int playerindex );
void AddRecipientsByTeam( CTeam *team );
void RemoveRecipientsByTeam( CTeam *team );
void RemoveRecipientsNotOnTeam( CTeam *team );
void UsePredictionRules( void );
bool IsUsingPredictionRules( void ) const;
bool IgnorePredictionCull( void ) const;
void SetIgnorePredictionCull( bool ignore );
void AddPlayersFromBitMask( CBitVec< ABSOLUTE_PLAYER_LIMIT >& playerbits );
void RemovePlayersFromBitMask( CBitVec< ABSOLUTE_PLAYER_LIMIT >& playerbits );
private:
bool m_bReliable;
bool m_bInitMessage;
CUtlVector< int > m_Recipients;
// If using prediction rules, the filter itself suppresses local player
bool m_bUsingPredictionRules;
// If ignoring prediction cull, then external systems can determine
// whether this is a special case where culling should not occur
bool m_bIgnorePredictionCull;
};
//-----------------------------------------------------------------------------
// Purpose: Simple class to create a filter for a single player ( unreliable )
//-----------------------------------------------------------------------------
class CSingleUserRecipientFilter : public CRecipientFilter
{
public:
CSingleUserRecipientFilter( const CBasePlayer *player )
{
AddRecipient( player );
}
};
//-----------------------------------------------------------------------------
// Purpose: Simple class to create a filter for all players on a given team
//-----------------------------------------------------------------------------
class CTeamRecipientFilter : public CRecipientFilter
{
public:
CTeamRecipientFilter( int team, bool isReliable = false );
};
//-----------------------------------------------------------------------------
// Purpose: Simple class to create a filter for all players ( unreliable )
//-----------------------------------------------------------------------------
class CBroadcastRecipientFilter : public CRecipientFilter
{
public:
CBroadcastRecipientFilter( void )
{
AddAllPlayers();
}
};
//-----------------------------------------------------------------------------
// Purpose: Simple class to create a filter for all players ( reliable )
//-----------------------------------------------------------------------------
class CReliableBroadcastRecipientFilter : public CBroadcastRecipientFilter
{
public:
CReliableBroadcastRecipientFilter( void )
{
MakeReliable();
}
};
//-----------------------------------------------------------------------------
// Purpose: Simple class to create a filter for all players except for one ( unreliable )
//-----------------------------------------------------------------------------
class CBroadcastNonOwnerRecipientFilter : public CRecipientFilter
{
public:
CBroadcastNonOwnerRecipientFilter( CBasePlayer *player )
{
AddAllPlayers();
RemoveRecipient( player );
}
};
//-----------------------------------------------------------------------------
// Purpose: Add players in PAS to recipient list (unreliable)
//-----------------------------------------------------------------------------
class CPASFilter : public CRecipientFilter
{
public:
CPASFilter( void )
{
}
CPASFilter( const Vector& origin )
{
AddRecipientsByPAS( origin );
}
};
//-----------------------------------------------------------------------------
// Purpose: Add players in PAS to list and if not in single player, use attenuation
// to remove those that are too far away from source origin
// Source origin can be stated as an entity or just a passed in origin
// (unreliable)
//-----------------------------------------------------------------------------
class CPASAttenuationFilter : public CPASFilter
{
public:
CPASAttenuationFilter( void )
{
}
CPASAttenuationFilter( CBaseEntity *entity, soundlevel_t soundlevel ) :
CPASFilter( static_cast<const Vector&>(entity->GetSoundEmissionOrigin()) )
{
Filter( entity->GetSoundEmissionOrigin(), SNDLVL_TO_ATTN( soundlevel ) );
}
CPASAttenuationFilter( CBaseEntity *entity, float attenuation = ATTN_NORM ) :
CPASFilter( static_cast<const Vector&>(entity->GetSoundEmissionOrigin()) )
{
Filter( entity->GetSoundEmissionOrigin(), attenuation );
}
CPASAttenuationFilter( const Vector& origin, soundlevel_t soundlevel ) :
CPASFilter( origin )
{
Filter( origin, SNDLVL_TO_ATTN( soundlevel ) );
}
CPASAttenuationFilter( const Vector& origin, float attenuation = ATTN_NORM ) :
CPASFilter( origin )
{
Filter( origin, attenuation );
}
CPASAttenuationFilter( CBaseEntity *entity, const char *lookupSound ) :
CPASFilter( static_cast<const Vector&>(entity->GetSoundEmissionOrigin()) )
{
soundlevel_t level = CBaseEntity::LookupSoundLevel( lookupSound );
float attenuation = SNDLVL_TO_ATTN( level );
Filter( entity->GetSoundEmissionOrigin(), attenuation );
}
CPASAttenuationFilter( const Vector& origin, const char *lookupSound ) :
CPASFilter( origin )
{
soundlevel_t level = CBaseEntity::LookupSoundLevel( lookupSound );
float attenuation = SNDLVL_TO_ATTN( level );
Filter( origin, attenuation );
}
CPASAttenuationFilter( CBaseEntity *entity, const char *lookupSound, HSOUNDSCRIPTHANDLE& handle ) :
CPASFilter( static_cast<const Vector&>(entity->GetSoundEmissionOrigin()) )
{
soundlevel_t level = CBaseEntity::LookupSoundLevel( lookupSound, handle );
float attenuation = SNDLVL_TO_ATTN( level );
Filter( entity->GetSoundEmissionOrigin(), attenuation );
}
CPASAttenuationFilter( const Vector& origin, const char *lookupSound, HSOUNDSCRIPTHANDLE& handle ) :
CPASFilter( origin )
{
soundlevel_t level = CBaseEntity::LookupSoundLevel( lookupSound, handle );
float attenuation = SNDLVL_TO_ATTN( level );
Filter( origin, attenuation );
}
public:
void Filter( const Vector& origin, float attenuation = ATTN_NORM );
};
//-----------------------------------------------------------------------------
// Purpose: Simple PVS based filter ( unreliable )
//-----------------------------------------------------------------------------
class CPVSFilter : public CRecipientFilter
{
public:
CPVSFilter( const Vector& origin )
{
AddRecipientsByPVS( origin );
}
};
#endif // RECIPIENTFILTER_H
|