Update notes for mappers.
This commit is contained in:
parent
d2bb60b559
commit
450865322f
2 changed files with 13 additions and 7 deletions
16
MAPPING.md
16
MAPPING.md
|
|
@ -1,20 +1,26 @@
|
||||||
# Notes for mappers
|
# 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
|
### Toggling features
|
||||||
|
|
||||||
- **Store:**<br/>`CallACS("SWWMHandler","ToggleStore",#)`<br/>Passing **0** disables the store, 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/>`CallACS("SWWMHandler","ToggleRevive",#)`<br/>Passing **0** disables reviving, 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.
|
**Note:** These settings will persist between level changes.
|
||||||
|
|
||||||
### Mission log
|
### Mission log
|
||||||
|
|
||||||
- **Adding a new entry:**<br/>`CallACS("SWWMMissionLog","AddLog","YOUR TEXT HERE")`<br/>Prefixed LANGUAGE entries are supported.
|
- **Adding a new entry:**<br/>`ScriptCall("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)*.
|
- **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
|
### 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.
|
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.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,3 @@
|
||||||
[default]
|
[default]
|
||||||
SWWM_MODVER="\cyDEMOLITIONIST \cw1.3pre r1129 \cu(Sat May 4 18:37:52 CEST 2024)\c-";
|
SWWM_MODVER="\cyDEMOLITIONIST \cw1.3pre r1130 \cu(Mon May 6 09:33:38 CEST 2024)\c-";
|
||||||
SWWM_SHORTVER="\cw1.3pre r1129 \cu(2024-05-04 18:37:52)\c-";
|
SWWM_SHORTVER="\cw1.3pre r1130 \cu(2024-05-06 09:33:38)\c-";
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue