doc/html/newapi_notes.html
author bailopan
Thu Aug 18 16:56:23 2005 +0000 (2005-08-18)
branchB-work
changeset 144 8f8565e045a0
parent 0 d15304fcb7a7
child 176 9a743aab6b3d
permissions -rw-r--r--
Updated changelog + html doc
darope@0
     1
<!-- vi: set ts=4 sw=4 : -->
darope@0
     2
<!-- vim: set tw=75 : -->
darope@0
     3
darope@0
     4
<HTML>
darope@0
     5
<head>
darope@0
     6
<title>HLSDK NEWAPI Notes</title>
darope@0
     7
</head>
darope@0
     8
<body>
darope@0
     9
darope@0
    10
<h1>HLSDK NEWAPI Notes
darope@0
    11
</h1>
darope@0
    12
darope@0
    13
<hr>
darope@0
    14
<ul>
darope@0
    15
   <li><a href=#OnFreeEntPrivateData>OnFreeEntPrivateData</a>
darope@0
    16
   <li><a href=#GameShutdown>GameShutdown</a>
darope@0
    17
   <li><a href=#ShouldCollide>ShouldCollide</a>
bailopan@144
    18
   <li><a href=#CvarValue>CvarValue</a>
darope@0
    19
</ul>
darope@0
    20
darope@0
    21
<b>NOTE</b>: No examples of these found in SDK...
darope@0
    22
darope@0
    23
<p>
darope@0
    24
darope@0
    25
<hr><h3><tt><a name="OnFreeEntPrivateData">OnFreeEntPrivateData</a></tt></h3>
darope@0
    26
<dd><tt>void OnFreeEntPrivateData(edict_t pEnt);</tt><p>
darope@0
    27
<i>from engine/eiface.h:</i><br>
darope@0
    28
<blockquote><tt>
darope@0
    29
	Called right before the object's memory is freed.  Calls its destructor.
darope@0
    30
</tt></blockquote>
darope@0
    31
<p><i>comments:</i><br>
darope@0
    32
<blockquote>
darope@0
    33
	See also <a
darope@0
    34
	href="http://list.valvesoftware.com/pipermail/hlcoders/2002-January/001397.html"
darope@0
    35
	>Ken Birdwell on constructors</a>, from the HLCoders list.
darope@0
    36
	<br>Added in SDK 2.0.  
darope@0
    37
</blockquote>
darope@0
    38
darope@0
    39
<hr><h3><tt><a name="GameShutdown">GameShutdown</a></tt></h3>
darope@0
    40
<dd><tt>void GameShutdown(void);</tt><p>
darope@0
    41
<p><i>comments:</i><br>
darope@0
    42
<blockquote>
darope@0
    43
	Added in SDK 2.0.
darope@0
    44
</blockquote>
darope@0
    45
darope@0
    46
<hr><h3><tt><a name="ShouldCollide">ShouldCollide</a></tt></h3>
darope@0
    47
<dd><tt>int ShouldCollide(edict_t *pentTouched, edict_t *pentOther);</tt><p>
darope@0
    48
<i>from [email protected], via HLCoders:</i><br>
darope@0
    49
<blockquote><tt>
darope@0
    50
	..a hook that can override if any two entities should collide  
darope@0
    51
	when they try to pass through each other.
darope@0
    52
</tt></blockquote>
darope@0
    53
<p><i>comments:</i><br>
darope@0
    54
<blockquote>
darope@0
    55
	Mugsy from DoD indicates that the return value for normal operation is 1.
darope@0
    56
	<br>Added in SDK 2.0.  
darope@0
    57
</blockquote>
darope@0
    58
bailopan@144
    59
<hr><h3><tt><a name="CvarValue">CvarValue</a></tt></h3>
bailopan@144
    60
<dd><tt>void (*pfnCvarValue)( const edict_t *pEnt, const char *value );</tt><p>
bailopan@144
    61
<i>from [email protected], via HLCoders:</i><br>
bailopan@144
    62
<blockquote><tt>
bailopan@144
    63
When the client responds to the cvar request you will get a callback to pfnCvarValue() 
bailopan@144
    64
with the edict of the player who is responding and the cvars values.
bailopan@144
    65
</tt></blockquote>
bailopan@144
    66
<p><i>comments:</i><br>
bailopan@144
    67
<blockquote>
bailopan@144
    68
	This API can lead to conflicts when you query more than one cvar from a player 
bailopan@144
    69
	at a time.  Use IS_QUERYING_CLIENT_CVAR to check if another plugin is querying before
bailopan@144
    70
	you do so.
bailopan@144
    71
</blockquote>
bailopan@144
    72
darope@0
    73
<p>
darope@0
    74
<hr>
darope@0
    75
darope@0
    76
</body>
darope@0
    77
</HTML>