TASVideos

Tool-assisted game movies
When human skills are just not enough

Sand Box

<< Sand Box

This page documents the the behavior and parameters of Lua functions available for the BizHawk emulator. This is an autogenerated page, do not edit

Table of contents [expand all] [collapse all]

All type names represent the standard .NET types of the same name. Except for func which represents a lua function and table which represents a lua table. For more information on .NET types can be found in MSDN documentation.

Types and notation

userdata

A library for setting and retrieving dynamic data that will be saved and loaded with savestates

userdata.set

userdata.get

userdata.clear

userdata.remove

userdata.containskey

bit

A library for performing standard bitwise operations.

bit.band

bit.bnot

bit.bor

bit.bxor

bit.lshift

bit.rol

bit.ror

bit.rshift

bit.arshift

bit.check

bit.set

bit.clear

bit.byteswap_16

bit.byteswap_32

bit.byteswap_64

emu

A library for interacting with the currently loaded emulator core

emu.displayvsync

emu.frameadvance

emu.framecount

emu.disassemble

emu.getregister

emu.getregisters

emu.setregister

emu.totalexecutedcycles

emu.getsystemid

emu.islagged

emu.setislagged

emu.lagcount

emu.setlagcount

emu.limitframerate

emu.minimizeframeskip

emu.setrenderplanes

emu.yield

emu.getdisplaytype

emu.getboardname

emu.getluacore

event

A library for registering lua functions to emulator events.
  All events support multiple registered methods.
All registered event methods can be named and return a Guid when registered

event.onframeend

event.onframestart

event.oninputpoll

event.onloadstate

event.onmemoryexecute

event.onmemoryexecuteany

event.onmemoryread

event.onmemorywrite

event.onsavestate

event.onexit

event.unregisterbyid

event.unregisterbyname

event.availableScopes

gameinfo

gameinfo.getromname

gameinfo.getromhash

gameinfo.indatabase

gameinfo.getstatus

gameinfo.isstatusbad

gameinfo.getboardtype

gameinfo.getoptions

genesis

Functions specific to GenesisHawk (functions may not run when an Genesis game is not loaded)

genesis.getlayer_bga

genesis.getlayer_bgb

genesis.getlayer_bgw

genesis.setlayer_bga

genesis.setlayer_bgb

genesis.setlayer_bgw

joypad

joypad.get

joypad.getimmediate

joypad.setfrommnemonicstr

joypad.set

joypad.setanalog

mainmemory

Main memory library reads and writes from the Main memory domain (the default memory domain set by any given core)

mainmemory.getname

mainmemory.getcurrentmemorydomainsize

mainmemory.readbyte

mainmemory.writebyte

mainmemory.readbyterange

mainmemory.writebyterange

mainmemory.readfloat

mainmemory.writefloat

mainmemory.read_s8

mainmemory.write_s8

mainmemory.read_u8

mainmemory.write_u8

mainmemory.read_s16_le

mainmemory.write_s16_le

mainmemory.read_s16_be

mainmemory.write_s16_be

mainmemory.read_u16_le

mainmemory.write_u16_le

mainmemory.read_u16_be

mainmemory.write_u16_be

mainmemory.read_s24_le

mainmemory.write_s24_le

mainmemory.read_s24_be

mainmemory.write_s24_be

mainmemory.read_u24_le

mainmemory.write_u24_le

mainmemory.read_u24_be

mainmemory.write_u24_be

mainmemory.read_s32_le

mainmemory.write_s32_le

mainmemory.read_s32_be

mainmemory.write_s32_be

mainmemory.read_u32_le

mainmemory.write_u32_le

mainmemory.read_u32_be

mainmemory.write_u32_be

memory

These functions behavior identically to the mainmemory functions but the user can set the memory domain to read and write from. The default domain is the system bus. Use getcurrentmemorydomain(), and usememorydomain() to control which domain is used. Each core has its own set of valid memory domains. Use getmemorydomainlist() to get a list of memory domains for the current core loaded.

memory.getmemorydomainlist

memory.getmemorydomainsize

memory.getcurrentmemorydomain

memory.getcurrentmemorydomainsize

memory.usememorydomain

memory.hash_region

memory.readbyte

memory.writebyte

memory.readbyterange

memory.writebyterange

memory.readfloat

memory.writefloat

memory.read_s8

memory.write_s8

memory.read_u8

