1 #LyX 2.1 created this file. For more info see http://www.lyx.org/
6 \use_default_options true
7 \maintain_unincluded_children false
9 \language_package default
14 \font_typewriter default
16 \font_default_family default
17 \use_non_tex_fonts false
23 \default_output_format default
25 \bibtex_command default
26 \index_command default
27 \paperfontsize default
31 \pdf_bookmarksnumbered false
32 \pdf_bookmarksopen false
33 \pdf_bookmarksopenlevel 1
41 \use_package amsmath 1
42 \use_package amssymb 1
45 \use_package mathdots 1
46 \use_package mathtools 1
48 \use_package stackrel 1
49 \use_package stmaryrd 1
50 \use_package undertilde 1
52 \cite_engine_type default
56 \paperorientation portrait
73 \paragraph_separation indent
74 \paragraph_indentation default
75 \quotes_language english
78 \paperpagestyle default
79 \tracking_changes false
89 lsnes Lua functions reference
96 \begin_layout Standard
97 \begin_inset CommandInset toc
98 LatexCommand tableofcontents
105 \begin_layout Standard
106 \begin_inset Newpage pagebreak
112 \begin_layout Section
116 \begin_layout Subsection
120 \begin_layout Itemize
121 Coordinates increase to right and down.
124 \begin_layout Itemize
125 The origin is at top left of game area or buffer.
128 \begin_layout Subsection
132 \begin_layout Itemize
133 Methods that draw something (unless stated otherwise) require a valid rendering
135 This context can come in three ways:
139 \begin_layout Enumerate
140 The default rendering context of paint callback (the screen).
143 \begin_layout Enumerate
144 The default rendering context of video callback (the video).
147 \begin_layout Enumerate
148 Explicitly set rendering context (RENDERCTX:set).
152 \begin_layout Itemize
153 The rendering context is always reset when callback ends.
156 \begin_layout Subsection
160 \begin_layout Standard
161 (Direct) colors can be specified either as numbers or strings.
164 \begin_layout Itemize
165 -1 is fully transparent.
168 \begin_layout Itemize
169 Non-negative numbers less than
170 \begin_inset Formula $2^{32}$
173 are partially opaque colors (
174 \begin_inset Formula $a*2^{24}+r*2^{16}+g*2^{8}+b$
181 \begin_layout Itemize
182 \begin_inset Formula $a$
186 \begin_inset Formula $0-255$
190 \begin_inset Formula $0$
194 \begin_inset Formula $256$
197 would be fully transparent.
201 \begin_layout Itemize
202 Thus, numbers in range
203 \begin_inset Formula $0-16777215$
206 stand for fully opaque colors.
210 \begin_layout Itemize
211 \begin_inset Formula $r$
215 \begin_inset Formula $g$
219 \begin_inset Formula $b$
222 are intensities of base colors on scale
223 \begin_inset Formula $0-255$
230 \begin_layout Itemize
231 Color can also be specified by name as string: The following color names
232 are known: aliceblue antiquewhite antiquewhite1 antiquewhite2 antiquewhite3
233 antiquewhite4 aqua aquamarine aquamarine1 aquamarine2 aquamarine3 aquamarine4
234 azure azure1 azure2 azure3 azure4 beige bisque bisque1 bisque2 bisque3
235 bisque4 black blanchedalmond blue blue1 blue2 blue3 blue4 blueviolet brown
236 brown1 brown2 brown3 brown4 burlywood burlywood1 burlywood2 burlywood3
237 burlywood4 cadet cadetblue cadetblue1 cadetblue2 cadetblue3 cadetblue4
238 chartreuse chartreuse1 chartreuse2 chartreuse3 chartreuse4 chocolate chocolate1
239 chocolate2 chocolate3 chocolate4 coral coral1 coral2 coral3 coral4 cornflowerbl
240 ue cornsilk cornsilk1 cornsilk2 cornsilk3 cornsilk4 crimson cyan cyan1 cyan2
241 cyan3 cyan4 darkblue darkcyan darkgoldenrod darkgoldenrod1 darkgoldenrod2
242 darkgoldenrod3 darkgoldenrod4 darkgray darkgreen darkgrey darkkhaki darkmagenta
243 darkolivegreen darkolivegreen1 darkolivegreen2 darkolivegreen3 darkolivegreen4
244 darkorange darkorange1 darkorange2 darkorange3 darkorange4 darkorchid darkorchi
245 d1 darkorchid2 darkorchid3 darkorchid4 darkred darksalmon darkseagreen darkseagr
246 een1 darkseagreen2 darkseagreen3 darkseagreen4 darkslateblue darkslategray
247 darkslategray1 darkslategray2 darkslategray3 darkslategray4 darkslategrey
248 darkturquoise darkviolet deeppink deeppink1 deeppink2 deeppink3 deeppink4
249 deepskyblue deepskyblue1 deepskyblue2 deepskyblue3 deepskyblue4 dimgray
250 dimgrey dodgerblue dodgerblue1 dodgerblue2 dodgerblue3 dodgerblue4 firebrick
251 firebrick1 firebrick2 firebrick3 firebrick4 floralwhite forestgreen fractal
252 fuchsia gainsboro ghostwhite gold gold1 gold2 gold3 gold4 goldenrod goldenrod1
253 goldenrod2 goldenrod3 goldenrod4 gray gray0 gray1 gray10 gray100 gray11
254 gray12 gray13 gray14 gray15 gray16 gray17 gray18 gray19 gray2 gray20 gray21
255 gray22 gray23 gray24 gray25 gray26 gray27 gray28 gray29 gray3 gray30 gray31
256 gray32 gray33 gray34 gray35 gray36 gray37 gray38 gray39 gray4 gray40 gray41
257 gray42 gray43 gray44 gray45 gray46 gray47 gray48 gray49 gray5 gray50 gray51
258 gray52 gray53 gray54 gray55 gray56 gray57 gray58 gray59 gray6 gray60 gray61
259 gray62 gray63 gray64 gray65 gray66 gray67 gray68 gray69 gray7 gray70 gray71
260 gray72 gray73 gray74 gray75 gray76 gray77 gray78 gray79 gray8 gray80 gray81
261 gray82 gray83 gray84 gray85 gray86 gray87 gray88 gray89 gray9 gray90 gray91
262 gray92 gray93 gray94 gray95 gray96 gray97 gray98 gray99 green green1 green2
263 green3 green4 greenyellow grey grey0 grey1 grey10 grey100 grey11 grey12
264 grey13 grey14 grey15 grey16 grey17 grey18 grey19 grey2 grey20 grey21 grey22
265 grey23 grey24 grey25 grey26 grey27 grey28 grey29 grey3 grey30 grey31 grey32
266 grey33 grey34 grey35 grey36 grey37 grey38 grey39 grey4 grey40 grey41 grey42
267 grey43 grey44 grey45 grey46 grey47 grey48 grey49 grey5 grey50 grey51 grey52
268 grey53 grey54 grey55 grey56 grey57 grey58 grey59 grey6 grey60 grey61 grey62
269 grey63 grey64 grey65 grey66 grey67 grey68 grey69 grey7 grey70 grey71 grey72
270 grey73 grey74 grey75 grey76 grey77 grey78 grey79 grey8 grey80 grey81 grey82
271 grey83 grey84 grey85 grey86 grey87 grey88 grey89 grey9 grey90 grey91 grey92
272 grey93 grey94 grey95 grey96 grey97 grey98 grey99 honeydew honeydew1 honeydew2
273 honeydew3 honeydew4 hotpink hotpink1 hotpink2 hotpink3 hotpink4 indianred
274 indianred1 indianred2 indianred3 indianred4 indigo ivory ivory1 ivory2
275 ivory3 ivory4 khaki khaki1 khaki2 khaki3 khaki4 lavender lavenderblush
276 lavenderblush1 lavenderblush2 lavenderblush3 lavenderblush4 lawngreen lemonchif
277 fon lemonchiffon1 lemonchiffon2 lemonchiffon3 lemonchiffon4 lightblue lightblue1
278 lightblue2 lightblue3 lightblue4 lightcoral lightcyan lightcyan1 lightcyan2
279 lightcyan3 lightcyan4 lightgoldenrod lightgoldenrod1 lightgoldenrod2 lightgolde
280 nrod3 lightgoldenrod4 lightgoldenrodyellow lightgray lightgreen lightgrey
281 lightpink lightpink1 lightpink2 lightpink3 lightpink4 lightsalmon lightsalmon1
282 lightsalmon2 lightsalmon3 lightsalmon4 lightseagreen lightskyblue lightskyblue1
283 lightskyblue2 lightskyblue3 lightskyblue4 lightslateblue lightslategray
284 lightslategrey lightsteelblue lightsteelblue1 lightsteelblue2 lightsteelblue3
285 lightsteelblue4 lightyellow lightyellow1 lightyellow2 lightyellow3 lightyellow4
286 lime limegreen linen magenta magenta1 magenta2 magenta3 magenta4 maroon
287 maroon1 maroon2 maroon3 maroon4 mediumaquamarine mediumblue mediumforestgreen
288 mediumgoldenrod mediumorchid mediumorchid1 mediumorchid2 mediumorchid3
289 mediumorchid4 mediumpurple mediumpurple1 mediumpurple2 mediumpurple3 mediumpurp
290 le4 mediumseagreen mediumslateblue mediumspringgreen mediumturquoise mediumviole
291 tred midnightblue mintcream mistyrose mistyrose1 mistyrose2 mistyrose3 mistyrose
292 4 moccasin navajowhite navajowhite1 navajowhite2 navajowhite3 navajowhite4
293 navy navyblue oldlace olive olivedrab olivedrab1 olivedrab2 olivedrab3
294 olivedrab4 orange orange1 orange2 orange3 orange4 orangered orangered1
295 orangered2 orangered3 orangered4 orchid orchid1 orchid2 orchid3 orchid4
296 palegoldenrod palegreen palegreen1 palegreen2 palegreen3 palegreen4 paleturquoi
297 se paleturquoise1 paleturquoise2 paleturquoise3 paleturquoise4 palevioletred
298 palevioletred1 palevioletred2 palevioletred3 palevioletred4 papayawhip
299 peachpuff peachpuff1 peachpuff2 peachpuff3 peachpuff4 peru pink pink1 pink2
300 pink3 pink4 plum plum1 plum2 plum3 plum4 powderblue purple purple1 purple2
301 purple3 purple4 red red1 red2 red3 red4 rosybrown rosybrown1 rosybrown2
302 rosybrown3 rosybrown4 royalblue royalblue1 royalblue2 royalblue3 royalblue4
303 saddlebrown salmon salmon1 salmon2 salmon3 salmon4 sandybrown seagreen
304 seagreen1 seagreen2 seagreen3 seagreen4 seashell seashell1 seashell2 seashell3
305 seashell4 sienna sienna1 sienna2 sienna3 sienna4 silver skyblue skyblue1
306 skyblue2 skyblue3 skyblue4 slateblue slateblue1 slateblue2 slateblue3 slateblue
307 4 slategray slategray1 slategray2 slategray3 slategray4 slategrey snow snow1
308 snow2 snow3 snow4 springgreen springgreen1 springgreen2 springgreen3 springgree
309 n4 steelblue steelblue1 steelblue2 steelblue3 steelblue4 tan tan1 tan2 tan3
310 tan4 teal thistle thistle1 thistle2 thistle3 thistle4 tomato tomato1 tomato2
311 tomato3 tomato4 transparent turquoise turquoise1 turquoise2 turquoise3
312 turquoise4 violet violetred violetred1 violetred2 violetred3 violetred4
313 wheat wheat1 wheat2 wheat3 wheat4 white whitesmoke yellow yellow1 yellow2
314 yellow3 yellow4 yellowgreen
317 \begin_layout Itemize
318 The HSL base color names: hsl-<hue><saturation><lightness>.
322 \begin_layout Itemize
323 Hue can be one of: r (red), ry (red-yellow), o (orange, same as red-yellow),
324 y (yellow), yg (yellow-green), g (green), gc (green-cyan), c (cyan), cb
325 (cyan-blue), b (blue), bm (blue-magenta), m (magenta), mr (magenta-red).
328 \begin_layout Itemize
329 Saturation is 0-8, where 0 is greyscale and 8 is fully saturated.
332 \begin_layout Itemize
333 Lightness is 0-8, where 0 is black and 8 is white.
337 \begin_layout Itemize
338 The color names can have a modifier after space (multiple modifiers are
339 allowed, separated by spaces): opaque10, opaque20, opaque25, opaque30,
340 opaque40, opaque50, opaque60, opaque70, opaque75, opaque80, opaque90, opaque,
341 hue{+,-}{1-23}, {saturation,lightness}{+,-}{1-16}.
345 \begin_layout Itemize
346 opaqueness is measured as percentage.
349 \begin_layout Itemize
350 Hue adjustments are on 24-step scale.
353 \begin_layout Itemize
354 Saturation and lightness adjustments are on 16-step scale.
358 \begin_layout Section
362 \begin_layout Standard
363 These tokens are special, and are expanded while the script is being loaded
366 \begin_layout Subsection
367 @@LUA_SCRIPT_FILENAME@@
370 \begin_layout Standard
371 Expanded to string token containing path and filename of this Lua script.
372 Handy for referencing other lua scripts or resources that are relative
376 \begin_layout Standard
377 In practicular, this is suitable to be passed as base argument of various
378 functions like loadfile, dofile, resolve_filename, gui.bitmap_load, gui.bitmap_lo
379 ad_png and gui.bitmap_load_pal.
382 \begin_layout Section
386 \begin_layout Subsection
387 MMAP_STRUCT: Quasi-table mapping emulated memory
390 \begin_layout Standard
391 Objects act like tables, but the values reflect emulated memory.
394 \begin_layout Subsubsection
395 static function new: Create a new instance
398 \begin_layout Itemize
399 Syntax: mmap memory.mmap.new()
402 \begin_layout Itemize
403 Syntax: mmap classes.MMAP_STRUCT.new()
406 \begin_layout Standard
410 \begin_layout Itemize
411 mmap: MMAP_STRUCT: The created mmap structure.
414 \begin_layout Standard
415 Create a new object (with no mappings) and return it.
418 \begin_layout Subsubsection
419 operator(): Bind key in mmap structure
422 \begin_layout Itemize
423 Syntax: obj(key, {marea, address|addrobj}, type)
426 \begin_layout Standard
430 \begin_layout Itemize
431 obj: MMAP_STRUCT: The structure to manipulate.
434 \begin_layout Itemize
435 key: String: The name of the key in array to map.
438 \begin_layout Itemize
439 marea: String: The memory area the mapped address is in (default: global
443 \begin_layout Itemize
444 address: Number: The offset of memory addreess, relative to specified memory
445 area or global memory space.
448 \begin_layout Itemize
449 addrobj: ADDRESS: The memory address.
452 \begin_layout Itemize
453 type: String: The type of data to map.
457 \begin_layout Itemize
458 One of: byte, sbyte, word, sword, hword, shword, dword, sdword, qword, sqword,
463 \begin_layout Standard
464 Bind key <key> in mmap structure <obj> to address <address> (relative to
466 The memory address is treated as type <type>.
469 \begin_layout Itemize
471 \begin_inset Quotes eld
475 \begin_inset Quotes erd
479 \begin_inset Quotes eld
483 \begin_inset Quotes erd
487 \begin_inset Quotes eld
491 \begin_inset Quotes erd
497 \begin_layout Standard
498 This binds signed word at address WRAM+0x2A into key
499 \begin_inset Quotes eld
503 \begin_inset Quotes erd
509 \begin_layout Standard
510 \begin_inset Newpage pagebreak
516 \begin_layout Subsection
517 ZIPWRITER: Write .zip files
520 \begin_layout Standard
521 This class does writing of .zip files.
524 \begin_layout Subsubsection
525 Static function new: Create a new zipfile
528 \begin_layout Itemize
529 Syntax: zip zip.writer.new(filename, [compression])
532 \begin_layout Itemize
533 Deprecated: zip zip.create(filename, [compression])
536 \begin_layout Standard
540 \begin_layout Itemize
541 filename: string: The name of the file to write.
544 \begin_layout Itemize
545 compression: number: Compression level (0-9).
549 \begin_layout Standard
553 \begin_layout Itemize
554 zip: ZIPWRITER: The newly created ZIP writer.
557 \begin_layout Standard
558 Create a new ZIPWRITER object and return it.
561 \begin_layout Subsubsection
562 Method commit: Finish creating ZIP file.
565 \begin_layout Itemize
566 Syntax: zipfile:commit()
569 \begin_layout Standard
573 \begin_layout Itemize
574 zipfile: ZIPFILE: The ZIP file object.
577 \begin_layout Standard
578 Finish writing the ZIP file and actually create it on disk.
581 \begin_layout Itemize
582 If a member is currently open, it is implicitly closed.
585 \begin_layout Itemize
586 Invoking this on already committed or rolled back zipfile causes an error.
589 \begin_layout Subsubsection
590 Method rollback: Cancel writing the ZIP file.
593 \begin_layout Itemize
594 Syntax: zipfile:rollback()
597 \begin_layout Standard
601 \begin_layout Itemize
602 zipfile: ZIPFILE: The ZIP file object.
605 \begin_layout Standard
606 Cancel writing the whole ZIP file.
607 The file on disk will not be modified.
610 \begin_layout Itemize
611 If a member is currently open, it is implicitly closed.
614 \begin_layout Itemize
615 Invoking this on already committed or rolled back zipfile causes an error.
618 \begin_layout Subsubsection
619 Method create_file: Start writing a new member
622 \begin_layout Itemize
623 Syntax: zipfile:create_file(filename)
626 \begin_layout Standard
630 \begin_layout Itemize
631 zipfile: ZIPFILE: The ZIP file object.
634 \begin_layout Itemize
635 string filename: Name of the new member to create
638 \begin_layout Standard
639 Start writing a new member <filename> in ZIP file.
642 \begin_layout Itemize
643 If a member is currently open, it is implicitly closed.
646 \begin_layout Itemize
647 Invoking this on already committed or rolled back zipfile causes an error.
650 \begin_layout Subsubsection
651 Method close_file: Close member
654 \begin_layout Itemize
655 Syntax: zipfile:close_file()
658 \begin_layout Standard
662 \begin_layout Itemize
663 zipfile: ZIPFILE: The ZIP file object.
666 \begin_layout Standard
667 Close the currently open member in zipfile.
670 \begin_layout Itemize
671 Invoking this on already committed or rolled back zipfile causes an error.
674 \begin_layout Itemize
675 Invoking this without an open member causes an error.
678 \begin_layout Subsubsection
679 Method write: Write data
682 \begin_layout Itemize
683 Syntax: zipfile:write(data)
686 \begin_layout Standard
690 \begin_layout Itemize
691 zipfile: ZIPFILE: The ZIP file object.
694 \begin_layout Itemize
695 data: string: The data to write.
698 \begin_layout Standard
699 Write <data> in binary mode (as-is) to currently open member.
702 \begin_layout Itemize
703 Invoking this without a member being open causes an error.
706 \begin_layout Standard
707 \begin_inset Newpage pagebreak
713 \begin_layout Subsection
714 TILEMAP: Tiled collection of bitmaps.
717 \begin_layout Standard
718 A tilemap is tiled table, each cell holding a bitmap (indexed or direct).
721 \begin_layout Subsubsection
722 Static function new: Create a tilemap
725 \begin_layout Itemize
726 Syntax: tilemap gui.tiled_bitmap.new(w, h, bw, bh);
729 \begin_layout Itemize
730 Syntax: tilemap classes.TILEMAP.new(w, h, bw, bh);
733 \begin_layout Itemize
734 Deprecated: tilemap gui.tilemap(w, h, bw, bh);
737 \begin_layout Standard
741 \begin_layout Itemize
742 w: number: Width of the tilemap in tiles
745 \begin_layout Itemize
746 h: number: Height of the tilemap in tiles
749 \begin_layout Itemize
750 bw: number: Width of each tile in pixels.
753 \begin_layout Itemize
754 bh: number: Height of each tile in pixels.
757 \begin_layout Standard
761 \begin_layout Itemize
762 tilemap: TILEMAP: the newly created tilemap
765 \begin_layout Standard
766 Create a new tilemap of <w>*<h> tiles, each of <bw>*<bh> pixels and return
770 \begin_layout Subsubsection
771 TILEMAP:getsize: Query tilemap size
774 \begin_layout Itemize
775 Syntax: width, height tmap:getsize()
778 \begin_layout Standard
782 \begin_layout Itemize
783 tmap: TILEMAP: The tilemap to query.
786 \begin_layout Standard
790 \begin_layout Itemize
791 width: number : The width of the tilemap in tiles.
794 \begin_layout Itemize
795 height: number: The height of the tilemap in tiles.
798 \begin_layout Standard
799 Get size of tilemap in tiles.
802 \begin_layout Subsubsection
803 TILEMAP:getcsize: Query tilemap cell size
806 \begin_layout Itemize
807 Syntax: width, height tmap:getcsize()
810 \begin_layout Standard
814 \begin_layout Itemize
815 tmap: TILEMAP: The tilemap to query.
818 \begin_layout Standard
822 \begin_layout Itemize
823 width: number: The width of tilemap tile in pixels.
826 \begin_layout Itemize
827 height: number: The height of tilemap tile in pixels.
830 \begin_layout Standard
831 Get size of each tilemap tile in pixels.
834 \begin_layout Subsubsection
835 TILEMAP:get: Query tilemap tile
838 \begin_layout Itemize
839 Syntax: bitmap, palette tmap:get(x, y)
842 \begin_layout Standard
846 \begin_layout Itemize
847 tmap: TILEMAP: The tilemap to query.
850 \begin_layout Itemize
851 x: number: The x-coordinate of tile to query.
854 \begin_layout Itemize
855 y: number: The y-coordinate of tile to query.
858 \begin_layout Standard
862 \begin_layout Itemize
863 bitmap: The associated bitmap (BITMAP or DBITMAP), or nil if none.
866 \begin_layout Itemize
867 palette: The palette (PALETTE) associated with indexed-color bitmap, if
872 \begin_layout Standard
873 Return the contents of tile at <x>,<y>.
876 \begin_layout Subsubsection
877 TILEMAP:set: Set tilemap cell
880 \begin_layout Itemize
881 Syntax: tmap:set(x, y)
884 \begin_layout Itemize
885 Syntax: tmap:set(x, y, bitmap)
888 \begin_layout Itemize
889 Syntax: tmap:set(x, y, bitmap, palette)
892 \begin_layout Standard
896 \begin_layout Itemize
897 tmap: TILEMAP: The tilemap to manipulate.
900 \begin_layout Itemize
901 number x: The x-coordinate of tile to set.
904 \begin_layout Itemize
905 number y: The y-coordinate of tile to set.
908 \begin_layout Itemize
909 bitmap: BITMAP/DBITMAP: The bitmap to set to tile.
912 \begin_layout Itemize
913 palette: PALETTE: The associated palette for bitmap.
916 \begin_layout Standard
917 Set the contents of tile <x>,<y>.
918 If no <bitmap> is given, clears the tile.
919 Otherwise sets the tile to contain bitmap <bitmap> with associated palette
923 \begin_layout Itemize
924 Specifying index bitmap <bitmap> without palette <palette> causes an error.
927 \begin_layout Subsubsection
928 TILEMAP:scroll: Scroll tilemap
931 \begin_layout Itemize
932 Syntax: tmap:scroll(ox, oy);
935 \begin_layout Itemize
936 Syntax: tmap:scroll(ox, oy, x, y, w, h);
939 \begin_layout Itemize
940 Syntax: tmap:scroll(ox, oy, x, y, w, h, circ_x, circ_y);
943 \begin_layout Standard
947 \begin_layout Itemize
948 tmap: TILEMAP: The tilemap to manipulate.
951 \begin_layout Itemize
952 ox: number: The number of tiles to scroll horizontally (positive is to right).
955 \begin_layout Itemize
956 oy: number: The number of tiles to scroll vertically (positive is to down).
959 \begin_layout Itemize
960 x: number: The left edge of scroll window.
963 \begin_layout Itemize
964 y: number: The top edge of scroll window.
967 \begin_layout Itemize
968 w: number: The width of scroll window.
971 \begin_layout Itemize
972 h: number: The height of scroll window.
975 \begin_layout Itemize
976 circ_x: boolean: If true, treat the window as circular in horizontal direction.
979 \begin_layout Itemize
980 circ_y: boolean: If true, treat the window as circular in vertical direction.
983 \begin_layout Standard
984 Scroll the specified tilemap <tmap> by <ox>,<oy>.
985 If a window <x>,<y>,<w>,<h> is specified, only that part is scrolled.
986 <circ_x> and <circ_y> control if scroll is circular or not.
989 \begin_layout Itemize
990 Specifying out-of-range window causes an error.
993 \begin_layout Subsubsection
994 TILEMAP:draw: Draw tilemap
997 \begin_layout Itemize
998 Name: tmap:draw(x, y)
1001 \begin_layout Itemize
1002 Name: tmap:draw(x, y, x0, y0, w, h)
1005 \begin_layout Standard
1009 \begin_layout Itemize
1010 tmap: TILEMAP: The tilemap to draw.
1013 \begin_layout Itemize
1014 x: The x coordinate on screen to draw to.
1017 \begin_layout Itemize
1018 y: The y coordinate on screen to draw to.
1021 \begin_layout Itemize
1022 x0: number: The x coordinate on tilemap (in pixels) to start drawing from.
1025 \begin_layout Itemize
1026 y0: number: The y coordinate on tilemap (in pixels) to start drawing from.
1029 \begin_layout Itemize
1030 w: number: The width to draw (in pixels).
1033 \begin_layout Itemize
1034 h: number: The height to draw (in pixels).
1037 \begin_layout Standard
1038 Draw tilemap <tmap> to screen at <x>,<y>.
1039 If a window <x0>,<y0>,<w>,<h> is specified, only that part is drawn.
1042 \begin_layout Itemize
1043 This method requires a rendering context to work.
1046 \begin_layout Subsubsection
1047 TILEMAP:draw_outside: Draw tilemap outside game area
1050 \begin_layout Itemize
1051 Name: tmap:draw_outside(x, y)
1054 \begin_layout Itemize
1055 Name: tmap:draw_outside(x, y, x0, y0, w, h)
1058 \begin_layout Standard
1059 Like TILEMAP:draw, but draws only outside game area.
1062 \begin_layout Standard
1063 \begin_inset Newpage pagebreak
1069 \begin_layout Subsection
1070 RENDERCTX: Off-screen rendering context
1073 \begin_layout Standard
1074 Object acting as off-screen rendering context.
1077 \begin_layout Subsubsection
1078 Static function new: Create a render queue
1081 \begin_layout Itemize
1082 Syntax: renderctx gui.renderctx.new(width, height);
1085 \begin_layout Itemize
1086 Syntax: renderctx classes.RENDERCTX.new(width, height);
1089 \begin_layout Itemize
1090 Deprecated: renderctx gui.renderq_new(width, height);
1093 \begin_layout Standard
1097 \begin_layout Itemize
1098 width: number: The notional width of the game area.
1101 \begin_layout Itemize
1102 height: number: The notional height of the game area.
1105 \begin_layout Standard
1109 \begin_layout Itemize
1110 rendectx: RENDERCTX: The newly created render context.
1113 \begin_layout Standard
1114 Create a render context with reported size <width>*<height> and return it.
1117 \begin_layout Subsubsection
1118 Static function setnull: Reset to default queue
1121 \begin_layout Itemize
1122 Syntax: gui.renderctx.setnull()
1125 \begin_layout Itemize
1126 Syntax: classes.RENDERCTX:setnull()
1129 \begin_layout Itemize
1130 Deprecated: gui.renderq_set()
1133 \begin_layout Standard
1134 Reset the used render context back to default for the executing callback:
1137 \begin_layout Itemize
1138 The default for paint callback is the screen
1141 \begin_layout Itemize
1142 The default for video callback is the video frame
1145 \begin_layout Itemize
1146 The default otherwise is nothing.
1149 \begin_layout Subsubsection
1150 Method clear: Clear a render queue
1153 \begin_layout Itemize
1154 Syntax: renderctx:clear()
1157 \begin_layout Itemize
1158 Deprecated: gui.renderq_clear(renderctx)
1161 \begin_layout Standard
1165 \begin_layout Itemize
1166 renderctx: RENDERCTX: The render queue to clear.
1169 \begin_layout Standard
1170 Clear all drawing from the context.
1173 \begin_layout Subsubsection
1174 Method set: Change active render context
1177 \begin_layout Itemize
1178 Syntax: renderctx:set()
1181 \begin_layout Itemize
1182 Deprecated: gui.renderq_set(renderctx)
1185 \begin_layout Standard
1189 \begin_layout Itemize
1190 renderctx: RENDERCTX: The render queue to use.
1193 \begin_layout Standard
1194 Switch the current rendering context <renderctx>.
1197 \begin_layout Subsubsection
1198 Method run: Draw all objects in context to another
1201 \begin_layout Itemize
1202 Syntax: renderctx:run()
1205 \begin_layout Itemize
1206 Deprecated: gui.renderq_run(renderctx)
1209 \begin_layout Standard
1213 \begin_layout Itemize
1214 renderctx: RENDERCTX: The render context to overlay.
1217 \begin_layout Standard
1218 Overlay the specified render context <context> upon the active rendering
1222 \begin_layout Itemize
1223 Trying to overlay rendering context upon itself is a bad idea.
1226 \begin_layout Subsubsection
1227 Method render: Render a contex to bitmap
1230 \begin_layout Itemize
1231 Syntax: bitmap renderctx:render()
1234 \begin_layout Standard
1238 \begin_layout Itemize
1239 renderctx: RENDERCTX: The context to render.
1242 \begin_layout Standard
1246 \begin_layout Itemize
1247 bitmap: DBITMAP: The rendered bitmap.
1250 \begin_layout Standard
1251 Render the specified context <renderctx> to a new bitmap.
1254 \begin_layout Itemize
1255 The size of bitmap will be nominal game area size, plus any set gaps.
1258 \begin_layout Itemize
1259 This method does not require active rendering context.
1262 \begin_layout Subsubsection
1263 Method synchronous_repaint: Paint screen now
1266 \begin_layout Itemize
1267 Syntax: renderctx:synchronous_repaint()
1270 \begin_layout Itemize
1271 Deprecated: gui.synchronous_repaint(renderctx)
1274 \begin_layout Standard
1278 \begin_layout Itemize
1279 renderctx: RENDERCTX: The context to paint.
1282 \begin_layout Standard
1283 Immediately redraw the screen with game overlayed by drawings from context
1287 \begin_layout Itemize
1288 This does not require active rendering context.
1291 \begin_layout Itemize
1292 Will not cause paint callback to be invoked.
1295 \begin_layout Standard
1296 \begin_inset Newpage pagebreak
1302 \begin_layout Subsection
1303 PALETTE: Color palette for indexed image
1306 \begin_layout Subsubsection
1307 Static function new: Create a new palette
1310 \begin_layout Itemize
1311 Syntax: palette gui.palette.new()
1314 \begin_layout Itemize
1315 Syntax: palette classes.PALETTE.new()
1318 \begin_layout Itemize
1319 Deprecated: palette gui.palette_new()
1322 \begin_layout Standard
1326 \begin_layout Itemize
1327 palette: PALETTE: The created palette.
1330 \begin_layout Standard
1331 Create a new palette (with all colors transparent) and return it.
1334 \begin_layout Subsubsection
1335 Static function load: Load a palette
1338 \begin_layout Itemize
1339 Syntax: palette gui.palette.load(file, [base])
1342 \begin_layout Itemize
1343 Syntax: palette classes.PALETTE.load(file, [base])
1346 \begin_layout Itemize
1347 Deprecated: palette gui.palette_load(file, [base])
1350 \begin_layout Standard
1354 \begin_layout Itemize
1355 string file: The file to load.
1358 \begin_layout Itemize
1359 string base (optional): The base file to resolve file relative to.
1362 \begin_layout Standard
1366 \begin_layout Itemize
1367 palette: PALETTE: The loaded palette.
1370 \begin_layout Standard
1371 Load a palette from file <file> (resolved relative to <base>).
1374 \begin_layout Itemize
1375 The file format is a series of lines, each with following format:
1379 \begin_layout Itemize
1380 Blank or just whitespace: Ignored
1383 \begin_layout Itemize
1384 First non-whitespace is '#': Ignored
1387 \begin_layout Itemize
1388 <r> <g> <b>: Fully opaque color with specified RGB values (0-255)
1391 \begin_layout Itemize
1392 <r> <g> <b> <a>: Color with specified RGB values (0-255) and specified alpha
1393 (0-256, 0 being fully transparent and 256 fully opaque).
1396 \begin_layout Itemize
1397 transparent: Fully transparent color
1401 \begin_layout Subsubsection
1402 Static function load_str: Load a palette from string
1405 \begin_layout Itemize
1406 Syntax: palette gui.palette.load(data)
1409 \begin_layout Itemize
1410 Syntax: palette classes.PALETTE.load(data)
1413 \begin_layout Itemize
1414 Deprecated: palette gui.palette_load(data)
1417 \begin_layout Standard
1421 \begin_layout Itemize
1422 string data: The palette data.
1425 \begin_layout Standard
1429 \begin_layout Itemize
1430 palette: PALETTE: The loaded palette.
1433 \begin_layout Standard
1434 Like PALETTE:load, but instead of reading palette from file, reads it from
1438 \begin_layout Subsubsection
1439 Method set: Set palette entry
1442 \begin_layout Itemize
1443 Syntax: palette:set(index, color)
1446 \begin_layout Itemize
1447 Deprecated: gui.palette_set(palette, ...)
1450 \begin_layout Standard
1454 \begin_layout Itemize
1455 palette: PALETTE: The palette to manipulate
1458 \begin_layout Itemize
1459 index: number: The index of color to set (0-65535).
1462 \begin_layout Itemize
1463 color: number/string: The color value to set.
1466 \begin_layout Standard
1467 Set palette <palette> index <index> to color <color>.
1470 \begin_layout Subsubsection
1471 Method get: Get palette entry
1474 \begin_layout Itemize
1475 Syntax: number palette:get(index)
1478 \begin_layout Standard
1482 \begin_layout Itemize
1483 palette: PALETTE: The palette to query
1486 \begin_layout Itemize
1487 index: number: The index of color to get (0-65535).
1490 \begin_layout Standard
1494 \begin_layout Itemize
1495 The palette entry as integer.
1498 \begin_layout Standard
1499 Get palette entry <index> of palette <palette> and return it.
1502 \begin_layout Subsubsection
1503 Method hash: Hash a palette
1506 \begin_layout Itemize
1507 Syntax: hash palette:hash()
1510 \begin_layout Itemize
1511 Deprecated: hash gui.palette_hash(palette)
1514 \begin_layout Standard
1518 \begin_layout Itemize
1519 palette: The palette to hash.
1522 \begin_layout Standard
1526 \begin_layout Itemize
1527 hash: string: 64-hex digit hash.
1530 \begin_layout Standard
1531 Obtain crypto-grade hash of palette data of <palette>.
1534 \begin_layout Itemize
1535 All colors after the last non-transparent one are ignored.
1538 \begin_layout Subsubsection
1539 Method adjust_transparency: Adjust transparency
1542 \begin_layout Itemize
1543 Syntax: palette:adjust_transparency(newvalue)
1546 \begin_layout Itemize
1547 Deprecated: gui.adjust_transparency(palette, ...)
1550 \begin_layout Standard
1554 \begin_layout Itemize
1555 palette: PALETTE: The palette to adjust.
1558 \begin_layout Itemize
1559 Number adj: The factor to multiply opaqueness with times 256.
1562 \begin_layout Standard
1563 Multiply opaqueness of all colors in palette <palette> by factor of <adj>/256.
1566 \begin_layout Standard
1567 \begin_inset Newpage pagebreak
1573 \begin_layout Subsection
1574 BITMAP: Indexed-color bitmap
1577 \begin_layout Subsubsection
1578 Static function new: Create a new bitmap
1581 \begin_layout Itemize
1582 Syntax: bitmap gui.bitmap.new(w, h, [fillcolor])
1585 \begin_layout Itemize
1586 Syntax: bitmap classes.BITMAP.new(w, h, [fillcolor])
1589 \begin_layout Itemize
1590 Deprecated: bitmap gui.bitmap_new(w, h, false, [fillcolor])
1593 \begin_layout Standard
1597 \begin_layout Itemize
1598 w: number: The width of bitmap to create in pixels.
1601 \begin_layout Itemize
1602 h: number: The height of bitmap to create in pixels.
1605 \begin_layout Itemize
1606 false: boolean: Constant boolean false.
1609 \begin_layout Itemize
1610 fillcolor: number: The initial fill index.
1611 Default 0 if not specified.
1614 \begin_layout Standard
1615 Create a new bitmap of size <w>*<h>.
1616 Fill the bitmap with color index <fillcolor>.
1619 \begin_layout Subsubsection
1620 Method draw: Draw a bitmap
1623 \begin_layout Itemize
1624 Syntax: bitmap:draw(x, y, palette)
1627 \begin_layout Itemize
1628 Deprecated: gui.bitmap_draw(x, y, bitmap, palette)
1631 \begin_layout Standard
1635 \begin_layout Itemize
1636 bitmap: BITMAP: The bitmap to draw
1639 \begin_layout Itemize
1640 x: number: The x-coordinate on screen.
1643 \begin_layout Itemize
1644 y: number: The y-coordinate on screen.
1647 \begin_layout Itemize
1648 palette: The palette to use for drawing.
1651 \begin_layout Standard
1652 Draw bitmap <bitmap> on screen at <x>,<y> with palette <palette>.
1655 \begin_layout Subsubsection
1656 Method draw_outside: Draw a bitmap outside game area
1659 \begin_layout Itemize
1660 Syntax: bitmap:draw_outside(x, y, palette)
1663 \begin_layout Standard
1664 Like bitmap:draw, but does not draw on game area.
1667 \begin_layout Subsubsection
1668 Method draw_clip: Draw a bitmap, with clipping
1671 \begin_layout Itemize
1672 Syntax: bitmap:draw_clip(x, y, palette, x0, y0, width, height)
1675 \begin_layout Standard
1679 \begin_layout Itemize
1680 bitmap: BITMAP: The bitmap to draw
1683 \begin_layout Itemize
1684 x: number: The x-coordinate on screen.
1687 \begin_layout Itemize
1688 y: number: The y-coordinate on screen.
1691 \begin_layout Itemize
1692 palette: The palette to use for drawing.
1695 \begin_layout Itemize
1696 x0: The smallest bitmap x coordinate to draw.
1699 \begin_layout Itemize
1700 y0: The smallest bitmap y coordinate to draw.
1703 \begin_layout Itemize
1704 width: Width of region to draw
1707 \begin_layout Itemize
1708 height: Height of region to draw.
1711 \begin_layout Standard
1712 Like bitmap:draw, but clip the bitmap area drawn.
1715 \begin_layout Subsubsection
1716 Method draw_clip_outside: Draw a bitmap outside game are, with clipping
1719 \begin_layout Itemize
1720 Syntax: bitmap:draw_clip_outside(x, y, palette, x0, y0, width, height)
1723 \begin_layout Standard
1724 Like bitmap:draw_clip, but only draw outside game area.
1727 \begin_layout Subsubsection
1728 Method pset: Set pixel in bitmap
1731 \begin_layout Itemize
1732 Syntax: bitmap:pset(x, y, color)
1735 \begin_layout Itemize
1736 Deprecaed: gui.bitmap_pset(bitmap, ...)
1739 \begin_layout Standard
1743 \begin_layout Itemize
1744 bitmap: BITMAP: The bitmap to manipulate.
1747 \begin_layout Itemize
1748 x: number: x-coordinate of pixel to set.
1751 \begin_layout Itemize
1752 y: number: y-coordinate of pixel to set.
1755 \begin_layout Itemize
1756 color: number: The color index to set.
1759 \begin_layout Standard
1760 Sets specified pixel <x>,<y> in bitmap <bitmap> to color index <color>.
1763 \begin_layout Subsubsection
1764 Method pget: Get pixel in bitmap
1767 \begin_layout Itemize
1768 Syntax: color bitmap:pget(x,y)
1771 \begin_layout Itemize
1772 Deprecated: color gui.bitmap_pget(bitmap, ...)
1775 \begin_layout Standard
1779 \begin_layout Itemize
1780 bitmap: BITMAP: The bitmap to query.
1783 \begin_layout Itemize
1784 x: number: x-coordinate of pixel to get.
1787 \begin_layout Itemize
1788 y: number: y-coordinate of pixel to get.
1791 \begin_layout Standard
1795 \begin_layout Itemize
1796 color: number: The color index in specified pixel.
1799 \begin_layout Standard
1800 Gets color index of specified pixel <x>,<y> in bitmap <bitmap>.
1803 \begin_layout Subsubsection
1804 Method size: Get size of bitmap
1807 \begin_layout Itemize
1808 Syntax: width, height bitmap:size()
1811 \begin_layout Itemize
1812 Syntax: width, height gui.bitmap_size(bitmap)
1815 \begin_layout Standard
1819 \begin_layout Itemize
1820 bitmap: BITMAP: The bitmap to query.
1823 \begin_layout Standard
1827 \begin_layout Itemize
1828 width: number: The width of the bitmap.
1831 \begin_layout Itemize
1832 height: number: The height of the bitmap.
1835 \begin_layout Standard
1836 Get size of bitmap <bitmap>.
1839 \begin_layout Subsubsection
1840 Method blit: Blit a bitmap into another
1843 \begin_layout Itemize
1844 Syntax: dest:blit(dx, dy, src, sx, sy, w, h, [ck])
1847 \begin_layout Itemize
1848 Deprecated: gui.bitmap_blit(dest, ...)
1851 \begin_layout Standard
1855 \begin_layout Itemize
1856 dest: BITMAP: The target bitmap to blit to.
1859 \begin_layout Itemize
1860 dx: number: The x-coordinate in target.
1863 \begin_layout Itemize
1864 dy: number: The y-coordinate in target.
1867 \begin_layout Itemize
1868 src: BITMAP: The source bitmap.
1871 \begin_layout Itemize
1872 sx: number: The x-coordinate in source.
1875 \begin_layout Itemize
1876 sy: number: The y-coordinate in source.
1879 \begin_layout Itemize
1880 w: number: The width of area to blit.
1883 \begin_layout Itemize
1884 h: number: The height of area to blit.
1887 \begin_layout Itemize
1888 ck: number: The color key.
1889 Pixels with this index are not copied.
1893 \begin_layout Itemize
1894 If none is specified, all pixels are copied.
1898 \begin_layout Standard
1899 Copy region of size <w>*<h> at <sx>,<sy> in bitmap <src> into <dest> at
1901 If a color key <ck> is specified, pixels of that color are not copied.
1904 \begin_layout Subsubsection
1905 Method blit_scaled: Blit a bitmap into another with scaling
1908 \begin_layout Itemize
1909 Syntax: dest:blit_scaled(dx, dy, src, sx, sy, w, h, hscl, [vscl], [ck])
1912 \begin_layout Itemize
1913 Deprecated: gui.bitmap_blit_scaled(dest, ...)
1916 \begin_layout Standard
1920 \begin_layout Itemize
1921 dest: BITMAP: The target bitmap to blit to.
1924 \begin_layout Itemize
1925 dx: number: The x-coordinate in target.
1928 \begin_layout Itemize
1929 dy: number: The y-coordinate in target.
1932 \begin_layout Itemize
1933 src: BITMAP: The source bitmap.
1936 \begin_layout Itemize
1937 sx: number: The x-coordinate in source.
1940 \begin_layout Itemize
1941 sy: number: The y-coordinate in source.
1944 \begin_layout Itemize
1945 w: number: The width of area to blit.
1948 \begin_layout Itemize
1949 h: number: The height of area to blit.
1952 \begin_layout Itemize
1953 hscl: number: Horizontal scale factor (integer).
1956 \begin_layout Itemize
1957 vscl: number: Vertical scale factor (integer).
1958 Defaults to the same as <hscl>.
1961 \begin_layout Itemize
1962 ck: number: The color key.
1963 Pixels with this index are not copied.
1967 \begin_layout Itemize
1968 If none is specified, all pixels are copied.
1972 \begin_layout Standard
1973 Like BITMAP:blit, but also scales the copied part of bitmap (using nearest
1974 neighbor) by factor of <hscl>*<vscl>.
1977 \begin_layout Subsubsection
1978 Method blit_porterduff: Blit a bitmap into another with Porter-Duff composition
1981 \begin_layout Itemize
1982 Syntax: dest:blit_porterduff(dx, dy, src, sx, sy, w, h, operator)
1985 \begin_layout Itemize
1986 Deprecated: gui.bitmap_blit_porterduff(dest, ...)
1989 \begin_layout Standard
1993 \begin_layout Itemize
1994 dest: BITMAP: The target bitmap to blit to.
1997 \begin_layout Itemize
1998 dx: number: The x-coordinate in target.
2001 \begin_layout Itemize
2002 dy: number: The y-coordinate in target.
2005 \begin_layout Itemize
2006 src: BITMAP: The source bitmap.
2009 \begin_layout Itemize
2010 sx: number: The x-coordinate in source.
2013 \begin_layout Itemize
2014 sy: number: The y-coordinate in source.
2017 \begin_layout Itemize
2018 w: number: The width of area to blit.
2021 \begin_layout Itemize
2022 h: number: The height of area to blit.
2025 \begin_layout Itemize
2026 operator: string: The operator to use.
2030 \begin_layout Itemize
2031 Can be one of: Src, Atop, Over, In, Out, Dest, DestAtop, DestOver, DestIn,
2032 DestOut, Clear or Xor.
2036 \begin_layout Standard
2037 Like BITMAP:blit, but instead of just overwriting, applies specified Porter-Duff
2042 \begin_layout Itemize
2043 Color index 0 in source and target is treated as background.
2046 \begin_layout Subsubsection
2047 Method blit_scaled_porterduff: Blit a bitmap into another with scaling and
2048 Porter-Duff composition
2051 \begin_layout Itemize
2052 Syntax: dest:blit_scaled_porterduff(dx, dy, src, sx, sy, w, h, hscl, [vscl],
2056 \begin_layout Itemize
2057 Deprecated: gui.bitmap_blit_scaled_porterduff(dest, ...)
2060 \begin_layout Standard
2064 \begin_layout Itemize
2065 dest: BITMAP: The target bitmap to blit to.
2068 \begin_layout Itemize
2069 dx: number: The x-coordinate in target.
2072 \begin_layout Itemize
2073 dy: number: The y-coordinate in target.
2076 \begin_layout Itemize
2077 src: BITMAP: The source bitmap.
2080 \begin_layout Itemize
2081 sx: number: The x-coordinate in source.
2084 \begin_layout Itemize
2085 sy: number: The y-coordinate in source.
2088 \begin_layout Itemize
2089 w: number: The width of area to blit.
2092 \begin_layout Itemize
2093 h: number: The height of area to blit.
2096 \begin_layout Itemize
2097 hscl: number: Horizontal scale factor (integer).
2100 \begin_layout Itemize
2101 vscl: number: Vertical scale factor (integer).
2102 Defaults to the same as <hscl>.
2105 \begin_layout Itemize
2106 operator: string: The operator to use.
2110 \begin_layout Itemize
2111 Can be one of: Src, Atop, Over, In, Out, Dest, DestAtop, DestOver, DestIn,
2112 DestOut, Clear or Xor.
2116 \begin_layout Standard
2117 Like BITMAP:blit_porterduff, but also scales the source by <hscl>*<vscl>
2118 like BITMAP:blit_scaled.
2121 \begin_layout Subsubsection
2122 Method blit_priority: Blit a bitmap into another with color priority
2125 \begin_layout Itemize
2126 Syntax: dest:blit_priority(dx, dy, src, sx, sy, w, h)
2129 \begin_layout Itemize
2130 Deprecated: gui.bitmap_blit_priority(dest, ...)
2133 \begin_layout Standard
2137 \begin_layout Itemize
2138 dest: BITMAP: The target bitmap to blit to.
2141 \begin_layout Itemize
2142 dx: number: The x-coordinate in target.
2145 \begin_layout Itemize
2146 dy: number: The y-coordinate in target.
2149 \begin_layout Itemize
2150 src: BITMAP: The source bitmap.
2153 \begin_layout Itemize
2154 sx: number: The x-coordinate in source.
2157 \begin_layout Itemize
2158 sy: number: The y-coordinate in source.
2161 \begin_layout Itemize
2162 w: number: The width of area to blit.
2165 \begin_layout Itemize
2166 h: number: The height of area to blit.
2169 \begin_layout Standard
2170 Like BITMAP:blit, but only copy pixels where source color index is greater
2171 than destination color index.
2174 \begin_layout Subsubsection
2175 Method blit_scaled_priority: Blit a bitmap into another with color priority
2179 \begin_layout Itemize
2180 Syntax: dest:blit_scaled_priority(dx, dy, src, sx, sy, w, h, hscl, [vscl])
2183 \begin_layout Itemize
2184 Deprecated: gui.bitmap_blit_scaled_priority(dest, ...)
2187 \begin_layout Standard
2191 \begin_layout Itemize
2192 dest: BITMAP: The target bitmap to blit to.
2195 \begin_layout Itemize
2196 dx: number: The x-coordinate in target.
2199 \begin_layout Itemize
2200 dy: number: The y-coordinate in target.
2203 \begin_layout Itemize
2204 src: BITMAP: The source bitmap.
2207 \begin_layout Itemize
2208 sx: number: The x-coordinate in source.
2211 \begin_layout Itemize
2212 sy: number: The y-coordinate in source.
2215 \begin_layout Itemize
2216 w: number: The width of area to blit.
2219 \begin_layout Itemize
2220 h: number: The height of area to blit.
2223 \begin_layout Itemize
2224 hscl: number: Horizontal scale factor (integer).
2227 \begin_layout Itemize
2228 vscl: number: Vertical scale factor (integer).
2229 Defaults to the same as <hscl>.
2232 \begin_layout Standard
2233 Like BITMAP:blit_priority, but apply scaling by <hscl>*<vscl> like BITMAP:blit_s
2237 \begin_layout Subsubsection
2238 Method save_png: Save a bitmap to PNG
2241 \begin_layout Itemize
2242 Syntax: bitmap:save_png(filename, [base], palette)
2245 \begin_layout Itemize
2246 Syntax: data bitmap:save_png(palette)
2249 \begin_layout Itemize
2251 gui.bitmap_save_png(bitmap, ...)
2254 \begin_layout Standard
2258 \begin_layout Itemize
2259 bitmap: BITMAP: The bitmap to save.
2262 \begin_layout Itemize
2263 filename: string: The filename to save to.
2266 \begin_layout Itemize
2267 base: string: The base filename is resolved relative to.
2270 \begin_layout Itemize
2271 palette: PALETTE: The palette to use.
2274 \begin_layout Standard
2278 \begin_layout Itemize
2279 data: string: BASE64 encoded PNG data.
2282 \begin_layout Standard
2283 Save bitmap <bitmap>, with palette <pal> into PNG file <filename> (relative
2284 to <base>) or return BASE64 encoding of it.
2287 \begin_layout Subsubsection
2288 Method hash: Hash a bitmap
2291 \begin_layout Itemize
2292 Syntax: hash bitmap:hash()
2295 \begin_layout Itemize
2296 Deprecated: hash bitmap:hash(bitmap)
2299 \begin_layout Standard
2303 \begin_layout Itemize
2304 bitmap: BITMAP: The bitmap to hash.
2307 \begin_layout Standard
2311 \begin_layout Itemize
2312 hash: string: 64-hex digit hash
2315 \begin_layout Standard
2316 Hashes bitmap <bitmap> and returns crypto-strong hash.
2320 \begin_layout Itemize
2321 Color order in bitmap is significant.
2324 \begin_layout Standard
2325 \begin_inset Newpage pagebreak
2331 \begin_layout Subsection
2332 DBITMAP: Direct-color bitmap
2335 \begin_layout Subsubsection
2336 Static function: new: Create a new bitmap
2339 \begin_layout Itemize
2340 Syntax: bitmap gui.dbitmap.new(w, h, [fillcolor])
2343 \begin_layout Itemize
2344 Syntax: bitmap classes.DBITMAP.new(w, h, [fillcolor])
2347 \begin_layout Itemize
2348 Deprecated: bitmap gui.bitmap_new (w, h, true, [fillcolor]).
2351 \begin_layout Standard
2355 \begin_layout Itemize
2356 w: number: The width of new bitmap.
2359 \begin_layout Itemize
2360 h: number: The height of new bitmap.
2363 \begin_layout Itemize
2364 true: boolean: Fixed boolean true
2367 \begin_layout Itemize
2368 fillcolor: The color to fill the bitmap with (default transparent).
2371 \begin_layout Standard
2375 \begin_layout Itemize
2376 bitmap: DBITMAP: The new bitmap.
2379 \begin_layout Standard
2380 Create a new direct-color bitmap of size <w>*<h>, initially filled with
2384 \begin_layout Subsubsection
2385 Method draw: Draw a bitmap
2388 \begin_layout Itemize
2389 Syntax: bitmap.draw(x, y)
2392 \begin_layout Itemize
2393 Deprecated: gui.bitmap_draw(x, y, bitmap)
2396 \begin_layout Standard
2400 \begin_layout Itemize
2401 bitmap: DBITMAP: The bitmap to draw.
2404 \begin_layout Itemize
2405 x: number: X-coordinate on screen.
2408 \begin_layout Itemize
2409 y: number: Y-coordinate on screen.
2412 \begin_layout Standard
2413 Draw bitmap <bitmap> on screen at <x>,<y>.
2416 \begin_layout Subsubsection
2417 Method draw_outside: Draw a bitmap outside game area
2420 \begin_layout Itemize
2421 Syntax: dbitmap:draw_outside(x, y, palette)
2424 \begin_layout Standard
2425 Like dbitmap:draw, but does not draw on game area.
2428 \begin_layout Subsubsection
2429 Method draw_clip: Draw a bitmap, with clipping
2432 \begin_layout Itemize
2433 Syntax: dbitmap:draw(x, y, palette, x0, y0, width, height)
2436 \begin_layout Standard
2440 \begin_layout Itemize
2441 bitmap: DBITMAP: The bitmap to draw
2444 \begin_layout Itemize
2445 x: number: The x-coordinate on screen.
2448 \begin_layout Itemize
2449 y: number: The y-coordinate on screen.
2452 \begin_layout Itemize
2453 x0: The smallest bitmap x coordinate to draw.
2456 \begin_layout Itemize
2457 y0: The smallest bitmap y coordinate to draw.
2460 \begin_layout Itemize
2461 width: Width of region to draw
2464 \begin_layout Itemize
2465 height: Height of region to draw.
2468 \begin_layout Standard
2469 Like dbitmap:draw, but clip the bitmap area drawn.
2472 \begin_layout Subsubsection
2473 Method draw_clip_outside: Draw a bitmap outside game are, with clipping
2476 \begin_layout Itemize
2477 Syntax: dbitmap:draw_clip_outside(x, y, palette, x0, y0, width, height)
2480 \begin_layout Standard
2481 Like dbitmap:draw_clip, but only draw outside game area.
2484 \begin_layout Subsubsection
2485 Method pset: Set pixel in bitmap
2488 \begin_layout Itemize
2489 Syntax: bitmap:pset(x, y, color)
2492 \begin_layout Itemize
2493 Deprecaed: gui.bitmap_pset(bitmap, ...)
2496 \begin_layout Standard
2500 \begin_layout Itemize
2501 bitmap: DBITMAP: The bitmap to manipulate.
2504 \begin_layout Itemize
2505 x: number: x-coordinate of pixel to set.
2508 \begin_layout Itemize
2509 y: number: y-coordinate of pixel to set.
2512 \begin_layout Itemize
2513 color: number/string: The color to set.
2516 \begin_layout Standard
2517 Sets specified pixel <x>,<y> in bitmap <bitmap> to color <color>.
2520 \begin_layout Subsubsection
2521 Method pget: Get pixel in bitmap
2524 \begin_layout Itemize
2525 Syntax: color bitmap:pget(x,y)
2528 \begin_layout Itemize
2529 Deprecated: color gui.bitmap_pget(bitmap, ...)
2532 \begin_layout Standard
2536 \begin_layout Itemize
2537 bitmap: DBITMAP: The bitmap to query.
2540 \begin_layout Itemize
2541 x: number: x-coordinate of pixel to get.
2544 \begin_layout Itemize
2545 y: number: y-coordinate of pixel to get.
2548 \begin_layout Standard
2552 \begin_layout Itemize
2553 color: number: The color of specified pixel.
2556 \begin_layout Standard
2557 Gets color index of specified pixel <x>,<y> in bitmap <bitmap>.
2560 \begin_layout Subsubsection
2561 Method size: Get size of bitmap
2564 \begin_layout Itemize
2565 Syntax: width, height bitmap:size()
2568 \begin_layout Itemize
2569 Syntax: width, height gui.bitmap_size(bitmap)
2572 \begin_layout Standard
2576 \begin_layout Itemize
2577 bitmap: DBITMAP: The bitmap to query.
2580 \begin_layout Standard
2584 \begin_layout Itemize
2585 width: number: The width of the bitmap.
2588 \begin_layout Itemize
2589 height: number: The height of the bitmap.
2592 \begin_layout Standard
2593 Get size of bitmap <bitmap>.
2596 \begin_layout Subsubsection
2597 Method blit: Blit a bitmap into another
2600 \begin_layout Itemize
2601 Syntax: dest:blit(dx, dy, src, sx, sy, w, h, [ck])
2604 \begin_layout Itemize
2605 Syntax: dest:blit(dx, dy, src, srcpal, sx, sy, w, h, [ck])
2608 \begin_layout Itemize
2609 Deprecated: gui.bitmap_blit(dest, ...)
2612 \begin_layout Standard
2616 \begin_layout Itemize
2617 dest: DBITMAP: The target bitmap to blit to.
2620 \begin_layout Itemize
2621 dx: number: The x-coordinate in target.
2624 \begin_layout Itemize
2625 dy: number: The y-coordinate in target.
2628 \begin_layout Itemize
2629 src: BITMAP/DBITMAP: The source bitmap.
2632 \begin_layout Itemize
2633 srcpal: PALETTE: If <src> is indexed, this is the palette for source.
2636 \begin_layout Itemize
2637 sx: number: The x-coordinate in source.
2640 \begin_layout Itemize
2641 sy: number: The y-coordinate in source.
2644 \begin_layout Itemize
2645 w: number: The width of area to blit.
2648 \begin_layout Itemize
2649 h: number: The height of area to blit.
2652 \begin_layout Itemize
2653 ck: number: The color key.
2654 Pixels with this index are not copied.
2658 \begin_layout Itemize
2659 If none is specified, all pixels are copied.
2662 \begin_layout Itemize
2663 If <src> is paletted, this is color index, otherwise it is a color.
2667 \begin_layout Standard
2668 Copy region of size <w>*<h> at <sx>,<sy> in bitmap <src> (with palette <pal>
2669 if indexed) into <dest> at <dx>,<dy>.
2670 If a color key <ck> is specified, pixels of that color are not copied.
2673 \begin_layout Subsubsection
2674 Method blit_scaled: Blit a bitmap into another with scaling
2677 \begin_layout Itemize
2678 Syntax: dest:blit_scaled(dx, dy, src, sx, sy, w, h, hscl, [vscl], [ck])
2681 \begin_layout Itemize
2682 Syntax: dest:blit_scaled(dx, dy, src, srcpal, sx, sy, w, h, hscl, [vscl],
2686 \begin_layout Itemize
2687 Deprecated: gui.bitmap_blit_scaled(dest, ...)
2690 \begin_layout Standard
2694 \begin_layout Itemize
2695 dest: DBITMAP: The target bitmap to blit to.
2698 \begin_layout Itemize
2699 dx: number: The x-coordinate in target.
2702 \begin_layout Itemize
2703 dy: number: The y-coordinate in target.
2706 \begin_layout Itemize
2707 src: BITMAP/DBITMAP: The source bitmap.
2710 \begin_layout Itemize
2711 srcpal: PALETTE: If <src> is indexed, this is the palette for source.
2714 \begin_layout Itemize
2715 sx: number: The x-coordinate in source.
2718 \begin_layout Itemize
2719 sy: number: The y-coordinate in source.
2722 \begin_layout Itemize
2723 w: number: The width of area to blit.
2726 \begin_layout Itemize
2727 h: number: The height of area to blit.
2730 \begin_layout Itemize
2731 hscl: number: Horizontal scale factor (integer).
2734 \begin_layout Itemize
2735 vscl: number: Vertical scale factor (integer).
2736 Defaults to the same as <hscl>.
2739 \begin_layout Itemize
2740 ck: number: The color key.
2741 Pixels with this index are not copied.
2745 \begin_layout Itemize
2746 If none is specified, all pixels are copied.
2749 \begin_layout Itemize
2750 If <src> is paletted, this is color index, otherwise it is a color.
2754 \begin_layout Standard
2755 Like DBITMAP:blit, but also scales the copied part of bitmap (using nearest
2756 neighbor) by factor of <hscl>*<vscl>.
2759 \begin_layout Subsubsection
2760 Method blit_porterduff: Blit a bitmap into another with Porter-Duff composition
2763 \begin_layout Itemize
2764 Syntax: dest:blit_porterduff(dx, dy, src, sx, sy, w, h, operator)
2767 \begin_layout Itemize
2768 Syntax: dest:blit_porterduff(dx, dy, src, srcpal, sx, sy, w, h, operator)
2771 \begin_layout Itemize
2772 Deprecated: gui.bitmap_blit_porterduff(dest, ...)
2775 \begin_layout Standard
2779 \begin_layout Itemize
2780 dest: DBITMAP: The target bitmap to blit to.
2783 \begin_layout Itemize
2784 dx: number: The x-coordinate in target.
2787 \begin_layout Itemize
2788 dy: number: The y-coordinate in target.
2791 \begin_layout Itemize
2792 src: BITMAP/DBITMAP: The source bitmap.
2795 \begin_layout Itemize
2796 srcpal: PALETTE: If <src> is indexed, this is the palette for source.
2799 \begin_layout Itemize
2800 sx: number: The x-coordinate in source.
2803 \begin_layout Itemize
2804 sy: number: The y-coordinate in source.
2807 \begin_layout Itemize
2808 w: number: The width of area to blit.
2811 \begin_layout Itemize
2812 h: number: The height of area to blit.
2815 \begin_layout Itemize
2816 operator: string: The operator to use.
2820 \begin_layout Itemize
2821 Can be one of: Src, Atop, Over, In, Out, Dest, DestAtop, DestOver, DestIn,
2822 DestOut, Clear or Xor.
2826 \begin_layout Standard
2827 Like DBITMAP:blit, but instead of just overwriting, applies specified Porter-Duf
2832 \begin_layout Itemize
2833 In target, fully transparent is background.
2834 In source, either fully transparent (if direct) or index 0 (if paletted)
2835 is treated as background.
2838 \begin_layout Subsubsection
2839 Method blit_scaled_porterduff: Blit a bitmap into another with scaling and
2840 Porter-Duff composition
2843 \begin_layout Itemize
2844 Syntax: dest:blit_scaled_porterduff(dx, dy, src, sx, sy, w, h, hscl, [vscl],
2848 \begin_layout Itemize
2849 Syntax: dest:blit_scaled_porterduff(dx, dy, src, srcpal, sx, sy, w, h, hscl,
2853 \begin_layout Itemize
2854 Deprecated: gui.bitmap_blit_scaled_porterduff(dest, ...)
2857 \begin_layout Standard
2861 \begin_layout Itemize
2862 dest: DBITMAP: The target bitmap to blit to.
2865 \begin_layout Itemize
2866 dx: number: The x-coordinate in target.
2869 \begin_layout Itemize
2870 dy: number: The y-coordinate in target.
2873 \begin_layout Itemize
2874 src: BITMAP/DBITMAP: The source bitmap.
2877 \begin_layout Itemize
2878 srcpal: PALETTE: If <src> is indexed, this is the palette for source.
2881 \begin_layout Itemize
2882 sx: number: The x-coordinate in source.
2885 \begin_layout Itemize
2886 sy: number: The y-coordinate in source.
2889 \begin_layout Itemize
2890 w: number: The width of area to blit.
2893 \begin_layout Itemize
2894 h: number: The height of area to blit.
2897 \begin_layout Itemize
2898 hscl: number: Horizontal scale factor (integer).
2901 \begin_layout Itemize
2902 vscl: number: Vertical scale factor (integer).
2903 Defaults to the same as <hscl>.
2906 \begin_layout Itemize
2907 operator: string: The operator to use.
2911 \begin_layout Itemize
2912 Can be one of: Src, Atop, Over, In, Out, Dest, DestAtop, DestOver, DestIn,
2913 DestOut, Clear or Xor.
2917 \begin_layout Standard
2918 Like DBITMAP:blit_porterduff, but also scales the source by <hscl>*<vscl>
2919 like DBITMAP:blit_scaled.
2922 \begin_layout Subsubsection
2923 Method adjust_transparency: Adjust transparency of bitmap
2926 \begin_layout Itemize
2927 Syntax: bitmap:adjust_transparency(newvalue)
2930 \begin_layout Itemize
2931 Deprecated: gui.adjust_transparency(bitmap, ...)
2934 \begin_layout Standard
2938 \begin_layout Itemize
2939 bitmap: DBITMAP: The bitmap to adjust.
2942 \begin_layout Itemize
2943 Number adj: The factor to multiply opaqueness with times 256.
2946 \begin_layout Standard
2947 Multiply opaqueness of all colors in bitmap <bitmap> by factor of <adj>/256.
2950 \begin_layout Subsubsection
2951 Method save_png: Save a bitmap to PNG
2954 \begin_layout Itemize
2955 Syntax: bitmap:save_png(filename, [base])
2958 \begin_layout Itemize
2959 Syntax: data bitmap:save_png()
2962 \begin_layout Itemize
2964 gui.bitmap_save_png(bitmap, ...)
2967 \begin_layout Standard
2971 \begin_layout Itemize
2972 bitmap: DBITMAP: The bitmap to save.
2975 \begin_layout Itemize
2976 filename: string: The filename to save to.
2979 \begin_layout Itemize
2980 base: string: The base filename is resolved relative to.
2983 \begin_layout Standard
2987 \begin_layout Itemize
2988 data: string: BASE64 encoded PNG data.
2991 \begin_layout Standard
2992 Save bitmap <bitmap> into PNG file <filename> (relative to <base>) or return
2993 BASE64 encoding of it.
2996 \begin_layout Subsubsection
2997 Method hash: Hash a bitmap
3000 \begin_layout Itemize
3001 Syntax: hash bitmap:hash()
3004 \begin_layout Itemize
3005 Deprecated: hash bitmap:hash(bitmap)
3008 \begin_layout Standard
3012 \begin_layout Itemize
3013 bitmap: DBITMAP: The bitmap to hash.
3016 \begin_layout Standard
3020 \begin_layout Itemize
3021 hash: string: 64-hex digit hash
3024 \begin_layout Standard
3025 Hashes bitmap <bitmap> and returns crypto-strong hash.
3029 \begin_layout Subsection
3030 IMAGELOADER: Load an image
3033 \begin_layout Subsubsection
3034 Static function load: Load a bitmap from file
3037 \begin_layout Itemize
3038 Syntax: bitmap, palette gui.image.load(file, [base])
3041 \begin_layout Itemize
3042 Syntax: bitmap, palette classes.IMAGELOADER.load(file, [base])
3045 \begin_layout Itemize
3047 gui.bitmap_load(...)
3050 \begin_layout Standard
3054 \begin_layout Itemize
3055 file: string: The file to read.
3058 \begin_layout Itemize
3059 base: string: The base to resolve <file> relative to.
3062 \begin_layout Standard
3066 \begin_layout Itemize
3067 bitmap: BITMAP/DBITMAP: The new bitmap
3070 \begin_layout Itemize
3071 palette: PALETTE: If bitmap is paletted, this is the palette, otherwise
3075 \begin_layout Standard
3076 Load a new bitmap and return it (plus associated palette if any).
3079 \begin_layout Subsubsection
3080 Static function load_str: Load a bitmap from string
3083 \begin_layout Itemize
3084 Syntax: bitmap, palette gui.image.load_str(data)
3087 \begin_layout Itemize
3088 Syntax: bitmap, palette classes.IMAGELOADER.load_str(data)
3091 \begin_layout Itemize
3093 gui.bitmap_load_str(...)
3096 \begin_layout Standard
3100 \begin_layout Itemize
3101 data: string: The image data
3104 \begin_layout Standard
3108 \begin_layout Itemize
3109 bitmap: BITMAP/DBITMAP: The new bitmap
3112 \begin_layout Itemize
3113 palette: PALETTE: If bitmap is paletted, this is the palette, otherwise
3117 \begin_layout Standard
3118 Like IMAGELOADER:load, but read the bitmap from string <data> instead of
3122 \begin_layout Subsubsection
3123 Static function load_png: Load a bitmap from PNG file
3126 \begin_layout Itemize
3127 Syntax: bitmap, palette gui.image.load_png(file, [base])
3130 \begin_layout Itemize
3131 Syntax: bitmap, palette classes.IMAGELOADER.load_png(file, [base])
3134 \begin_layout Itemize
3136 gui.bitmap_load_png(...)
3139 \begin_layout Standard
3143 \begin_layout Itemize
3144 file: string: The file to read.
3147 \begin_layout Itemize
3148 base: string: The base to resolve <file> relative to.
3151 \begin_layout Standard
3155 \begin_layout Itemize
3156 bitmap: BITMAP/DBITMAP: The new bitmap
3159 \begin_layout Itemize
3160 palette: PALETTE: If bitmap is paletted, this is the palette, otherwise
3164 \begin_layout Standard
3165 Like IMAGELOADER:load, but load a PNG file instead.
3168 \begin_layout Subsubsection
3169 Static function load_png_str: Load a PNG bitmap from string
3172 \begin_layout Itemize
3173 Syntax: bitmap, palette gui.image.load_png_str(data)
3176 \begin_layout Itemize
3177 Syntax: bitmap, palette classes.IMAGELOADER.load_png_str(data)
3180 \begin_layout Itemize
3182 gui.bitmap_load_png_str(...)
3185 \begin_layout Standard
3189 \begin_layout Itemize
3190 data: string: The image data, base64 encoded.
3193 \begin_layout Standard
3197 \begin_layout Itemize
3198 bitmap: BITMAP/DBITMAP: The new bitmap
3201 \begin_layout Itemize
3202 palette: PALETTE: If bitmap is paletted, this is the palette, otherwise
3206 \begin_layout Standard
3207 Like IMAGELOADER:load_png, but read the bitmap from BASE64 encoded string
3208 <data> instead of file.
3211 \begin_layout Standard
3212 \begin_inset Newpage pagebreak
3218 \begin_layout Subsection
3219 CUSTOMFONT: Arbitrary-sized bitmap font
3222 \begin_layout Subsubsection
3223 Static function new: Return a new empty font
3226 \begin_layout Itemize
3227 Syntax: font gui.font.new()
3230 \begin_layout Itemize
3231 Syntax: font classes.CUSTOMFONT.new()
3234 \begin_layout Itemize
3235 Deprecated: font gui.font_new()
3238 \begin_layout Standard
3242 \begin_layout Itemize
3243 font: CUSTOMFONT: New font.
3246 \begin_layout Standard
3247 Create a new font with no characters and return it.
3250 \begin_layout Subsubsection
3251 Static function: load: Load a font file
3254 \begin_layout Itemize
3255 Syntax: font gui.font.load(file, [base])
3258 \begin_layout Itemize
3259 Syntax: font gui.font.load()
3262 \begin_layout Itemize
3263 Syntax: font classes.CUSTOMFONT.load(file, [base])
3266 \begin_layout Itemize
3267 Syntax: font classes.CUSTOMFONT.load()
3270 \begin_layout Itemize
3271 Deprecated: font gui.loadfont(...)
3274 \begin_layout Standard
3278 \begin_layout Itemize
3279 file: string: The file to read the font from
3282 \begin_layout Itemize
3283 base: string: The file to resolve <file> relative to.
3286 \begin_layout Standard
3290 \begin_layout Itemize
3291 font: CUSTOMFONT: New font.
3294 \begin_layout Standard
3295 Load font from file <file> (relative to <base>).
3296 If no filename is given, system default font is loaded.
3299 \begin_layout Subsubsection
3300 operator(): Render text to screen
3303 \begin_layout Itemize
3304 Syntax: font(x, y, text, [fgc], [bgc], [hlc])
3307 \begin_layout Standard
3311 \begin_layout Itemize
3312 font: CUSTOMFONT: The font to use.
3315 \begin_layout Itemize
3316 x: number: The x-position on screen to draw to.
3319 \begin_layout Itemize
3320 y: number: The y-position on screen to draw to.
3323 \begin_layout Itemize
3324 text: string: The text to draw.
3327 \begin_layout Itemize
3328 fgc: number/string: Foreground color (default white).
3331 \begin_layout Itemize
3332 bgc: number/string: Background color (default transparent).
3335 \begin_layout Itemize
3336 hlc: number/string: Outline color (default transparent).
3339 \begin_layout Standard
3340 Draws a string <text> with specified font <font> and colors <fgc>,<bgc>,<hlc>
3344 \begin_layout Itemize
3345 If <hlc> is transparent, no outline is drawn.
3348 \begin_layout Subsubsection
3349 Method edit: Alter glyph in font
3352 \begin_layout Itemize
3353 Syntax: font:edit(character, glyph)
3356 \begin_layout Standard
3360 \begin_layout Itemize
3361 font: CUSTOMFONT: The font to edit.
3364 \begin_layout Itemize
3365 character: string: The character to edit (UTF-8 encoded).
3368 \begin_layout Itemize
3369 glyph: BITMAP: The bitmap to use.
3372 \begin_layout Standard
3373 Replace character <character> in font <font> by <glyph>.
3376 \begin_layout Itemize
3377 Color index 0 is background, everything else is foreground.
3380 \begin_layout Itemize
3381 <character> may be empty string, meaning the replacement character used
3385 \begin_layout Itemize
3386 <character> may be multi-codepoint string, meaning character used for that
3390 \begin_layout Standard
3391 \begin_inset Newpage pagebreak
3397 \begin_layout Subsection
3398 ICONV: Character set conversions
3401 \begin_layout Subsubsection
3402 Static function new: Create new character set converter
3405 \begin_layout Itemize
3406 Syntax: iconv iconv.new(from, to);
3409 \begin_layout Itemize
3410 Syntax: iconv classes.ICONV.new(from, to);
3413 \begin_layout Itemize
3414 Deprecated: iconv iconv_new(...);
3417 \begin_layout Standard
3421 \begin_layout Itemize
3422 from: string: The source character set.
3425 \begin_layout Itemize
3426 to: string: The target character set.
3429 \begin_layout Standard
3433 \begin_layout Itemize
3434 iconv: ICONV: The converter.
3437 \begin_layout Standard
3438 Create a character set converter, converting from <from> to <to> and return
3442 \begin_layout Subsubsection
3443 Operator(): Convert string fragment from character set to another
3446 \begin_layout Itemize
3447 Syntax: success, result, unconverted, error iconv(input)
3450 \begin_layout Standard
3454 \begin_layout Itemize
3455 iconv: ICONV: The context to use.
3458 \begin_layout Itemize
3459 input: string: The input to convert.
3462 \begin_layout Standard
3466 \begin_layout Itemize
3467 success: boolean: True if conversion was successful, false if not.
3470 \begin_layout Itemize
3471 result: string: The string (partially) converted.
3474 \begin_layout Itemize
3475 unconvered: number: Number of bytes that were not converted (only if <success>
3479 \begin_layout Itemize
3480 error: string: Error that caused conversion to stop (only if <success> is
3485 \begin_layout Itemize
3486 INVALID: The input string is invalid.
3489 \begin_layout Itemize
3490 INCOMPLETE: The input string cuts off in middle of character.
3493 \begin_layout Itemize
3494 INTERNALERR: Internal error.
3498 \begin_layout Standard
3499 Convert a string <input> using character set converter <iconv> and return
3503 \begin_layout Standard
3504 \begin_inset Newpage pagebreak
3510 \begin_layout Subsection
3511 FILEREADER: Read a file as a stream
3514 \begin_layout Subsubsection
3515 Static function open: Open a stream
3518 \begin_layout Itemize
3519 Syntax: handle filereader.open(file, [base])
3522 \begin_layout Itemize
3523 Syntax: handle classes.FILEREADER.open(file, [base])
3526 \begin_layout Itemize
3527 Deprecated: handle open_file(file, [base])
3530 \begin_layout Standard
3534 \begin_layout Itemize
3535 file: string: The filename to read.
3538 \begin_layout Itemize
3539 base: string: The base <file> is resolved against.
3542 \begin_layout Standard
3546 \begin_layout Itemize
3547 handle: FILEREADER: The new file reader.
3550 \begin_layout Standard
3551 Open file <file> (relative to <base>) and return a handle to it.
3554 \begin_layout Subsubsection
3555 operator(): Read line/bytes from stream
3558 \begin_layout Itemize
3559 Syntax: result handle()
3562 \begin_layout Itemize
3563 Syntax: result handle(bytes)
3566 \begin_layout Standard
3570 \begin_layout Itemize
3571 handle: FILEREADER: The handle to read from.
3574 \begin_layout Itemize
3575 bytes: Number of bytes to read (default is next line).
3578 \begin_layout Standard
3582 \begin_layout Itemize
3583 result: string: The read data, or nil on end-of-file.
3586 \begin_layout Standard
3587 Reads next line or <bytes> bytes from specified file handle <handle>.
3590 \begin_layout Itemize
3591 If reading specified number of bytes, the bytes are read in binary mode
3595 \begin_layout Itemize
3596 If reading next line, the line is read in text mode (any line ending is
3600 \begin_layout Subsubsection
3601 Method lines: Iterator to read all lines
3604 \begin_layout Itemize
3605 Syntax: for line in handle:lines() do ...
3609 \begin_layout Standard
3613 \begin_layout Itemize
3614 handle: FILEREADER: The handle to read.
3617 \begin_layout Standard
3621 \begin_layout Itemize
3622 A lua iterator with one variable.
3625 \begin_layout Standard
3626 Return a Lua iterator that iterates all the lines in <handle>.
3629 \begin_layout Standard
3630 \begin_inset Newpage pagebreak
3636 \begin_layout Subsection
3637 COMPARE_OBJ: Watch memory area for changes
3640 \begin_layout Standard
3641 Objects of this class allow fast checking for modifications to given memory
3645 \begin_layout Subsubsection
3646 Static function new: Create a checker
3649 \begin_layout Itemize
3650 Syntax: handle classes.COMPARE_OBJ.new({marea, offset|addrobj}, size, [rows,
3654 \begin_layout Itemize
3655 Syntax: handle memory.compare_new({marea, offset|addrobj}, size, rows, stride)
3658 \begin_layout Standard
3662 \begin_layout Itemize
3663 marea: string: The memory area to interpret <offset> against.
3666 \begin_layout Itemize
3667 offset: number: The initial offset in memory area.
3670 \begin_layout Itemize
3671 addrobj: ADDRESS: The memory address.
3674 \begin_layout Itemize
3675 size: number: The number of bytes in each row.
3678 \begin_layout Itemize
3679 rows: number: The number of rows.
3683 \begin_layout Itemize
3684 stride: number: The number of bytes offset increments from one row to next.
3687 \begin_layout Standard
3691 \begin_layout Itemize
3695 \begin_layout Standard
3696 Return an object watching specified memory area.
3699 \begin_layout Itemize
3700 Note: For fastest operation, limit checks to inside one memory area (that
3701 has to be mappable, individual RAM areas often are).
3704 \begin_layout Subsubsection
3705 operator(): Check area for modifications
3708 \begin_layout Itemize
3709 Syntax: boolean handle()
3712 \begin_layout Standard
3716 \begin_layout Itemize
3717 True if memory block has been modified since last call (or object creation
3718 if first call), false if not.
3721 \begin_layout Standard
3722 Check if the block has been modified.
3725 \begin_layout Subsection
3726 ADDRESS: Memory address
3729 \begin_layout Standard
3730 Objects of this class contain a memory address.
3733 \begin_layout Subsubsection
3734 Static function new: Create new memory address
3737 \begin_layout Itemize
3738 Syntax: ADDRESS classes.ADDRESS.new(string marea, number offset)
3741 \begin_layout Itemize
3742 Syntax: ADDRESS memory.address.new(string marea, number offset)
3745 \begin_layout Itemize
3746 Syntax: ADDRESS memory.mkaddr(string marea, number offset)
3749 \begin_layout Standard
3753 \begin_layout Itemize
3754 marea: The memory area
3757 \begin_layout Itemize
3758 offset: The offset in memory area.
3761 \begin_layout Standard
3765 \begin_layout Itemize
3769 \begin_layout Standard
3770 Construct a new memory address object.
3773 \begin_layout Subsubsection
3774 Method: addr: Get global address
3777 \begin_layout Itemize
3778 Syntax: number addr:addr()
3781 \begin_layout Standard
3785 \begin_layout Itemize
3786 addr: ADRESS: The original address.
3789 \begin_layout Standard
3793 \begin_layout Itemize
3794 The global address corresponding to this address.
3797 \begin_layout Subsubsection
3798 Method: vma: Get memory area
3801 \begin_layout Itemize
3802 Syntax: string addr:vma()
3805 \begin_layout Standard
3809 \begin_layout Itemize
3810 addr: ADRESS: The original address.
3813 \begin_layout Standard
3817 \begin_layout Itemize
3818 The memory area corresponding to this address.
3821 \begin_layout Subsubsection
3822 Method: offset: Get memory area offset
3825 \begin_layout Itemize
3826 Syntax: string addr:offset()
3829 \begin_layout Standard
3833 \begin_layout Itemize
3834 addr: ADRESS: The original address.
3837 \begin_layout Standard
3841 \begin_layout Itemize
3842 The offset in memory area corresponding to this address.
3845 \begin_layout Subsubsection
3846 Method: replace: Replace address part
3849 \begin_layout Itemize
3850 Syntax: ADDRESS addr:replace(offset[, bits])
3853 \begin_layout Standard
3857 \begin_layout Itemize
3858 addr: ADRESS: The original address.
3861 \begin_layout Itemize
3862 offset: number: The new offset
3865 \begin_layout Itemize
3866 bits: number: The number of LSB to replace.
3869 \begin_layout Standard
3873 \begin_layout Itemize
3874 The modified address
3877 \begin_layout Standard
3878 Returns a new address, with <bits> (all if missing) least significant bits
3879 of <addr> replaced by LSB of <offset>.
3882 \begin_layout Subsubsection
3883 Method: add: Add to address
3886 \begin_layout Itemize
3887 Syntax: ADDRESS addr:add(offset)
3890 \begin_layout Itemize
3891 Syntax: ADDRESS addr:add(number, stride)
3894 \begin_layout Itemize
3895 Syntax: ADDRESS addr:add(number, stride, offset)
3898 \begin_layout Standard
3902 \begin_layout Itemize
3903 addr: ADRESS: The original address.
3906 \begin_layout Itemize
3907 offset: number: Offset to add.
3910 \begin_layout Itemize
3911 number: number: Number of table strides to add.
3914 \begin_layout Itemize
3915 stride: number: The table stride.
3918 \begin_layout Standard
3922 \begin_layout Itemize
3923 The modified address
3926 \begin_layout Standard
3927 Adds <offset>, <number>*<stride> or <number>*<stride>+<offset> into specified
3931 \begin_layout Subsection
3932 ADDRESS:<op>: Read/Write memory
3935 \begin_layout Itemize
3936 Syntax: none addr:<op>(value)
3939 \begin_layout Itemize
3940 Syntax: number addr:<op>()
3943 \begin_layout Standard
3947 \begin_layout Itemize
3948 addr: ADDRESS: The address to read/write.
3951 \begin_layout Itemize
3952 value: number: The number to write.
3955 \begin_layout Standard
3959 \begin_layout Itemize
3963 \begin_layout Standard
3964 Read/Write value from/to given address <addr>.
3965 The value written is <value>.
3966 <Op> is of form: [i][s]<type>, where:
3969 \begin_layout Itemize
3970 <type> is one of 'byte', 'word', 'hword', 'dword', 'qword', 'float', 'double'.
3973 \begin_layout Itemize
3974 'i' signifies that the value is treated as opposite-to-normal endianess,
3977 \begin_layout Itemize
3978 's' signifies that value is treated as signed (not available for floating-point).
3981 \begin_layout Standard
3982 \begin_inset Newpage pagebreak
3988 \begin_layout Section
3992 \begin_layout Subsection
3993 print: Print values to console
3996 \begin_layout Itemize
3997 Syntax: none print(value...
4001 \begin_layout Standard
4002 Prints specified values to console.
4003 Can print any Lua type at least enough to identify the type and instance.
4006 \begin_layout Subsection
4007 tostringx: Format a value to string
4010 \begin_layout Itemize
4011 Syntax: string tostringx(value val)
4014 \begin_layout Standard
4015 Formats value <val> like print would, and returns the result as a string.
4018 \begin_layout Subsection
4019 exec: Execute lsnes commands
4022 \begin_layout Itemize
4023 Syntax: none exec(string cmd)
4026 \begin_layout Standard
4027 Execute lsnes command <cmd>.
4030 \begin_layout Subsection
4031 utime: Get current time
4034 \begin_layout Itemize
4035 Syntax: (number,number) utime()
4038 \begin_layout Standard
4039 Returns two numbers.
4040 First is time since some epoch in seconds, the second is microseconds mod
4041 10^6 since that epoch.
4044 \begin_layout Subsection
4045 set_idle_timeout: Run function after timeout when emulator is idle
4048 \begin_layout Itemize
4049 Syntax: none set_idle_timeout(number timeout)
4052 \begin_layout Standard
4053 Set number of microseconds to block idle for.
4054 After this timeout has expired, on_idle() will be called once.
4057 \begin_layout Subsection
4058 set_timer_timeout: Run function after timeout.
4061 \begin_layout Itemize
4062 Syntax: none set_timer_timeout(number timeout)
4065 \begin_layout Standard
4066 Set number of microseconds to block timer for.
4067 After this timeout has expired, on_timer() will be called once.
4070 \begin_layout Subsection
4071 bus_address: Look up address in system bus.
4074 \begin_layout Itemize
4075 Syntax: none bus_address(number bus_addr)
4078 \begin_layout Standard
4079 Returns virtual address corresponding to specified address on system bus.
4082 \begin_layout Subsection
4083 loopwrapper: Convert loop into callable function
4086 \begin_layout Itemize
4087 Syntax: function loopwrapper(function fun, ...)
4090 \begin_layout Standard
4091 Calls function <fun> with function and specified arguments.
4092 The function passed suspends execution until the function returned is called.
4093 Handy for linear flow control among multiple invocations of a hook.
4097 \begin_layout LyX-Code
4098 on_paint = loopwrapper(function(wait)
4102 \begin_layout LyX-Code
4107 \begin_layout LyX-Code
4109 \begin_inset Quotes eld
4113 \begin_inset Quotes erd
4119 \begin_layout LyX-Code
4124 \begin_layout LyX-Code
4129 \begin_layout LyX-Code
4133 \begin_layout Subsection
4134 list_bindings: List keybindings
4137 \begin_layout Itemize
4138 Syntax: table list_bindings([string cmd])
4141 \begin_layout Standard
4142 Get table of all keybindings, indexed by keyspec (modifiers|mask/key).
4143 If <cmd> is specified, the table is limited to that command.
4144 Also searches for controller keys.
4147 \begin_layout Subsection
4148 get_alias: Get expansion of alias
4151 \begin_layout Itemize
4152 Syntax: string get_alias(string aname)
4155 \begin_layout Standard
4156 Get expansion of given alias <aname>.
4159 \begin_layout Subsection
4160 set_alias: Set expansion of alias
4163 \begin_layout Itemize
4164 Syntax: none set_alias(string aname, string value)
4167 \begin_layout Standard
4168 Set expansion of given alias.
4171 \begin_layout Subsection
4172 create_ibind: Create invese binding
4175 \begin_layout Itemize
4176 Syntax: INVERSEBIND create_ibind(string name, string cmd)
4179 \begin_layout Standard
4180 Return object representing inverse binding with specified name <name> and
4181 specified command <cmd>.
4184 \begin_layout Itemize
4185 Note: To create press/release commands, use aliases +foo and -foo .
4188 \begin_layout Itemize
4189 Note: Keep the returned object around.
4192 \begin_layout Subsection
4193 create_command: Create a command
4196 \begin_layout Itemize
4197 Syntax: COMMANDBIND create_command(string name, function a)
4200 \begin_layout Itemize
4201 Syntax: COMMANDBIND create_command(string name, function a, function b)
4204 \begin_layout Standard
4205 Return object representing a command (pair).
4208 \begin_layout Itemize
4209 If only one function is specied, the command is level-sensitive, <a> is
4213 \begin_layout Itemize
4214 If <b> is function, the function is edge-sensitive, <a> is positive edge
4215 callback and <b> is negative edge callback.
4218 \begin_layout Itemize
4219 All callbacks get single argument: The parameters passed.
4222 \begin_layout Itemize
4223 Keep the returned object around.
4226 \begin_layout Subsection
4227 loadfile: Load Lua script
4230 \begin_layout Itemize
4231 Syntax: function loadfile(string filename[, string base])
4234 \begin_layout Standard
4235 Load lua script from <filename>, resolved relative to <base> (if empty,
4239 \begin_layout Subsection
4240 dofile: Execute Lua script
4243 \begin_layout Itemize
4244 Syntax: function dofile(string filename[, string base])
4247 \begin_layout Standard
4248 Execute lua script from <filename>, resolved relative to <base> (if empty,
4249 current directory) and return all return values.
4252 \begin_layout Subsection
4253 resolve_filename: Resolve name of file relative to another
4256 \begin_layout Itemize
4257 Syntax: string resolve_filename(string filename[, string base])
4260 \begin_layout Standard
4261 Resolve name of file <filename> relative to <base> and return the result.
4264 \begin_layout Subsection
4265 render_queue_function: Return paint function for render queue
4268 \begin_layout Itemize
4269 Syntax: function render_queue_function(RENDERQUEUE rq)
4272 \begin_layout Standard
4273 Return function that renders render queue <rq>.
4276 \begin_layout Itemize
4277 Handy for paint callback if one is using render queues updated in other
4282 \begin_layout LyX-Code
4283 handle = callback.paint:register(render_queue_function(my_rq));
4286 \begin_layout Subsection
4287 identify_class: Identify class of object
4290 \begin_layout Itemize
4291 Syntax: string identify_class(userdata object)
4294 \begin_layout Standard
4295 Identifies the class of userdata <object>, if possible.
4296 If no identification is possible, returns
4297 \begin_inset Quotes eld
4301 \begin_inset Quotes erd
4307 \begin_layout Subsection
4308 lookup_class: Lookup class by name
4311 \begin_layout Itemize
4312 Syntax: classobj lookup_class(string name)
4315 \begin_layout Standard
4316 Looks up class corresponding to <name>, if possible.
4317 If not found, returns nil.
4318 The classobj has following fields:
4321 \begin_layout Itemize
4322 _static_methods: Return static method names
4325 \begin_layout Itemize
4326 _class_methods: Return class method names
4329 \begin_layout Itemize
4330 <static-function-name>: The specified static function.
4333 \begin_layout Subsection
4334 all_classes: Get list of all classes
4337 \begin_layout Itemize
4342 \begin_layout Standard
4343 Get names of all classes available.
4346 \begin_layout Subsection
4350 \begin_layout Subsection
4354 \begin_layout Standard
4358 \begin_layout Subsection
4359 filereader: Class FILEREADER
4362 \begin_layout Standard
4363 See class FILEREADER.
4366 \begin_layout Standard
4367 \begin_inset Newpage pagebreak
4373 \begin_layout Section
4377 \begin_layout Standard
4378 Bitwise logical functions and related.
4381 \begin_layout Subsection
4382 bit.none/bit.bnot: Bitwise none or NOT function
4385 \begin_layout Itemize
4386 Syntax: number bit.none(number...)
4389 \begin_layout Itemize
4390 Syntax: number bit.bnot(number...)
4393 \begin_layout Standard
4394 48-bit bitwise NOT / NONE function (set bits that are set in none of the
4398 \begin_layout Subsection
4399 bit.any/bit.bor: Bitwise any or OR function
4402 \begin_layout Itemize
4403 Syntax: number bit.any(number...)
4406 \begin_layout Itemize
4407 Syntax: number bit.bor(number...)
4410 \begin_layout Standard
4411 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
4414 \begin_layout Subsection
4415 bit.all/bit.band: Bitwise all or AND function
4418 \begin_layout Itemize
4419 Syntax: number bit.all(number...)
4422 \begin_layout Itemize
4423 Syntax: number bit.band(number...)
4426 \begin_layout Standard
4427 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
4431 \begin_layout Subsection
4432 bit.parity/bit.bxor: Bitwise parity or XOR function
4435 \begin_layout Itemize
4436 Syntax: number bit.parity(number...)
4439 \begin_layout Itemize
4440 Syntax: number bit.bxor(number...)
4443 \begin_layout Standard
4444 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
4448 \begin_layout Subsection
4449 bit.lrotate: Rotate a number left
4452 \begin_layout Itemize
4453 Syntax: number bit.lrotate(number base[, number amount[, number bits]])
4456 \begin_layout Standard
4457 Rotate <bits>-bit (max 48, default 48) number <base> left by <amount> (default
4461 \begin_layout Subsection
4462 bit.rrotate: Rotate a number right
4465 \begin_layout Itemize
4466 Syntax: number bit.rrotate(number base[, number amount[, number bits]])
4469 \begin_layout Standard
4470 Rotate <bits>-bit (max 48, default 48) number <base> right by <amount> (default
4474 \begin_layout Subsection
4475 bit.lshift: Shift a number left
4478 \begin_layout Itemize
4479 Syntax: number bit.lshift(number base[, number amount[, number bits]])
4482 \begin_layout Standard
4483 Shift <bits>-bit (max 48, default 48) number <base> left by <amount> (default
4485 The new bits are filled with zeroes.
4488 \begin_layout Subsection
4489 bit.lrshift: Shift a number right (logical)
4492 \begin_layout Itemize
4493 Syntax: number bit.lrshift(number base[, number amount[, number bits]])
4496 \begin_layout Standard
4497 Shift <bits>-bit (max 48, default 48) number <base> logically right by <amount>
4499 The new bits are filled with zeroes.
4502 \begin_layout Subsection
4503 bit.arshift: Shift a number right (arithmetic)
4506 \begin_layout Itemize
4507 Syntax: number bit.arshift(number base[, number amount[, number bits]])
4510 \begin_layout Standard
4511 Shift <bits>-bit (max 48, default 48) number <base> logically right by <amount>
4513 The new bits are shifted in with copy of the high bit.
4516 \begin_layout Subsection
4517 bit.extract: Extract/shuffle bits from number
4520 \begin_layout Itemize
4521 Syntax: number bit.extract(number base[, number bit0[, number bit1,...]])
4524 \begin_layout Standard
4525 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1 and so on.
4528 \begin_layout Itemize
4529 Note: Bit numbers up to 51 should work reliably (then things start falling
4530 apart due to double precision issues).
4533 \begin_layout Itemize
4534 Note: There are two special bit positions, true and false, standing for
4535 always set bit and always clear bit.
4538 \begin_layout Subsection
4539 bit.value: Construct number with specified bits set
4542 \begin_layout Itemize
4543 Syntax: number bit.value([number bit1[, number bit2,...]])
4546 \begin_layout Standard
4547 Returns bitwise OR of 1 left shifted by <bit1> places, 1 left shifted by
4548 <bit2> places and so on.
4549 As special value, nil argument is no-op.
4552 \begin_layout Subsection
4553 bit.test: Test if bit is set
4556 \begin_layout Itemize
4557 Syntax: boolean bit.test(number a, number bit)
4560 \begin_layout Standard
4561 Tests if bit <bit> is set in <a>.
4562 If it is set, returns true, otherwise false.
4565 \begin_layout Subsection
4566 bit.testn: Test if bit is clear
4569 \begin_layout Itemize
4570 Syntax: boolean bit.testn(number a, number bit)
4573 \begin_layout Standard
4574 Tests if bit <bit> is set in <a>.
4575 If it is clear, returns true, otherwise false.
4578 \begin_layout Subsection
4579 bit.test_any: Test if any bit is set
4582 \begin_layout Itemize
4583 Syntax: boolean bit.test_any(number a, number b)
4586 \begin_layout Standard
4587 Returns true if bitwise and of <a> and <b> is nonzero, otherwise false.
4590 \begin_layout Subsection
4591 bit.test_all: Test if all bits are set
4594 \begin_layout Itemize
4595 Syntax: boolean bit.test_all(number a, number b)
4598 \begin_layout Standard
4599 Returns true if bitwise and of <a> and <b> equals <b>, otherwise false.
4602 \begin_layout Subsection
4603 bit.popcount: Population count
4606 \begin_layout Itemize
4607 Syntax: number bit.popcount(number a)
4610 \begin_layout Standard
4611 Returns number of set bits in <a>.
4614 \begin_layout Subsection
4615 bit.clshift: Chained left shift
4618 \begin_layout Itemize
4619 Syntax: (number, number) bit.clshift(number a, number b, [number amount,[number
4623 \begin_layout Standard
4624 Does chained left shift on <a>, <b> by <amount> positions (default 1), assuming
4625 numbers to be of specified number of bits <bits> (default 48).
4628 \begin_layout Subsection
4629 bit.crshift: Chained right shift
4632 \begin_layout Itemize
4633 Syntax: (number, number) bit.crshift(number a, number b, [number amount,[number
4637 \begin_layout Standard
4638 Does chained right shift on <a>, <b> by <amount> positions (default 1),
4639 assuming numbers to be of specified number of bits <bits> (default 48).
4642 \begin_layout Subsection
4643 bit.flagdecode: Decode bitfield into flags
4646 \begin_layout Itemize
4647 Syntax: string bit.flagdecode(number a, number bits, [string on, [string
4651 \begin_layout Standard
4652 Return string of length bits where ith character is ith character of on
4653 if bit i is on, otherwise ith character of off.
4654 Out of range reads give last character.
4657 \begin_layout Itemize
4658 Note: <on> defaults to '*' if empty.
4661 \begin_layout Itemize
4662 Note: <off> defaults to '-' if empty.
4665 \begin_layout Subsection
4666 bit.rflagdecode: Decode bitfield into flags
4669 \begin_layout Itemize
4670 Syntax: string bit.rflagdecode(number a, number bits, [string on, [string
4674 \begin_layout Standard
4675 Like bit.flagdecode, but outputs the string in the opposite order (most significa
4679 \begin_layout Subsection
4680 bit.swap{,s}{,h,d,q}word: Swap word endian
4683 \begin_layout Itemize
4684 Syntax: number bit.swapword(number n)
4687 \begin_layout Itemize
4688 Syntax: number bit.swaphword(number n)
4691 \begin_layout Itemize
4692 Syntax: number bit.swapdword(number n)
4695 \begin_layout Itemize
4696 Syntax: number bit.swapqword(number n)
4699 \begin_layout Itemize
4700 Syntax: number bit.swapsword(number n)
4703 \begin_layout Itemize
4704 Syntax: number bit.swapshword(number n)
4707 \begin_layout Itemize
4708 Syntax: number bit.swapsdword(number n)
4711 \begin_layout Itemize
4712 Syntax: number bit.swapsqword(number n)
4715 \begin_layout Standard
4716 Swap endianess of (un)signed integer <n>.
4719 \begin_layout Subsection
4720 bit.compose: Compose multi-byte number
4723 \begin_layout Itemize
4724 Syntax: number bit.compose(number n...)
4727 \begin_layout Standard
4729 \begin_inset Formula $n_{1}+256n_{2}+256^{2}n_{3}+\ldots$
4735 \begin_layout Subsection
4736 bit.binary_ld_{{u,s}{8,16,24,32,64},float,double}{l,b}e: Load binary integer
4739 \begin_layout Itemize
4740 Syntax: number bit.binary_ld_<type>le(string str, number pos);
4743 \begin_layout Itemize
4744 Syntax: number bit.binary_ld_<type>be(string str, number pos);
4747 \begin_layout Standard
4748 Load little (*le) or big (*be) endian binary number from position <pos>
4750 Type may be one of: u8, u16, u24, u32, u64, s8, s16, s24, s32, s64, float,
4754 \begin_layout Subsection
4755 bit.binary_st_{{u,s}{8,16,24,32,64},float,double}{l,b}e: Store binary integer
4758 \begin_layout Itemize
4759 Syntax: string bit.binary_st_<type>le(number x);
4762 \begin_layout Itemize
4763 Syntax: string bit.binary_st_<type>be(number x);
4766 \begin_layout Standard
4767 Store specified number <x> as binary in string and return the result.
4768 Type may be one of: u8, u16, u24, u32, u64, s8, s16, s24, s32, s64, float,
4772 \begin_layout Subsection
4773 bit.quotent: Integer quotent
4776 \begin_layout Itemize
4777 Syntax: number bit.quotent(number a, number b)
4780 \begin_layout Standard
4781 Calculate quotent a/b.
4784 \begin_layout Subsection
4785 bit.multidiv: Divide and split among multiple divisiors
4788 \begin_layout Itemize
4790 bit.multidiv(number v, number q...)
4793 \begin_layout Standard
4794 Does the following steps:
4797 \begin_layout Enumerate
4801 \begin_layout Enumerate
4806 \begin_layout Enumerate
4807 Calculate quotent(v'/q) and add that to numbers returned.
4810 \begin_layout Enumerate
4811 v' <- remainder(v'/q)
4815 \begin_layout Enumerate
4816 Add v' to numbers returned.
4819 \begin_layout Standard
4820 That is, it successively divides <v> by <q>s, and reduces <v> modulo <q>
4822 <v> may be floating point, <q>s are integers.
4825 \begin_layout Itemize
4827 bit.multidiv(time, 3600, 60) splits time into hours, minutes and seconds.
4830 \begin_layout Itemize
4832 bit.multidiv(a, b) calculates quotent and remainder of a/b.
4835 \begin_layout Subsection
4836 bit.mul32: 32-bit multiply
4839 \begin_layout Itemize
4840 Syntax: number, number bit.mul32(number a, number b)
4843 \begin_layout Standard
4844 Multiply 32-bit numbers <a> and <b>.
4845 The first return value is low 32 bits of result, the second is high 32
4849 \begin_layout Standard
4850 \begin_inset Newpage pagebreak
4856 \begin_layout Section
4860 \begin_layout Subsection
4861 classes.<foo>: The classobj for class <foo>
4864 \begin_layout Itemize
4865 Syntax: classes.<foo>
4868 \begin_layout Standard
4869 The classobj for class <foo>.
4872 \begin_layout Subsection
4873 classes.<foo>._static_methods: Enumerate static methods
4876 \begin_layout Itemize
4878 classes.<foo>._static_methods()
4881 \begin_layout Standard
4882 Returns all static methods of <foo> as strings.
4885 \begin_layout Subsection
4886 classes.<foo>._class_methods: Enumerate static methods
4889 \begin_layout Itemize
4891 classes.<foo>._class_methods()
4894 \begin_layout Standard
4895 Returns all class methods of <foo> as strings.
4898 \begin_layout Subsection
4899 classes.<foo>.<bar>: Static method
4902 \begin_layout Itemize
4903 Syntax: variable classes.<foo>.<bar>(variable...)
4906 \begin_layout Standard
4907 Invokes static method <bar> of class <foo>.
4910 \begin_layout Section
4914 \begin_layout Subsection
4915 gui.resolution: Get current resolution
4918 \begin_layout Itemize
4919 Syntax: (number, number) gui.resolution()
4922 \begin_layout Standard
4923 Returns 2-tuple (hresolution, vresolution).
4926 \begin_layout Subsection
4927 gui.left_gap/gui.right_gap/gui.top_gap/gui.bottom_gap: Set edge gaps
4930 \begin_layout Itemize
4931 Syntax: number gui.left_gap(number gap)
4934 \begin_layout Itemize
4935 Syntax: number gui.right_gap(number gap)
4938 \begin_layout Itemize
4939 Syntax: number gui.top_gap(number gap)
4942 \begin_layout Itemize
4943 Syntax: number gui.bottom_gap(number gap)
4946 \begin_layout Standard
4947 Set the specified edge gap to specified value <gap> (max gap is 8191).
4948 If successful, old gap is returned.
4951 \begin_layout Subsection
4952 gui.delta_left_gap/gui.delta_right_gap/gui.delta_top_gap/gui.delta_bottom_gap:
4956 \begin_layout Itemize
4957 Syntax: number gui.delta_left_gap(number dgap)
4960 \begin_layout Itemize
4961 Syntax: number gui.delta_right_gap(number dgap)
4964 \begin_layout Itemize
4965 Syntax: number gui.delta_top_gap(number dgap)
4968 \begin_layout Itemize
4969 Syntax: number gui.delta_bottom_gap(number dgap)
4972 \begin_layout Standard
4973 Increase the specified edge gap by specified value <dgap> (max gap is 8191)
4974 and return the old gap (returns nothing on error).
4977 \begin_layout Subsection
4978 gui.text/gui.textH/gui.textV,gui.textHV: Draw text
4981 \begin_layout Itemize
4982 Syntax: none gui.text(number x, number y, string text[, number fgc[, number
4986 \begin_layout Itemize
4987 Syntax: none gui.textH(number x, number y, string text[, number fgc[, number
4991 \begin_layout Itemize
4992 Syntax: none gui.textV(number x, number y, string text[, number fgc[, number
4996 \begin_layout Itemize
4997 Syntax: none gui.textHV(number x, number y, string text[, number fgc[, number
5001 \begin_layout Standard
5002 Draw specified text on the GUI (each character cell is 8 or 16 wide and
5007 \begin_layout Itemize
5008 x: X-coordinate to start the drawing from (and x-coordinate at begining
5012 \begin_layout Itemize
5013 y: Y-coordinate to start the drawing from.
5016 \begin_layout Itemize
5017 text: The text to draw.
5020 \begin_layout Itemize
5021 fgc: Text color (default is 0xFFFFFF (white))
5024 \begin_layout Itemize
5025 bgc: Background color (default is -1 (transparent))
5028 \begin_layout Standard
5029 Note: The H variants draw at double width and V variants draw at double
5033 \begin_layout Subsection
5034 gui.rectangle: Draw a rectangle
5037 \begin_layout Itemize
5038 Syntax: none gui.rectangle(number x, number y, number width, number height[,
5039 number thickness[, number outline[, number fill]]])
5042 \begin_layout Standard
5043 Draw rectangle on the GUI.
5047 \begin_layout Itemize
5048 x: X-coordinate of left edge.
5051 \begin_layout Itemize
5052 y: Y-coordinate of upper edge.
5055 \begin_layout Itemize
5056 width: Width of rectangle.
5059 \begin_layout Itemize
5060 height: Height of rectangle.
5063 \begin_layout Itemize
5064 thickness: Thickness of outline (default is 1).
5067 \begin_layout Itemize
5068 outline: Color of outline (default is 0xFFFFFF (white))
5071 \begin_layout Itemize
5072 fill: Color of fill (default is -1 (transparent))
5075 \begin_layout Subsection
5076 gui.solidrectangle: Draw a solid rectangle
5079 \begin_layout Itemize
5080 Syntax: none gui.rectangle(number x, number y, number width, number height[,
5084 \begin_layout Standard
5085 Draw solid rectangle on the GUI.
5089 \begin_layout Itemize
5090 x: X-coordinate of left edge.
5093 \begin_layout Itemize
5094 y: Y-coordinate of upper edge.
5097 \begin_layout Itemize
5098 width: Width of rectangle.
5101 \begin_layout Itemize
5102 height: Height of rectangle.
5105 \begin_layout Itemize
5106 color: Color of rectangle (default is 0xFFFFFF (white))
5109 \begin_layout Subsection
5110 gui.box: Draw a 3D-effect box
5113 \begin_layout Itemize
5114 Syntax: none gui.box(number x, number y, number width, number height[, number
5115 thickness[, number outline1[,number outline2[, number fill]]]])
5118 \begin_layout Standard
5119 Draw rectangle with 3D effect on the GUI.
5123 \begin_layout Itemize
5124 x: X-coordinate of left edge.
5127 \begin_layout Itemize
5128 y: Y-coordinate of upper edge.
5131 \begin_layout Itemize
5132 width: Width of rectangle.
5135 \begin_layout Itemize
5136 height: Height of rectangle.
5139 \begin_layout Itemize
5140 thickness: Thickness of outline (default is 1).
5143 \begin_layout Itemize
5144 outline1: First color of outline (default is 0xFFFFFF (white))
5147 \begin_layout Itemize
5148 outline2: First color of outline (default is 0x808080 (dark gray))
5151 \begin_layout Itemize
5152 fill: Color of fill (default is 0xC0C0C0 (light grayy))
5155 \begin_layout Subsection
5156 gui.pixel: Draw a single pixel
5159 \begin_layout Itemize
5160 Syntax: none gui.pixel(number x, number y[, number color])
5163 \begin_layout Standard
5164 Draw one pixel on the GUI.
5168 \begin_layout Itemize
5169 x: X-coordinate of the pixel
5172 \begin_layout Itemize
5173 y: Y-coordinate of the pixel
5176 \begin_layout Itemize
5177 color: Color of the pixel (default is 0xFFFFFF (white))
5180 \begin_layout Subsection
5181 gui.crosshair: Draw a crosshair
5184 \begin_layout Itemize
5185 Syntax: none gui.crosshair(number x, number y[, number length[, number color]])
5188 \begin_layout Standard
5193 \begin_layout Itemize
5194 x: X-coordinate of the crosshair
5197 \begin_layout Itemize
5198 y: Y-coordinate of the crosshair
5201 \begin_layout Itemize
5202 length: Length of the crosshair lines (default 10).
5205 \begin_layout Itemize
5206 color: Color of the crosshair (default is 0xFFFFFF (white))
5209 \begin_layout Subsection
5210 gui.line: Draw a line
5213 \begin_layout Itemize
5214 Syntax: none gui.line(number x1, number y1, number x2, number y2[, number
5218 \begin_layout Standard
5223 \begin_layout Itemize
5224 x1: X-coordinate of one end.
5227 \begin_layout Itemize
5228 y1: Y-coordinate of one end.
5231 \begin_layout Itemize
5232 x2: X-coordinate of the other end.
5235 \begin_layout Itemize
5236 y2: Y-coordinate of the other end.
5239 \begin_layout Itemize
5240 color: Color of the line (default is 0xFFFFFF (white)).
5243 \begin_layout Subsection
5244 gui.circle: Draw a (filled) circle
5247 \begin_layout Itemize
5248 Syntax: none gui.circle(number x, number y, number r[, number thick[, number
5249 border[, number fil]]])
5252 \begin_layout Standard
5257 \begin_layout Itemize
5258 x: X-coordinate of the center
5261 \begin_layout Itemize
5262 y: Y-coordinate of the center
5265 \begin_layout Itemize
5266 r: The radius of the circle
5269 \begin_layout Itemize
5270 thick: Border thickness
5273 \begin_layout Itemize
5274 border: Border color (default is 0xFFFFFF (white))
5277 \begin_layout Itemize
5278 fill: Fill color (default is -1 (transparent)).
5281 \begin_layout Subsection
5282 gui.repaint: Arrange a repaint
5285 \begin_layout Itemize
5286 Syntax: none gui.repaint()
5289 \begin_layout Standard
5290 Request on_repaint() to happen as soon as possible.
5293 \begin_layout Subsection
5294 gui.subframe_update: Enable/Disable subframe updates
5297 \begin_layout Itemize
5298 Syntax: none gui.subframe_update(boolean on)
5301 \begin_layout Standard
5302 Request subframe updates (calling on_paint() on subframes) to happen (<on>=true)
5303 or not happen (<on>=false).
5306 \begin_layout Subsection
5307 gui.screenshot: Write a screenshot
5310 \begin_layout Itemize
5311 Syntax: none gui.screenshot(string filename)
5314 \begin_layout Standard
5315 Write PNG screenshot of the current frame (no drawings) to specified file
5319 \begin_layout Subsection
5320 gui.screenshot_bitmap: Write a screenshot to bitmap
5323 \begin_layout Itemize
5324 Syntax: DBITMAP gui.screenshot_bitmap()
5327 \begin_layout Standard
5328 Write PNG screenshot of the current frame (no drawings) to dbitmap and return
5332 \begin_layout Subsection
5333 gui.color: Compose a color.
5336 \begin_layout Itemize
5337 Syntax: number gui.color(number r, number g, number b[, number a])
5340 \begin_layout Itemize
5341 Syntax: number gui.color(string c)
5344 \begin_layout Standard
5345 Returns color (in notation Lua scripts use) corresponding to color (<r>,<g>,<b>)
5346 , each component in scale 0-255.
5347 If <a> is specified, that is alpha (0 is fully transparent, 256(sic) is
5349 The default alpha is 256.
5352 \begin_layout Standard
5353 The form taking a string returns color corresponding color name.
5356 \begin_layout Subsection
5357 gui.status: Set status variable
5360 \begin_layout Itemize
5361 Syntax: none gui.status(string name, string value)
5364 \begin_layout Standard
5366 \begin_inset Quotes eld
5370 \begin_inset Quotes erd
5373 to <value> in status area.
5376 \begin_layout Subsection
5377 gui.rainbow: Rainbow color calculation
5380 \begin_layout Itemize
5381 Syntax: number gui.rainbow(number step, number steps[, number color])
5384 \begin_layout Standard
5385 Perform hue rotation of color <color> (default bright red), by <step> steps.
5386 The number of steps per full rotation is given by absolute value of <steps>.
5389 \begin_layout Standard
5390 If <step> is negative, the rotation will be counterclockwise.
5393 \begin_layout Subsection
5394 gui.kill_frame: Kill video frame and associated sound
5397 \begin_layout Itemize
5398 Syntax: none gui.kill_frame()
5401 \begin_layout Standard
5402 Kills the currently dumped video frame + the associated sound.
5403 Only valid in on_video callback.
5406 \begin_layout Subsection
5407 gui.set_video_scale: Set video frame scale
5410 \begin_layout Itemize
5411 Syntax: none gui.set_video_scale(number h, number v)
5414 \begin_layout Standard
5415 Sets the scale factors of current frame to <h>x<v>.
5416 Only valid in on_video callback.
5419 \begin_layout Subsection
5420 gui.arrow: Draw an arrow
5423 \begin_layout Itemize
5424 Syntax: none gui.arrow(number x, number y, number length, number hwidth,
5425 number direction[, bool fill[, number color[, number twidth[, number hthick]]]]
5429 \begin_layout Standard
5430 Draws an arrow using color <color>.
5431 The tip of arrow is at (<x>, <y>).
5435 \begin_layout Enumerate
5436 <length>: The length of arrow tail.
5439 \begin_layout Enumerate
5440 <hwidth>: The width of arrow head.
5444 \begin_layout Enumerate
5445 <direction>: Direction of arrow.
5446 0 is to right, +1 rotates 45 degrees counterclockwise.
5449 \begin_layout Enumerate
5450 <fill>: If true, fill the arrow head.
5454 \begin_layout Enumerate
5455 <twidth>: Tail width.
5460 \begin_layout Enumerate
5461 <hthick>: Head thickness (only used if <fill> is false).
5462 Default is <twidth>.
5465 \begin_layout Subsection
5466 gui.tiled_bitmap: Class TILEMAP
5469 \begin_layout Standard
5473 \begin_layout Subsection
5474 gui.palette: Class PALETTE
5477 \begin_layout Standard
5481 \begin_layout Subsection
5482 gui.bitmap: Class BITMAP
5485 \begin_layout Standard
5489 \begin_layout Subsection
5490 gui.dbitmap: Class DBITMAP
5493 \begin_layout Standard
5497 \begin_layout Subsection
5498 gui.font: Class CUSTOMFONT
5501 \begin_layout Standard
5502 See class CUSTOMFONT.
5505 \begin_layout Subsection
5506 gui.renderctx: Class RENDERCTX
5509 \begin_layout Standard
5510 See class RENDERCTX.
5513 \begin_layout Subsection
5514 gui.image: Class IMAGELOADER
5517 \begin_layout Standard
5518 See class IMAGELOADER.
5521 \begin_layout Subsection
5522 gui.get_runmode: Get current emulator mode
5525 \begin_layout Itemize
5526 Syntax: string gui.get_runmode()
5529 \begin_layout Standard
5530 Gets the current emulator runmode.
5531 The possible ones are:
5534 \begin_layout Itemize
5535 quit: Emulator is quitting.
5538 \begin_layout Itemize
5539 normal: Emulator is running emulation
5542 \begin_layout Itemize
5543 load: Emulator is loading a movie/savestate
5546 \begin_layout Itemize
5547 advance_frame: Emulator is doing frame advance
5550 \begin_layout Itemize
5551 advance_subframe: Emulator is doing subframe advance
5554 \begin_layout Itemize
5555 skiplag: Emulator is skipping lag frames
5558 \begin_layout Itemize
5559 skiplag_pending: Emulator will start skipping lag frames next frame
5562 \begin_layout Itemize
5563 pause: Emulator is paused
5566 \begin_layout Itemize
5567 pause_break: Emulator is paused at breakpoint
5570 \begin_layout Itemize
5571 corrupt: Emulator can't run because corrupt emulation state
5574 \begin_layout Itemize
5575 unknown: Unknown state (should not happen).
5578 \begin_layout Standard
5579 \begin_inset Newpage pagebreak
5585 \begin_layout Section
5589 \begin_layout Standard
5591 Functions manipulating input are only available in on_input callback.
5594 \begin_layout Subsection
5595 input.get: Read controller button/axis (deprecated)
5598 \begin_layout Itemize
5599 Syntax: number input.get(number controller, number index)
5602 \begin_layout Standard
5603 Read the specified index <index> (zero-based) from specified controller
5604 <controller> (zero-based).
5608 \begin_layout Subsection
5609 input.set: Write controller button/axis (deprecated)
5612 \begin_layout Itemize
5613 Syntax: none input.set(number controller, number index, number value)
5616 \begin_layout Standard
5617 Write the specified index <index> (zero-based) from specified controller
5618 <controller> (zero-based), storing value <value>.
5621 \begin_layout Subsection
5622 input.get2: Read controller button/axis
5625 \begin_layout Itemize
5626 Syntax: number input.get2(number port, number controller, number index)
5629 \begin_layout Standard
5630 Read the specified input tuple.
5631 Port 0 is system port.
5634 \begin_layout Subsection
5635 input.set2: Write controller button/axis
5638 \begin_layout Itemize
5639 Syntax: input.set2(number port, number controller, number index, number value)
5642 \begin_layout Standard
5643 Write the specified input tuple.
5644 Port 0 is system port.
5647 \begin_layout Subsection
5648 input.lcid_to_pcid2: Look up logical controller
5651 \begin_layout Itemize
5652 Syntax: (number, number) input.lcid_to_pcid2(number lcid)
5655 \begin_layout Standard
5656 Look up physical pcid pair (port, controller) corresponding to specified
5657 logical controller (1-based).
5658 Returns nothing if controller does not exist.
5661 \begin_layout Subsection
5662 input.port_type: Look up port type
5665 \begin_layout Itemize
5666 Syntax: string input.port_type(number port)
5669 \begin_layout Standard
5670 Return type of specified port.
5673 \begin_layout Subsection
5674 input.controller_info: Get information about controller
5677 \begin_layout Itemize
5678 Syntax: table input.controller_info(number port, number controller)
5681 \begin_layout Standard
5682 Get controller info for specified controller.
5683 If controller does not exist, returns nil.
5684 Otherwise returns a table with following fields:
5687 \begin_layout Itemize
5688 type (string): Type of the controller.
5691 \begin_layout Itemize
5692 class (string): Class of the controller.
5695 \begin_layout Itemize
5696 classnum (number): Number of the controller within its class (1-based)
5699 \begin_layout Itemize
5700 lcid (number): Logical controller number of the controller.
5703 \begin_layout Itemize
5704 button_count (number): Number of buttons on controller
5707 \begin_layout Itemize
5708 buttons (array): Array of following info about each button:
5712 \begin_layout Itemize
5713 type (string): Type of button.
5715 \begin_inset Quotes eld
5719 \begin_inset Quotes erd
5723 \begin_inset Quotes eld
5727 \begin_inset Quotes erd
5731 \begin_inset Quotes eld
5735 \begin_inset Quotes erd
5739 \begin_inset Quotes eld
5743 \begin_inset Quotes erd
5749 \begin_layout Itemize
5750 name (string): Name of button.
5753 \begin_layout Itemize
5754 symbol (string): Symbol of button.
5755 Only present for type
5756 \begin_inset Quotes eld
5760 \begin_inset Quotes erd
5766 \begin_layout Itemize
5767 hidden (boolean): True if hidden button.
5772 \begin_layout Subsection
5773 input.veto_button: Veto a button press
5776 \begin_layout Itemize
5777 Syntax: none input.veto_button()
5780 \begin_layout Standard
5781 Signals that the button event should be vetoed.
5782 Only valid in on_button callback.
5785 \begin_layout Subsection
5786 input.geta: Get all buttons for controller (deprecated)
5789 \begin_layout Itemize
5790 Syntax: (number, number...) input.geta(number controller)
5793 \begin_layout Standard
5794 Get input state for entiere controller.
5795 Returns n return values.
5798 \begin_layout Itemize
5799 1st return value: Bitmask: bit i is set if i:th index is nonzero
5802 \begin_layout Itemize
5803 2nd- return value: value of i:th index.
5806 \begin_layout Subsection
5807 input.seta: Set all buttons for controller (deprecated)
5810 \begin_layout Itemize
5811 Syntax: none input.seta(number controller, number bitmask, number args...)
5814 \begin_layout Standard
5815 Set state for entiere controller.
5816 args is up to N values for indices (overriding values in bitmask if specified).
5819 \begin_layout Subsection
5820 input.controllertype: Get controller type (deprecated)
5823 \begin_layout Itemize
5824 syntax: string input.controllertype(number controller)
5827 \begin_layout Standard
5828 Get the type of controller as string.
5831 \begin_layout Subsection
5832 input.reset: Execute (delayed) reset
5835 \begin_layout Itemize
5836 Syntax: none input.reset([number cycles])
5839 \begin_layout Standard
5841 If <cycles> is greater than zero, do delayed reset.
5842 0 (or no value) causes immediate reset.
5845 \begin_layout Itemize
5846 Note: Only available with subframe flag false.
5849 \begin_layout Subsection
5850 input.raw: Return raw input data
5853 \begin_layout Itemize
5854 Syntax: table input.raw()
5857 \begin_layout Standard
5858 Returns table of tables of all available keys and axes.
5859 The first table is indexed by key name (platform-dependent!), and the inner
5860 table has the following fields:
5863 \begin_layout Itemize
5864 value: Last reported value for control
5868 \begin_layout Itemize
5869 For keys: 1 for pressed, 0 for released.
5872 \begin_layout Itemize
5873 For axes: -32767...32767.
5876 \begin_layout Itemize
5877 For presure-sensitive buttons: 0...32767.
5880 \begin_layout Itemize
5881 For hats: Bitmask: 1=>Up, 2=>Right, 4=>Down, 8=>Left.
5884 \begin_layout Itemize
5885 For mouse: Coordinates relative to game area.
5889 \begin_layout Itemize
5890 ktype: Type of key (disabled, key, mouse, axis, hat, pressure).
5893 \begin_layout Subsection
5894 input.keyhook: Hook a key
5897 \begin_layout Itemize
5898 Syntax: none input.keyhook(string key, boolean state)
5901 \begin_layout Standard
5902 Requests that keyhook events to be sent for key <key> (<state>=true) or
5903 not sent (<state>=false).
5906 \begin_layout Subsection
5907 input.joyget: Get controls for controller
5910 \begin_layout Itemize
5911 Syntax: table input.joyget(number logical)
5914 \begin_layout Standard
5915 Returns table for current controls for specified logical controller <logical>.
5916 The names of fields vary by controller type.
5919 \begin_layout Itemize
5920 The buttons have the same name as those are referred to in other contexts
5924 \begin_layout Itemize
5925 The analog axes are usually
5926 \begin_inset Quotes eld
5930 \begin_inset Quotes erd
5934 \begin_inset Quotes eld
5938 \begin_inset Quotes erd
5944 \begin_layout Itemize
5945 Each field is numeric or boolean depending on axis/button.
5948 \begin_layout Subsection
5949 input.joyset: Set controls for controller
5952 \begin_layout Itemize
5953 Syntax: none input.joyset(number controller, table controls)
5956 \begin_layout Standard
5957 Set the the state of specified controller to values specified in specified
5961 \begin_layout Itemize
5962 Each field can be boolean or number.
5965 \begin_layout Itemize
5966 Also, buttons allow strings, which cause value to be inverted.
5969 \begin_layout Subsection
5970 input.lcid_to_pcid: Look up logical controller (deprecated)
5973 \begin_layout Itemize
5974 Syntax: (number, number, number) input.lcid_to_pcid(number lcid)
5977 \begin_layout Standard
5978 Returns the legacy pcid for controller (or false if there isn't one), followed
5980 Returns nothing if controller does not exist.
5983 \begin_layout Standard
5984 \begin_inset Newpage pagebreak
5990 \begin_layout Section
5994 \begin_layout Standard
5995 Various keybinding-related functions
5998 \begin_layout Subsection
5999 keyboard.bind: Bind a key
6002 \begin_layout Itemize
6003 Syntax: none keyboard.bind(string mod, string mask, string key, string cmd)
6006 \begin_layout Standard
6007 Bind specified key with specified modifers to specified command.
6010 \begin_layout Subsection
6011 keyboard.unbind: Unbind a key
6014 \begin_layout Itemize
6015 Syntax: none keyboard.unbind(string mod, string mask, string key)
6018 \begin_layout Standard
6019 Unbind specified key with specified modifers.
6022 \begin_layout Subsection
6023 keyboard.alias: Set alias expansion
6026 \begin_layout Itemize
6027 Syntax: none keyboard.alias(string alias, string expansion)
6030 \begin_layout Standard
6031 Set expansion of given command.
6034 \begin_layout Standard
6035 \begin_inset Newpage pagebreak
6041 \begin_layout Section
6045 \begin_layout Standard
6049 \begin_layout Subsection
6050 subtitle.byindex: Look up start and length of subtitle by index
6053 \begin_layout Itemize
6054 Syntax: (number, number) subtitle.byindex(number i)
6057 \begin_layout Standard
6058 Read the frame and length of ith subtitle.
6059 Returns nothing if not present.
6062 \begin_layout Subsection
6063 subtitle.set: Write a subtitle
6066 \begin_layout Itemize
6067 Syntax: none subtitle.set(number f, number l, string txt)
6070 \begin_layout Standard
6071 Set the text of subtitle.
6074 \begin_layout Subsection
6075 subtitle.get: Read a subtitle
6078 \begin_layout Itemize
6079 Syntax: string subtitle.get(number f, number l)
6082 \begin_layout Standard
6083 Get the text of subtitle.
6086 \begin_layout Subsection
6087 subtitle.delete: Delete a subtitle
6090 \begin_layout Itemize
6091 Syntax: none subtitle.delete(number f, number l)
6094 \begin_layout Standard
6095 Delete specified subtitle.
6098 \begin_layout Standard
6099 \begin_inset Newpage pagebreak
6105 \begin_layout Section
6109 \begin_layout Standard
6110 Host memory handling (extra memory saved to savestates).
6111 Host memory starts empty.
6114 \begin_layout Itemize
6115 Reads out of range return false.
6118 \begin_layout Itemize
6119 Writes out of range extend the memory.
6122 \begin_layout Subsection
6123 hostmemory.read: Read byte from host memory
6126 \begin_layout Itemize
6127 Syntax: number hostmemory.read(number address)
6130 \begin_layout Standard
6131 Reads byte from hostmemory slot address <address>.
6134 \begin_layout Subsection
6135 hostmemory.write: Write byte to host memory
6138 \begin_layout Itemize
6139 Syntax: none hostmemory.write(number address, number value)
6142 \begin_layout Standard
6143 Writes hostmemory slot with value <value> 0-255.
6146 \begin_layout Subsection
6147 hostmemory.read{,s}{byte,{,h,d,q}word}: Read from host memory
6150 \begin_layout Itemize
6151 Syntax: number hostmemory.readbyte(number address)
6154 \begin_layout Itemize
6155 Syntax: number hostmemory.readsbyte(number address)
6158 \begin_layout Itemize
6159 Syntax: number hostmemory.readword(number address)
6162 \begin_layout Itemize
6163 Syntax: number hostmemory.readsword(number address)
6166 \begin_layout Itemize
6167 Syntax: number hostmemory.readhword(number address)
6170 \begin_layout Itemize
6171 Syntax: number hostmemory.readshword(number address)
6174 \begin_layout Itemize
6175 Syntax: number hostmemory.readdword(number address)
6178 \begin_layout Itemize
6179 Syntax: number hostmemory.readsdword(number address)
6182 \begin_layout Itemize
6183 Syntax: number hostmemory.readqword(number address)
6186 \begin_layout Itemize
6187 Syntax: number hostmemory.readsqword(number address)
6190 \begin_layout Standard
6191 Read elements (big-endian) from given address <address>.
6194 \begin_layout Itemize
6198 \begin_layout Itemize
6202 \begin_layout Itemize
6206 \begin_layout Itemize
6210 \begin_layout Itemize
6211 qword is 8 elements.
6214 \begin_layout Itemize
6215 The 's' variants do signed read.
6218 \begin_layout Subsection
6219 hostmemory.read{float,double}: Read from host memory
6222 \begin_layout Itemize
6223 syntax: number hostmemory.readfloat(number address)
6226 \begin_layout Itemize
6227 Syntax: number hostmemory.readdouble(number address)
6230 \begin_layout Standard
6231 Read elements (big-endian) floating-pont from given address <address>.
6234 \begin_layout Subsection
6235 hostmemory.write{,s}{byte,{,h,d,q}word}: Write to host memory
6238 \begin_layout Itemize
6239 Syntax: number hostmemory.writebyte(number address, number value)
6242 \begin_layout Itemize
6243 Syntax: number hostmemory.writesbyte(number address, number value)
6246 \begin_layout Itemize
6247 Syntax: number hostmemory.writeword(number address, number value)
6250 \begin_layout Itemize
6251 Syntax: number hostmemory.writesword(number address, number value)
6254 \begin_layout Itemize
6255 Syntax: number hostmemory.writehword(number address, number value)
6258 \begin_layout Itemize
6259 Syntax: number hostmemory.writeshword(number address, number value)
6262 \begin_layout Itemize
6263 Syntax: number hostmemory.writedword(number address, number value)
6266 \begin_layout Itemize
6267 Syntax: number hostmemory.writesdword(number address, number value)
6270 \begin_layout Itemize
6271 Syntax: number hostmemory.writeqword(number address, number value)
6274 \begin_layout Itemize
6275 Syntax: number hostmemory.writesqword(number address, number value)
6278 \begin_layout Standard
6279 Write value <value> to elements (little-endian) starting from given address
6283 \begin_layout Itemize
6287 \begin_layout Itemize
6291 \begin_layout Itemize
6295 \begin_layout Itemize
6299 \begin_layout Itemize
6300 qword is 8 elements.
6303 \begin_layout Itemize
6304 The 's' variants do signed write.
6307 \begin_layout Subsection
6308 hostmemory.write{float,double}: Write to host memory
6311 \begin_layout Itemize
6312 syntax: none hostmemory.readfloat(number address, number value)
6315 \begin_layout Itemize
6316 Syntax: none hostmemory.readdouble(number address, number value)
6319 \begin_layout Standard
6320 Write elements (big-endian) floating-pont to given address <address>, storing
6324 \begin_layout Standard
6325 \begin_inset Newpage pagebreak
6331 \begin_layout Section
6335 \begin_layout Standard
6339 \begin_layout Subsection
6340 movie.currentframe: Get current frame number
6343 \begin_layout Itemize
6344 Syntax: number movie.currentframe()
6347 \begin_layout Standard
6348 Return number of current frame.
6351 \begin_layout Subsection
6352 movie.framecount: Get move frame count
6355 \begin_layout Itemize
6356 Syntax: number movie.framecount()
6359 \begin_layout Standard
6360 Return number of frames in movie.
6363 \begin_layout Subsection
6364 movie.lagcount: Get current lag count
6367 \begin_layout Itemize
6368 Syntax: number movie.lagcount()
6371 \begin_layout Standard
6372 Return number of lag frames recorded so far.
6375 \begin_layout Subsection
6376 movie.readonly: Is in playback mode?
6379 \begin_layout Itemize
6380 Syntax: boolean movie.readonly()
6383 \begin_layout Standard
6384 Return true if in playback mode, false if in recording.
6387 \begin_layout Subsection
6388 movie.rerecords: Movie rerecord count
6391 \begin_layout Itemize
6392 Syntax: number movie.rerecords()
6395 \begin_layout Standard
6396 Returns the current value of rerecord count.
6399 \begin_layout Subsection
6400 movie.set_readwrite: Set recording mode.
6403 \begin_layout Itemize
6404 Syntax: none movie.set_readwrite()
6407 \begin_layout Standard
6408 Set recording mode (does not cause on_readwrite callback).
6411 \begin_layout Subsection
6412 movie.frame_subframes: Count subframes in frame
6415 \begin_layout Itemize
6416 Syntax: number movie.frame_subframes(number frame)
6419 \begin_layout Standard
6420 Count number of subframes in specified frame <frame> (frame numbers are
6421 1-based) and return that.
6424 \begin_layout Subsection
6425 movie.read_subframes: Read subframe data (deprecated)
6428 \begin_layout Itemize
6429 Syntax: table movie.read_subframes(number frame, number subframe)
6432 \begin_layout Standard
6433 Read specifed subframe in specified frame and return data as array.
6436 \begin_layout Subsection
6437 movie.read_rtc: Read current RTC time
6440 \begin_layout Itemize
6441 Syntax: (number, number) movie.read_rtc()
6444 \begin_layout Standard
6445 Returns the current value of the RTC as a pair (second, subsecond).
6448 \begin_layout Subsection
6449 movie.unsafe_rewind: Fast movie rewind to saved state
6452 \begin_layout Itemize
6453 Syntax: none movie.unsafe_rewind([UNSAFEREWIND state])
6456 \begin_layout Standard
6457 Start setting point for unsafe rewind or jump to point of unsafe rewind.
6460 \begin_layout Itemize
6461 If called without argument, causes emulator to start process of setting
6462 unsafe rewind point.
6463 When this has finished, callback on_set_rewind occurs, passing the rewind
6464 state to lua script.
6467 \begin_layout Itemize
6468 If called with argument, causes emulator rewind to passed rewind point as
6470 recording mode is implicitly activated.
6473 \begin_layout Standard
6474 The following warnings apply to unsafe rewinding:
6477 \begin_layout Itemize
6478 There are no safety checks against misuse (that's what
6479 \begin_inset Quotes eld
6483 \begin_inset Quotes erd
6489 \begin_layout Itemize
6490 Only call rewind from timeline rewind point was set from.
6493 \begin_layout Itemize
6494 Only call rewind from after the rewind point was set.
6497 \begin_layout Subsection
6498 movie.to_rewind: Load savestate as rewind point
6501 \begin_layout Itemize
6502 Syntax: UNSAFEREWIND movie.to_rewind(string filename)
6505 \begin_layout Standard
6506 Load specified savestate file <filename> as rewind point and return UNSAFEREWIND
6507 corresponding to it.
6510 \begin_layout Itemize
6511 Note: This operation does not take emulated time.
6514 \begin_layout Subsection
6515 movie.copy_movie/INPUTMOVIE::copy_movie: Copy movie to movie object
6518 \begin_layout Itemize
6519 Syntax: INPUTMOVIE movie.copy_movie([INPUTMOVIE/string movie])
6522 \begin_layout Itemize
6523 Syntax: INPUTMOVIE INPUTMOVIE::copy_movie()
6526 \begin_layout Standard
6527 Copies specified movie or branch <movie>/current object (if none or nil,
6528 the active movie) as new movie object.
6531 \begin_layout Subsection
6532 movie.get_frame/INPUTMOVIE::get_frame: Read specified frame in movie.
6535 \begin_layout Itemize
6536 Syntax: INPUTFRAME movie.get_frame([INPUTMOVIE/string movie,] number frame)
6539 \begin_layout Itemize
6540 Syntax: INPUTFRAME INPUTMOVIE::get_frame(number frame);
6543 \begin_layout Standard
6544 Get INPUTFRAME object corresponding to specified frame in specified movie
6548 \begin_layout Subsection
6549 movie.set_frame/INPUTMOVIE::set_frame: Write speicifed frame in movie.
6552 \begin_layout Itemize
6553 Syntax: none movie.set_frame([INPUTMOVIE/string movie,] number frame, INPUTFRAME
6557 \begin_layout Itemize
6558 Syntax: none INPUTMOVIE::set_frame(number frame, INPUTFRAME data)
6561 \begin_layout Standard
6562 Set data in specified frame.
6565 \begin_layout Itemize
6566 Note: Past can't be edited in active movie.
6569 \begin_layout Subsection
6570 movie.get_size/INPUTMOVIE::get_size: Get size of movie
6573 \begin_layout Itemize
6574 Syntax: integer movie.get_size([INPUTMOVIE/string movie])
6577 \begin_layout Itemize
6578 Syntax: integer INPUTMOVIE::get_size()
6581 \begin_layout Standard
6582 Return number of subframes in specified movie or branch.
6585 \begin_layout Subsection
6586 movie.count_frames/INPUTMOVIE::count_frames: Count frames in movie
6589 \begin_layout Itemize
6590 Syntax: number movie.count_frames([INPUTMOVIE/string movie])
6593 \begin_layout Itemize
6594 Syntax: number INPUTMOVIE::count_frames()
6597 \begin_layout Standard
6598 Return number of frames in movie.
6601 \begin_layout Subsection
6602 movie.find_frame/INPUTMOVIE::find_frame: Find subframe corresponding to frame
6605 \begin_layout Itemize
6606 Syntax: number movie.find_frame([INPUTMOVIE/string movie], number frame)
6609 \begin_layout Itemize
6610 Syntax: number INPUTMOVIE::find_frame(number frame)
6613 \begin_layout Standard
6614 Returns starting subframe of given frame (frame numbers are 1-based).
6615 Returns -1 if frame number is bad.
6618 \begin_layout Subsection
6619 movie.blank_frame/INPUTMOVIE::blank_frame: Return a blank frame
6622 \begin_layout Itemize
6623 Syntax: INPUTFRAME movie.blank_frame([INPUTMOVIE/string movie])
6626 \begin_layout Itemize
6627 Syntax: INPUTFRAME INPUTMOVIE::blank_frame()
6630 \begin_layout Standard
6631 Return blank INPUTFRAME with frame type from specified movie.
6634 \begin_layout Subsection
6635 movie.append_frames/INPUTMOVIE::append_frames: Append blank frames
6638 \begin_layout Itemize
6639 Syntax: none movie.append_frames([INPUTMOVIE/string movie,] number frames)
6642 \begin_layout Itemize
6643 Syntax: none INPUTMOVIE::append_frames(number frames)
6646 \begin_layout Standard
6647 Append specified number <frames> of frames.
6650 \begin_layout Subsection
6651 movie.append_frame/INPUTMOVIE::append_frame: Append a frame
6654 \begin_layout Itemize
6655 Syntax: none movie.append_frame([INPUTMOVIE/string movie,] INPUTFRAME frame)
6658 \begin_layout Itemize
6659 Syntax: none INPUTMOVIE::append_frame(INPUTFRAME frame)
6662 \begin_layout Standard
6663 Append specified frame <frame>.
6664 Past of current movie can't be edited.
6667 \begin_layout Subsection
6668 movie.truncate/INPUTMOVIE::truncate: Truncate a movie.
6671 \begin_layout Itemize
6672 Syntax: none movie.truncate([INPUTMOVIE/string movie,] number frames)
6675 \begin_layout Itemize
6676 Syntax: none INPUTMOVIE::truncate(number frames)
6679 \begin_layout Standard
6680 Truncate the specified movie to specified number of frames.
6683 \begin_layout Subsection
6684 movie.edit/INPUTMOVIE::edit: Edit a movie
6687 \begin_layout Itemize
6688 Syntax: none movie.edit([INPUTMOVIE movie,] number frame, number port, number
6689 controller, number control, number/bool value)
6692 \begin_layout Itemize
6693 Syntax: none movie.edit(string branch, number frame, number port, number
6694 controller, number control, number/bool value)
6697 \begin_layout Itemize
6698 Syntax: none INPUTMOVIE::edit(number frame, number port, number controller,
6699 number control, number/bool value)
6702 \begin_layout Standard
6703 Change specified control in specified frame in specified movie.
6704 Past can't be edited in active movie.
6707 \begin_layout Subsection
6708 movie.copy_frames2: Copy frames between movies
6711 \begin_layout Itemize
6712 Syntax: none movie.copy_frames2([INPUTMOVIE/string dstmov,] number dst, [INPUTMOV
6713 IE/string srcmov,] number src, number count)
6716 \begin_layout Standard
6717 Copy specified number of frames between two movies.
6718 The copy proceeeds in forward direction.
6721 \begin_layout Subsection
6722 movie.copy_frames/INPUTMOVIE::copy_frames: Copy frames in movie
6725 \begin_layout Itemize
6726 Syntax: none movie.copy_frames([INPUTMOVIE/string mov,] number dst, number
6727 src, number count, bool backwards)
6730 \begin_layout Itemize
6731 Syntax: none INPUTMOVIE::copy_frames(number dst, number src, number count,
6735 \begin_layout Standard
6736 Copy specified number of frames from one point in movie to another.
6737 If backwards is true, the copy will be done backwards.
6740 \begin_layout Subsection
6741 movie.serialize/INPUTMOVIE::serialize: Serialize movie
6744 \begin_layout Itemize
6745 Syntax: none movie.serialize([INPUTMOVIE movie/string,] string filename,
6749 \begin_layout Itemize
6750 Syntax: none INPUTMOIVE::serialize(string filename, bool binary)
6753 \begin_layout Standard
6754 Serialize given movie into file.
6755 If binary is true, binary format (more compact and much faster) is used.
6758 \begin_layout Subsection
6759 movie.unserialize: Unserialize movie
6762 \begin_layout Itemize
6763 Syntax: INPUTMOVIE movie.unserialize(INPUTFRAME template, string filename,
6767 \begin_layout Standard
6768 Unserialize movie from file.
6769 The given frame is used as template to decide the frame type.
6770 If binary is true, binary format is decoded (much faster).
6773 \begin_layout Subsection
6774 movie.current_first_subframe: Return first subframe in current frame
6777 \begin_layout Itemize
6778 Syntax: number movie.current_first_subframe()
6781 \begin_layout Standard
6782 Returns first subframe in current frame.
6785 \begin_layout Subsection
6786 movie.pollcounter: Return poll counter for speified control
6789 \begin_layout Itemize
6790 Syntax: number movie.pollcounter(number port, number controller, number control)
6793 \begin_layout Standard
6794 Returns number of times the specified control has been polled this frame.
6797 \begin_layout Subsection
6798 movie.current_branch: Return current branch
6801 \begin_layout Itemize
6802 Syntax: string movie.current_branch()
6805 \begin_layout Standard
6806 Returns the name of the current branch.
6809 \begin_layout Subsection
6810 movie.get_branches: Return names of all branches
6813 \begin_layout Itemize
6815 movie.get_branches()
6818 \begin_layout Standard
6819 Returns the name of all branches.
6822 \begin_layout Subsection
6823 movie.rom_loaded: Is ROM loaded?
6826 \begin_layout Itemize
6827 Syntax: boolean movie.rom_loaded()
6830 \begin_layout Standard
6831 Returns true if ROM is loaded, false otherwise.
6834 \begin_layout Subsection
6835 movie.get_rom_info: Get info about loaded ROM
6838 \begin_layout Itemize
6839 Syntax: Table movie.get_rom_info()
6842 \begin_layout Standard
6843 Returns a table of tables.
6844 The outer table is indexed by ROM slot index.
6845 The inner table has the following fields:
6848 \begin_layout Itemize
6849 filename: The name of file
6852 \begin_layout Itemize
6853 hint: File name hint
6856 \begin_layout Itemize
6857 sha256: SHA-256 hash of ROM.
6860 \begin_layout Itemize
6861 xml_filename: The name of file for markup
6864 \begin_layout Itemize
6865 xml_hint: File name hint for markup
6868 \begin_layout Itemize
6869 xml_sha256: SHA-256 hash of ROM markup.
6872 \begin_layout Standard
6873 If there is no markup, the xml_* fields are absent.
6876 \begin_layout Subsection
6877 movie.get_game_info: Get info about loaded game
6880 \begin_layout Itemize
6881 Syntax: Table movie.get_game_info()
6884 \begin_layout Standard
6885 Returns a table with following fields:
6888 \begin_layout Itemize
6889 core: The name of the core
6892 \begin_layout Itemize
6893 core_short: Short name of the core
6896 \begin_layout Itemize
6897 type: The name of the system type
6900 \begin_layout Itemize
6901 type_long: The long name of the system type
6904 \begin_layout Itemize
6905 region: The name of region
6908 \begin_layout Itemize
6909 region_long: The long name of region
6912 \begin_layout Itemize
6913 gametype: The gametype of movie.
6916 \begin_layout Itemize
6917 fps: Nominal fps as floating-point value
6920 \begin_layout Itemize
6921 fps_n: Exact nominal fps numerator
6924 \begin_layout Itemize
6925 fps_d: Exact nominal fps denominator.
6928 \begin_layout Subsection
6929 INPUTFRAME::get_button: Get button
6932 \begin_layout Itemize
6933 Syntax: boolean INPUTFRAME::get_button(number port, number controller, number
6937 \begin_layout Standard
6938 Returns state of given button as boolean.
6941 \begin_layout Subsection
6942 INPUTFRAME::get_axis: Get axis
6945 \begin_layout Itemize
6946 Syntax: number INPUTFRAME::get_axis(number port, number controller, number
6950 \begin_layout Standard
6951 Returns state of given axis as number.
6954 \begin_layout Subsection
6955 INPUTFRAME::set_button/INPUTFRAME::set_axis: Set button or axis
6958 \begin_layout Itemize
6959 Syntax: none INPUTFRAME::set_button(number port, number controller, number
6960 control, number/bool value)
6963 \begin_layout Itemize
6964 Syntax: none INPUTFRAME::set_axis(number port, number controller, number
6968 \begin_layout Standard
6969 Set the given button/axis to given value.
6972 \begin_layout Subsection
6973 INPUTFRAME::serialize: Serialize a frame
6976 \begin_layout Itemize
6977 Syntax: string INPUTFRAME::serialize()
6980 \begin_layout Standard
6981 Return string representation of frame.
6984 \begin_layout Subsection
6985 INPUTFRAME::unserialize: Unserialize a frame
6988 \begin_layout Itemize
6989 Syntax: none INPUTFRAME::unserialize(string data)
6992 \begin_layout Standard
6993 Set current frame from given data.
6996 \begin_layout Subsection
6997 INPUTFRAME::get_stride: Get movie stride
7000 \begin_layout Itemize
7001 Syntax: number INPUTFRAME::get_stride()
7004 \begin_layout Standard
7005 Return number of bytes needed to store the input frame.
7006 Mainly useful for some debugging.
7009 \begin_layout Standard
7010 \begin_inset Newpage pagebreak
7016 \begin_layout Section
7020 \begin_layout Standard
7021 Routines for settings manipulation
7024 \begin_layout Subsection
7025 settings.get: Get value of setting
7028 \begin_layout Itemize
7029 Syntax: string settings.get(string name)
7032 \begin_layout Standard
7033 Get value of setting <name>.
7034 If setting value can't be obtained, returns (nil, error message).
7037 \begin_layout Subsection
7038 settings.set: Set value of setting
7041 \begin_layout Itemize
7042 Syntax: none settings.set(string name, string value)
7045 \begin_layout Standard
7046 Set value <value> of setting <name>.
7047 If setting can't be set, returns (nil, error message).
7050 \begin_layout Subsection
7051 settings.get_all: Get values of all settings
7054 \begin_layout Itemize
7055 Syntax: table settings.get_all()
7058 \begin_layout Standard
7059 Return a table with all setting names as keys and all current values as
7063 \begin_layout Subsection
7064 settings.get_speed: Get current speed
7067 \begin_layout Itemize
7068 Syntax: number/string settings.get_speed()
7071 \begin_layout Standard
7072 Return the current speed multiplier (1 is normal), or
7073 \begin_inset Quotes eld
7077 \begin_inset Quotes erd
7080 if speed is set to turbo (this does not react to turbo toggle).
7083 \begin_layout Subsection
7084 settings.set_speed: Set current speed
7087 \begin_layout Itemize
7088 Syntax: settings.get_speed(number spd)
7091 \begin_layout Itemize
7092 Syntax: settings.get_speed(string special)
7095 \begin_layout Standard
7096 Set the current speed multiplier (1 is normal).
7097 The speed may be positive multiplier or
7098 \begin_inset Quotes eld
7102 \begin_inset Quotes erd
7108 \begin_layout Standard
7109 \begin_inset Newpage pagebreak
7115 \begin_layout Section
7119 \begin_layout Standard
7120 Contains various functions for managing memory
7123 \begin_layout Subsection
7124 memory.vma_count: Count number of memory areas.
7127 \begin_layout Itemize
7128 Syntax: number memory.vma_count()
7131 \begin_layout Standard
7132 Returns the number of memory areas
7135 \begin_layout Subsection
7136 memory.read_vma: Lookup memory area info by index
7139 \begin_layout Itemize
7140 Syntax: table memory.read_vma(number index)
7143 \begin_layout Standard
7144 Reads the specified memory area (indices start from zero).
7145 Trying to read invalid memory area gives nil.
7146 The return value is table with the following fields:
7149 \begin_layout Itemize
7150 region_name (string): The readable name of the memory area
7153 \begin_layout Itemize
7154 baseaddr (number): Base address of the memory area
7157 \begin_layout Itemize
7158 lastaddr (number): Last address in the memory area.
7161 \begin_layout Itemize
7162 size (number): The size of memory area in bytes.
7165 \begin_layout Itemize
7166 readonly (boolean): True of the memory area corresponds to ROM.
7169 \begin_layout Itemize
7170 iospace (boolean): True if the memory area is I/O space.
7173 \begin_layout Itemize
7174 native_endian (boolean): True if the memory area has native endian as opposed
7178 \begin_layout Subsection
7179 memory.find_vma: Find memory area info by address
7182 \begin_layout Itemize
7183 Syntax: table memory.find_vma(number address)
7186 \begin_layout Standard
7187 Finds the memory area containing specified address.
7188 Returns table in the same format as read_vma or nil if not found.
7191 \begin_layout Subsection
7192 memory.read{,s}{byte,{,h,d,q}word}: Read memory
7195 \begin_layout Itemize
7196 Syntax: none memory.readbyte({string marea, number address|ADDRESS addrobj})
7199 \begin_layout Itemize
7200 Syntax: none memory.readword({string marea, number address|ADDRESS addrobj})
7203 \begin_layout Itemize
7204 Syntax: none memory.readhword({string marea, number address|ADDRESS addrobj})
7207 \begin_layout Itemize
7208 Syntax: none memory.readdword({string marea, number address|ADDRESS addrobj})
7211 \begin_layout Itemize
7212 Syntax: none memory.readqword({string marea, number address|ADDRESS addrobj})
7215 \begin_layout Itemize
7216 Syntax: none memory.readsbyte({string marea, number address|ADDRESS addrobj})
7219 \begin_layout Itemize
7220 Syntax: none memory.readsword({string marea, number address|ADDRESS addrobj})
7223 \begin_layout Itemize
7224 Syntax: none memory.readshword({string marea, number address|ADDRESS addrobj})
7227 \begin_layout Itemize
7228 Syntax: none memory.readsdword({string marea, number address|ADDRESS addrobj})
7231 \begin_layout Itemize
7232 Syntax: none memory.readsqword({string marea, number address|ADDRESS addrobj})
7235 \begin_layout Standard
7236 Reads the specified address <address> (if 's' variant is used, do undergo
7240 \begin_layout Subsection
7241 memory.{,s}read_sg: Scatter/Gather read memory
7244 \begin_layout Itemize
7245 Syntax: none memory.read_sg(string/boolean/number...)
7248 \begin_layout Itemize
7249 Syntax: none memory.sread_sg(string/boolean/number...)
7252 \begin_layout Standard
7253 Perform (2s complement signed if using memory.sread_sg) scatter/gather read
7255 Each argument can be string, boolean or number:
7258 \begin_layout Itemize
7259 String: Set memory area addresses are relative to (e.g.
7263 \begin_layout Itemize
7264 boolean: If true, increment relative address by 1, if false, decrement by
7266 The new address is read as next higher byte.
7269 \begin_layout Itemize
7270 integer: Set the relative address to specified value and read the address
7271 as next higher byte.
7274 \begin_layout Subsection
7275 memory.write_sg: Scatter/Gather write memory
7278 \begin_layout Itemize
7279 Syntax: none memory.write_sg(number value, string/boolean/number...)
7282 \begin_layout Standard
7283 Perform scatter/gather write of value <value> on memory.
7284 Each argument can be string, boolean or number:
7287 \begin_layout Itemize
7288 String: Set memory area addresses are relative to (e.g.
7292 \begin_layout Itemize
7293 boolean: If true, increment relative address by 1, if false, decrement by
7295 The new address is read as next higher byte.
7298 \begin_layout Itemize
7299 integer: Set the relative address to specified value and read the address
7300 as next higher byte.
7303 \begin_layout Subsection
7304 memory.read{float,double}: Read memory
7307 \begin_layout Itemize
7308 Syntax: none memory.readfloat({string marea, number address|ADDRESS addrobj})
7311 \begin_layout Itemize
7312 Syntax: none memory.readdouble({string marea, number address|ADDRESS addrobj})
7315 \begin_layout Standard
7316 Reads the specified address <address>
7319 \begin_layout Subsection
7320 memory.write{byte,{,h,d,q}word,float,double}: Write memory
7323 \begin_layout Itemize
7324 Syntax: none memory.writebyte({string marea, number address|ADDRESS addrobj},
7328 \begin_layout Itemize
7329 Syntax: none memory.writeword({string marea, number address|ADDRESS addrobj},
7333 \begin_layout Itemize
7334 Syntax: none memory.writehword({string marea, number address|ADDRESS addrobj},
7338 \begin_layout Itemize
7339 Syntax: none memory.writedword({string marea, number address|ADDRESS addrobj},
7343 \begin_layout Itemize
7344 Syntax: none memory.writeqword({string marea, number address|ADDRESS addrobj},
7348 \begin_layout Itemize
7349 Syntax: none memory.writefloat({string marea, number address|ADDRESS addrobj},
7353 \begin_layout Itemize
7354 Syntax: none memory.writedouble({string marea, number address|ADDRESS addrobj},
7358 \begin_layout Standard
7359 Writes the specified value <value> (negative integer values undergo 2's
7360 complement) to specified address <address>.
7363 \begin_layout Subsection
7364 memory.map{{,s}{byte,{,h,d,q}word},float,double}: Map an array
7367 \begin_layout Itemize
7368 Syntax: userdata memory.map<type>({string marea, number base|ADDRESS addrobj},
7372 \begin_layout Standard
7373 Returns a table mapping specified memory aperture for read/write.
7376 \begin_layout Itemize
7377 Type may be one of: byte, sbyte, word, sword, hword, shword, dword, sdword,
7378 qword, sqword, float or double.
7381 \begin_layout Subsection
7382 memory.hash_region: Hash region of memory
7385 \begin_layout Itemize
7386 Syntax: string memory.hash_region({string marea, number base|ADDRESS addrobj},
7390 \begin_layout Standard
7391 Hash <size> bytes starting from address <base> (relative to <marea>) and
7395 \begin_layout Subsection
7396 memory.hash_region2: Hash region of memory
7399 \begin_layout Itemize
7400 Syntax: string memory.hash_region2({string marea, number base|ADDRESS addrobj},
7401 number size[, number rows, number stride])
7404 \begin_layout Standard
7405 Hash <rows> blocks of <size> bytes starting from address <base> (relative
7407 The blocks are offset by <stride> from one another and return the SHA-256.
7410 \begin_layout Subsection
7411 memory.hash_region_skein: Hash region of memory
7414 \begin_layout Itemize
7415 Syntax: string memory.hash_region_skein({string marea, number base|ADDRESS
7416 addrobj}, number size[, number rows, number stride])
7419 \begin_layout Standard
7420 Same as memory.hash_region2, but uses Skein-512-256 (v1.3; one of the SHA-3
7421 finalists) as hash function.
7424 \begin_layout Subsection
7425 memory.store: Store region of memory
7428 \begin_layout Itemize
7429 Syntax: none memory.store({string marea, number addr|ADDRESS addrobj}, number
7430 daddr[, number rows, number stride]
7433 \begin_layout Standard
7434 Copy memory starting from <addr> in memory area <marea> (each row being
7435 of size <size>, there being <rows> rows, and rows being separated by <stride>
7436 in memory) into savestate-saved memory area, starting from <daadr> (all
7437 rows are written back to back).
7440 \begin_layout Subsection
7441 memory.storecmp: Compare and store region of memory
7444 \begin_layout Itemize
7445 Syntax: bool memory.storecmp({string marea, number addr|ADDRESS addrobj},
7446 number daddr[, number rows, number stride]
7449 \begin_layout Standard
7450 Like memory.store, but returns true if target of copy already held the value
7451 that would be copied before the copy happened.
7452 Otherwise returns false (if target and source differ before copy).
7455 \begin_layout Subsection
7456 memory.hash_state: Hash system state
7459 \begin_layout Itemize
7460 Syntax: string memory.hash_state()
7463 \begin_layout Standard
7464 Hash the current system state.
7465 Mainly useful for debugging savestates.
7468 \begin_layout Subsection
7469 memory.readregion: Read region of memory
7472 \begin_layout Itemize
7473 Syntax: table memory.readregion({string marea, number base|ADDRESS addrobj},
7477 \begin_layout Standard
7478 Read a region of memory.
7481 \begin_layout Itemize
7482 Warning: If the region crosses memory area boundary, the results are undefined.
7485 \begin_layout Subsection
7486 memory.writeregion: Write region of memory
7489 \begin_layout Itemize
7490 Syntax: none memory.writeregion({string marea, number base|ADDRESS addrobj},
7491 number size, table data)
7494 \begin_layout Standard
7495 Write a region of memory.
7498 \begin_layout Itemize
7499 Warning: If the region crosses memory area boundary, the results are undefined.
7502 \begin_layout Subsection
7503 memory.action: Run core action
7506 \begin_layout Itemize
7507 memory.action(string action, [<params>])
7510 \begin_layout Standard
7512 The different models expect parameters as:
7515 \begin_layout Itemize
7519 \begin_layout Itemize
7523 \begin_layout Itemize
7527 \begin_layout Itemize
7531 \begin_layout Itemize
7535 \begin_layout Subsection
7536 memory.action_flags: Get core action flags
7539 \begin_layout Itemize
7540 memory.action_flags(string action)
7543 \begin_layout Standard
7544 Get value of action flags for core action <action>.
7547 \begin_layout Itemize
7551 \begin_layout Itemize
7552 Bit 1: Selected (not all actions can be selected)?
7555 \begin_layout Subsection
7556 memory.get_lag_flag: Get lag flag
7559 \begin_layout Itemize
7560 Syntax: boolean memory.get_lag_flag()
7563 \begin_layout Standard
7564 Get the value of core lag flag.
7565 True if this frame has been lag so far, false if poll has been detected.
7568 \begin_layout Subsection
7569 memory.set_lag_flag: Set lag flag
7572 \begin_layout Itemize
7573 Syntax: none memory.set_lag_flag(boolean flag)
7576 \begin_layout Standard
7577 Set the value of core lag flag.
7578 This flag automatically gets cleared if poll is detected, but can be forcibly
7579 set or cleared if game so requires.
7582 \begin_layout Itemize
7583 Should only be used in on_frame_emulated callback.
7586 \begin_layout Itemize
7587 Setting or clearing this affects the emulator lag counter.
7590 \begin_layout Subsection
7591 memory.{,un}register{read,write,exec}: (Un)Register read / write / execute
7595 \begin_layout Itemize
7596 Syntax: function memory.registerread({string marea, number addr|ADDRESS addrobj},
7600 \begin_layout Itemize
7601 Syntax: function memory.registerwrite({string marea, number addr|ADDRESS
7602 addrobj}, function fn);
7605 \begin_layout Itemize
7606 Syntax: function memory.registerexec({string marea, number addr|ADDRESS addrobj},
7610 \begin_layout Itemize
7611 Syntax: none memory.unregisterread({string marea, number addr|ADDRESS addrobj},
7615 \begin_layout Itemize
7616 Syntax: none memory.unregisterwrite({string marea, number addr|ADDRESS addrobj},
7620 \begin_layout Itemize
7621 Syntax: none memory.unregisterexec({string marea, number addr|ADDRESS addrobj},
7625 \begin_layout Standard
7626 Add or remove callback on memory read, write or execute (depending on the
7628 <addr> is relative to <marea>.
7629 <fn> is the callback.
7630 The register* functions return <fn> (which can then be passed to unregister*
7634 \begin_layout Itemize
7635 Not all cores support this, and it may be unsupported for some memory areas.
7638 \begin_layout Itemize
7639 The functions are passed two parameters: Address and value.
7642 \begin_layout Subsection
7643 memory.{,un}registertrace: Set/Clear trace hook
7646 \begin_layout Itemize
7647 Syntax: function memory.registertrace(number processor, function fn);
7650 \begin_layout Itemize
7651 Syntax: none memory.unregistertrace(number processor, function fn);
7654 \begin_layout Standard
7655 Add or remove trace callback.
7656 <processor> is system-dependent processor number (0 is usually main CPU).
7657 The function arguments work like in other (un)register* functions.
7660 \begin_layout Itemize
7661 The functions are passed two parameters: Trace CPU and Trace event string.
7664 \begin_layout Subsection
7665 memory.cheat: Set cheat
7668 \begin_layout Itemize
7669 Syntax: none memory.cheat({string marea, number addr|ADDRESS addrobj}, number
7673 \begin_layout Itemize
7674 Syntax: none memory.cheat({string marea, number addr|ADDRESS addrobj});
7677 \begin_layout Standard
7678 Set or clear cheat (value <value>) on address <addr> (relative to <marea>).
7679 If <value> is not speicified, clear a cheat.
7682 \begin_layout Itemize
7683 Not all cores support this, and it may be unsupported for some memory areas.
7686 \begin_layout Subsection
7687 memory.setxmask: Set global execute hook mask
7690 \begin_layout Itemize
7691 Syntax: none memory.setxmask(number mask)
7694 \begin_layout Standard
7695 Set the global execute hook mask to <mask>.
7696 The meaning of each bit is system-dependent, but bit 0 should be the main
7700 \begin_layout Subsection
7701 memory.getregister: Get register value
7704 \begin_layout Itemize
7705 Syntax: number/boolean memory.getregister(string register)
7708 \begin_layout Standard
7709 Get the value of named register.
7712 \begin_layout Subsection
7713 memory.getregisters: Get register values
7716 \begin_layout Itemize
7717 Syntax: table memory.getregisters()
7720 \begin_layout Standard
7721 Get the value of all known registers as table.
7724 \begin_layout Subsection
7725 memory.setregister: Set register value
7728 \begin_layout Itemize
7729 Syntax: none memory.setregister(string register, number/boolean value)
7732 \begin_layout Standard
7733 Set the value of named register.
7736 \begin_layout Subsection
7737 memory.mmap: Class MMAP_STRUCT
7740 \begin_layout Standard
7741 See class MMAP_STRUCT
7744 \begin_layout Standard
7745 \begin_inset Newpage pagebreak
7751 \begin_layout Section
7755 \begin_layout Standard
7756 Contains newer memory functions.
7759 \begin_layout Subsection
7760 memory2(): Get all memory area names.
7763 \begin_layout Itemize
7764 Syntax: table memory2()
7767 \begin_layout Standard
7768 Returns array of all valid memory area names.
7771 \begin_layout Subsection
7772 memory2.<marea>:info: Get memory area info
7775 \begin_layout Itemize
7776 Syntax: table memory2.<marea>:info()
7779 \begin_layout Standard
7780 Return table describing given memory area.
7781 Includes fields address, size, last, readonly, special and endian.
7784 \begin_layout Subsection
7785 memory2.<marea>:<op>: Read/Write memory
7788 \begin_layout Itemize
7789 Syntax: none memory2.<marea>:<op>(number offset, number value)
7792 \begin_layout Itemize
7793 Syntax: number memory2.<marea>:<op>(number offset)
7796 \begin_layout Standard
7797 Read/Write value from/to given memory area <marea> at given offset <offset>
7799 The value written is <value>.
7800 <Op> is of form: [i][s]<type>, where:
7803 \begin_layout Itemize
7804 <type> is one of 'byte', 'word', 'hword', 'dword', 'qword', 'float', 'double'.
7807 \begin_layout Itemize
7808 'i' signifies that the value is treated as opposite-to-normal endianess,
7811 \begin_layout Itemize
7812 's' signifies that value is treated as signed (not available for floating-point).
7815 \begin_layout Subsection
7816 memory2.<marea>:read: Scatter-gather value read
7819 \begin_layout Itemize
7820 Syntax: number memory2.<marea>:read(number addr...)
7823 \begin_layout Standard
7824 Read value from given memory area <marea> at byte offsets <addr>..., given
7825 in order of increasing significance.
7826 Value of true and false are special.
7827 True increments address by 1, and false decrements address by 1.
7830 \begin_layout Subsection
7831 memory2.<marea>:sread: Signed scatter-gather value read
7834 \begin_layout Itemize
7835 Syntax: number memory2.<marea>:sread(number addr...)
7838 \begin_layout Standard
7839 Like memory2.<marea>:read, but reads signed values.
7842 \begin_layout Subsection
7843 memory2.<marea>:write: Scatter-gather value write
7846 \begin_layout Itemize
7847 Syntax: number memory2.<marea>:write(number val, number addr...)
7850 \begin_layout Standard
7851 Write value <val> to given memory area <marea> at byte offsets <addr>..., given
7852 in order of increasing significance.
7853 Value of true and false are special.
7854 True increments address by 1, and false decrements address by 1.
7857 \begin_layout Subsection
7858 memory2.<marea>:cheat: Set/Clear cheat
7861 \begin_layout Itemize
7862 Syntax: none memory2.<marea>:cheat(number addr, [number value])
7865 \begin_layout Standard
7866 Set/Clear cheat at offset <addr> of memory area <marea>.
7867 If <value> is given, cheat with specified value is set.
7868 Otherwise cheat on address is removed.
7871 \begin_layout Subsection
7872 memory2.<marea>:sha256: SHA-256
7875 \begin_layout Itemize
7876 Syntax: string memory2.<marea>:sha256(number addr, number size[, number rows,
7880 \begin_layout Standard
7881 Compute SHA-256 of <rows> (default 1) chunks of <size> bytes each, starting
7882 from offset <addr> of area <marea>.
7883 The chunks are separated by <stride>.
7886 \begin_layout Subsection
7887 memory2.<marea>:skein: Skein-512-256
7890 \begin_layout Itemize
7891 Syntax: string memory2.<marea>:skein(number addr, number size[, number rows,
7895 \begin_layout Standard
7896 Same as memory2.<marea>:sha256, except with Skein-512-256 as hash function.
7899 \begin_layout Subsection
7900 memory2.<marea>:store{,cmp}: Copy region to Lua memory with compare
7903 \begin_layout Itemize
7904 Syntax: none memory2.<marea>:store(number addr, number daddr, number size[,
7905 number rows, number stride])
7908 \begin_layout Itemize
7909 Syntax: boolean memory2.<marea>:storecmp(number addr, number daddr, number
7910 size[, number rows, number stride])
7913 \begin_layout Standard
7914 Copy <rows> (default 1) chunks of <size> bytes each, starting from offset
7915 <addr> of area <marea>.
7916 The chunks are separated by <stride>.
7917 The target is Lua host memory, starting from offset <daddr>.
7920 \begin_layout Standard
7921 Additionally, the storecmp method returns false if target was modified (otherwis
7925 \begin_layout Subsection
7926 memory2.<marea>:readregion: Read region
7929 \begin_layout Itemize
7930 Syntax table memory2.<marea>:readregion(number addr, number size)
7933 \begin_layout Standard
7934 Read <size> bytes starting from <addr> in <marea> and return as array.
7937 \begin_layout Subsection
7938 memory2.<marea>:writeregion: Write region
7941 \begin_layout Itemize
7942 Syntax none memory2.<marea>:writeregion(number addr, table data)
7945 \begin_layout Standard
7946 Write array <data> to bytes starting from <addr> in <marea>.
7949 \begin_layout Subsection
7950 memory2.<marea>:register{read,write,exec}: Register hook
7953 \begin_layout Itemize
7954 Syntax: function memory2.<marea>:registerread(number addr, function fn);
7957 \begin_layout Itemize
7958 Syntax: function memory2.<marea>:registerwrite(number addr, function fn);
7961 \begin_layout Itemize
7962 Syntax: function memory2.<marea>:registerexec(number addr, function fn);
7965 \begin_layout Standard
7966 Register debug callback <fn> of specified type at offset <addr> of memory
7971 \begin_layout Subsection
7972 memory2.<marea>:unregister{read,write,exec}: Unregister hook
7975 \begin_layout Itemize
7976 Syntax: none memory2.<marea>:unregisterread(number addr, function fn);
7979 \begin_layout Itemize
7980 Syntax: none memory2.<marea>:unregisterwrite(number addr, function fn);
7983 \begin_layout Itemize
7984 Syntax: none memory2.<marea>:unregisterexec(number addr, function fn);
7987 \begin_layout Standard
7988 Unregister debug callback <fn> of specified type at offset <addr> of memory
7992 \begin_layout Standard
7993 \begin_inset Newpage pagebreak
7999 \begin_layout Section
8003 \begin_layout Standard
8004 Contains random number generation methods.
8005 These functions do not return reproducable results.
8008 \begin_layout Subsection
8009 random.boolean: Random boolean
8012 \begin_layout Itemize
8013 Syntax: boolean random.boolean()
8016 \begin_layout Standard
8017 Returns true or false at random (50-50 chance).
8020 \begin_layout Subsection
8021 random.integer: Random integer
8024 \begin_layout Itemize
8025 Syntax: number random.integer(number highplusone)
8028 \begin_layout Itemize
8029 Syntax: number random.integer(number low, number high)
8032 \begin_layout Standard
8033 With one argument, return random integer [0,<highplusone>) (upper end exclusive).
8034 With two arguments, return random integer [<low>,<high>] (both ends inclusive).
8037 \begin_layout Standard
8038 The returned numbers are from uniform distribution.
8041 \begin_layout Subsection
8042 random.float: Random float
8045 \begin_layout Itemize
8046 Syntax: number random.float()
8049 \begin_layout Standard
8050 Returns random decimal number [0,1).
8053 \begin_layout Subsection
8054 random.among: Random parameter
8057 \begin_layout Itemize
8058 Syntax: value random.among(value values...)
8061 \begin_layout Standard
8062 Returns random parameter value, picked at uniform.
8063 Multiple equivalent values are returned with higher chance.
8066 \begin_layout Subsection
8067 random.amongtable: Random from table
8070 \begin_layout Itemize
8071 Syntax: value random.amongtable(table tab)
8074 \begin_layout Standard
8075 Returns random value from table <tab>.
8076 As in random.among, no equality testing is done.
8079 \begin_layout Standard
8080 \begin_inset Newpage pagebreak
8086 \begin_layout Section
8090 \begin_layout Subsection
8091 zip.enumerate: Enumerate members in zipfile
8094 \begin_layout Itemize
8095 Syntax: Table zip.enumerate(string filename[, boolean invert])
8098 \begin_layout Standard
8099 Returns table of files in zip archive <filename>.
8100 If <invert> is true, instead of returning array of names, returns table
8101 with keys being member names and values being true.
8104 \begin_layout Subsection
8105 zip.writer: Class ZIPWRITER
8108 \begin_layout Standard
8109 See class ZIPWRITER.
8112 \begin_layout Standard
8113 \begin_inset Newpage pagebreak
8119 \begin_layout Section
8123 \begin_layout Standard
8124 Various callback-related functions.
8127 \begin_layout Subsection
8128 \begin_inset CommandInset label
8130 name "sub:callback.register:-Register-a"
8134 callback.register: Register a callback
8137 \begin_layout Itemize
8138 Syntax: function callback.register(string cbname, function cbfun);
8141 \begin_layout Standard
8142 Instruct function <cbfun> to be added to list of callbacks to call on event
8143 <cbname> (See section
8144 \begin_inset CommandInset ref
8146 reference "sec:Callbacks"
8151 The callback name does not have the 'on_' prefix (e.g.
8153 \begin_inset Quotes eld
8157 \begin_inset Quotes erd
8164 \begin_layout Subsection
8165 \begin_inset CommandInset label
8167 name "sub:callback.unregister:-Unregister-"
8171 callback.unregister: Unregister a callback
8174 \begin_layout Itemize
8175 Syntax: function callback.unregister(string cbname, function cbfun);
8178 \begin_layout Standard
8179 Instruct function <cbfun> to be removed from list of callbacks to call on
8183 \begin_layout Subsection
8184 callback.<cbname>:register: Register callback
8187 \begin_layout Itemize
8188 Syntax: function callback.<cbname>:register(function cbfun)
8191 \begin_layout Standard
8192 Synonym for callback.register (section
8193 \begin_inset CommandInset ref
8195 reference "sub:callback.register:-Register-a"
8199 ), albeit with callback name specified differently.
8202 \begin_layout Subsection
8203 callback.<cbname>:unregister: Register callback
8206 \begin_layout Itemize
8207 Syntax: function callback.<cbname>:unregister(function cbfun)
8210 \begin_layout Standard
8211 Synonym for callback.unregister (section
8212 \begin_inset CommandInset ref
8214 reference "sub:callback.unregister:-Unregister-"
8218 ), albeit with callback name specified differently.
8221 \begin_layout Section
8225 \begin_layout Standard
8226 Various bsnes-specific functions.
8229 \begin_layout Subsection
8230 bsnes.dump_sprite: Dump a sprite
8233 \begin_layout Itemize
8234 Syntax: BITMAP bsnes.dump_sprite(string marea, number addr, number width,
8235 number height[, number stride])
8238 \begin_layout Standard
8239 Dumps given sprite (in native format) from memory.
8240 memory area is usually
8241 \begin_inset Quotes eld
8245 \begin_inset Quotes erd
8249 <Width> and <height> are given in 8x8 blocks.
8250 <Stride> overrides row stride (default 512).
8253 \begin_layout Subsection
8254 bsnes.dump_palette: Dump a palette
8257 \begin_layout Itemize
8258 Syntax: PALETTE bsnes.dump_palette(string marea, number addr, bool full256,
8262 \begin_layout Standard
8263 Dumps a palette from memory.
8264 memory area is usually
8265 \begin_inset Quotes eld
8269 \begin_inset Quotes erd
8273 If <full256> is true, 256 colors are dumped (otherwise 16).
8274 If <first_trans> is true, first color is forced transparent.
8277 \begin_layout Subsection
8278 bsnes.enablelayer: Set layer visibility
8281 \begin_layout Itemize
8282 Syntax: none bsnes.enablelayer(number layer, number priority, boolean enabled)
8285 \begin_layout Standard
8286 Enable or disable specified layer at specified priority.
8289 \begin_layout Subsection
8290 bsnes.redump_sprite: Redump a sprite
8293 \begin_layout Itemize
8294 Syntax: none bsnes.redump_sprite(BITMAP bitmap, string marea, number addr[,
8298 \begin_layout Standard
8299 Like bsnes.dump_sprite, but instead dumps to specified bitmap <bitmap>.
8300 The specified bitmap must have size multiple of 8x8.
8303 \begin_layout Subsection
8304 bsnes.redump_palette: Redump a palette
8307 \begin_layout Itemize
8308 Syntax: none bsnes.dump_palette(PALETTE pal, string marea, number addr, bool
8312 \begin_layout Standard
8313 Like bsnes.dump_palette, but instead dumps to specified palette <pal>.
8314 The specified palette must have either 16 or 256 colors.
8317 \begin_layout Section
8318 extensions to table string
8321 \begin_layout Subsection
8322 string.charU: string.char, UTF-8 version.
8325 \begin_layout Itemize
8326 Syntax: string string.charU(number n...)
8329 \begin_layout Standard
8330 Like Lua string.char(), but works in terms of Unicode codepoints.
8331 The returned string is UTF-8.
8334 \begin_layout Subsection
8335 string.byteU: string.byte, UTF-8 version.
8338 \begin_layout Itemize
8340 string.byteU(string str[, number i[, number j]])
8343 \begin_layout Standard
8344 Like string.byte(), but works in terms of Unicode codepoints.
8345 The input string <str> is assumed UTF-8.
8348 \begin_layout Subsection
8349 string.regex: Match string against regular expression
8352 \begin_layout Itemize
8353 Syntax: boolean/string...
8354 string.regex(string regexp, string against)
8357 \begin_layout Standard
8358 Match POSIX-extended regular expression <regexp> against string <against>.
8359 If no match, false is returned.
8360 Otherwise if string has no subcaptures, true is returned.
8361 Otherwise each subcapture is returned as a string (in order of starting
8365 \begin_layout Subsection
8366 string.hex: Transform integer into hex string
8369 \begin_layout Itemize
8370 Syntax: string string.hex(number n, [number digits])
8373 \begin_layout Standard
8374 Returns hexadecimal string representation of <n>, optionally padded with
8375 zeroes to <digits> digits (default is not to pad).
8378 \begin_layout Subsection
8379 string.lpad: Pad string with spaces from left
8382 \begin_layout Itemize
8383 Syntax: string string.lpad(string x, number n)
8386 \begin_layout Standard
8387 Pad string <x> to <n> bytes by inserting spaces at start and return the
8391 \begin_layout Subsection
8392 string.rpad: Pad string with spaces from right
8395 \begin_layout Itemize
8396 Syntax: string string.rpad(string x, number n)
8399 \begin_layout Standard
8400 Pad string <x> to <n> bytes by inserting spaces at end and return the result.
8403 \begin_layout Section
8407 \begin_layout Standard
8408 Contains copy of global variables from time of Lua initialization.
8412 \begin_layout Standard
8413 \begin_inset Newpage pagebreak
8419 \begin_layout Section
8420 \begin_inset CommandInset label
8422 name "sec:Callbacks"
8429 \begin_layout Standard
8430 Various callbacks to Lua that can occur.
8433 \begin_layout Subsection
8434 on_paint: Screen is being painted
8437 \begin_layout Itemize
8438 Callback: on_paint(bool not_synth)
8441 \begin_layout Standard
8442 Called when screen is being painted.
8443 Any gui.* calls requiring graphic context draw on the screen.
8446 \begin_layout Itemize
8447 not_synth is true if this hook is being called in response to received frame,
8451 \begin_layout Subsection
8452 on_video: Dumped video frame is being painted
8455 \begin_layout Itemize
8456 Callback: on_video()
8459 \begin_layout Standard
8460 Called when video dump frame is being painted.
8461 Any gui.* calls requiring graphic context draw on the video.
8464 \begin_layout Subsection
8465 on_frame_emulated: Frame emulation complete
8468 \begin_layout Itemize
8469 Callback: on_frame_emulated()
8472 \begin_layout Standard
8473 Called when emulating frame has completed and on_paint()/on_video() calls
8474 are about to be issued.
8477 \begin_layout Subsection
8478 on_frame: Frame emulation starting.
8481 \begin_layout Itemize
8482 Callback: on_frame()
8485 \begin_layout Standard
8486 Called on each starting whole frame.
8489 \begin_layout Subsection
8490 on_rewind: Movie rewound to beginning
8493 \begin_layout Itemize
8494 Callback: on_rewind()
8497 \begin_layout Standard
8498 Called when rewind movie to beginning has completed.
8501 \begin_layout Subsection
8502 on_pre_load: Load operation is about to start
8505 \begin_layout Itemize
8506 Callback: on_pre_load(string name)
8509 \begin_layout Standard
8510 Called just before savestate/movie load occurs (note: loads are always delayed,
8511 so this occurs even when load was initiated by lua).
8514 \begin_layout Subsection
8515 on_err_Load: Load failed
8518 \begin_layout Itemize
8519 Callback: on_err_load(string name)
8522 \begin_layout Standard
8523 Called if loadstate goes wrong.
8526 \begin_layout Subsection
8527 on_post_load: Load completed
8530 \begin_layout Itemize
8531 Callback: on_post_load(string name, boolean was_savestate)
8534 \begin_layout Standard
8535 Called on successful loadstate.
8536 was_savestate gives if this was a savestate or a movie.
8539 \begin_layout Subsection
8540 on_pre_save: Save operation is about to start
8543 \begin_layout Itemize
8544 Callback: on_pre_save(string name, boolean is_savestate)
8547 \begin_layout Standard
8548 Called just before savestate save occurs (note: movie saves are synchronous
8549 and won't trigger these callbacks if called from Lua).
8552 \begin_layout Subsection
8553 on_err_save: Save failed
8556 \begin_layout Itemize
8557 Callback: on_err_save(string name)
8560 \begin_layout Standard
8561 Called if savestate goes wrong.
8564 \begin_layout Subsection
8565 on_post_save: Save completed
8568 \begin_layout Itemize
8569 Callback: on_post_save(string name, boolean is_savestate)
8572 \begin_layout Standard
8573 Called on successful savaestate.
8574 is_savestate gives if this was a savestate or a movie.
8577 \begin_layout Subsection
8578 on_quit: Emulator is shutting down
8581 \begin_layout Itemize
8585 \begin_layout Standard
8586 Called when emulator is shutting down.
8589 \begin_layout Subsection
8590 on_input: Polling for input
8593 \begin_layout Standard
8594 Called when emulator is just sending input to bsnes core.
8595 Warning: This is called even in readonly mode, but the results are ignored.
8598 \begin_layout Subsection
8599 on_reset: System has been reset
8602 \begin_layout Itemize
8603 Callback: on_reset()
8606 \begin_layout Standard
8607 Called when system is reset.
8610 \begin_layout Subsection
8611 on_readwrite: Entered recording mode
8614 \begin_layout Itemize
8615 Callback: on_readwrite()
8618 \begin_layout Standard
8619 Called when moving into recording mode as result of
8620 \begin_inset Quotes eld
8624 \begin_inset Quotes erd
8627 command (note: moving to rwmode by Lua won't trigger this, as per recursive
8631 \begin_layout Subsection
8632 on_snoop/on_snoop2: Snoop core controller reads
8635 \begin_layout Itemize
8636 Callback: on_snoop(number port, number controller, number index, number
8640 \begin_layout Itemize
8641 Callback: on_snoop2(number port, number controller, number index, number
8645 \begin_layout Standard
8646 Called each time bsnes asks for input.
8647 The value is the final value to be sent to bsnes core (readonly mode, autohold
8648 and autofire have been taken into account).
8649 Might be useful when translating movies to format suitable for console
8651 Note: There is no way to modify the value to be sent.
8654 \begin_layout Itemize
8655 On_snoop2 is called instead of on_snoop if defined.
8656 Reserves port 0 for system, having first user port be port 1.
8659 \begin_layout Subsection
8660 on_keyhook: Hooked key/axis has been moved
8663 \begin_layout Itemize
8664 Callback: on_keyhook(string keyname, table state)
8667 \begin_layout Standard
8668 Sent when key that has keyhook events requested changes state.
8669 Keyname is name of the key (group) and state is the state (same kind as
8670 table values in input.raw).
8673 \begin_layout Subsection
8677 \begin_layout Itemize
8681 \begin_layout Standard
8682 Called when requested by set_idle_timeout(), the timeout has expired and
8683 emulator is waiting.
8686 \begin_layout Subsection
8687 on_timer: Timer event
8690 \begin_layout Itemize
8691 Callback: on_timer()
8694 \begin_layout Standard
8695 Called when requested by set_idle_timeout() and the timeout has expired
8696 (regardless if emulator is waiting).
8699 \begin_layout Subsection
8700 on_set_rewind: Rewind point has been set
8703 \begin_layout Itemize
8704 Callback: on_set_rewind(UNSAFEREWIND r)
8707 \begin_layout Standard
8708 Called when unsafe rewind object has been constructed.
8711 \begin_layout Subsection
8712 on_pre_rewind: Rewind is about to occur
8715 \begin_layout Itemize
8716 Callback: on_pre_rewind()
8719 \begin_layout Standard
8720 Called just before unsafe rewind is about to occur.
8723 \begin_layout Subsection
8724 on_post_rewind: Rewind has occured
8727 \begin_layout Itemize
8728 Callback: on_post_rewind()
8731 \begin_layout Standard
8732 Called just after unsafe rewind has occured.
8735 \begin_layout Subsection
8736 on_button: Button has been pressed
8739 \begin_layout Itemize
8740 Callback: on_button(number port, number controller, number index, string
8744 \begin_layout Standard
8745 Called on controller button press, with following parameters:
8748 \begin_layout Itemize
8749 port: Port number (0 is system)
8752 \begin_layout Itemize
8753 controller: Controller within port
8756 \begin_layout Itemize
8757 index: Index of button.
8760 \begin_layout Itemize
8761 type: Type of event, one of:
8765 \begin_layout Itemize
8766 \begin_inset Quotes eld
8770 \begin_inset Quotes erd
8773 : Button was pressed.
8776 \begin_layout Itemize
8777 \begin_inset Quotes eld
8781 \begin_inset Quotes erd
8784 : Button was released.
8787 \begin_layout Itemize
8788 \begin_inset Quotes eld
8792 \begin_inset Quotes erd
8798 \begin_layout Itemize
8799 \begin_inset Quotes eld
8803 \begin_inset Quotes erd
8806 : Released from hold.
8809 \begin_layout Itemize
8810 \begin_inset Quotes eld
8814 \begin_inset Quotes erd
8817 : Typing input on button.
8820 \begin_layout Itemize
8821 \begin_inset Quotes eld
8825 \begin_inset Quotes erd
8828 : Typing input undone.
8831 \begin_layout Itemize
8832 \begin_inset Quotes eld
8835 autofire <duty> <cycle>
8836 \begin_inset Quotes erd
8839 : Autofire with specifie duty and cycle.
8842 \begin_layout Itemize
8843 \begin_inset Quotes eld
8847 \begin_inset Quotes erd
8853 \begin_layout Itemize
8854 \begin_inset Quotes eld
8858 \begin_inset Quotes erd
8861 : Analog action on axis.
8865 \begin_layout Subsection
8866 on_movie_lost: Movie data is about to be lost
8869 \begin_layout Itemize
8870 Callback: on_movie_lost(STRING kind)
8873 \begin_layout Standard
8874 Called just before something would happen that could lose movie data.
8878 \begin_layout Itemize
8879 readwrite: Switching to recording mode.
8882 \begin_layout Itemize
8883 reload: ROM is being reloaded in recording mode.
8886 \begin_layout Itemize
8887 load: New movie is being loaded.
8890 \begin_layout Itemize
8891 unsaferewind: Unsafe rewind is happening.
8894 \begin_layout Subsection
8895 on_latch: Latch line is rising
8898 \begin_layout Itemize
8899 Callback: on_latch(<core-dependent-parameters>)
8902 \begin_layout Standard
8903 Called when latch line for controller is rising.
8904 Some cores may not support this.
8907 \begin_layout Section
8908 System-dependent behaviour
8911 \begin_layout Subsection
8915 \begin_layout Itemize
8916 Registers are: pbpc, pb, pc, r0, r1, r2, r3, r4, r5, a, x, y, z, s, d, db,
8917 p, e, irq, wai, mdr, vector, aa, rd, sp, dp, p_n, p_v, p_m, p_x, p_d, p_i,
8918 p_z, p_c, ppu_display_disabled, ppu_oam_priority, ppu_bg_tilesize[0], ppu_bg_ti
8919 lesize[1], ppu_bg_tilesize[2], ppu_bg_tilesize[3], ppu_bg3_priority, ppu_mosaic_
8920 enabled[0], ppu_mosaic_enabled[1], ppu_mosaic_enabled[2], ppu_mosaic_enabled[3],
8921 ppu_vram_incmode, ppu_mode7_vflip, ppu_mode7_hflip, ppu_window1_enabled[0],
8922 ppu_window1_enabled[1], ppu_window1_enabled[2], ppu_window1_enabled[3],
8923 ppu_window1_enabled[4], ppu_window1_enabled[5], ppu_window1_invert[0],
8924 ppu_window1_invert[1], ppu_window1_invert[2], ppu_window1_invert[3], ppu_window
8925 1_invert[4], ppu_window1_invert[5], ppu_window2_enabled[0], ppu_window2_enabled[
8926 1], ppu_window2_enabled[2], ppu_window2_enabled[3], ppu_window2_enabled[4],
8927 ppu_window2_enabled[5], ppu_window2_invert[0], ppu_window2_invert[1], ppu_windo
8928 w2_invert[2], ppu_window2_invert[3], ppu_window2_invert[4], ppu_window2_invert[5
8929 ], ppu_bg_enabled[0], ppu_bg_enabled[1], ppu_bg_enabled[2], ppu_bg_enabled[3],
8930 ppu_bg_enabled[4], ppu_bgsub_enabled[0], ppu_bgsub_enabled[1], ppu_bgsub_enable
8931 d[2], ppu_bgsub_enabled[3], ppu_bgsub_enabled[4], ppu_window_enabled[0],
8932 ppu_window_enabled[1], ppu_window_enabled[2], ppu_window_enabled[3], ppu_window
8933 _enabled[4], ppu_sub_window_enabled[0], ppu_sub_window_enabled[1], ppu_sub_windo
8934 w_enabled[2], ppu_sub_window_enabled[3], ppu_sub_window_enabled[4], ppu_addsub_m
8935 ode, ppu_direct_color, ppu_color_mode, ppu_color_halve, ppu_color_enabled[0],
8936 ppu_color_enabled[1], ppu_color_enabled[2], ppu_color_enabled[3], ppu_color_ena
8937 bled[4], ppu_color_enabled[5], ppu_mode7_extbg, ppu_pseudo_hires, ppu_overscan,
8938 ppu_oam_interlace, ppu_interlace, ppu_latch_hcounter, ppu_latch_vcounter,
8939 ppu_counters_latched, ppu_time_over, ppu_range_over, ppu_ppu1_mdr, ppu_ppu2_mdr
8940 , ppu_bg_y[0], ppu_bg_y[1], ppu_bg_y[2], ppu_bg_y[3], ppu_ioamaddr, ppu_icgramad
8941 dr, ppu_display_brightness, ppu_oam_basesize, ppu_oam_nameselect, ppu_oam_tdaddr
8942 , ppu_oam_baseaddr, ppu_oam_addr, ppu_oam_firstsprite, ppu_oam_latchdata,
8943 ppu_bg_mode, ppu_mosaic_size, ppu_mosaic_countdown, ppu_bg_scaddr[0], ppu_bg_sc
8944 addr[1], ppu_bg_scaddr[2], ppu_bg_scaddr[3], ppu_bg_scsize[0], ppu_bg_scsize[1],
8945 ppu_bg_scsize[2], ppu_bg_scsize[3], ppu_bg_tdaddr[0], ppu_bg_tdaddr[1],
8946 ppu_bg_tdaddr[2], ppu_bg_tdaddr[3], ppu_bg_ofslatch, ppu_m7_hofs, ppu_m7_vofs,
8947 ppu_bg_hofs[0], ppu_bg_hofs[1], ppu_bg_hofs[2], ppu_bg_hofs[3], ppu_bg_vofs[0],
8948 ppu_bg_vofs[1], ppu_bg_vofs[2], ppu_bg_vofs[3], ppu_vram_mapping, ppu_vram_incs
8949 ize, ppu_vram_addr, ppu_mode7_repeat, ppu_m7_latch, ppu_m7a, ppu_m7b, ppu_m7c,
8950 ppu_m7d, ppu_m7x, ppu_m7y, ppu_cgram_addr, ppu_cgram_latchdata, ppu_window1_lef
8951 t, ppu_window1_right, ppu_window2_left, ppu_window2_right, ppu_window_mask[0],
8952 ppu_window_mask[1], ppu_window_mask[2], ppu_window_mask[3], ppu_window_mask[4],
8953 ppu_window_mask[5], ppu_color_mask, ppu_colorsub_mask, ppu_color_r, ppu_color_g
8954 , ppu_color_b, ppu_color_rgb, ppu_scanlines, ppu_hcounter, ppu_vcounter,
8955 ppu_vram_readbuffer, ppu_oam_itemcount, ppu_oam_tilecount,
8958 \begin_layout Itemize
8959 on_latch has no parameters
8962 \begin_layout Itemize
8963 CPU 0 is S-CPU, 1 is S-SMP.
8966 \begin_layout Itemize
8967 Cheats are supported for ROM, SRAM, WRAM, BSXFLASH, SLOT{A,B}_{RAM,ROM}.
8970 \begin_layout Itemize
8971 Read/Write/Execute hooks are supported for ROM, SRAM, WRAM, BSXFLASH, SLOT{A,B}_
8975 \begin_layout Itemize
8976 Memory areas are: WRAM, APURAM, VRAM, OAM, CGRAM, RTC, DSPRAM, DSPPROM,
8977 DSPDROM, SRAM, ROM, BUS, PTRTABLE, CPU_STATE, PPU_STATE, SMP_STATE, DSP_STATE,
8978 BSXFLASH, BSX_RAM, BSX_PRAM, SLOTA_ROM, SLOTB_ROM, SLOTA_RAM, SLOTB_RAM,
8979 GBCPU_STATE, GBROM, GBRAM, GBWRAM, GBHRAM.
8982 \begin_layout Subsection
8986 \begin_layout Itemize
8987 Registers are: wrambank, cyclecounter, pc, sp, hf1, hf2, zf, cf, a, b, c,
8991 \begin_layout Itemize
8992 on_latch is not supported
8995 \begin_layout Itemize
8999 \begin_layout Itemize
9000 Cheats are supported for ROM, SRAM and WRAM.
9003 \begin_layout Itemize
9004 Read/Write/Execute hooks are supported for ROM (read/execute only), SRAM
9008 \begin_layout Itemize
9009 Memory areas are: SRAM, WRAM, VRAM, IOAMHRAM, ROM, BUS.