From 0604112a2e48f9279609e7b1ec8fa5eff33cfcec Mon Sep 17 00:00:00 2001 From: NovaRain Date: Wed, 22 Jan 2025 21:37:06 +0800 Subject: [PATCH] Edits to function documents --- artifacts/scripting/functions.yml | 4 ++-- artifacts/scripting/sfall function notes.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/artifacts/scripting/functions.yml b/artifacts/scripting/functions.yml index 01fb65ce..be0c178c 100644 --- a/artifacts/scripting/functions.yml +++ b/artifacts/scripting/functions.yml @@ -940,7 +940,7 @@ - name: inc_npc_level detail: void inc_npc_level(int party_member_pid) opcode: 0x81a5 - doc: Takes a party member PID or an NPC name (deprecated, for compatibility with sfall 4.1.5/3.8.15 or earlier) as an argument. The NPC must be in your party. This function ignores player level requirements and the minimum 3 player level delay between NPC level gains. It also ignores the random element, regardless of sfall's `NPCAutoLevel` setting. + doc: Takes a party member PID or an NPC name (deprecated, for compatibility with sfall 4.1.5/3.8.15 or earlier) as an argument. The NPC must be in your party. This function ignores player level requirements and the minimum 3 player level delay between NPC level gains. It also ignores the random element, regardless of sfall's `NPCAutoLevel` or `PartyMemberNonRandomLevelUp` setting. - name: get_npc_level detail: int get_npc_level(string npc) opcode: 0x8241 @@ -1654,7 +1654,7 @@ - name: set_spray_settings detail: void set_spray_settings(int centerMult, int centerDiv, int targetMult, int targetDiv) doc: | - Allows changing the multipliers and divisors for the bullet distribution of burst attacks dynamically. All settings are automatically reset to default values (**ComputeSpray_\*** settings in ddraw.ini) after each attack action + Allows changing the multipliers and divisors for the bullet distribution of burst attacks dynamically. All settings are automatically reset to default values (i.e. **ComputeSpray_\*** settings in ddraw.ini) after each attack action - Should be called before the calculation of the bullet distribution (e.g. in `HOOK_TOHIT` or `HOOK_AMMOCOST`) - `centerDiv/targetDiv`: the minimum value of divisor is 1 - `centerMult/targetMult`: multiplier values are capped at divisor values diff --git a/artifacts/scripting/sfall function notes.md b/artifacts/scripting/sfall function notes.md index 11f57a8e..2212fb65 100644 --- a/artifacts/scripting/sfall function notes.md +++ b/artifacts/scripting/sfall function notes.md @@ -111,7 +111,7 @@ FUNCTION REFERENCE ----- ##### `void inc_npc_level(int pid/string name)` - Takes a party member PID or an NPC name (deprecated, for compatibility with sfall 4.1.5/3.8.15 or earlier) as an argument. The NPC must be in your party. -- This function ignores player level requirements and the minimum 3 player level delay between NPC level gains. It also ignores the random element, regardless of sfall's **NPCAutoLevel** setting. +- This function ignores player level requirements and the minimum 3 player level delay between NPC level gains. It also ignores the random element, regardless of sfall's **NPCAutoLevel** or **PartyMemberNonRandomLevelUp** setting. ----- ##### `int get_npc_level(int pid/string name)` @@ -1090,7 +1090,7 @@ sfall_funcX metarule functions ##### set_spray_settings `void sfall_func4("set_spray_settings", int centerMult, int centerDiv, int targetMult, int targetDiv)` -- Allows changing the multipliers and divisors for the bullet distribution of burst attacks dynamically. All settings are automatically reset to default values (**ComputeSpray_\*** settings in **ddraw.ini**) after each attack action +- Allows changing the multipliers and divisors for the bullet distribution of burst attacks dynamically. All settings are automatically reset to default values (i.e. **ComputeSpray_\*** settings in **ddraw.ini**) after each attack action - Should be called before the calculation of the bullet distribution (e.g. in `HOOK_TOHIT` or `HOOK_AMMOCOST`) - `centerDiv/targetDiv`: the minimum value of divisor is 1 - `centerMult/targetMult`: multiplier values are capped at divisor values