doc/html/newapi_notes.html
author Scott Ehlert <ds@alliedmods.net>
Thu Sep 26 22:57:05 2013 -0500 (2013-09-26)
changeset 286 202d9c3207a2
parent 249 0e54d20d8f28
permissions -rw-r--r--
Fixed warning when building stub_mm plugin.
     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    <li><a href=#CvarValue2>CvarValue2</a>
    20 </ul>
    21 
    22 <b>NOTE</b>: No examples of these found in SDK...
    23 
    24 <p>
    25 
    26 <hr><h3><tt><a name="OnFreeEntPrivateData">OnFreeEntPrivateData</a></tt></h3>
    27 <dd><tt>void OnFreeEntPrivateData(edict_t pEnt);</tt><p>
    28 <i>from engine/eiface.h:</i><br>
    29 <blockquote><tt>
    30 	Called right before the object's memory is freed.  Calls its destructor.
    31 </tt></blockquote>
    32 <p><i>comments:</i><br>
    33 <blockquote>
    34 	See also <a
    35 	href="http://list.valvesoftware.com/pipermail/hlcoders/2002-January/001397.html"
    36 	>Ken Birdwell on constructors</a>, from the HLCoders list.
    37 	<br>Added in SDK 2.0.  
    38 </blockquote>
    39 
    40 <hr><h3><tt><a name="GameShutdown">GameShutdown</a></tt></h3>
    41 <dd><tt>void GameShutdown(void);</tt><p>
    42 <p><i>comments:</i><br>
    43 <blockquote>
    44 	Added in SDK 2.0.
    45 </blockquote>
    46 
    47 <hr><h3><tt><a name="ShouldCollide">ShouldCollide</a></tt></h3>
    48 <dd><tt>int ShouldCollide(edict_t *pentTouched, edict_t *pentOther);</tt><p>
    49 <i>from [email protected], via HLCoders:</i><br>
    50 <blockquote><tt>
    51 	..a hook that can override if any two entities should collide  
    52 	when they try to pass through each other.
    53 </tt></blockquote>
    54 <p><i>comments:</i><br>
    55 <blockquote>
    56 	Mugsy from DoD indicates that the return value for normal operation is 1.
    57 	<br>Added in SDK 2.0.  
    58 </blockquote>
    59 
    60 <hr><h3><tt><a name="CvarValue">CvarValue</a></tt></h3>
    61 <dd><tt>void (*pfnCvarValue)( const edict_t *pEnt, const char *value );</tt><p>
    62 <i>from [email protected], via HLCoders:</i><br>
    63 <blockquote><tt>
    64 When the client responds to the cvar request you will get a callback to pfnCvarValue() 
    65 with the edict of the player who is responding and the cvars values.
    66 </tt></blockquote>
    67 <p><i>comments:</i><br>
    68 <blockquote>
    69 	Added 2005-08-11, no SDK update.  (Available in patched SDK as of hlsdk-2.3-p2.)
    70 </blockquote>
    71 <blockquote>
    72 	<b>Use of this function is DEPRECATED. It has been obsoleted by the
    73 		pfnCvarValue2() function. See below.</b>
    74 </blockquote>
    75 
    76 <hr><h3><tt><a name="CvarValue2">CvarValue2</a></tt></h3>
    77 <dd><tt>void (*pfnCvarValue2)( const edict_t *pEnt, int requestID, const char *cvarName, const char *value );</tt><p>
    78 <i>from [email protected], via HLCoders:</i><br>
    79 <blockquote><tt>
    80 		When the pfnQueryClientCvarValue2() completes it will call
    81 		pfnCvarValue2() with the request ID you supplied earlier, the name
    82 		of the cvar you requested and the value of that cvar. On failure (i.e
    83 		that user is not connected or the cvar does not exist) the value of the
    84 		returned cvar will be "Bad CVAR request". If you specify an invalid
    85 		player edict you will get "Bad Player" as the value response.<br>
    86 		If a client has a cvar value set to "Bad CVAR request" it cannot be
    87 		differentiated from a bad request for a cvar. This is considered
    88 		okay because that value is not considered to be useful as a valid
    89 		cvar value.
    90 </tt></blockquote>
    91 <p><i>comments:</i><br>
    92 <blockquote>
    93 	Added 2005-11-22, no SDK update.  (Available in patched SDK as of hlsdk-2.3-p3.)
    94 </blockquote>
    95 
    96 <p>
    97 <hr>
    98 
    99 </body>
   100 </HTML>