From 17332379cb4539ffb063911b583f28a2024f3c9d Mon Sep 17 00:00:00 2001 From: Drifter Date: Mon, 29 Jan 2018 12:36:26 -0500 Subject: [PATCH] Update documentation. --- natives.cpp | 8 ++++---- sourcemod/scripting/include/dhooks.inc | 12 +++++++----- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/natives.cpp b/natives.cpp index 03b472f..a0beda4 100644 --- a/natives.cpp +++ b/natives.cpp @@ -35,7 +35,7 @@ IPluginFunction *GetCallback(IPluginContext *pContext, HookSetup * setup, const return ret; } -//native Handle:DHookCreate(offset, HookType:hooktype, ReturnType:returntype, ThisPointerType:thistype, DHookCallback:callback); +//native Handle:DHookCreate(offset, HookType:hooktype, ReturnType:returntype, ThisPointerType:thistype, DHookCallback:callback = INVALID_FUNCTION); // Callback is now optional here. cell_t Native_CreateHook(IPluginContext *pContext, const cell_t *params) { HookSetup *setup = new HookSetup((ReturnType)params[3], PASSFLAG_BYVAL, (HookType)params[2], (ThisPointerType)params[4], params[1], pContext->GetFunctionById(params[5])); @@ -92,7 +92,7 @@ cell_t Native_AddParam(IPluginContext *pContext, const cell_t *params) return 1; } -// native DHookEntity(Handle:setup, bool:post, entity, DHookRemovalCB:removalcb, DHookCallback:callback); +// native DHookEntity(Handle:setup, bool:post, entity, DHookRemovalCB:removalcb, DHookCallback:callback = INVALID_FUNCTION); // Both callbacks are optional cell_t Native_HookEntity(IPluginContext *pContext, const cell_t *params) { HookSetup *setup; @@ -142,7 +142,7 @@ cell_t Native_HookEntity(IPluginContext *pContext, const cell_t *params) return manager->hookid; } -// native DHookGamerules(Handle:setup, bool:post, DHookRemovalCB:removalcb, DHookCallback:callback); +// native DHookGamerules(Handle:setup, bool:post, DHookRemovalCB:removalcb, DHookCallback:callback = INVALID_FUNCTION); // Both callbacks are optional cell_t Native_HookGamerules(IPluginContext *pContext, const cell_t *params) { HookSetup *setup; @@ -194,7 +194,7 @@ cell_t Native_HookGamerules(IPluginContext *pContext, const cell_t *params) return manager->hookid; } -// DHookRaw(Handle:setup, bool:post, Address:addr, DHookRemovalCB:removalcb, DHookCallback:callback); +// DHookRaw(Handle:setup, bool:post, Address:addr, DHookRemovalCB:removalcb, DHookCallback:callback = INVALID_FUNCTION); // Both callbacks are optional cell_t Native_HookRaw(IPluginContext *pContext, const cell_t *params) { HookSetup *setup; diff --git a/sourcemod/scripting/include/dhooks.inc b/sourcemod/scripting/include/dhooks.inc index 381e55f..604b186 100644 --- a/sourcemod/scripting/include/dhooks.inc +++ b/sourcemod/scripting/include/dhooks.inc @@ -170,7 +170,7 @@ native bool DHookRemoveEntityListener(ListenType type, ListenCB callback); * @param hooktype Type of hook * @param returntype Type type of return * @param thistype Type of this pointer or ignore (ignore can be used if not needed) - * @param callback Callback function + * @param callback Optional callback function, if not set here must be set when hooking. * * @return Returns setup handle for the hook or INVALID_HANDLE. */ @@ -187,7 +187,6 @@ native Handle DHookCreate(int offset, HookType hooktype, ReturnType returntype, * @noreturn */ native void DHookAddParam(Handle setup, HookParamType type, int size=-1, DHookPassFlag flag=DHookPass_ByVal); -//native DHookAddParam(Handle:setup, HookParamType:type); /* Hook entity * @@ -195,8 +194,9 @@ native void DHookAddParam(Handle setup, HookParamType type, int size=-1, DHookPa * @param post True to make the hook a post hook. (If you need to change the retunr value or need the return value use a post hook! If you need to change params and return use a pre and post hook!) * @param entity Entity index to hook on. * @param removalcb Callback for when the hook is removed (Entity hooks are auto-removed on entity destroyed and will call this callback) + * @param callback Optional callback function, if not set here must be set when creating the hook. * - * @error Invalid setup handle, invalid entity or invalid hook type. + * @error Invalid setup handle, invalid address, invalid hook type or invalid callback. * @return -1 on fail a hookid on success */ native int DHookEntity(Handle setup, bool post, int entity, DHookRemovalCB removalcb=INVALID_FUNCTION, DHookCallback callback=INVALID_FUNCTION); @@ -206,8 +206,9 @@ native int DHookEntity(Handle setup, bool post, int entity, DHookRemovalCB remov * @param setup Setup handle to use to add the hook. * @param post True to make the hook a post hook. (If you need to change the retunr value or need the return value use a post hook! If you need to change params and return use a pre and post hook!) * @param removalcb Callback for when the hook is removed (Game rules hooks are auto-removed on map end and will call this callback) + * @param callback Optional callback function, if not set here must be set when creating the hook. * - * @error Invalid setup handle, failing to get gamerules pointer or invalid hook type. + * @error Invalid setup handle, invalid address, invalid hook type or invalid callback. * @return -1 on fail a hookid on success */ native int DHookGamerules(Handle setup, bool post, DHookRemovalCB removalcb=INVALID_FUNCTION, DHookCallback callback=INVALID_FUNCTION); @@ -218,8 +219,9 @@ native int DHookGamerules(Handle setup, bool post, DHookRemovalCB removalcb=INVA * @param post True to make the hook a post hook. (If you need to change the retunr value or need the return value use a post hook! If you need to change params and return use a pre and post hook!) * @param addr This pointer address. * @param removalcb Callback for when the hook is removed (Entity hooks are auto-removed on entity destroyed and will call this callback) + * @param callback Optional callback function, if not set here must be set when creating the hook. * - * @error Invalid setup handle, invalid address or invalid hook type. + * @error Invalid setup handle, invalid address, invalid hook type or invalid callback. * @return -1 on fail a hookid on success */ native int DHookRaw(Handle setup, bool post, Address addr, DHookRemovalCB removalcb=INVALID_FUNCTION, DHookCallback callback=INVALID_FUNCTION);