Flummi/amxmodx
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ham_const: Fix up headings for proper display in api reference

Browse Source
This commit is contained in:
Valentin Grünbacher 2014-08-04 19:39:40 +02:00
parent b5aef1856d
commit bc3808cb3f
1 changed files with 54 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
plugins/include/ham_const.inc
View File

@ -6,9 +6,9 @@
/**
* Ham return types.
*
* Return these from hooks to disable calling the target function.
* Numbers match up with fakemeta's FMRES_* for clarity. They are interchangable.
* 0 (or no return) is also interpretted as HAM_IGNORED.
* @note Return these from hooks to disable calling the target function.
* Numbers match up with fakemeta's FMRES_* for clarity. They are
* interchangable. 0 (or no return) is also interpretted as HAM_IGNORED.
*/
#define HAM_IGNORED 1 /**< Calls target function, returns normal value */
#define HAM_HANDLED 2 /**< Tells the module you did something, still calls target function and returns normal value */
@ -16,24 +16,21 @@
#define HAM_SUPERCEDE 4 /**< Block the target call, and use your return value (if applicable) (Set with SetHamReturn*()) */
/**
* A few notes about all of the following functions:
* - Not all functions will do as you expect on all mods.
* If a function does not do what you would believe it should
* DO NOT file a bug report, you will be ignored.
* List of virtual functions made available through the hamsandwich module.
*
* - Passing invalid parameters has potential to crash the server
* So be careful, and adequately test!
*
* - All functions take (and pass) a "this" index as the first param.
* @note Not all functions will do as you expect on all mods. If a function does
* not do what you would believe it should DO NOT file a bug report, you
* will be ignored.
* @note Passing invalid parameters has potential to crash the server, so be
* careful, and test carefully and adequately!
* @note All functions take (and pass) a "this" index as the first param.
* This is the entity from which the function is being executed on.
*
* - All functions and forwards (eg: {Register,Execute}Ham[B]) require
* @note All functions and forwards (eg: {Register,Execute}Ham[B]) require
* the mod to have the pev and base keys in addition to the function
* keys for the corresponding mod/operating system in hamdata.ini
*
* - Some functions that return booleans may need to be logically ANDed
* to get the results desired. e.g: if (ExecuteHam(Ham_TS_IsObjective, this) & 0x0000FFFF != 0) { // true.. }
* because the module will return the full integer value.
* @note Some functions that return booleans may need to be logically ANDed
* to get the desired results because the mod will return the full integer
* value. E.g.: (ExecuteHam(Ham_TS_IsObjective, this) & 0x0000FFFF) != 0
*/
enum Ham
@ -3723,7 +3720,7 @@ enum Ham
};
/**
* Ham errors types.
* Ham error types.
*/
enum HamError
{
@ -3736,8 +3733,7 @@ enum HamError
};
/**
* To be used with [Get|Set]HamItemInfo.
* Ham prefix to avoid collision. :(
* Constants for usage with [Get|Set]HamItemInfo
*/
enum HamItemInfo
{