Added documentation for set_spray_settings

This commit is contained in:
NovaRain
2023-05-18 22:52:00 +08:00
parent a3cfc481a5
commit 37e7af2a17
2 changed files with 23 additions and 3 deletions
+11 -1
View File
@@ -703,7 +703,7 @@
items:
- name: metarule2_explosions
detail: int metarule2_explosions(int arg1, int arg2)
doc: Was made as a dirty easy hack to allow dynamically change some explosion parameters (ranged attack). All changed parameters are reset to vanilla state automatically after each attack action.
doc: Was made as a dirty easy hack to allow to dynamically change some explosion parameters (ranged attack). All changed parameters are automatically reset to vanilla state after each attack action.
opcode: 0x8261
- name: set_attack_explosion_pattern
@@ -1556,6 +1556,16 @@
opcode: 0x8192
doc: Should only be used during the target critters turn while in combat.
- name: set_spray_settings
detail: void set_spray_settings(int centerMult, int centerDiv, int targetMult, int targetDiv)
doc: |
Allows to dynamically change the multipilers and divisors for the bullet distribution of burst attacks. All settings are automatically reset to default values (**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` with **CheckWeaponAmmoCost=1** in ddraw.ini)
- `centerDiv/targetDiv`: the minimum value of divisor is 1
- `centerMult/targetMult`: multiplier values are capped at divisor values
- __NOTE:__ refer to the description of **ComputeSpray_\*** settings in ddraw.ini for details of the bullet distribution of burst attacks
macro: sfall.h
- name: Car
items:
- name: set_car_current_town