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:24] – asie
@@ Line 13: / Line 13: @@
 TODO (potential names: ''lastmx'', ''lastmy'', ''songpos'', ''songrow'', ''songvol'', ''enhancer'', ''playerx'', ''playery'', ''playerdist'')
+===== String IDs =====
+^ ID ^ String ^
+| 7 | ''Torches:'' |
+| 8 | ''   Gems:'' |
+| 11 | '' T '' |
+| 25 | '' Torch'' |
+TODO: Complete list.
 ===== Commands =====
@@ Line 40: / Line 50: @@
 ==== 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 ====
@@ Line 48: / Line 60: @@
 ==== 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 80: / Line 100: @@
 ==== chstr ====
-Takes one argument.
+Syntax: ''chstr string_id contents''
+Replaces the string with ID ''string_id'' with ''contents''.
 ==== color, colour ====
@@ Line 105: / Line 127: @@
 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 287: / Line 319: @@
 ==== playsongres ====
-Takes one argument.
+Syntax: ''playsongres resource_index''.
+Playes the song at asset index ''resource_index''.
 ==== playwav ====
@@ Line 295: / Line 329: @@
 ==== putblock ====
-Takes four arguments.
+Syntax: ''putblock x y element color''.
+Place a statless ''element'' of color ''color'' at position ''x'', ''y''.
 ==== putcolor, putcolour ====
@@ Line 343: / Line 379: @@
 ==== rgb ====
-Takes four arguments.
+Syntax: ''rgb id r g b''
+Set the color ''id'' to color values ''r'', ''g'', ''b'' (range 0-63).
 ==== savescreen ====
@@ Line 425: / Line 463: @@
 ==== 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.