doc/txt/newapi_notes.txt
changeset 249 0e54d20d8f28
parent 248 f72386298cba
     1.1 --- a/doc/txt/newapi_notes.txt	Tue Aug 23 20:31:28 2005 +0000
     1.2 +++ b/doc/txt/newapi_notes.txt	Wed Dec 21 18:40:50 2005 +0000
     1.3 @@ -7,6 +7,7 @@
     1.4    - GameShutdown
     1.5    - ShouldCollide
     1.6    - CvarValue
     1.7 +  - CvarValue2
     1.8  
     1.9  NOTE: No examples of these found in SDK...
    1.10  
    1.11 @@ -67,8 +68,35 @@
    1.12  
    1.13  comments:
    1.14  
    1.15 -    This API can lead to conflicts when you query more than one cvar from
    1.16 -    a player at a time. Use IS_QUERYING_CLIENT_CVAR to check if another
    1.17 -    plugin is querying before you do so.
    1.18 +    Added 2005-08-11, no SDK update. (Available in patched SDK as of
    1.19 +    hlsdk-2.3-p2.)
    1.20 +
    1.21 +    Use of this function is DEPRECATED. It has been obsoleted by the
    1.22 +    pfnCvarValue2() function. See below.
    1.23  
    1.24  --------------------------------------------------------------------------
    1.25 +
    1.26 +CvarValue2
    1.27 +
    1.28 +void (*pfnCvarValue2)( const edict_t *pEnt, int requestID, const char
    1.29 +*cvarName, const char *value );
    1.30 +
    1.31 +from [email protected], via HLCoders:
    1.32 +
    1.33 +    When the pfnQueryClientCvarValue2() completes it will call
    1.34 +    pfnCvarValue2() with the request ID you supplied earlier, the name of
    1.35 +    the cvar you requested and the value of that cvar. On failure (i.e
    1.36 +    that user is not connected or the cvar does not exist) the value of
    1.37 +    the returned cvar will be "Bad CVAR request". If you specify an
    1.38 +    invalid player edict you will get "Bad Player" as the value response.
    1.39 +    If a client has a cvar value set to "Bad CVAR request" it cannot be
    1.40 +    differentiated from a bad request for a cvar. This is considered okay
    1.41 +    because that value is not considered to be useful as a valid cvar
    1.42 +    value.
    1.43 +
    1.44 +comments:
    1.45 +
    1.46 +    Added 2005-11-22, no SDK update. (Available in patched SDK as of
    1.47 +    hlsdk-2.3-p3.)
    1.48 +
    1.49 +--------------------------------------------------------------------------