Fixed makefile error when issuing 'make clean' or 'make distclean'.
1 <!-- vi: set ts=4 sw=4 : -->
2 <!-- vim: set tw=75 : -->
6 <title>HLSDK Engine Notes</title>
10 <h1>HLSDK Engine Notes
15 <li><a href=#PrecacheModel>PrecacheModel</a>
16 <li><a href=#PrecacheSound>PrecacheSound</a>
17 <li><a href=#SetModel>SetModel</a>
18 <li><a href=#ModelIndex>ModelIndex</a>
19 <li><a href=#ModelFrames>ModelFrames</a>
20 <li><a href=#SetSize>SetSize</a>
21 <li><a href=#ChangeLevel>ChangeLevel</a>
22 <li><a href=#GetSpawnParms>GetSpawnParms</a>
23 <li><a href=#SaveSpawnParms>SaveSpawnParms</a>
24 <li><a href=#VecToYaw>VecToYaw</a>
25 <li><a href=#VecToAngles>VecToAngles</a>
26 <li><a href=#MoveToOrigin>MoveToOrigin</a>
27 <li><a href=#ChangeYaw>ChangeYaw</a>
28 <li><a href=#ChangePitch>ChangePitch</a>
29 <li><a href=#FindEntityByString>FindEntityByString</a>
30 <li><a href=#GetEntityIllum>GetEntityIllum</a>
31 <li><a href=#FindEntityInSphere>FindEntityInSphere</a>
32 <li><a href=#FindClientInPVS>FindClientInPVS</a>
33 <li><a href=#EntitiesInPVS>EntitiesInPVS</a>
34 <li><a href=#MakeVectors>MakeVectors</a>
35 <li><a href=#AngleVectors>AngleVectors</a>
36 <li><a href=#CreateEntity>CreateEntity</a>
37 <li><a href=#RemoveEntity>RemoveEntity</a>
38 <li><a href=#CreateNamedEntity>CreateNamedEntity</a>
39 <li><a href=#MakeStatic>MakeStatic</a>
40 <li><a href=#EntIsOnFloor>EntIsOnFloor</a>
41 <li><a href=#DropToFloor>DropToFloor</a>
42 <li><a href=#WalkMove>WalkMove</a>
43 <li><a href=#SetOrigin>SetOrigin</a>
44 <li><a href=#EmitSound>EmitSound</a>
45 <li><a href=#EmitAmbientSound>EmitAmbientSound</a>
46 <li><a href=#TraceLine>TraceLine</a>
47 <li><a href=#TraceToss>TraceToss</a>
48 <li><a href=#TraceMonsterHull>TraceMonsterHull</a>
49 <li><a href=#TraceHull>TraceHull</a>
50 <li><a href=#TraceModel>TraceModel</a>
51 <li><a href=#TraceTexture>TraceTexture</a>
52 <li><a href=#TraceSphere>TraceSphere</a>
53 <li><a href=#GetAimVector>GetAimVector</a>
54 <li><a href=#ServerCommand>ServerCommand</a>
55 <li><a href=#ServerExecute>ServerExecute</a>
56 <li><a href=#ClientCommand>ClientCommand</a>
57 <li><a href=#ParticleEffect>ParticleEffect</a>
58 <li><a href=#LightStyle>LightStyle</a>
59 <li><a href=#DecalIndex>DecalIndex</a>
60 <li><a href=#PointContents>PointContents</a>
61 <li><a href=#MessageBegin>MessageBegin</a>
62 <li><a href=#MessageEnd>MessageEnd</a>
63 <li><a href=#WriteByte>WriteByte</a>
64 <li><a href=#WriteChar>WriteChar</a>
65 <li><a href=#WriteShort>WriteShort</a>
66 <li><a href=#WriteLong>WriteLong</a>
67 <li><a href=#WriteAngle>WriteAngle</a>
68 <li><a href=#WriteCoord>WriteCoord</a>
69 <li><a href=#WriteString>WriteString</a>
70 <li><a href=#WriteEntity>WriteEntity</a>
71 <li><a href=#CVarRegister>CVarRegister</a>
72 <li><a href=#CVarGetFloat>CVarGetFloat</a>
73 <li><a href=#CVarGetString>CVarGetString</a>
74 <li><a href=#CVarSetFloat>CVarSetFloat</a>
75 <li><a href=#CVarSetString>CVarSetString</a>
76 <li><a href=#AlertMessage>AlertMessage</a>
77 <li><a href=#EngineFprintf>EngineFprintf</a>
78 <li><a href=#PvAllocEntPrivateData>PvAllocEntPrivateData</a>
79 <li><a href=#PvEntPrivateData>PvEntPrivateData</a>
80 <li><a href=#FreeEntPrivateData>FreeEntPrivateData</a>
81 <li><a href=#SzFromIndex>SzFromIndex</a>
82 <li><a href=#AllocString>AllocString</a>
83 <li><a href=#GetVarsOfEnt>GetVarsOfEnt</a>
84 <li><a href=#PEntityOfEntOffset>PEntityOfEntOffset</a>
85 <li><a href=#EntOffsetOfPEntity>EntOffsetOfPEntity</a>
86 <li><a href=#IndexOfEdict>IndexOfEdict</a>
87 <li><a href=#PEntityOfEntIndex>PEntityOfEntIndex</a>
88 <li><a href=#FindEntityByVars>FindEntityByVars</a>
89 <li><a href=#GetModelPtr>GetModelPtr</a>
90 <li><a href=#RegUserMsg>RegUserMsg</a>
91 <li><a href=#AnimationAutomove>AnimationAutomove</a>
92 <li><a href=#GetBonePosition>GetBonePosition</a>
93 <li><a href=#FunctionFromName>FunctionFromName</a>
94 <li><a href=#NameForFunction>NameForFunction</a>
95 <li><a href=#ClientPrintf>ClientPrintf</a>
96 <li><a href=#ServerPrint>ServerPrint</a>
97 <li><a href=#Cmd_Args>Cmd_Args</a>
98 <li><a href=#Cmd_Argv>Cmd_Argv</a>
99 <li><a href=#Cmd_Argc>Cmd_Argc</a>
100 <li><a href=#GetAttachment>GetAttachment</a>
101 <li><a href=#CRC32_Init>CRC32_Init</a>
102 <li><a href=#CRC32_ProcessBuffer>CRC32_ProcessBuffer</a>
103 <li><a href=#CRC32_ProcessByte>CRC32_ProcessByte</a>
104 <li><a href=#CRC32_Final>CRC32_Final</a>
105 <li><a href=#RandomLong>RandomLong</a>
106 <li><a href=#RandomFloat>RandomFloat</a>
107 <li><a href=#SetView>SetView</a>
108 <li><a href=#Time>Time</a>
109 <li><a href=#CrosshairAngle>CrosshairAngle</a>
110 <li><a href=#LoadFileForMe>LoadFileForMe</a>
111 <li><a href=#FreeFile>FreeFile</a>
112 <li><a href=#EndSection>EndSection</a>
113 <li><a href=#CompareFileTime>CompareFileTime</a>
114 <li><a href=#GetGameDir>GetGameDir</a>
115 <li><a href=#Cvar_RegisterVariable>Cvar_RegisterVariable</a>
116 <li><a href=#FadeClientVolume>FadeClientVolume</a>
117 <li><a href=#SetClientMaxspeed>SetClientMaxspeed</a>
118 <li><a href=#CreateFakeClient>CreateFakeClient</a>
119 <li><a href=#RunPlayerMove>RunPlayerMove</a>
120 <li><a href=#NumberOfEntities>NumberOfEntities</a>
121 <li><a href=#GetInfoKeyBuffer>GetInfoKeyBuffer</a>
122 <li><a href=#InfoKeyValue>InfoKeyValue</a>
123 <li><a href=#SetKeyValue>SetKeyValue</a>
124 <li><a href=#SetClientKeyValue>SetClientKeyValue</a>
125 <li><a href=#IsMapValid>IsMapValid</a>
126 <li><a href=#StaticDecal>StaticDecal</a>
127 <li><a href=#PrecacheGeneric>PrecacheGeneric</a>
128 <li><a href=#GetPlayerUserId>GetPlayerUserId</a>
129 <li><a href=#BuildSoundMsg>BuildSoundMsg</a>
130 <li><a href=#IsDedicatedServer>IsDedicatedServer</a>
131 <li><a href=#CVarGetPointer>CVarGetPointer</a>
132 <li><a href=#GetPlayerWONId>GetPlayerWONId</a>
133 <li><a href=#Info_RemoveKey>Info_RemoveKey</a>
134 <li><a href=#GetPhysicsKeyValue>GetPhysicsKeyValue</a>
135 <li><a href=#SetPhysicsKeyValue>SetPhysicsKeyValue</a>
136 <li><a href=#GetPhysicsInfoString>GetPhysicsInfoString</a>
137 <li><a href=#PrecacheEvent>PrecacheEvent</a>
138 <li><a href=#PlaybackEvent>PlaybackEvent</a>
139 <li><a href=#SetFatPVS>SetFatPVS</a>
140 <li><a href=#SetFatPAS>SetFatPAS</a>
141 <li><a href=#CheckVisibility>CheckVisibility</a>
142 <li><a href=#DeltaSetField>DeltaSetField</a>
143 <li><a href=#DeltaUnsetField>DeltaUnsetField</a>
144 <li><a href=#DeltaAddEncoder>DeltaAddEncoder</a>
145 <li><a href=#GetCurrentPlayer>GetCurrentPlayer</a>
146 <li><a href=#CanSkipPlayer>CanSkipPlayer</a>
147 <li><a href=#DeltaFindField>DeltaFindField</a>
148 <li><a href=#DeltaSetFieldByIndex>DeltaSetFieldByIndex</a>
149 <li><a href=#DeltaUnsetFieldByIndex>DeltaUnsetFieldByIndex</a>
150 <li><a href=#SetGroupMask>SetGroupMask</a>
151 <li><a href=#CreateInstancedBaseline>CreateInstancedBaseline</a>
152 <li><a href=#Cvar_DirectSet>Cvar_DirectSet</a>
153 <li><a href=#ForceUnmodified>ForceUnmodified</a>
154 <li><a href=#GetPlayerStats>GetPlayerStats</a>
155 <li><a href=#AddServerCommand>AddServerCommand</a>
156 <li><a href=#Voice_GetClientListening>Voice_GetClientListening</a>
157 <li><a href=#Voice_SetClientListening>Voice_SetClientListening</a>
158 <li><a href=#GetPlayerAuthId>GetPlayerAuthId</a>
159 <li><a href=#SequenceGet>SequenceGet</a>
160 <li><a href=#SequencePickSentence>SequencePickSentence</a>
161 <li><a href=#GetFileSize>GetFileSize</a>
162 <li><a href=#GetApproxWavePlayLen>GetApproxWavePlayLen</a>
163 <li><a href=#IsCareerMatch>IsCareerMatch</a>
164 <li><a href=#GetLocalizedStringLength>GetLocalizedStringLength</a>
165 <li><a href=#RegisterTutorMessageShown>RegisterTutorMessageShown</a>
166 <li><a href=#GetTimesTutorMessageShown>GetTimesTutorMessageShown</a>
167 <li><a href=#ProcessTutorMessageDecayBuffer>ProcessTutorMessageDecayBuffer</a>
168 <li><a href=#ConstructTutorMessageDecayBuffer>ConstructTutorMessageDecayBuffer</a>
169 <li><a href=#ResetTutorMessageDecayData>ResetTutorMessageDecayData</a>
170 <li><a href=#QueryClientCvarValue>QueryClientCvarValue</a>
171 <li><a href=#QueryClientCvarValue2>QueryClientCvarValue2</a>
174 <hr><h3><tt><a name="PrecacheModel">PrecacheModel</a></tt></h3>
175 <i>from engine/eiface.h:</i><br>
176 <dd><tt>int PrecacheModel(char *s);</tt><br>
177 <dd><tt>PRECACHE_MODEL()</tt>
178 <p><i>comments:</i><br>
183 <hr><h3><tt><a name="PrecacheSound">PrecacheSound</a></tt></h3>
184 <i>from engine/eiface.h:</i><br>
185 <dd><tt>int PrecacheSound(char *s);</tt><br>
186 <dd><tt>PRECACHE_SOUND()</tt>
187 <p><i>comments:</i><br>
192 <hr><h3><tt><a name="SetModel">SetModel</a></tt></h3>
193 <i>from engine/eiface.h:</i><br>
194 <dd><tt>void SetModel(edict_t *e, const char *m);</tt><br>
195 <dd><tt>SET_MODEL()</tt>
196 <p><i>comments:</i><br>
201 <hr><h3><tt><a name="ModelIndex">ModelIndex</a></tt></h3>
202 <i>from engine/eiface.h:</i><br>
203 <dd><tt>int ModelIndex(const char *m);</tt><br>
204 <dd><tt>MODEL_INDEX()</tt>
205 <p><i>comments:</i><br>
210 <hr><h3><tt><a name="ModelFrames">ModelFrames</a></tt></h3>
211 <i>from engine/eiface.h:</i><br>
212 <dd><tt>int ModelFrames(int modelIndex);</tt><br>
213 <dd><tt>MODEL_FRAMES()</tt>
214 <p><i>comments:</i><br>
219 <hr><h3><tt><a name="SetSize">SetSize</a></tt></h3>
220 <i>from engine/eiface.h:</i><br>
221 <dd><tt>void SetSize(edict_t *e, const float *rgflMin, const float *rgflMax);</tt><br>
222 <dd><tt>SET_SIZE()</tt>
223 <p><i>comments:</i><br>
228 <hr><h3><tt><a name="ChangeLevel">ChangeLevel</a></tt></h3>
229 <i>from engine/eiface.h:</i><br>
230 <dd><tt>void ChangeLevel(char *s1, char *s2);</tt><br>
231 <dd><tt>CHANGE_LEVEL()</tt>
232 <p><i>comments:</i><br>
237 <hr><h3><tt><a name="GetSpawnParms">GetSpawnParms</a></tt></h3>
238 <i>from engine/eiface.h:</i><br>
239 <dd><tt>void GetSpawnParms(edict_t *ent);</tt><br>
240 <dd><tt>GET_SPAWN_PARMS()</tt>
241 <p><i>comments:</i><br>
246 <hr><h3><tt><a name="SaveSpawnParms">SaveSpawnParms</a></tt></h3>
247 <i>from engine/eiface.h:</i><br>
248 <dd><tt>void SaveSpawnParms(edict_t *ent);</tt><br>
249 <dd><tt>SAVE_SPAWN_PARMS()</tt>
250 <p><i>comments:</i><br>
255 <hr><h3><tt><a name="VecToYaw">VecToYaw</a></tt></h3>
256 <i>from engine/eiface.h:</i><br>
257 <dd><tt>float VecToYaw(const float *rgflVector);</tt><br>
258 <dd><tt>VEC_TO_YAW()</tt>
259 <p><i>comments:</i><br>
264 <hr><h3><tt><a name="VecToAngles">VecToAngles</a></tt></h3>
265 <i>from engine/eiface.h:</i><br>
266 <dd><tt>void VecToAngles(const float *rgflVectorIn, float *rgflVectorOut);</tt><br>
267 <dd><tt>VEC_TO_ANGLES()</tt>
268 <p><i>comments:</i><br>
273 <hr><h3><tt><a name="MoveToOrigin">MoveToOrigin</a></tt></h3>
274 <i>from engine/eiface.h:</i><br>
275 <dd><tt>void MoveToOrigin(edict_t *ent, const float *pflGoal, float dist, int iMoveType);</tt><br>
276 <dd><tt>MOVE_TO_ORIGIN()</tt>
277 <p><i>comments:</i><br>
282 <hr><h3><tt><a name="ChangeYaw">ChangeYaw</a></tt></h3>
283 <i>from engine/eiface.h:</i><br>
284 <dd><tt>void ChangeYaw(edict_t *ent);</tt><br>
285 <dd><tt>oldCHANGE_YAW()</tt>
286 <p><i>comments:</i><br>
291 <hr><h3><tt><a name="ChangePitch">ChangePitch</a></tt></h3>
292 <i>from engine/eiface.h:</i><br>
293 <dd><tt>void ChangePitch(edict_t *ent);</tt><br>
294 <dd><tt>CHANGE_PITCH()</tt>
295 <p><i>comments:</i><br>
300 <hr><h3><tt><a name="FindEntityByString">FindEntityByString</a></tt></h3>
301 <i>from engine/eiface.h:</i><br>
302 <dd><tt>edict_t *FindEntityByString(edict_t *pEdictStartSearchAfter, const char *pszField, const char *pszValue);</tt><br>
303 <dd><tt>FIND_ENTITY_BY_STRING()</tt>
304 <p><i>comments:</i><br>
309 <hr><h3><tt><a name="GetEntityIllum">GetEntityIllum</a></tt></h3>
310 <i>from engine/eiface.h:</i><br>
311 <dd><tt>int GetEntityIllum(edict_t *pEnt);</tt><br>
312 <dd><tt>GETENTITYILLUM()</tt>
313 <p><i>comments:</i><br>
318 <hr><h3><tt><a name="FindEntityInSphere">FindEntityInSphere</a></tt></h3>
319 <i>from engine/eiface.h:</i><br>
320 <dd><tt>edict_t *FindEntityInSphere(edict_t *pEdictStartSearchAfter, const float *org, float rad);</tt><br>
321 <dd><tt>FIND_ENTITY_IN_SPHERE()</tt>
322 <p><i>comments:</i><br>
327 <hr><h3><tt><a name="FindClientInPVS">FindClientInPVS</a></tt></h3>
328 <i>from engine/eiface.h:</i><br>
329 <dd><tt>edict_t *FindClientInPVS(edict_t *pEdict);</tt><br>
330 <dd><tt>FIND_ENTITY_IN_PVS()</tt>
331 <p><i>comments:</i><br>
336 <hr><h3><tt><a name="EntitiesInPVS">EntitiesInPVS</a></tt></h3>
337 <i>from engine/eiface.h:</i><br>
338 <dd><tt>edict_t *EntitiesInPVS(edict_t *pplayer);</tt>
339 <p><i>comments:</i><br>
344 <hr><h3><tt><a name="MakeVectors">MakeVectors</a></tt></h3>
345 <i>from engine/eiface.h:</i><br>
346 <dd><tt>void MakeVectors(const float *rgflVector);</tt><br>
347 <dd><tt>MAKE_VECTORS()</tt>
348 <p><i>comments:</i><br>
353 <hr><h3><tt><a name="AngleVectors">AngleVectors</a></tt></h3>
354 <i>from engine/eiface.h:</i><br>
355 <dd><tt>void AngleVectors(const float *rgflVector, float *forward, float *right, float *up);</tt>
356 <p><i>comments:</i><br>
361 <hr><h3><tt><a name="CreateEntity">CreateEntity</a></tt></h3>
362 <i>from engine/eiface.h:</i><br>
363 <dd><tt>edict_t *CreateEntity(void);</tt><br>
364 <dd><tt>CREATE_ENTITY()</tt>
365 <p><i>comments:</i><br>
370 <hr><h3><tt><a name="RemoveEntity">RemoveEntity</a></tt></h3>
371 <i>from engine/eiface.h:</i><br>
372 <dd><tt>void RemoveEntity(edict_t *e);</tt><br>
373 <dd><tt>REMOVE_ENTITY()</tt>
374 <p><i>comments:</i><br>
379 <hr><h3><tt><a name="CreateNamedEntity">CreateNamedEntity</a></tt></h3>
380 <i>from engine/eiface.h:</i><br>
381 <dd><tt>edict_t *CreateNamedEntity(int className);</tt><br>
382 <dd><tt>CREATE_NAMED_ENTITY()</tt>
383 <p><i>comments:</i><br>
388 <hr><h3><tt><a name="MakeStatic">MakeStatic</a></tt></h3>
389 <i>from engine/eiface.h:</i><br>
390 <dd><tt>void MakeStatic(edict_t *ent);</tt><br>
391 <dd><tt>MAKE_STATIC()</tt>
392 <p><i>comments:</i><br>
397 <hr><h3><tt><a name="EntIsOnFloor">EntIsOnFloor</a></tt></h3>
398 <i>from engine/eiface.h:</i><br>
399 <dd><tt>int EntIsOnFloor(edict_t *e);</tt><br>
400 <dd><tt>ENT_IS_ON_FLOOR()</tt>
401 <p><i>comments:</i><br>
406 <hr><h3><tt><a name="DropToFloor">DropToFloor</a></tt></h3>
407 <i>from engine/eiface.h:</i><br>
408 <dd><tt>int DropToFloor(edict_t *e);</tt><br>
409 <dd><tt>DROP_TO_FLOOR()</tt>
410 <p><i>comments:</i><br>
415 <hr><h3><tt><a name="WalkMove">WalkMove</a></tt></h3>
416 <i>from engine/eiface.h:</i><br>
417 <dd><tt>int WalkMove(edict_t *ent, float yaw, float dist, int iMode);</tt><br>
418 <dd><tt>WALK_MOVE()</tt>
419 <p><i>comments:</i><br>
424 <hr><h3><tt><a name="SetOrigin">SetOrigin</a></tt></h3>
425 <i>from engine/eiface.h:</i><br>
426 <dd><tt>void SetOrigin(edict_t *e, const float *rgflOrigin);</tt><br>
427 <dd><tt>SET_ORIGIN()</tt>
428 <p><i>comments:</i><br>
433 <hr><h3><tt><a name="EmitSound">EmitSound</a></tt></h3>
434 <i>from engine/eiface.h:</i><br>
435 <dd><tt>void EmitSound(edict_t *entity, int channel, const char *sample, /*int*/float volume, float attenuation, int fFlags, int pitch);</tt><br>
436 <dd><tt>EMIT_SOUND_DYN2()</tt>
437 <p><i>comments:</i><br>
442 <hr><h3><tt><a name="EmitAmbientSound">EmitAmbientSound</a></tt></h3>
443 <i>from engine/eiface.h:</i><br>
444 <dd><tt>void EmitAmbientSound(edict_t *entity, float *pos, const char *samp, float vol, float attenuation, int fFlags, int pitch);</tt><br>
445 <dd><tt>EMIT_AMBIENT_SOUND()</tt>
446 <p><i>comments:</i><br>
451 <hr><h3><tt><a name="TraceLine">TraceLine</a></tt></h3>
452 <i>from engine/eiface.h:</i><br>
453 <dd><tt>void TraceLine(const float *v1, const float *v2, int fNoMonsters, edict_t *pentToSkip, TraceResult *ptr);</tt><br>
454 <dd><tt>TRACE_LINE()</tt>
455 <p><i>comments:</i><br>
460 <hr><h3><tt><a name="TraceToss">TraceToss</a></tt></h3>
461 <i>from engine/eiface.h:</i><br>
462 <dd><tt>void TraceToss(edict_t *pent, edict_t *pentToIgnore, TraceResult *ptr);</tt><br>
463 <dd><tt>TRACE_TOSS()</tt>
464 <p><i>comments:</i><br>
469 <hr><h3><tt><a name="TraceMonsterHull">TraceMonsterHull</a></tt></h3>
470 <i>from engine/eiface.h:</i><br>
471 <dd><tt>int TraceMonsterHull(edict_t *pEdict, const float *v1, const float *v2, int fNoMonsters, edict_t *pentToSkip, TraceResult *ptr);</tt><br>
472 <dd><tt>TRACE_MONSTER_HULL()</tt>
473 <p><i>comments:</i><br>
478 <hr><h3><tt><a name="TraceHull">TraceHull</a></tt></h3>
479 <i>from engine/eiface.h:</i><br>
480 <dd><tt>void TraceHull(const float *v1, const float *v2, int fNoMonsters, int hullNumber, edict_t *pentToSkip, TraceResult *ptr);</tt><br>
481 <dd><tt>TRACE_HULL()</tt>
482 <p><i>comments:</i><br>
487 <hr><h3><tt><a name="TraceModel">TraceModel</a></tt></h3>
488 <i>from engine/eiface.h:</i><br>
489 <dd><tt>void TraceModel(const float *v1, const float *v2, int hullNumber, edict_t *pent, TraceResult *ptr);</tt>
490 <p><i>comments:</i><br>
495 <hr><h3><tt><a name="TraceTexture">TraceTexture</a></tt></h3>
496 <i>from engine/eiface.h:</i><br>
497 <dd><tt>const char *TraceTexture(edict_t *pTextureEntity, const float *v1, const float *v2);</tt><br>
498 <dd><tt>TRACE_TEXTURE()</tt>
499 <p><i>comments:</i><br>
504 <hr><h3><tt><a name="TraceSphere">TraceSphere</a></tt></h3>
505 <i>from engine/eiface.h:</i><br>
506 <dd><tt>void TraceSphere(const float *v1, const float *v2, int fNoMonsters, float radius, edict_t *pentToSkip, TraceResult *ptr);</tt>
507 <p><i>comments:</i><br>
512 <hr><h3><tt><a name="GetAimVector">GetAimVector</a></tt></h3>
513 <i>from engine/eiface.h:</i><br>
514 <dd><tt>void GetAimVector(edict_t *ent, float speed, float *rgflReturn);</tt><br>
515 <dd><tt>GET_AIM_VECTOR()</tt>
516 <p><i>comments:</i><br>
521 <hr><h3><tt><a name="ServerCommand">ServerCommand</a></tt></h3>
522 <i>from engine/eiface.h:</i><br>
523 <dd><tt>void ServerCommand(char *str);</tt><br>
524 <dd><tt>SERVER_COMMAND()</tt>
525 <p><i>comments:</i><br>
527 Executes a server command, as if typed at the console (ie "exec
528 myconfig.cfg", or "quit"). Note that it appears no commands are
529 executed until <b>after</b> GameDLLInit is called. If
530 ServerCommand is called earlier than that, the command is delayed until
534 <hr><h3><tt><a name="ServerExecute">ServerExecute</a></tt></h3>
535 <i>from engine/eiface.h:</i><br>
536 <dd><tt>void ServerExecute(void);</tt><br>
537 <dd><tt>SERVER_EXECUTE()</tt>
538 <p><i>comments:</i><br>
543 <hr><h3><tt><a name="ClientCommand">ClientCommand</a></tt></h3>
544 <i>from engine/eiface.h:</i><br>
545 <dd><tt>void ClientCommand(edict_t *pEdict, char *szFmt, ...);</tt><br>
546 <dd><tt>CLIENT_COMMAND()</tt>
547 <p><i>comments:</i><br>
552 <hr><h3><tt><a name="ParticleEffect">ParticleEffect</a></tt></h3>
553 <i>from engine/eiface.h:</i><br>
554 <dd><tt>void ParticleEffect(const float *org, const float *dir, float color, float count);</tt><br>
555 <dd><tt>PARTICLE_EFFECT()</tt>
556 <p><i>comments:</i><br>
561 <hr><h3><tt><a name="LightStyle">LightStyle</a></tt></h3>
562 <i>from engine/eiface.h:</i><br>
563 <dd><tt>void LightStyle(int style, char *val);</tt><br>
564 <dd><tt>LIGHT_STYLE()</tt>
565 <p><i>comments:</i><br>
570 <hr><h3><tt><a name="DecalIndex">DecalIndex</a></tt></h3>
571 <i>from engine/eiface.h:</i><br>
572 <dd><tt>int DecalIndex(const char *name);</tt><br>
573 <dd><tt>DECAL_INDEX()</tt>
574 <p><i>comments:</i><br>
579 <hr><h3><tt><a name="PointContents">PointContents</a></tt></h3>
580 <i>from engine/eiface.h:</i><br>
581 <dd><tt>int PointContents(const float *rgflVector);</tt><br>
582 <dd><tt>POINT_CONTENTS()</tt>
583 <p><i>comments:</i><br>
588 <hr><h3><tt><a name="MessageBegin">MessageBegin</a></tt></h3>
589 <i>from engine/eiface.h:</i><br>
590 <dd><tt>void MessageBegin(int msg_dest, int msg_type, const float *pOrigin, edict_t *ed);</tt><br>
591 <dd><tt>MESSAGE_BEGIN()</tt>
592 <p><i>comments:</i><br>
594 Begin a network message to send to the client.
595 <br><b><tt>msg_type</tt></b> should be a number returned by <a
596 href="#RegUserMsg">RegUserMsg</a>.
597 <br><b><tt>msg_dest</tt></b> is one of:
599 <li> <b><tt>MSG_BROADCAST</tt></b> - "unreliable to all"
600 <li> <b><tt>MSG_ONE</tt></b> - "reliable to one (msg_entity)"
601 <li> <b><tt>MSG_ALL</tt></b> - "reliable to all"
602 <li> <b><tt>MSG_INIT</tt></b> - "write to the init string"
603 <li> <b><tt>MSG_PVS</tt></b> - "Ents in PVS of org" (PVS=potentially visible set)
604 <li> <b><tt>MSG_PAS</tt></b> - "Ents in PAS of org" (PAS=potentially audible set)
605 <li> <b><tt>MSG_PVS_R</tt></b> - "Reliable to PVS"
606 <li> <b><tt>MSG_PAS_R</tt></b> - "Reliable to PAS"
607 <li> <b><tt>MSG_ONE_UNRELIABLE</tt></b> - "Send to one client, but don't put in reliable stream, put in unreliable datagram (could be dropped)"
611 <hr><h3><tt><a name="MessageEnd">MessageEnd</a></tt></h3>
612 <i>from engine/eiface.h:</i><br>
613 <dd><tt>void MessageEnd(void);</tt><br>
614 <dd><tt>MESSAGE_END()</tt>
615 <p><i>comments:</i><br>
620 <hr><h3><tt><a name="WriteByte">WriteByte</a></tt></h3>
621 <i>from engine/eiface.h:</i><br>
622 <dd><tt>void WriteByte(int iValue);</tt><br>
623 <dd><tt>WRITE_BYTE()</tt>
624 <p><i>comments:</i><br>
629 <hr><h3><tt><a name="WriteChar">WriteChar</a></tt></h3>
630 <i>from engine/eiface.h:</i><br>
631 <dd><tt>void WriteChar(int iValue);</tt><br>
632 <dd><tt>WRITE_CHAR()</tt>
633 <p><i>comments:</i><br>
638 <hr><h3><tt><a name="WriteShort">WriteShort</a></tt></h3>
639 <i>from engine/eiface.h:</i><br>
640 <dd><tt>void WriteShort(int iValue);</tt><br>
641 <dd><tt>WRITE_SHORT()</tt>
642 <p><i>comments:</i><br>
647 <hr><h3><tt><a name="WriteLong">WriteLong</a></tt></h3>
648 <i>from engine/eiface.h:</i><br>
649 <dd><tt>void WriteLong(int iValue);</tt><br>
650 <dd><tt>WRITE_LONG()</tt>
651 <p><i>comments:</i><br>
656 <hr><h3><tt><a name="WriteAngle">WriteAngle</a></tt></h3>
657 <i>from engine/eiface.h:</i><br>
658 <dd><tt>void WriteAngle(float flValue);</tt><br>
659 <dd><tt>WRITE_ANGLE()</tt>
660 <p><i>comments:</i><br>
665 <hr><h3><tt><a name="WriteCoord">WriteCoord</a></tt></h3>
666 <i>from engine/eiface.h:</i><br>
667 <dd><tt>void WriteCoord(float flValue);</tt><br>
668 <dd><tt>WRITE_COORD()</tt>
669 <p><i>comments:</i><br>
674 <hr><h3><tt><a name="WriteString">WriteString</a></tt></h3>
675 <i>from engine/eiface.h:</i><br>
676 <dd><tt>void WriteString(const char *sz);</tt><br>
677 <dd><tt>WRITE_STRING()</tt>
678 <p><i>comments:</i><br>
683 <hr><h3><tt><a name="WriteEntity">WriteEntity</a></tt></h3>
684 <i>from engine/eiface.h:</i><br>
685 <dd><tt>void WriteEntity(int iValue);</tt><br>
686 <dd><tt>WRITE_ENTITY()</tt>
687 <p><i>comments:</i><br>
692 <hr><h3><tt><a name="CVarRegister">CVarRegister</a></tt></h3>
693 <i>from engine/eiface.h:</i><br>
694 <dd><tt>void CVarRegister(cvar_t *pCvar);</tt><br>
695 <dd><tt>CVAR_REGISTER()</tt>
696 <p><i>comments:</i><br>
698 Register a new cvar (server variable).
701 <hr><h3><tt><a name="CVarGetFloat">CVarGetFloat</a></tt></h3>
702 <i>from engine/eiface.h:</i><br>
703 <dd><tt>float CVarGetFloat(const char *szVarName);</tt><br>
704 <dd><tt>CVAR_GET_FLOAT()</tt>
705 <p><i>comments:</i><br>
707 Return the float value of a cvar.
710 <hr><h3><tt><a name="CVarGetString">CVarGetString</a></tt></h3>
711 <i>from engine/eiface.h:</i><br>
712 <dd><tt>const char *CVarGetString(const char *szVarName);</tt><br>
713 <dd><tt>CVAR_GET_STRING()</tt>
714 <p><i>comments:</i><br>
716 Return the string value of a cvar.
719 <hr><h3><tt><a name="CVarSetFloat">CVarSetFloat</a></tt></h3>
720 <i>from engine/eiface.h:</i><br>
721 <dd><tt>void CVarSetFloat(const char *szVarName, float flValue);</tt><br>
722 <dd><tt>CVAR_SET_FLOAT()</tt>
723 <p><i>comments:</i><br>
725 Set the float value of a cvar.
728 <hr><h3><tt><a name="CVarSetString">CVarSetString</a></tt></h3>
729 <i>from engine/eiface.h:</i><br>
730 <dd><tt>void CVarSetString(const char *szVarName, const char *szValue);</tt><br>
731 <dd><tt>CVAR_SET_STRING()</tt>
732 <p><i>comments:</i><br>
734 Set the string value of a cvar.
737 <hr><h3><tt><a name="AlertMessage">AlertMessage</a></tt></h3>
738 <i>from engine/eiface.h:</i><br>
739 <dd><tt>void AlertMessage(ALERT_TYPE atype, char *szFmt, ...);</tt><br>
741 <p><i>comments:</i><br>
743 Print an alert message.
744 <br><b><tt>atype</tt></b> is one of:
746 <li> <b><tt>at_notice</tt></b>
747 <li> <b><tt>at_console</tt></b> - "same as at_notice, but forces a ConPrintf, not a message box". Prints output to server console, but only shown if 'developer' is set.
748 <li> <b><tt>at_aiconsole</tt></b> - "same as at_console, but only shown if developer level is 2!"
749 <li> <b><tt>at_warning</tt></b>
750 <li> <b><tt>at_error</tt></b>
751 <li> <b><tt>at_logged</tt></b> - "Server print to console (only in multiplayer games)." Prints output to server logs and console.
755 <hr><h3><tt><a name="EngineFprintf">EngineFprintf</a></tt></h3>
756 <i>from engine/eiface.h:</i><br>
757 <dd><tt>void EngineFprintf(FILE *pfile, char *szFmt, ...);</tt><br>
758 <dd><tt>ENGINE_FPRINTF()</tt>
759 <p><i>comments:</i><br>
764 <hr><h3><tt><a name="PvAllocEntPrivateData">PvAllocEntPrivateData</a></tt></h3>
765 <i>from engine/eiface.h:</i><br>
766 <dd><tt>void *PvAllocEntPrivateData(edict_t *pEdict, long cb);</tt><br>
767 <dd><tt>ALLOC_PRIVATE()</tt>
768 <p><i>comments:</i><br>
773 <hr><h3><tt><a name="PvEntPrivateData">PvEntPrivateData</a></tt></h3>
774 <i>from engine/eiface.h:</i><br>
775 <dd><tt>void *PvEntPrivateData(edict_t *pEdict);</tt><br>
776 <dd><tt>GET_PRIVATE()</tt>
777 <p><i>comments:</i><br>
779 Returns a pointer to the base class type of the given edict. For
782 CBaseEntity *pPlayer=(CBaseEntity *)GET_PRIVATE(pEntity);
786 <hr><h3><tt><a name="FreeEntPrivateData">FreeEntPrivateData</a></tt></h3>
787 <i>from engine/eiface.h:</i><br>
788 <dd><tt>void FreeEntPrivateData(edict_t *pEdict);</tt><br>
789 <dd><tt>FREE_PRIVATE()</tt>
790 <p><i>comments:</i><br>
795 <hr><h3><tt><a name="SzFromIndex">SzFromIndex</a></tt></h3>
796 <i>from engine/eiface.h:</i><br>
797 <dd><tt>const char *SzFromIndex(int iString);</tt>
798 <p><i>comments:</i><br>
803 <hr><h3><tt><a name="AllocString">AllocString</a></tt></h3>
804 <i>from engine/eiface.h:</i><br>
805 <dd><tt>int AllocString(const char *szValue);</tt><br>
806 <dd><tt>ALLOC_STRING()</tt>
807 <p><i>comments:</i><br>
812 <hr><h3><tt><a name="GetVarsOfEnt">GetVarsOfEnt</a></tt></h3>
813 <i>from engine/eiface.h:</i><br>
814 <dd><tt>struct entvars_s *GetVarsOfEnt(edict_t *pEdict);</tt>
815 <p><i>comments:</i><br>
820 <hr><h3><tt><a name="PEntityOfEntOffset">PEntityOfEntOffset</a></tt></h3>
821 <i>from engine/eiface.h:</i><br>
822 <dd><tt>edict_t *PEntityOfEntOffset(int iEntOffset);</tt><br>
824 <p><i>comments:</i><br>
829 <hr><h3><tt><a name="EntOffsetOfPEntity">EntOffsetOfPEntity</a></tt></h3>
830 <i>from engine/eiface.h:</i><br>
831 <dd><tt>int EntOffsetOfPEntity(const edict_t *pEdict);</tt>
832 <p><i>comments:</i><br>
837 <hr><h3><tt><a name="IndexOfEdict">IndexOfEdict</a></tt></h3>
838 <i>from engine/eiface.h:</i><br>
839 <dd><tt>int IndexOfEdict(const edict_t *pEdict);</tt><br>
840 <dd><tt>ENTINDEX()</tt>
841 <p><i>comments:</i><br>
843 Returns the server slot (ie 1 to maxplayers) of the given player edict.
846 <hr><h3><tt><a name="PEntityOfEntIndex">PEntityOfEntIndex</a></tt></h3>
847 <i>from engine/eiface.h:</i><br>
848 <dd><tt>edict_t *PEntityOfEntIndex(int iEntIndex);</tt><br>
849 <dd><tt>INDEXENT()</tt>
850 <p><i>comments:</i><br>
852 Returns the edict for the player in the given server slot (ie 1 to
856 <hr><h3><tt><a name="FindEntityByVars">FindEntityByVars</a></tt></h3>
857 <i>from engine/eiface.h:</i><br>
858 <dd><tt>edict_t *FindEntityByVars(struct entvars_s *pvars);</tt>
859 <p><i>comments:</i><br>
864 <hr><h3><tt><a name="GetModelPtr">GetModelPtr</a></tt></h3>
865 <i>from engine/eiface.h:</i><br>
866 <dd><tt>void *GetModelPtr(edict_t *pEdict);</tt><br>
867 <dd><tt>GET_MODEL_PTR()</tt>
868 <p><i>comments:</i><br>
873 <hr><h3><tt><a name="RegUserMsg">RegUserMsg</a></tt></h3>
874 <i>from engine/eiface.h:</i><br>
875 <dd><tt>int RegUserMsg(const char *pszName, int iSize);</tt><br>
876 <dd><tt>REG_USER_MSG()</tt>
877 <p><i>comments:</i><br>
879 Register a network message type with the given name, and size if known.
880 Returns the number assigned for the network message, to be used with <a
881 href="#MessageBegin">MessageBegin</a>. It appears that message
882 ID's 1-63 are reserved for the Engine, and that GameDLL messages are
883 allocated IDs starting at 64. The SDK <tt>dlls/util.h</tt> appears to
884 define six Engine messages:
886 <li> <tt>SVC_TEMPENTITY = 23</tt>
887 <li> <tt>SVC_INTERMISSION = 30</tt>
888 <li> <tt>SVC_CDTRACK = 32</tt>
889 <li> <tt>SVC_WEAPONANIM = 35</tt>
890 <li> <tt>SVC_ROOMTYPE = 37</tt>
891 <li> <tt>SVC_HLTV = 50</tt>
895 <hr><h3><tt><a name="AnimationAutomove">AnimationAutomove</a></tt></h3>
896 <i>from engine/eiface.h:</i><br>
897 <dd><tt>void AnimationAutomove(const edict_t *pEdict, float flTime);</tt>
898 <p><i>comments:</i><br>
903 <hr><h3><tt><a name="GetBonePosition">GetBonePosition</a></tt></h3>
904 <i>from engine/eiface.h:</i><br>
905 <dd><tt>void GetBonePosition(const edict_t *pEdict, int iBone, float *rgflOrigin, float *rgflAngles);</tt><br>
906 <dd><tt>GET_BONE_POSITION()</tt>
907 <p><i>comments:</i><br>
912 <hr><h3><tt><a name="FunctionFromName">FunctionFromName</a></tt></h3>
913 <i>from engine/eiface.h:</i><br>
914 <dd><tt>unsigned long FunctionFromName(const char *pName);</tt><br>
915 <dd><tt>FUNCTION_FROM_NAME()</tt>
916 <p><i>comments:</i><br>
918 Apparently, this finds the given exported function name string in the
919 GameDLL, and returns a pointer to said function (much like unix dlsym
920 or win32 GetProcAddress?). This appears to be used in GameDLL code for
921 loading savegames, as the savegames contain names of exported functions
922 in the GameDLL. Basically, this is the opposite of <a
923 href="#NameForFunction">NameForFunction</a>.
926 <hr><h3><tt><a name="NameForFunction">NameForFunction</a></tt></h3>
927 <i>from engine/eiface.h:</i><br>
928 <dd><tt>const char *NameForFunction(unsigned long function);</tt><br>
929 <dd><tt>NAME_FOR_FUNCTION()</tt>
930 <p><i>comments:</i><br>
932 Basically, the opposite of <a
933 href="#FunctionFromName">FunctionFromName</a>. Finds the given
934 function pointer address in the GameDLL, and returns the string name
935 for the corresponding function. This appears to be used in GameDLL
936 code for saving games, taking known function pointers and converting
937 them to function name strings to be stored in the savegames, so that
938 they can be converted back to function pointers upon game load.
941 <hr><h3><tt><a name="ClientPrintf">ClientPrintf</a></tt></h3>
942 <i>from engine/eiface.h:</i><br>
943 <dd><tt>void ClientPrintf(edict_t *pEdict, PRINT_TYPE ptype, const char *szMsg);</tt><br>
944 <dd><tt>CLIENT_PRINTF()</tt>
946 JOHN: engine callbacks so game DLL can print messages to individual
949 <p><i>comments:</i><br>
954 <hr><h3><tt><a name="ServerPrint">ServerPrint</a></tt></h3>
955 <i>from engine/eiface.h:</i><br>
956 <dd><tt>void ServerPrint(const char *szMsg);</tt>
957 <p><i>comments:</i><br>
959 Prints output to the server console.
962 <hr><h3><tt><a name="Cmd_Args">Cmd_Args</a></tt></h3>
963 <i>from engine/eiface.h:</i><br>
964 <dd><tt>const char *Cmd_Args(void);</tt><br>
965 <dd><tt>CMD_ARGS()</tt>
967 these 3 added so game DLL can easily access client 'cmd' strings
969 <p><i>comments:</i><br>
971 Returns the arguments for a command, as a single string. The command
972 string itself is not included, and must be queried with
973 <a href="#Cmd_Argv"><tt>CMD_ARGV(0)</tt></a>. For use in <a
974 href="dllapi_notes.html#ClientCommand">DLLAPI ClientCommand</a>, or in
975 the function provided to <a
976 href="#AddServerCommand">AddServerCommand</a>.
979 <hr><h3><tt><a name="Cmd_Argv">Cmd_Argv</a></tt></h3>
980 <i>from engine/eiface.h:</i><br>
981 <dd><tt>const char *Cmd_Argv(int argc);</tt><br>
982 <dd><tt>CMD_ARGV()</tt>
983 <p><i>comments:</i><br>
985 Returns the <i>nth</i> argument to the command. <tt>CMD_ARGV(0)</tt>
986 returns the command name itself.
989 <hr><h3><tt><a name="Cmd_Argc">Cmd_Argc</a></tt></h3>
990 <i>from engine/eiface.h:</i><br>
991 <dd><tt>int Cmd_Argc(void);</tt><br>
992 <dd><tt>CMD_ARGC()</tt>
993 <p><i>comments:</i><br>
995 Returns the number of arguments given to the command.
998 <hr><h3><tt><a name="GetAttachment">GetAttachment</a></tt></h3>
999 <i>from engine/eiface.h:</i><br>
1000 <dd><tt>void GetAttachment(const edict_t *pEdict, int iAttachment, float *rgflOrigin, float *rgflAngles);</tt><br>
1001 <dd><tt>GET_ATTACHMENT()</tt>
1002 <p><i>comments:</i><br>
1007 <hr><h3><tt><a name="CRC32_Init">CRC32_Init</a></tt></h3>
1008 <i>from engine/eiface.h:</i><br>
1009 <dd><tt>void CRC32_Init(CRC32_t *pulCRC);</tt><br>
1010 <dd><tt>CRC32_INIT()</tt>
1011 <p><i>comments:</i><br>
1016 <hr><h3><tt><a name="CRC32_ProcessBuffer">CRC32_ProcessBuffer</a></tt></h3>
1017 <i>from engine/eiface.h:</i><br>
1018 <dd><tt>void CRC32_ProcessBuffer(CRC32_t *pulCRC, void *p, int len);</tt><br>
1019 <dd><tt>CRC32_PROCESS_BUFFER()</tt>
1020 <p><i>comments:</i><br>
1025 <hr><h3><tt><a name="CRC32_ProcessByte">CRC32_ProcessByte</a></tt></h3>
1026 <i>from engine/eiface.h:</i><br>
1027 <dd><tt>void CRC32_ProcessByte(CRC32_t *pulCRC, unsigned char ch);</tt><br>
1028 <dd><tt>CRC32_PROCESS_BYTE()</tt>
1029 <p><i>comments:</i><br>
1034 <hr><h3><tt><a name="CRC32_Final">CRC32_Final</a></tt></h3>
1035 <i>from engine/eiface.h:</i><br>
1036 <dd><tt>CRC32_t CRC32_Final(CRC32_t pulCRC);</tt><br>
1037 <dd><tt>CRC32_FINAL()</tt>
1038 <p><i>comments:</i><br>
1043 <hr><h3><tt><a name="RandomLong">RandomLong</a></tt></h3>
1044 <i>from engine/eiface.h:</i><br>
1045 <dd><tt>long RandomLong(long lLow, long lHigh);</tt><br>
1046 <dd><tt>RANDOM_LONG()</tt>
1047 <p><i>comments:</i><br>
1052 <hr><h3><tt><a name="RandomFloat">RandomFloat</a></tt></h3>
1053 <i>from engine/eiface.h:</i><br>
1054 <dd><tt>float RandomFloat(float flLow, float flHigh);</tt><br>
1055 <dd><tt>RANDOM_FLOAT()</tt>
1056 <p><i>comments:</i><br>
1061 <hr><h3><tt><a name="SetView">SetView</a></tt></h3>
1062 <i>from engine/eiface.h:</i><br>
1063 <dd><tt>void SetView(const edict_t *pClient, const edict_t *pViewent);</tt><br>
1064 <dd><tt>SET_VIEW() </tt>
1065 <p><i>comments:</i><br>
1070 <hr><h3><tt><a name="Time">Time</a></tt></h3>
1071 <i>from engine/eiface.h:</i><br>
1072 <dd><tt>float Time(void);</tt>
1073 <p><i>comments:</i><br>
1078 <hr><h3><tt><a name="CrosshairAngle">CrosshairAngle</a></tt></h3>
1079 <i>from engine/eiface.h:</i><br>
1080 <dd><tt>void CrosshairAngle(const edict_t *pClient, float pitch, float yaw);</tt><br>
1081 <dd><tt>SET_CROSSHAIRANGLE()</tt>
1082 <p><i>comments:</i><br>
1087 <hr><h3><tt><a name="LoadFileForMe">LoadFileForMe</a></tt></h3>
1088 <i>from engine/eiface.h:</i><br>
1089 <dd><tt>byte * LoadFileForMe(char *filename, int *pLength);</tt><br>
1090 <dd><tt>LOAD_FILE_FOR_ME()</tt>
1091 <p><i>comments:</i><br>
1093 Opens the given filename (relative to the gamedir, or relative to the
1094 hlds directory, in that order), and returns a pointer to a byte array
1095 (character string) with the contents of the file. NULL-termination of
1096 the array indicates end of file. Length of the file in bytes is
1097 returned in the given int pointer.
1100 <hr><h3><tt><a name="FreeFile">FreeFile</a></tt></h3>
1101 <i>from engine/eiface.h:</i><br>
1102 <dd><tt>void FreeFile(void *buffer);</tt><br>
1103 <dd><tt>FREE_FILE()</tt>
1104 <p><i>comments:</i><br>
1106 Free the byte array of the given buffer which was returned by <a
1107 href="#LoadFileForMe">LoadFileForMe</a>.
1110 <hr><h3><tt><a name="EndSection">EndSection</a></tt></h3>
1111 <i>from engine/eiface.h:</i><br>
1112 <dd><tt>void EndSection(const char *pszSectionName);</tt>
1116 <p><i>comments:</i><br>
1121 <hr><h3><tt><a name="CompareFileTime">CompareFileTime</a></tt></h3>
1122 <i>from engine/eiface.h:</i><br>
1123 <dd><tt>int CompareFileTime(char *filename1, char *filename2, int *iCompare);</tt><br>
1124 <dd><tt>COMPARE_FILE_TIME()</tt>
1125 <p><i>comments:</i><br>
1130 <hr><h3><tt><a name="GetGameDir">GetGameDir</a></tt></h3>
1131 <i>from engine/eiface.h:</i><br>
1132 <dd><tt>void GetGameDir(char *szGetGameDir);</tt><br>
1133 <dd><tt>GET_GAME_DIR() </tt>
1134 <p><i>comments:</i><br>
1136 Copies the pathname of the game directory into the given buffer. Note
1137 that there's no way to inform the engine how big the buffer is, so be
1140 Prior to HL 1.1.1.1 (CS 1.6), this gave the full pathname of the game
1141 directory, ie "/usr/local/half-life/cstrike" or
1142 "C:\Games\Half-Life\cstrike". Now, it is only the string passed to
1143 hlds as the argument to "-game", ie "cstrike".
1146 <hr><h3><tt><a name="Cvar_RegisterVariable">Cvar_RegisterVariable</a></tt></h3>
1147 <i>from engine/eiface.h:</i><br>
1148 <dd><tt>void Cvar_RegisterVariable(cvar_t *variable);</tt><br>
1149 <dd><tt>CVAR_CREATE()</tt>
1150 <p><i>comments:</i><br>
1155 <hr><h3><tt><a name="FadeClientVolume">FadeClientVolume</a></tt></h3>
1156 <i>from engine/eiface.h:</i><br>
1157 <dd><tt>void FadeClientVolume(const edict_t *pEdict, int fadePercent, int fadeOutSeconds, int holdTime, int fadeInSeconds);</tt>
1158 <p><i>comments:</i><br>
1163 <hr><h3><tt><a name="SetClientMaxspeed">SetClientMaxspeed</a></tt></h3>
1164 <i>from engine/eiface.h:</i><br>
1165 <dd><tt>void SetClientMaxspeed(const edict_t *pEdict, float fNewMaxspeed);</tt>
1166 <p><i>comments:</i><br>
1171 <hr><h3><tt><a name="CreateFakeClient">CreateFakeClient</a></tt></h3>
1172 <i>from engine/eiface.h:</i><br>
1173 <dd><tt>edict_t * CreateFakeClient(const char *netname);</tt>
1175 returns NULL if fake client can't be created
1177 <p><i>comments:</i><br>
1182 <hr><h3><tt><a name="RunPlayerMove">RunPlayerMove</a></tt></h3>
1183 <i>from engine/eiface.h:</i><br>
1184 <dd><tt>void RunPlayerMove(edict_t *fakeclient, const float *viewangles, float forwardmove, float sidemove, float upmove, unsigned short buttons, byte impulse, byte msec);</tt>
1185 <p><i>comments:</i><br>
1190 <hr><h3><tt><a name="NumberOfEntities">NumberOfEntities</a></tt></h3>
1191 <i>from engine/eiface.h:</i><br>
1192 <dd><tt>int NumberOfEntities(void);</tt><br>
1193 <dd><tt>NUMBER_OF_ENTITIES()</tt>
1194 <p><i>comments:</i><br>
1199 <hr><h3><tt><a name="GetInfoKeyBuffer">GetInfoKeyBuffer</a></tt></h3>
1200 <i>from engine/eiface.h:</i><br>
1201 <dd><tt>char *GetInfoKeyBuffer(edict_t *e);</tt>
1203 passing in NULL gets the serverinfo
1205 <p><i>comments:</i><br>
1207 Returns the InfoKeyBuffer for the given edict. This is basically the
1208 fields from "setinfo" at the client console, and includes things like
1211 The sourcecode comment ("<i>passing in NULL gets the serverinfo</i>")
1212 isn't entirely accurate. There appear to be two server-side info
1213 buffers available, "<b>serverinfo</b>" and "<b>localinfo</b>", both
1214 accessible from the console by those two commands, respectively.
1216 Calling <tt>GetInfoKeyBuffer(NULL)</tt> will return the
1217 <b>localinfo</b> buffer. Calling
1218 <tt>GetInfoKeyBuffer(PEntityOfEntIndex(0))</tt>, ie passing the entity
1219 of slot 0, will return the <b>serverinfo</b> buffer.
1222 <hr><h3><tt><a name="InfoKeyValue">InfoKeyValue</a></tt></h3>
1223 <i>from engine/eiface.h:</i><br>
1224 <dd><tt>char *InfoKeyValue(char *infobuffer, char *key);</tt>
1225 <p><i>comments:</i><br>
1227 Returns the value for the given key in the given InfoKeyBuffer.
1230 <hr><h3><tt><a name="SetKeyValue">SetKeyValue</a></tt></h3>
1231 <i>from engine/eiface.h:</i><br>
1232 <dd><tt>void SetKeyValue(char *infobuffer, char *key, char *value);</tt>
1233 <p><i>comments:</i><br>
1235 Adds or sets a key/value pair in the given InfoKeyBuffer. Appears to
1236 work for only server info, and not client info. For clients, use <a
1237 href="#SetClientKeyValue">SetClientKeyValue</a>.
1240 <hr><h3><tt><a name="SetClientKeyValue">SetClientKeyValue</a></tt></h3>
1241 <i>from engine/eiface.h:</i><br>
1242 <dd><tt>void SetClientKeyValue(int clientIndex, char *infobuffer, char *key, char *value);</tt>
1243 <p><i>comments:</i><br>
1245 Adds or sets a key/value pair in a client's InfoKeyBuffer, by server
1246 slot (ie 1 to maxplayers).
1249 <hr><h3><tt><a name="IsMapValid">IsMapValid</a></tt></h3>
1250 <i>from engine/eiface.h:</i><br>
1251 <dd><tt>int IsMapValid(char *filename);</tt><br>
1252 <dd><tt>IS_MAP_VALID()</tt>
1253 <p><i>comments:</i><br>
1258 <hr><h3><tt><a name="StaticDecal">StaticDecal</a></tt></h3>
1259 <i>from engine/eiface.h:</i><br>
1260 <dd><tt>void StaticDecal(const float *origin, int decalIndex, int entityIndex, int modelIndex);</tt>
1261 <p><i>comments:</i><br>
1266 <hr><h3><tt><a name="PrecacheGeneric">PrecacheGeneric</a></tt></h3>
1267 <i>from engine/eiface.h:</i><br>
1268 <dd><tt>int PrecacheGeneric(char *s);</tt><br>
1269 <dd><tt>PRECACHE_GENERIC()</tt>
1270 <p><i>comments:</i><br>
1275 <hr><h3><tt><a name="GetPlayerUserId">GetPlayerUserId</a></tt></h3>
1276 <i>from engine/eiface.h:</i><br>
1277 <dd><tt>int GetPlayerUserId(edict_t *e);</tt><br>
1278 <dd><tt>GETPLAYERUSERID()
1280 returns the server assigned userid for this player. useful for logging
1281 frags, etc. returns -1 if the edict couldn't be found in the list of
1284 <p><i>comments:</i><br>
1286 Returns the session userid for the given player edict. As of server
1287 x106, this is constant for the life of the player connection, and
1288 unique for the life of the server process. Each time a client
1289 connects, they are given a userid of 1 plus the userid of the previous
1290 connecting client. When the server starts/restarts, the server starts
1294 <hr><h3><tt><a name="BuildSoundMsg">BuildSoundMsg</a></tt></h3>
1295 <i>from engine/eiface.h:</i><br>
1296 <dd><tt>void BuildSoundMsg(edict_t *entity, int channel, const char *sample, /*int*/float volume, float attenuation, int fFlags, int pitch, int msg_dest, int msg_type, const float *pOrigin, edict_t *ed);</tt><br>
1297 <dd><tt>BUILD_SOUND_MSG()</tt>
1298 <p><i>comments:</i><br>
1303 <hr><h3><tt><a name="IsDedicatedServer">IsDedicatedServer</a></tt></h3>
1304 <i>from engine/eiface.h:</i><br>
1305 <dd><tt>int IsDedicatedServer(void);</tt><br>
1306 <dd><tt>IS_DEDICATED_SERVER()
1308 is this a dedicated server?
1310 <p><i>comments:</i><br>
1315 <hr><h3><tt><a name="CVarGetPointer">CVarGetPointer</a></tt></h3>
1316 <i>from engine/eiface.h:</i><br>
1317 <dd><tt>cvar_t *CVarGetPointer(const char *szVarName);</tt><br>
1318 <dd><tt>CVAR_GET_POINTER()</tt>
1319 <p><i>comments:</i><br>
1321 Returns a pointer to a <tt>cvar_t</tt> struct for the given cvar
1322 (server variable) name.
1325 <hr><h3><tt><a name="GetPlayerWONId">GetPlayerWONId</a></tt></h3>
1326 <i>from engine/eiface.h:</i><br>
1327 <dd><tt>unsigned int GetPlayerWONId(edict_t *e);</tt>
1328 <dd><tt>GETPLAYERWONID()</tt>
1330 returns the server assigned WONid for this player. useful for logging
1331 frags, etc. returns -1 if the edict couldn't be found in the list of
1334 <p><i>comments:</i><br>
1336 Returns the WON id for the given player edict. As of server x106, this
1337 should be unique per client CD KEY, and should be consistent across all
1341 <hr><h3><tt><a name="Info_RemoveKey">Info_RemoveKey</a></tt></h3>
1342 <i>from engine/eiface.h:</i><br>
1343 <dd><tt>void Info_RemoveKey(char *s, const char *key);</tt>
1345 YWB 8/1/99 TFF Physics additions
1347 <p><i>comments:</i><br>
1352 <hr><h3><tt><a name="GetPhysicsKeyValue">GetPhysicsKeyValue</a></tt></h3>
1353 <i>from engine/eiface.h:</i><br>
1354 <dd><tt>const char *GetPhysicsKeyValue(const edict_t *pClient, const char *key);</tt>
1355 <p><i>comments:</i><br>
1360 <hr><h3><tt><a name="SetPhysicsKeyValue">SetPhysicsKeyValue</a></tt></h3>
1361 <i>from engine/eiface.h:</i><br>
1362 <dd><tt>void SetPhysicsKeyValue(const edict_t *pClient, const char *key, const char *value);</tt>
1363 <p><i>comments:</i><br>
1368 <hr><h3><tt><a name="GetPhysicsInfoString">GetPhysicsInfoString</a></tt></h3>
1369 <i>from engine/eiface.h:</i><br>
1370 <dd><tt>const char *GetPhysicsInfoString(const edict_t *pClient);</tt><br>
1371 <dd><tt>ENGINE_GETPHYSINFO()</tt>
1372 <p><i>comments:</i><br>
1377 <hr><h3><tt><a name="PrecacheEvent">PrecacheEvent</a></tt></h3>
1378 <i>from engine/eiface.h:</i><br>
1379 <dd><tt>unsigned short PrecacheEvent(int type, const char *psz);</tt><br>
1380 <dd><tt>PRECACHE_EVENT()</tt>
1381 <p><i>comments:</i><br>
1386 <hr><h3><tt><a name="PlaybackEvent">PlaybackEvent</a></tt></h3>
1387 <i>from engine/eiface.h:</i><br>
1388 <dd><tt>void PlaybackEvent(int flags, const edict_t *pInvoker, unsigned short eventindex, float delay, float *origin, float *angles, float fparam1, float fparam2, int iparam1, int iparam2, int bparam1, int bparam2);</tt><br>
1389 <dd><tt>PLAYBACK_EVENT_FULL()</tt>
1390 <p><i>comments:</i><br>
1395 <hr><h3><tt><a name="SetFatPVS">SetFatPVS</a></tt></h3>
1396 <i>from engine/eiface.h:</i><br>
1397 <dd><tt>unsigned char *SetFatPVS(float *org);</tt><br>
1398 <dd><tt>ENGINE_SET_PVS()</tt>
1399 <p><i>comments:</i><br>
1404 <hr><h3><tt><a name="SetFatPAS">SetFatPAS</a></tt></h3>
1405 <i>from engine/eiface.h:</i><br>
1406 <dd><tt>unsigned char *SetFatPAS(float *org);</tt><br>
1407 <dd><tt>ENGINE_SET_PAS()</tt>
1408 <p><i>comments:</i><br>
1413 <hr><h3><tt><a name="CheckVisibility">CheckVisibility</a></tt></h3>
1414 <i>from engine/eiface.h:</i><br>
1415 <dd><tt>int CheckVisibility(const edict_t *entity, unsigned char *pset);</tt><br>
1416 <dd><tt>ENGINE_CHECK_VISIBILITY()</tt>
1417 <p><i>comments:</i><br>
1422 <hr><h3><tt><a name="DeltaSetField">DeltaSetField</a></tt></h3>
1423 <i>from engine/eiface.h:</i><br>
1424 <dd><tt>void DeltaSetField(struct delta_s *pFields, const char *fieldname);</tt><br>
1425 <dd><tt>DELTA_SET()</tt>
1426 <p><i>comments:</i><br>
1431 <hr><h3><tt><a name="DeltaUnsetField">DeltaUnsetField</a></tt></h3>
1432 <i>from engine/eiface.h:</i><br>
1433 <dd><tt>void DeltaUnsetField(struct delta_s *pFields, const char *fieldname);</tt><br>
1434 <dd><tt>DELTA_UNSET()</tt>
1435 <p><i>comments:</i><br>
1440 <hr><h3><tt><a name="DeltaAddEncoder">DeltaAddEncoder</a></tt></h3>
1441 <i>from engine/eiface.h:</i><br>
1442 <dd><tt>void DeltaAddEncoder(char *name, void (*conditionalencode)( struct delta_s *pFields, const unsigned char *from, const unsigned char *to) );</tt><br>
1443 <dd><tt>DELTA_ADDENCODER()</tt>
1444 <p><i>comments:</i><br>
1449 <hr><h3><tt><a name="GetCurrentPlayer">GetCurrentPlayer</a></tt></h3>
1450 <i>from engine/eiface.h:</i><br>
1451 <dd><tt>int GetCurrentPlayer(void);</tt><br>
1452 <dd><tt>ENGINE_CURRENT_PLAYER()</tt>
1453 <p><i>comments:</i><br>
1458 <hr><h3><tt><a name="CanSkipPlayer">CanSkipPlayer</a></tt></h3>
1459 <i>from engine/eiface.h:</i><br>
1460 <dd><tt>int CanSkipPlayer(const edict_t *player);</tt><br>
1461 <dd><tt>ENGINE_CANSKIP()</tt>
1462 <p><i>comments:</i><br>
1467 <hr><h3><tt><a name="DeltaFindField">DeltaFindField</a></tt></h3>
1468 <i>from engine/eiface.h:</i><br>
1469 <dd><tt>int DeltaFindField(struct delta_s *pFields, const char *fieldname);</tt><br>
1470 <dd><tt>DELTA_FINDFIELD()</tt>
1471 <p><i>comments:</i><br>
1476 <hr><h3><tt><a name="DeltaSetFieldByIndex">DeltaSetFieldByIndex</a></tt></h3>
1477 <i>from engine/eiface.h:</i><br>
1478 <dd><tt>void DeltaSetFieldByIndex(struct delta_s *pFields, int fieldNumber);</tt><br>
1479 <dd><tt>DELTA_SETBYINDEX()</tt>
1480 <p><i>comments:</i><br>
1485 <hr><h3><tt><a name="DeltaUnsetFieldByIndex">DeltaUnsetFieldByIndex</a></tt></h3>
1486 <i>from engine/eiface.h:</i><br>
1487 <dd><tt>void DeltaUnsetFieldByIndex(struct delta_s *pFields, int fieldNumber);</tt><br>
1488 <dd><tt>DELTA_UNSETBYINDEX()</tt>
1489 <p><i>comments:</i><br>
1494 <hr><h3><tt><a name="SetGroupMask">SetGroupMask</a></tt></h3>
1495 <i>from engine/eiface.h:</i><br>
1496 <dd><tt>void SetGroupMask(int mask, int op);</tt><br>
1497 <dd><tt>ENGINE_SETGROUPMASK()</tt>
1498 <p><i>comments:</i><br>
1503 <hr><h3><tt><a name="CreateInstancedBaseline">CreateInstancedBaseline</a></tt></h3>
1504 <i>from engine/eiface.h:</i><br>
1505 <dd><tt>int CreateInstancedBaseline(int classname, struct entity_state_s *baseline);</tt><br>
1506 <dd><tt>ENGINE_INSTANCE_BASELINE()</tt>
1507 <p><i>comments:</i><br>
1512 <hr><h3><tt><a name="Cvar_DirectSet">Cvar_DirectSet</a></tt></h3>
1513 <i>from engine/eiface.h:</i><br>
1514 <dd><tt>void Cvar_DirectSet(struct cvar_s *var, char *value);</tt>
1515 <p><i>comments:</i><br>
1520 <hr><h3><tt><a name="ForceUnmodified">ForceUnmodified</a></tt></h3>
1521 <i>from engine/eiface.h:</i><br>
1522 <dd><tt>void ForceUnmodified(FORCE_TYPE type, float *mins, float *maxs, const char *filename);</tt><br>
1523 <dd><tt>ENGINE_FORCE_UNMODIFIED()</tt>
1525 Forces the client and server to be running with the same version of the
1526 specified file ( e.g., a player model ). Calling this has no effect in
1529 <p><i>comments:</i><br>
1534 <hr><h3><tt><a name="GetPlayerStats">GetPlayerStats</a></tt></h3>
1535 <i>from engine/eiface.h:</i><br>
1536 <dd><tt>void GetPlayerStats(const edict_t *pClient, int *ping, int *packet_loss);</tt><br>
1537 <dd><tt>PLAYER_CNX_STATS()</tt>
1538 <p><i>comments:</i><br>
1543 <hr><h3><tt><a name="AddServerCommand">AddServerCommand</a></tt></h3>
1544 <i>from engine/eiface.h:</i><br>
1545 <dd><tt>void AddServerCommand(char *cmd_name, void (*function) (void));</tt>
1546 <p><i>comments:</i><br>
1548 Registers a new server console command. When the given command string
1549 is typed at the console, the given function will be called. Arguments
1550 for the command can be retrieved in the function with
1551 <a href="#Cmd_Args">Cmd_Args</a>, <a href="#Cmd_Argv">Cmd_Argv</a>, and
1552 <a href="#Cmd_Argc">Cmd_Argc</a>.
1555 <hr><h3><tt><a name="Voice_GetClientListening">Voice_GetClientListening</a></tt></h3>
1556 <i>from engine/eiface.h:</i><br>
1557 <dd><tt>qboolean Voice_GetClientListening)(int iReceiver, int iSender);</tt>
1559 For voice communications, set which clients hear each other. NOTE: these
1560 functions take player entity indices (starting at 1).
1562 <p><i>comments:</i><br>
1567 <hr><h3><tt><a name="Voice_SetClientListening">Voice_SetClientListening</a></tt></h3>
1568 <i>from engine/eiface.h:</i><br>
1569 <dd><tt>qboolean Voice_SetClientListening)(int iReceiver, int iSender, qboolean bListen);</tt>
1571 For voice communications, set which clients hear each other. NOTE: these
1572 functions take player entity indices (starting at 1).
1574 <p><i>comments:</i><br>
1579 <hr><h3><tt><a name="GetPlayerAuthId">GetPlayerAuthId</a></tt></h3>
1580 <i>from engine/eiface.h:</i><br>
1581 <dd><tt>const char *GetPlayerAuthId(edict_t *e);</tt>
1582 <p><i>From Eric Smith <[email protected]> on <a href="http://list.valvesoftware.com/pipermail/hlcoders/2002-April/002865.html">hlcoders</a>:</i>
1584 The AuthID is a way for applications/mods to get the Authentication ID
1585 (uniqueID) for a player. The AuthID can be a WonID or a SteamID. The
1586 function I've written returns the AuthID as a string. Calling <a
1587 href="#GetPlayerWONId">GetPlayerWONId</a> will still work for Non-Steam
1588 players just like it always has. If applications/mods want to get a
1589 jump start on getting ready to support Steam players, then they can
1590 start using GetPlayerAuthId, which will still work for Non-Steam
1591 players, but it will give the WonID as a string instead of an unsigned
1594 <p><i>From Eric Smith <[email protected]> on <a href="http://list.valvesoftware.com/pipermail/servertest/2002-April/000567.html">servertest:</a></i>
1596 Only clients playing via Steam will have SteamIDs. Clients who are not
1597 using Steam will still have WonIDs (just like they always have). The
1598 server now supports WonIDs\SteamIDs and banning using either of them.
1599 WonIDs have not changed. SteamIDs use the format: STEAM_<#>:<#> where
1600 <#> is replaced by numbers. An example SteamID would be
1603 <p><i>From Eric Smith <[email protected]> on <a href="http://list.valvesoftware.com/pipermail/hlcoders/2002-April/002925.html">hlcoders:</a></i>
1605 This function will now return the string "BOT" as the AuthID for fake
1608 <p><i>comments:</i><br>
1610 Added for HL 1109; no SDK update. (Available in patched SDK as of hlsdk-2.3-p1.)
1613 <hr><h3><tt><a name="SequenceGet">SequenceGet</a></tt></h3>
1614 <i>from engine/eiface.h:</i><br>
1615 <dd><tt>void *SequenceGet(const char *fileName, const char *entryName);</tt>
1616 <p><i>comments:</i><br>
1618 Added for HL 1xxx; no SDK update. (Available in patched SDK as of hlsdk-2.3-p1.)
1621 <hr><h3><tt><a name="SequencePickSentence">SequencePickSentence</a></tt></h3>
1622 <i>from engine/eiface.h:</i><br>
1623 <dd><tt>void *SequencePickSentence(const char *groupName, int pickMethod,
1625 <p><i>comments:</i><br>
1627 Added for HL 1xxx; no SDK update. (Available in patched SDK as of hlsdk-2.3-p1.)
1630 <hr><h3><tt><a name="GetFileSize">GetFileSize</a></tt></h3>
1631 <i>from engine/eiface.h:</i><br>
1632 <dd><tt>int GetFileSize(char *filename);</tt>
1633 <p><i>comments:</i><br>
1635 Added for HL 1xxx; no SDK update. (Available in patched SDK as of hlsdk-2.3-p1.)
1638 <hr><h3><tt><a name="GetApproxWavePlayLen">GetApproxWavePlayLen</a></tt></h3>
1639 <i>from engine/eiface.h:</i><br>
1640 <dd><tt>unsigned int GetApproxWavePlayLen(const char *filepath);</tt>
1641 <p><i>comments:</i><br>
1643 Added for HL 1xxx; no SDK update. (Available in patched SDK as of hlsdk-2.3-p1.)
1646 <hr><h3><tt><a name="IsCareerMatch">IsCareerMatch</a></tt></h3>
1647 <i>from engine/eiface.h:</i><br>
1648 <dd><tt>int IsCareerMatch(void);</tt>
1649 <p><i>comments:</i><br>
1651 Added for HL 1xxx; no SDK update. (Available in patched SDK as of hlsdk-2.3-p1.)
1654 <hr><h3><tt><a name="GetLocalizedStringLength">GetLocalizedStringLength</a></tt></h3>
1655 <i>from engine/eiface.h:</i><br>
1656 <dd><tt>int GetLocalizedStringLength(const char *label);</tt>
1657 <p><i>comments:</i><br>
1659 Added for HL 1xxx; no SDK update. (Available in patched SDK as of hlsdk-2.3-p1.)
1662 <hr><h3><tt><a name="RegisterTutorMessageShown">RegisterTutorMessageShown</a></tt></h3>
1663 <i>from engine/eiface.h:</i><br>
1664 <dd><tt>void RegisterTutorMessageShown(int mid);</tt>
1665 <p><i>comments:</i><br>
1667 Added for HL 1xxx; no SDK update. (Available in patched SDK as of hlsdk-2.3-p1.)
1670 <hr><h3><tt><a name="GetTimesTutorMessageShown">GetTimesTutorMessageShown</a></tt></h3>
1671 <i>from engine/eiface.h:</i><br>
1672 <dd><tt>int GetTimesTutorMessageShown(int mid);</tt>
1673 <p><i>comments:</i><br>
1675 Added for HL 1xxx; no SDK update. (Available in patched SDK as of hlsdk-2.3-p1.)
1678 <hr><h3><tt><a name="ProcessTutorMessageDecayBuffer">ProcessTutorMessageDecayBuffer</a></tt></h3>
1679 <i>from engine/eiface.h:</i><br>
1680 <dd><tt>void ProcessTutorMessageDecayBuffer(int *buffer, int bufferLength);</tt>
1681 <p><i>comments:</i><br>
1683 Added for HL 1xxx; no SDK update. (Available in patched SDK as of hlsdk-2.3-p1.)
1686 <hr><h3><tt><a name="ConstructTutorMessageDecayBuffer">ConstructTutorMessageDecayBuffer</a></tt></h3>
1687 <i>from engine/eiface.h:</i><br>
1688 <dd><tt>void ConstructTutorMessageDecayBuffer(int *buffer, int bufferLength);</tt>
1689 <p><i>comments:</i><br>
1691 Added for HL 1xxx; no SDK update. (Available in patched SDK as of hlsdk-2.3-p1.)
1694 <hr><h3><tt><a name="ResetTutorMessageDecayData">ResetTutorMessageDecayData</a></tt></h3>
1695 <i>from engine/eiface.h:</i><br>
1696 <dd><tt>void ResetTutorMessageDecayData(void);</tt>
1697 <p><i>comments:</i><br>
1699 Added for HL 1xxx; no SDK update. (Available in patched SDK as of hlsdk-2.3-p1.)
1702 <hr><h3><tt><a name="QueryClientCvarValue">QueryClientCvarValue</a></tt></h3>
1703 <dd><tt>void (*pfnQueryClientCvarValue)( const edict_t *player, const char *cvarName );</tt><p>
1706 Calling this function requests the value of cvarName from player. The
1707 result is returned via a callback from NEW_DLL_FUNCTIONS.
1709 <p><i>comments:</i><br>
1711 Added 2005-08-11, no SDK update. (Available in patched SDK as of hlsdk-2.3-p2.)
1714 <b>Use of this function is DEPRECATED. It has been obsoleted by the
1715 pfnQueryClientCvarValue2() function. See below.</b>
1718 This API can lead to conflicts when you query more than one cvar from a player
1719 at a time. When using this function, use IS_QUERYING_CLIENT_CVAR to check if
1720 another plugin is querying before you do so. Use of this function is strongly
1721 advised against. Instead use the pfnQueryClientCvarValue2() function.
1725 <hr><h3><tt><a name="QueryClientCvarValue2">QueryClientCvarValue2</a></tt></h3>
1726 <dd><tt>void (*pfnQueryClientCvarValue2)( const edict_t *player, const char *cvarName, int requestID );</tt><p>
1729 Calling this function requests the value of cvarName from player and
1730 returns to you the supplied requestID on success (or failure).
1732 The response is sent to a pfnCvarValue2 callback in the
1733 NEW_DLL_FUNCTIONS structure.
1735 <p><i>comments:</i><br>
1737 Added 2005-11-23, no SDK update. (Available in patched SDK as of hlsdk-2.3-p3.)