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