memory.write_u8

memory.read_s16_le

memory.write_s16_le

memory.read_s16_be

memory.write_s16_be

memory.read_u16_le

memory.write_u16_le

memory.read_u16_be

memory.write_u16_be

memory.read_s24_le

memory.write_s24_le

memory.read_s24_be

memory.write_s24_be

memory.read_u24_le

memory.write_u24_le

memory.read_u24_be

memory.write_u24_be

memory.read_s32_le

memory.write_s32_le

memory.read_s32_be

memory.write_s32_be

memory.read_u32_le

memory.write_u32_le

memory.read_u32_be

memory.write_u32_be

memorysavestate

memorysavestate.savecorestate

memorysavestate.loadcorestate

memorysavestate.removestate

memorysavestate.clearstatesfrommemory

movie

movie.startsfromsavestate

movie.startsfromsaveram

movie.filename

movie.getinput

movie.getinputasmnemonic

movie.getreadonly

movie.getrerecordcount

movie.getrerecordcounting

movie.isloaded

movie.length

movie.mode

movie.save

movie.setreadonly

movie.setrerecordcount

movie.setrerecordcounting

movie.stop

movie.getfps

movie.getheader

movie.getcomments

movie.getsubtitles

nes

Functions related specifically to Nes Cores

nes.addgamegenie

nes.getallowmorethaneightsprites

nes.getbottomscanline

nes.getclipleftandright

nes.getdispbackground

nes.getdispsprites

nes.gettopscanline

nes.removegamegenie

nes.setallowmorethaneightsprites

nes.setclipleftandright

nes.setdispbackground

nes.setdispsprites

nes.setscanlines

snes

Functions specific to SNESHawk (functions may not run when an SNES game is not loaded)

snes.getlayer_bg_1

snes.getlayer_bg_2

snes.getlayer_bg_3

snes.getlayer_bg_4

snes.getlayer_obj_1

snes.getlayer_obj_2

snes.getlayer_obj_3

snes.getlayer_obj_4

snes.setlayer_bg_1

snes.setlayer_bg_2

snes.setlayer_bg_3

snes.setlayer_bg_4

snes.setlayer_obj_1

snes.setlayer_obj_2

snes.setlayer_obj_3

snes.setlayer_obj_4

SQL

A library for performing SQLite operations.

SQL.createdatabase

SQL.opendatabase

SQL.writecommand

SQL.readcommand

bizstring

A library exposing standard .NET string methods

bizstring.hex

bizstring.binary

bizstring.octal

bizstring.trim

bizstring.replace

bizstring.toupper

bizstring.tolower

bizstring.substring

bizstring.remove

bizstring.contains

bizstring.startswith

bizstring.endswith

bizstring.split

client

A library for manipulating the EmuHawk client UI

client.exit

client.exitCode

client.borderheight

client.borderwidth

client.bufferheight

client.bufferwidth

client.clearautohold

client.closerom

client.enablerewind

client.frameskip

client.invisibleemulation

client.seekframe

client.gettargetscanlineintensity

client.getwindowsize

client.SetGameExtraPadding

client.SetSoundOn

client.GetSoundOn

client.SetClientExtraPadding

client.ispaused

client.isturbo

client.isseeking

client.opencheats

client.openhexeditor

client.openramwatch

client.openramsearch

client.openrom

client.opentasstudio

client.opentoolbox

client.opentracelogger

client.pause

client.pause_av

client.reboot_core

client.screenheight

client.screenshot

client.screenshottoclipboard

client.settargetscanlineintensity

client.setscreenshotosd

client.screenwidth

client.setwindowsize

client.speedmode

client.getconfig

client.togglepause

client.transformPointX

client.transformPointY

client.unpause

client.unpause_av

client.xpos

client.ypos

client.getversion

client.getavailabletools

client.gettool

client.createinstance

client.displaymessages

client.saveram

client.sleep

client.exactsleep

comm

A library for communicating with other programs

comm.getluafunctionslist

comm.socketServerIsConnected

comm.socketServerScreenShot

comm.socketServerScreenShotResponse

comm.socketServerSend

comm.socketServerResponse

comm.socketServerSuccessful

comm.socketServerSetTimeout

comm.socketServerSetIp

comm.socketServerSetPort

comm.socketServerGetIp

comm.socketServerGetPort

comm.socketServerGetInfo

