Add basic kvd doc to fakemeta.inc and fix ham_const.inc lies

This commit is contained in:
Valentin Grünbacher 2015-05-05 11:16:26 +02:00
parent 8172519389
commit 79189c86ab
2 changed files with 16 additions and 1 deletions

View File

@ -473,7 +473,22 @@ native get_kvd(kvd_handle, KeyValueData:member, any:...);
// keyvalues structure rather than changing the internal engine strings. // keyvalues structure rather than changing the internal engine strings.
native set_kvd(kvd_handle, KeyValueData:member, any:...); native set_kvd(kvd_handle, KeyValueData:member, any:...);
/**
* Creates a KeyValueData handle.
*
* @note Handles should be freed using free_kvd().
*
* @return New KeyValueData handle
*/
native create_kvd(); native create_kvd();
/**
* Frees a KeyValueData handle.
*
* @param kvd_handle KeyValueData handle
*
* @noreturn
*/
native free_kvd(kvd_handle); native free_kvd(kvd_handle);
// These functions are used with the clientdata data structure (FM_UpdateClientData) // These functions are used with the clientdata data structure (FM_UpdateClientData)

View File

@ -70,7 +70,7 @@ enum Ham
/** /**
* Description: Typically this is similar to an engine keyvalue call. * Description: Typically this is similar to an engine keyvalue call.
* Use the kvd natives from fakemeta to handle the kvd_handle passed. * Use the kvd natives from fakemeta to handle the kvd_handle passed.
* NOTE: Do not pass handle 0 to this! Use get_kvd_handle(0) from fakemeta instead! * NOTE: Do not pass handle 0 to this! Use create_kvd() from fakemeta instead!
* Forward params: function(this, kvd_handle); * Forward params: function(this, kvd_handle);
* Return type: None. * Return type: None.
* Execute params: ExecuteHam(Ham_Keyvalue, this, kvd_handle); * Execute params: ExecuteHam(Ham_Keyvalue, this, kvd_handle);