reHLDS/reapi
2
0
Fork 0
mirror of https://github.com/rehlds/reapi.git synced 2025-01-16 00:28:17 +03:00
Code Issues Projects Releases Wiki Activity

Add more comments

Browse Source
This commit is contained in:
s1lent 2017-10-03 18:47:17 +07:00
parent b67d82af85
commit e52b83d873
No known key found for this signature in database
GPG Key ID: 0FE401DC73916B5C
2 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
reapi/extra/amxmodx/scripting/include/reapi_gamedll.inc
View File

@ -11,6 +11,8 @@
* *
* @param entity Entity index * @param entity Entity index
* @param callback The forward to call * @param callback The forward to call
* @param params Optional set of data to pass through to callback
* @param len Optional size of data
* *
* @note Use "" to reset callback * @note Use "" to reset callback
* @note Callback should be contains passing arguments as "public Think_Callback(const ent)" * @note Callback should be contains passing arguments as "public Think_Callback(const ent)"
@ -24,6 +26,8 @@ native SetThink(const ent, const callback[], const params[] = "", const len = 0)
* *
* @param entity Entity index * @param entity Entity index
* @param callback The forward to call * @param callback The forward to call
* @param params Optional set of data to pass through to callback
* @param len Optional size of data
* *
* @note Use "" to reset callback * @note Use "" to reset callback
* @note Callback should be contains passing arguments as "public Touch_Callback(const ent, const other)" * @note Callback should be contains passing arguments as "public Touch_Callback(const ent, const other)"
@ -37,6 +41,8 @@ native SetTouch(const ent, const callback[], const params[] = "", const len = 0)
* *
* @param entity Entity index * @param entity Entity index
* @param callback The forward to call * @param callback The forward to call
* @param params Optional set of data to pass through to callback
* @param len Optional size of data
* *
* @note Use "" to reset callback * @note Use "" to reset callback
* @note Callback should be contains passing arguments as "public Use_Callback(const ent, const activator, const caller, USE_TYPE:useType, Float:value)" * @note Callback should be contains passing arguments as "public Use_Callback(const ent, const activator, const caller, USE_TYPE:useType, Float:value)"
@ -50,6 +56,8 @@ native SetUse(const ent, const callback[], const params[] = "", const len = 0);
* *
* @param entity Entity index * @param entity Entity index
* @param callback The forward to call * @param callback The forward to call
* @param params Optional set of data to pass through to callback
* @param len Optional size of data
* *
* @note Use "" to reset callback * @note Use "" to reset callback
* @note Callback should be contains passing arguments as "public Blocked_Callback(const ent, const other)" * @note Callback should be contains passing arguments as "public Blocked_Callback(const ent, const other)"
@ -63,10 +71,12 @@ native SetBlocked(const ent, const callback[], const params[] = "", const len =
* *
* @param entity Entity index * @param entity Entity index
* @param callback The forward to call * @param callback The forward to call
* @param params Optional set of data to pass through to callback
* @param len Optional size of data
* *
* @note Use "" to reset callback * @note Use "" to reset callback
* @note Entity should be inherited from CBaseToggle, otherwise server can crash * @note Entity should be inherited from CBaseToggle, otherwise server can crash
* @note Callback should be contains passing arguments as "public MoveDone_Callback(const ent, const other)" * @note Callback should be contains passing arguments as "public MoveDone_Callback(const ent)"
* *
* @noreturn * @noreturn
*/ */

12
reapi/src/natives/natives_common.cpp
View File

@ -260,6 +260,8 @@ cell AMX_NATIVE_CALL amx_GetAttachment(AMX *amx, cell *params)
* *
* @param entity Entity index * @param entity Entity index
* @param callback The forward to call * @param callback The forward to call
* @param params Optional set of data to pass through to callback
* @param len Optional size of data
* *
* @note Use "" to reset callback * @note Use "" to reset callback
* @note Callback should be contains passing arguments as "public Think_Callback(const ent)" * @note Callback should be contains passing arguments as "public Think_Callback(const ent)"
@ -301,6 +303,8 @@ cell AMX_NATIVE_CALL amx_SetThink(AMX *amx, cell *params)
* *
* @param entity Entity index * @param entity Entity index
* @param callback The forward to call * @param callback The forward to call
* @param params Optional set of data to pass through to callback
* @param len Optional size of data
* *
* @note Use "" to reset callback * @note Use "" to reset callback
* @note Callback should be contains passing arguments as "public Touch_Callback(const ent, const other)" * @note Callback should be contains passing arguments as "public Touch_Callback(const ent, const other)"
@ -342,6 +346,8 @@ cell AMX_NATIVE_CALL amx_SetTouch(AMX *amx, cell *params)
* *
* @param entity Entity index * @param entity Entity index
* @param callback The forward to call * @param callback The forward to call
* @param params Optional set of data to pass through to callback
* @param len Optional size of data
* *
* @note Use "" to reset callback * @note Use "" to reset callback
* @note Callback should be contains passing arguments as "public Use_Callback(const ent, const activator, const caller, USE_TYPE:useType, Float:value)" * @note Callback should be contains passing arguments as "public Use_Callback(const ent, const activator, const caller, USE_TYPE:useType, Float:value)"
@ -383,6 +389,8 @@ cell AMX_NATIVE_CALL amx_SetUse(AMX *amx, cell *params)
* *
* @param entity Entity index * @param entity Entity index
* @param callback The forward to call * @param callback The forward to call
* @param params Optional set of data to pass through to callback
* @param len Optional size of data
* *
* @note Use "" to reset callback * @note Use "" to reset callback
* @note Callback should be contains passing arguments as "public Blocked_Callback(const ent, const other)" * @note Callback should be contains passing arguments as "public Blocked_Callback(const ent, const other)"
@ -424,10 +432,12 @@ cell AMX_NATIVE_CALL amx_SetBlocked(AMX *amx, cell *params)
* *
* @param entity Entity index * @param entity Entity index
* @param callback The forward to call * @param callback The forward to call
* @param params Optional set of data to pass through to callback
* @param len Optional size of data
* *
* @note Use "" to reset callback * @note Use "" to reset callback
* @note Entity should be inherited from CBaseToggle, otherwise server can crash * @note Entity should be inherited from CBaseToggle, otherwise server can crash
* @note Callback should be contains passing arguments as "public MoveDone_Callback(const ent, const other)" * @note Callback should be contains passing arguments as "public MoveDone_Callback(const ent)"
* *
* @noreturn * @noreturn
* *