mirror of
https://github.com/sfall-team/sfall.git
synced 2026-07-27 16:52:34 -07:00
NovaRain
f7d94e16c9
* before the amount was set in the dropped object only after the hook. Edits to hook script documents.
35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
---
|
|
title: Hooks
|
|
nav_order: 2
|
|
has_children: true
|
|
permalink: /hooks/
|
|
---
|
|
|
|
# Hooks
|
|
|
|
Hook scripts are specially named scripts that are run by sfall at specific points to allow mods to override normally hardcoded behaviour in a more flexible way than sfall's normal ini configuration.
|
|
|
|
In addition to the bit of code it overrides, the script will be run once when first loaded and again at each player reload to allow for setup. Hook scripts have access to a set of arguments supplied to sfall, but aren't required to use them all. They also return one or more values, but again they're optional, and you only need to return a value if you want to override the default.
|
|
|
|
See [hook types]({{ site.baseurl }}/hook-types/) and hook [functions reference]({{ site.baseurl }}/hook-functions/) for details.
|
|
|
|
## Hooks compatibility
|
|
|
|
To aid in mods compatibility, avoid using the predefined `hs_<name>.int` scripts. Instead it is recommended to use a normal global script combined with [register_hook_proc]({{ site.baseurl }}/hook-functions/#register_hook_proc) or [register_hook]({{ site.baseurl }}/hook-functions/#register_hook).
|
|
|
|
Example setup for a hook-script based mod:
|
|
|
|
```js
|
|
procedure tohit_hook_handler begin
|
|
display_msg("Modifying hit_hook " + get_sfall_arg);
|
|
set_hit_chance_max(100);
|
|
set_sfall_return(100);
|
|
end
|
|
|
|
procedure start begin
|
|
if game_loaded then begin
|
|
register_hook_proc(HOOK_TOHIT, tohit_hook_handler);
|
|
end
|
|
end
|
|
```
|