From 81daaba3eac6c7f3b912d2ea1fd964b33aebcd7a Mon Sep 17 00:00:00 2001 From: Grim <69561145+LinkIsGrim@users.noreply.github.com> Date: Sat, 9 Sep 2023 00:21:00 -0400 Subject: [PATCH] Docs - Add note in documentation regarding medical internal variables (#9373) * add note in documentation * Update docs/wiki/framework/medical-framework.md Co-authored-by: jonpas * Update medical-framework.md --------- Co-authored-by: jonpas --- docs/wiki/framework/medical-framework.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/wiki/framework/medical-framework.md b/docs/wiki/framework/medical-framework.md index 629b57cfd0..834eeced80 100644 --- a/docs/wiki/framework/medical-framework.md +++ b/docs/wiki/framework/medical-framework.md @@ -214,7 +214,7 @@ class ACE_Medical_Injuries { ``` {% endraw %} -## 4.4 Wound Handler Function +### 4.4 Wound Handler Function Custom wound handlers should follow the same spec as the built-in handler: `ace_medical_damage_fnc_woundsHandlerBase` @@ -236,3 +236,8 @@ The damage elements are sorted in descending order according to how much damage 0 | `player` | Unit that was hit 1 | `[[0.5, "Body", 1], [0.3, "Head", 0.6]]` | 0.5 damage to body (was 1 before armor), 0.3 damage to head (was 0.6 before armor) 2 | `"grenade"` | type grenade (non-selection-specific) + +## 5. Tweaking internal variables +Some of ACE Medical's underlying behavior, primarily related to damage handling and the vitals loop, can be fine-tuned by editing `ace_medical_const_` variables, found in [script_macros_medical.hpp](https://github.com/acemod/ACE3/blob/master/addons/medical_engine/script_macros_medical.hpp). + +Modification of those values should be done by advanced users only. Values and variable names are subject to change without prior warning. Modifying values mid-mission may lead to undefined behavior. Expect minimal support.