From 450865322f9f2d04de1a3a594cae2da72f77ac10 Mon Sep 17 00:00:00 2001 From: Marisa the Magician Date: Mon, 6 May 2024 09:33:38 +0200 Subject: [PATCH] Update notes for mappers. --- MAPPING.md | 16 +++++++++++----- language.version | 4 ++-- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/MAPPING.md b/MAPPING.md index 0be76b6ad..2b7c20468 100644 --- a/MAPPING.md +++ b/MAPPING.md @@ -1,20 +1,26 @@ # Notes for mappers +There's some useful functions that can be called from ACS using ScriptCall, these are documented below. *(And, since they're static functions, they can be also called from ZScript as-is)*. + ### Toggling features -- **Store:**
`CallACS("SWWMHandler","ToggleStore",#)`
Passing **0** disables the store, any other number will enable it again. -- **Reviving:**
`CallACS("SWWMHandler","ToggleRevive",#)`
Passing **0** disables reviving, any other number will enable it again. +- **Store:**
`ScriptCall("SWWMHandler","ToggleStore",#)`
Passing **0** disables the store, any other number will enable it again. +- **Reviving:**
`ScriptCall("SWWMHandler","ToggleRevive",#)`
Passing **0** disables reviving, any other number will enable it again. **Note:** These settings will persist between level changes. ### Mission log -- **Adding a new entry:**
`CallACS("SWWMMissionLog","AddLog","YOUR TEXT HERE")`
Prefixed LANGUAGE entries are supported. -- **Setting the date and time:**
`CallACS("SWWMMissionLog","SetClock",year,month,day,hour,minute,"timezone")`
Note that month and day start counting from zero, not one *(for programming-related reasons)*.
Please use abbreviations for timezones *(e.g.: EST, CET)*. +- **Adding a new entry:**
`ScriptCall("SWWMMissionLog","AddLog","YOUR TEXT HERE")`
Prefixed LANGUAGE entries are supported. +- **Setting the date and time:**
`ScriptCall("SWWMMissionLog","SetClock",year,month,day,hour,minute,"timezone")`
Note that month and day start counting from zero, not one *(for programming-related reasons)*.
Please use abbreviations for timezones *(e.g.: EST, CET)*. + +### Dialogue sequences + +It is now possible to create entirely new dialogue sequences. I have yet to document how this stuff works, as well as adding a proper interface for mappers, but if you're curious, all of the code is in the `SWWMDialogues` class. ### Custom boss healthbars -Using `CallACS("SWWMHandler","AddBoss",tid,"YOUR TAG HERE")` you can assign a group of monsters that will be treated as a boss fight, with a collective healthbar. Note that each call to this function will clear any active boss encounters. Prefixed LANGUAGE entries can be set as a tag, and the mod can automatically look up an alternative with the *"_FUN"* suffix if *"Fun Tags"* are enabled, should there be one defined. +Using `ScriptCall("SWWMHandler","AddBoss",tid,"YOUR TAG HERE")` you can assign a group of monsters that will be treated as a boss fight, with a collective healthbar. Note that each call to this function will clear any active boss encounters. Prefixed LANGUAGE entries can be set as a tag, and the mod can automatically look up an alternative with the *"_FUN"* suffix if *"Fun Tags"* are enabled, should there be one defined. An optional boolean argument can be passed that flags the boss fight as an *"end game"* boss. This serves little purpose other than allowing one specific achievement *("Kill an end-game boss with the Ynykron")* to work properly. diff --git a/language.version b/language.version index 5c48147e9..27432a707 100644 --- a/language.version +++ b/language.version @@ -1,3 +1,3 @@ [default] -SWWM_MODVER="\cyDEMOLITIONIST \cw1.3pre r1129 \cu(Sat May 4 18:37:52 CEST 2024)\c-"; -SWWM_SHORTVER="\cw1.3pre r1129 \cu(2024-05-04 18:37:52)\c-"; +SWWM_MODVER="\cyDEMOLITIONIST \cw1.3pre r1130 \cu(Mon May 6 09:33:38 CEST 2024)\c-"; +SWWM_SHORTVER="\cw1.3pre r1130 \cu(2024-05-06 09:33:38)\c-";