comm.mmfSetFilename

comm.mmfGetFilename

comm.mmfScreenshot

comm.mmfWrite

comm.mmfRead

comm.httpTest

comm.httpTestGet

comm.httpGet

comm.httpPost

comm.httpPostScreenshot

comm.httpSetTimeout

comm.httpSetPostUrl

comm.httpSetGetUrl

comm.httpGetPostUrl

comm.httpGetGetUrl

console

console.clear

console.getluafunctionslist

console.log

console.writeline

console.write

forms

A library for creating and managing custom dialogs

forms.addclick

forms.button

forms.checkbox

forms.clearclicks

forms.destroy

forms.destroyall

forms.dropdown

forms.getproperty

forms.gettext

forms.ischecked

forms.label

forms.newform

forms.openfile

forms.pictureBox

forms.clear

forms.refresh

forms.setDefaultForegroundColor

forms.setDefaultBackgroundColor

forms.setDefaultTextBackground

forms.drawBezier

forms.drawBox

forms.drawEllipse

forms.drawIcon

forms.drawImage

forms.clearImageCache

forms.drawImageRegion

forms.drawLine

forms.drawAxis

forms.drawArc

forms.drawPie

forms.drawPixel

forms.drawPolygon

forms.drawRectangle

forms.drawString

forms.drawText

forms.getMouseX

forms.getMouseY

forms.setdropdownitems

forms.setlocation

forms.setproperty

forms.createcolor

forms.setsize

forms.settext

forms.textbox

gui

gui.DrawNew

gui.DrawFinish

gui.addmessage

gui.clearGraphics

gui.cleartext

gui.defaultForeground

gui.defaultBackground

gui.defaultTextBackground

gui.defaultPixelFont

gui.drawBezier

gui.drawBox

gui.drawEllipse

gui.drawIcon

gui.drawImage

gui.clearImageCache

gui.drawImageRegion

gui.drawLine

gui.drawAxis

gui.drawPie

gui.drawPixel

gui.drawPolygon

gui.drawRectangle

gui.drawString

gui.drawText

gui.pixelText

gui.text

gui.createcanvas

input

input.get

All buttons that are pressed have their key values set to true; all others remain nil.

input.getmouse

savestate

savestate.load

savestate.loadslot

savestate.save

savestate.saveslot

tastudio

A library for manipulating the Tastudio dialog of the EmuHawk client

tastudio.engaged

tastudio.getrecording

tastudio.setrecording

tastudio.togglerecording

tastudio.islag

tastudio.setlag

tastudio.hasstate

tastudio.setplayback

tastudio.getselection

tastudio.submitinputchange

tastudio.submitanalogchange

tastudio.submitinsertframes

tastudio.submitdeleteframes

tastudio.applyinputchanges

tastudio.clearinputchanges

tastudio.addcolumn

tastudio.setbranchtext

tastudio.getbranches

tastudio.getbranchinput

tastudio.loadbranch

tastudio.getmarker

tastudio.removemarker

tastudio.setmarker

tastudio.onqueryitembg

tastudio.onqueryitemtext

tastudio.onqueryitemicon

tastudio.ongreenzoneinvalidated

tastudio.onbranchload

tastudio.onbranchsave

tastudio.onbranchremove

LuaCanvas

Represents a canvas object returned by the gui.createcanvas() method

LuaCanvas.setTitle

LuaCanvas.setLocation

LuaCanvas.clear

LuaCanvas.refresh

LuaCanvas.setDefaultForegroundColor

LuaCanvas.setDefaultBackgroundColor

LuaCanvas.setDefaultTextBackground

LuaCanvas.drawBezier

LuaCanvas.drawBox

LuaCanvas.drawEllipse

LuaCanvas.drawIcon

LuaCanvas.drawImage

LuaCanvas.clearImageCache

LuaCanvas.drawImageRegion

LuaCanvas.drawLine

LuaCanvas.drawAxis

LuaCanvas.drawArc

LuaCanvas.drawPie

LuaCanvas.drawPixel

LuaCanvas.drawPolygon

LuaCanvas.drawRectangle

LuaCanvas.drawString

LuaCanvas.drawText

LuaCanvas.getMouseX

LuaCanvas.getMouseY



Combined RSS Feed
SandBox last edited by feos on 2020-04-29 18:51:07
Page info and history | Latest diff | List referrers | View Source