OrdinaryMagician/swwmgz_m
OrdinaryMagician/swwmgz_m
1
Fork 0
Code Activity

Update notes for mappers.

Browse source
This commit is contained in:
Mari the Deer 2024-05-06 09:33:38 +02:00
commit 450865322f
2 changed files with 13 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

16
MAPPING.md
View file

@ -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:**<br/>`CallACS("SWWMHandler","ToggleStore",#)`<br/>Passing **0** disables the store, any other number will enable it again.
- **Reviving:**<br/>`CallACS("SWWMHandler","ToggleRevive",#)`<br/>Passing **0** disables reviving, any other number will enable it again.
- **Store:**<br/>`ScriptCall("SWWMHandler","ToggleStore",#)`<br/>Passing **0** disables the store, any other number will enable it again.
- **Reviving:**<br/>`ScriptCall("SWWMHandler","ToggleRevive",#)`<br/>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:**<br/>`CallACS("SWWMMissionLog","AddLog","YOUR TEXT HERE")`<br/>Prefixed LANGUAGE entries are supported.
- **Setting the date and time:**<br/>`CallACS("SWWMMissionLog","SetClock",year,month,day,hour,minute,"timezone")`<br/>Note that month and day start counting from zero, not one *(for programming-related reasons)*.<br/>Please use abbreviations for timezones *(e.g.: EST, CET)*.
- **Adding a new entry:**<br/>`ScriptCall("SWWMMissionLog","AddLog","YOUR TEXT HERE")`<br/>Prefixed LANGUAGE entries are supported.
- **Setting the date and time:**<br/>`ScriptCall("SWWMMissionLog","SetClock",year,month,day,hour,minute,"timezone")`<br/>Note that month and day start counting from zero, not one *(for programming-related reasons)*.<br/>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.