release:zzt_enhancer:oop_enhancements
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
release:zzt_enhancer:oop_enhancements [2021/05/28 21:25] – asie | release:zzt_enhancer:oop_enhancements [2021/05/29 10:47] (current) – asie | ||
---|---|---|---|
Line 8: | Line 8: | ||
* ZZT Enhancer commands are prefixed with ''' | * ZZT Enhancer commands are prefixed with ''' | ||
+ | * Variables must always be specified in quotes, like ''' | ||
===== Variables ===== | ===== Variables ===== | ||
Line 13: | Line 14: | ||
TODO (potential names: '' | TODO (potential names: '' | ||
- | ===== Commands | + | ===== String IDs ===== |
- | ==== ne, sw, se, nw ==== | + | ^ ID ^ String ^ |
+ | | 7 | '' | ||
+ | | 8 | '' | ||
+ | | 11 | '' | ||
+ | | 25 | '' | ||
- | TODO | + | TODO: Complete list. |
- | ==== tn, ts, te, tw ==== | + | ===== Commands ===== |
+ | |||
+ | ==== n, s, e, w, ne, sw, se, nw ==== | ||
+ | |||
+ | Move while preserving background color. | ||
TODO | TODO | ||
- | ==== tne, tsw, tse, tnw ==== | + | ==== tn, ts, te, tw, tne, tsw, tse, tnw ==== |
TODO | TODO | ||
Line 33: | Line 42: | ||
==== add ==== | ==== add ==== | ||
- | Takes two arguments. | + | Syntax: '' |
+ | |||
+ | Adds '' | ||
==== addcstat ==== | ==== addcstat ==== | ||
- | Takes five arguments. | + | Syntax: '' |
+ | |||
+ | Adds a stat to the sidebar, at Y position '' | ||
==== allocscreen ==== | ==== allocscreen ==== | ||
- | Takes one argument. | + | Syntax: '' |
+ | |||
+ | Allocate '' | ||
==== becomeb ==== | ==== becomeb ==== | ||
- | Takes two arguments. | + | Syntax: '' |
+ | |||
+ | Becomes a statless '' | ||
==== becomeo ==== | ==== becomeo ==== | ||
- | Takes five arguments. | + | Syntax: '' |
+ | |||
+ | Becomes a statted element with the specified parameters. | ||
==== bgfade ==== | ==== bgfade ==== | ||
Line 65: | Line 84: | ||
==== changeb ==== | ==== changeb ==== | ||
- | Takes four arguments. | + | Syntax: '' |
+ | |||
+ | Changes all instances of a given element ID and color to the other element ID and color. ? may be used as a wildcard in from_color. Faster than ZZT ''# | ||
+ | |||
+ | TODO: Can ? be used elsewhere? | ||
==== charedit ==== | ==== charedit ==== | ||
Line 73: | Line 96: | ||
==== charid ==== | ==== charid ==== | ||
- | Takes two arguments. | + | Syntax: '' |
+ | |||
+ | Changes the rendering character for '' | ||
+ | |||
+ | TODO: Does this work on elements with custom rendering logic? (Text, objects, etc.) | ||
==== chstr ==== | ==== chstr ==== | ||
- | Takes one argument. | + | Syntax: '' |
+ | |||
+ | Replaces the string with ID '' | ||
==== color, colour ==== | ==== color, colour ==== | ||
- | Takes one argument. | + | Syntax: '' |
+ | |||
+ | Sets the color value of the tile to '' | ||
==== colorxy, colourxy ==== | ==== colorxy, colourxy ==== | ||
Line 89: | Line 120: | ||
==== cropscreen ==== | ==== cropscreen ==== | ||
- | Takes seven arguments. | + | Syntax: '' |
+ | |||
+ | TODO | ||
==== defaultpal ==== | ==== defaultpal ==== | ||
Line 97: | Line 130: | ||
==== delete ==== | ==== delete ==== | ||
- | Takes one argument. | + | Syntax: '' |
+ | |||
+ | Deletes the variable ''" | ||
+ | |||
+ | ==== deletecstat ==== | ||
+ | |||
+ | Seemingly **not implemented** as of Enhancer 0.3b. TODO: Verify | ||
+ | |||
+ | Syntax: '' | ||
+ | |||
+ | Removes the custom stat at '' | ||
==== dieitem ==== | ==== dieitem ==== | ||
- | Takes no arguments. | + | Syntax: '' |
+ | |||
+ | Destroys the object and moves stat 0 - the player - to its location. | ||
==== divide ==== | ==== divide ==== | ||
- | Takes two arguments. | + | Syntax: '' |
+ | |||
+ | Divides ''" | ||
==== dualfont ==== | ==== dualfont ==== | ||
Line 116: | Line 163: | ||
==== enhance ==== | ==== enhance ==== | ||
+ | |||
+ | Syntax: '' | ||
TODO | TODO | ||
Line 137: | Line 186: | ||
==== freescreen ==== | ==== freescreen ==== | ||
- | Takes no arguments. | + | Syntax: '' |
+ | |||
+ | Deallocate all allocated screens. The opposite of '' | ||
==== freewav ==== | ==== freewav ==== | ||
Line 164: | Line 215: | ||
==== ifat ==== | ==== ifat ==== | ||
- | Takes four arguments. | + | Syntax: '' |
+ | |||
+ | If, at location '' | ||
==== ifbup ==== | ==== ifbup ==== | ||
Line 212: | Line 265: | ||
==== loadscreenres ==== | ==== loadscreenres ==== | ||
- | Takes two arguments. | + | Syntax: '' |
+ | |||
+ | Loads screen from resource '' | ||
==== loadwav ==== | ==== loadwav ==== | ||
Line 240: | Line 295: | ||
==== moveplayer ==== | ==== moveplayer ==== | ||
- | Takes two arguments. | + | Syntax: '' |
+ | |||
+ | Moves the player to location '' | ||
==== moveplayerhere ==== | ==== moveplayerhere ==== | ||
Line 248: | Line 305: | ||
==== multiply ==== | ==== multiply ==== | ||
- | Takes two arguments. | + | TODO: Is mul also valid? |
+ | |||
+ | Syntax: '' | ||
+ | |||
+ | Multiplies ''" | ||
==== playerchar ==== | ==== playerchar ==== | ||
- | Takes one argument. | + | Syntax: '' |
+ | |||
+ | Sets the player character to '' | ||
==== playercharn, | ==== playercharn, | ||
Line 260: | Line 323: | ||
==== playercol ==== | ==== playercol ==== | ||
- | Takes one argument. | + | Syntax: '' |
+ | |||
+ | Sets the player color to '' | ||
==== playsong ==== | ==== playsong ==== | ||
- | Takes no arguments. | + | Syntax: '' |
+ | |||
+ | Plays the song '' | ||
==== playsongres ==== | ==== playsongres ==== | ||
- | Takes one argument. | + | Syntax: '' |
+ | |||
+ | Playes the song at asset index '' | ||
==== playwav ==== | ==== playwav ==== | ||
Line 276: | Line 345: | ||
==== putblock ==== | ==== putblock ==== | ||
- | Takes four arguments. | + | Syntax: '' |
+ | |||
+ | Place a statless '' | ||
==== putcolor, putcolour ==== | ==== putcolor, putcolour ==== | ||
Line 288: | Line 359: | ||
==== putobj ==== | ==== putobj ==== | ||
- | Takes seven arguments. | + | Syntax: '' |
+ | |||
+ | Place a statted element with the specified parameters at location '' | ||
==== putobjup ==== | ==== putobjup ==== | ||
- | Takes five arguments. | + | Syntax: '' |
+ | |||
+ | TODO | ||
==== putsave ==== | ==== putsave ==== | ||
Line 300: | Line 375: | ||
==== puttext ==== | ==== puttext ==== | ||
- | Takes three arguments. | + | Syntax: '' |
+ | |||
+ | Puts the "'' | ||
==== putval ==== | ==== putval ==== | ||
Line 313: | Line 390: | ||
Takes the following types of arguments: '' | Takes the following types of arguments: '' | ||
+ | |||
+ | Makes future "x, y" location arguments be calculated relative to the provided target. | ||
==== restorescreen ==== | ==== restorescreen ==== | ||
- | Takes three arguments. | + | Syntax: '' |
+ | |||
+ | Restores the screen slot '' | ||
==== rgb ==== | ==== rgb ==== | ||
- | Takes four arguments. | + | Syntax: '' |
+ | |||
+ | Set the color '' | ||
==== savescreen ==== | ==== savescreen ==== | ||
- | Takes five arguments. | + | Syntax: '' |
+ | |||
+ | Saves the screen area from ('' | ||
==== scrollchar ==== | ==== scrollchar ==== | ||
Line 336: | Line 421: | ||
==== set ==== | ==== set ==== | ||
- | Takes two arguments. | + | Syntax: '' |
+ | |||
+ | Sets the variable ''" | ||
==== setcoli ==== | ==== setcoli ==== | ||
- | Takes two arguments. | + | Syntax: '' |
+ | |||
+ | Sets the intensity of color '' | ||
==== setmusicvol ==== | ==== setmusicvol ==== | ||
- | Takes one argument. | + | Syntax: '' |
+ | |||
+ | Sets the music volume to '' | ||
==== setpali ==== | ==== setpali ==== | ||
- | Takes one argument. | + | Syntax: '' |
+ | |||
+ | Sets the global palette intensity to '' | ||
==== setsongpos ==== | ==== setsongpos ==== | ||
Line 368: | Line 461: | ||
==== stopsong ==== | ==== stopsong ==== | ||
- | Takes no arguments. | + | Stops the currently playing song. |
==== subtract ==== | ==== subtract ==== | ||
- | Takes two arguments. | + | Syntax: '' |
+ | |||
+ | Subtracts '' | ||
==== teleport ==== | ==== teleport ==== | ||
Line 392: | Line 487: | ||
==== walk ==== | ==== walk ==== | ||
- | Takes two arguments. | + | Syntax: '' |
+ | |||
+ | Sets the walking direction to '' | ||
==== walkxy ==== | ==== walkxy ==== | ||
Takes four arguments. | Takes four arguments. |
release/zzt_enhancer/oop_enhancements.1622237108.txt.gz · Last modified: 2021/05/28 21:25 by asie