Differences

This shows you the differences between two versions of the page.

--- release:zzt_enhancer:oop_enhancements [2021/05/28 21:35] – asie
+++ release:zzt_enhancer:oop_enhancements [2021/05/29 10:47] (current) – asie
@@ Line 14: / Line 14: @@
 TODO (potential names: ''lastmx'', ''lastmy'', ''songpos'', ''songrow'', ''songvol'', ''enhancer'', ''playerx'', ''playery'', ''playerdist'')
-===== Commands =====
+===== String IDs =====
-==== ne, sw, se, nw ====
+^ ID ^ String ^
+| 7 | ''Torches:'' |
+| 8 | ''   Gems:'' |
+| 11 | '' T '' |
+| 25 | '' Torch'' |
-TODO
+TODO: Complete list.
-==== tn, ts, te, tw ====
+===== Commands =====
+==== n, s, e, w, ne, sw, se, nw ====
+Move while preserving background color.
 TODO
-==== tne, tsw, tse, tnw ====
+==== tn, ts, te, tw, tne, tsw, tse, tnw ====
 TODO
@@ Line 40: / Line 48: @@
 ==== addcstat ====
-Takes five arguments.
+Syntax: ''addcstat ypos color char name "variable"''
+Adds a stat to the sidebar, at Y position ''ypos'', with an icon ''color'', ''char'', name ''name'', tracking variable ''"variable"''.
 ==== allocscreen ====
-Takes one argument.
+Syntax: ''allocscreen number_of_screens''
+Allocate ''number_of_screens'' screens, addressable from ''0'' to ''number_of_screens - 1''.
 ==== becomeb ====
-Takes two arguments.
+Syntax: ''becomeb element color''.
+Becomes a statless ''element'' of color ''color''.
 ==== becomeo ====
-Takes five arguments.
+Syntax: ''becomeo element_id color ??? ??? ???''
+Becomes a statted element with the specified parameters.
 ==== bgfade ====
@@ Line 68: / Line 84: @@
 ==== changeb ====
-Takes four arguments.
+Syntax: ''changeb from_element from_color to_element to_color''.
+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 ''#change''.
+TODO: Can ? be used elsewhere?
 ==== charedit ====
@@ Line 76: / Line 96: @@
 ==== charid ====
-Takes two arguments.
+Syntax: ''charid element_id char_id''
+Changes the rendering character for ''element_id'' to ''char_id''.
+TODO: Does this work on elements with custom rendering logic? (Text, objects, etc.)
 ==== chstr ====
-Takes one argument.
+Syntax: ''chstr string_id contents''
+Replaces the string with ID ''string_id'' with ''contents''.
 ==== color, colour ====
@@ Line 94: / Line 120: @@
 ==== cropscreen ====
-Takes seven arguments.
+Syntax: ''cropscreen screen_index x1 y1 width height x2 y2''
+TODO
 ==== defaultpal ====
@@ Line 105: / Line 133: @@
 Deletes the variable ''"variable"''.
+==== deletecstat ====
+Seemingly **not implemented** as of Enhancer 0.3b. TODO: Verify
+Syntax: ''deletecstat ypos''
+Removes the custom stat at ''ypos''.
 ==== dieitem ====
-Takes no arguments.
+Syntax: ''dieitem''
+Destroys the object and moves stat 0 - the player - to its location.
 ==== divide ====
@@ Line 125: / Line 163: @@
 ==== enhance ====
+Syntax: ''enhance [16-byte lower-case hex value]''
 TODO
@@ Line 146: / Line 186: @@
 ==== freescreen ====
-Takes no arguments.
+Syntax: ''freescreen''.
+Deallocate all allocated screens. The opposite of ''allocscreen''.
 ==== freewav ====
@@ Line 223: / Line 265: @@
 ==== loadscreenres ====
-Takes two arguments.
+Syntax: ''loadscreenres screen_index resource_index''
+Loads screen from resource ''resource_index'' to slot ''screen_index''.
 ==== loadwav ====
@@ Line 269: / Line 313: @@
 ==== playerchar ====
-Takes one argument.
+Syntax: ''playerchar char_id''.
+Sets the player character to ''char_id''.
 ==== playercharn, playerchars, playerchare, playercharw ====
@@ Line 277: / Line 323: @@
 ==== playercol ====
-Takes one argument.
+Syntax: ''playercol color''.
+Sets the player color to ''color'' (0 - 255).
 ==== playsong ====
@@ Line 287: / Line 335: @@
 ==== playsongres ====
-Takes one argument.
+Syntax: ''playsongres resource_index''.
+Playes the song at asset index ''resource_index''.
 ==== playwav ====
@@ Line 295: / Line 345: @@
 ==== putblock ====
-Takes four arguments.
+Syntax: ''putblock x y element color''.
+Place a statless ''element'' of color ''color'' at position ''x'', ''y''.
 ==== putcolor, putcolour ====
@@ Line 307: / Line 359: @@
 ==== putobj ====
-Takes seven arguments.
+Syntax: ''putobj x y element_id color ??? ??? ???''
+Place a statted element with the specified parameters at location ''x'', ''y''.
 ==== putobjup ====
-Takes five arguments.
+Syntax: ''putobjup element_id color ??? ??? ???''
+TODO
 ==== putsave ====
@@ Line 339: / Line 395: @@
 ==== restorescreen ====
-Takes three arguments.
+Syntax: ''restorescreen screen_index x y''.
+Restores the screen slot ''screen_index'' to (''x'', ''y'').
 ==== rgb ====
-Takes four arguments.
+Syntax: ''rgb id r g b''
+Set the color ''id'' to color values ''r'', ''g'', ''b'' (range 0-63).
 ==== savescreen ====
-Takes five arguments.
+Syntax: ''savescreen screen_index x1 y1 x2 y2''.
+Saves the screen area from (''x1'', ''y1'') to (''x2'', ''y2'') to the screen slot ''screen_index''.
 ==== scrollchar ====
@@ Line 425: / Line 487: @@
 ==== walk ====
-Takes two arguments.
+Syntax: ''walk x y''
+Sets the walking direction to ''x'', ''y''. For instance, ''walk -1 -1'' will cause the object to walk north-west.
 ==== walkxy ====
 Takes four arguments.