Ikemen GO engine is written in golang programming language. On top of it the engine uses Lua as an embedded scripting language, allowing the application functionality to be adjusted after it has been built.

Among others, Lua scripts are responsible for following tasks:

• Logic behind everything that is displayed outside fight (including screenpack logic, which controls interface rendering)
• Features expanding match functionality: Stuff like continue screen, pause menu etc.)
• Game modes logic: The engine is responsible for actual fighting. Who will enter the match and what to do with the match result is handled by external Lua scripts.
• Game configuration

Default Lua scripts are available within external/script directory. Due to the fact that scripts are often updated and expanded between versions, any changes made to them locally may not be forward compatible with future engine releases (at least until the engine stabilizes feature wise). For this reason editing scrips directly is not recommended for normal players that use the engine as a Mugen replacement, but for full game makers who decide to branch off to tailor the scripts to work exactly as they need (or don't mind extra work in case of code conflicts).

Following sections briefly showcase some of the features that use Lua and at the same time don't require editing default Lua scripts directly. Article dedicated to Arcade Paths / Story Mode arcs also brings up the topic of external Lua scripts.

Explanation how Lua language works or how to edit default scripts to your liking is outside scope of this article. Refer to Lua 5.1 reference manual and dedicated sites specializing in teaching programming languages instead (e.g. 1, 2).

Current iteration of Lua scripts support in-game unlocking of characters, stages and game modes via optional select.def and screenpack parameters.

Character unlocking

Characters locked via select.def hidden parameter can be unlocked using unlock parameter assigned in the same line. Everything that follows unlock parameter is treated as pure Lua code (which means it has to be very last parameter in line). Lua code condition is executed each time the mode is initiated and upon returning to main menu. It should return boolean data type. If the code evaluates to boolean true the character locked via select.def hidden parameter becomes selectable. If the character has been unlocked, but later on the condition returns false, such character becomes locked again.

example 1

Below is an example of unlocking SuaveDude character based on data gathered during matches (by default used for generating hiscores).

When the game is started, data present within saves/stats.json file is read into a Lua table called stats (table structure is the same as in json file). Let's say you want to unlock the character only if player has finished arcade mode (made it to the end defeating final boss) at least once. In such case unlocking condition (pasted right after unlock = parameter in select.def line that adds hidden character) can look for example as follows:

stats.modes ~= nil and stats.modes.arcade ~= nil and stats.modes.arcade.clear >= 1

Above code will return true if condition is met, unlocking SuaveDude as a result, or false if player has not finished arcade mode at least once or deleted old stats.json file. Appropriate table existence checks are needed before reading the value - otherwise script execution would crash if the subtable is missing)

example 2

Let's say we want to make SuaveDude available in all modes, but not in "Boss Rush". In such case the unlock condition can look like this (using one of the functions that returns the same data as GameMode trigger)

gamemode() ~= "bossrush"

example 3

Due to how online play works (only inputs being sent over, which means both players essentially need the same game, including exactly the same looking and behaving select screens), having additional condition that ensures that characters and stages are unlocked during netplay is recommended. network() function returns true only in online modes, so it can be used for this purpose, for example like this:

(--[[here goes normal condition for unlocking, like in example 1 and 2]]) or network()

example 4

As explained in select.def, character parameters are defined in the same line as the character itself, which limits complexity of code that can be written there. For this reason, for more complicated conditions, it's worth to prepare Lua function (loaded via external modules functionality) and call it instead.

--function declared via external module
function myFunction(myArgument)
  --any Lua code goes here. The function should return boolean data type (true or false)
end

Stage unlocking

As above but the select.def unlock parameter is assigned as stage parameter.

Game Mode unlocking

Game Modes can be locked in screenpack DEF file, under [Title Info] section, by using special menu.unlock.<itemname> parameter (where <itemname> should replaced with itemname parameter associated with particular mode in main menu). Text assigned to this parameter is read as a pure Lua code and works in similar fashion to character and stages unlocking (mode will be visible only if the parameter is missing or if it returns true, otherwise the mode is hidden). Unlike characters and stages, game modes unlocking is runtime permanent (as soon as the mode is unlocked, the condition won't be checked again, until the game is restarted).

External lua scripts (let's call them modules) are meant to implement features coded in Lua without directly modifying scripts distributed with engine.

There are 3 alternative ways to load external modules. Modules are loaded after all default scripts in following order:

1. Any file with lua extension placed in external/mods directory will be loaded automatically (alphabetical order)
2. Paths to lua files can be added into save/config.json Modules table (in the same way as files are added to config.json CommonStates)
3. Screenpack can be distributed with its own lua file, referenced in DEF file, under [Files] section, via module = path_to_lua_file parameter

Keep in mind that despite external modules making your script changes portable (easy to share and not being overwritten by the engine itself upon update), we can't promise that these files will be always compatible with future engine iterations. For example functions overwritten by a module may be changed in a way that your code is not ready for. Ikemen GO Lua code itself could also benefit from a major refactoring effort, so if anyone will ever bother to do it, it could lead to major changes to the scripts flow and logic.

In most cases using modules requires good understanding of scripts distributed with the engine (you need to know how something has been implemented in order to override how it works or expand its current functionality). As an example here is an external module code that adds completely new game mode, without need to edit any of the existing Lua scripts.

-- main.t_itemname is a table storing functions with general game mode
-- configuration (usually ending with start.f_selectMode function call).
main.t_itemname.vs100kumite = function()
	main.f_playerInput(main.playerInput, 1)
	main.t_pIn[2] = 1
	main.aiRamp = false
	main.charparam.ai = true
	main.charparam.music = true
	main.charparam.single = true
	main.charparam.stage = true
	main.charparam.time = true
	main.dropDefeated = false -- defeated members are not removed from team
	main.elimination = false -- single lose doesn't stop further lua execution
	main.exitSelect = true
	main.forceRosterSize = true -- roster size enforced even if there are not enough characters to fill it
	--main.lifebar.match = true
	--main.lifebar.p2ailevel = true
	main.persistLife = true -- life maintained after match
	main.persistMusic = true -- don't stop the previous music at the start of the match.
	main.persistRounds = true -- lifebar uses consecutive wins for round numbers
	main.makeRoster = true
	main.motif.continuescreen = false -- no continue screen after we lose the match
	main.motif.hiscore = true
	main.motif.losescreen = false -- no lose screen after we lose the match
	main.motif.winscreen = true
	main.matchWins.draw = {0, 0}
	main.matchWins.simul = {1, 1}
	main.matchWins.single = {1, 1}
	main.matchWins.tag = {1, 1}
	main.orderSelect[1] = true
	main.orderSelect[2] = true
	main.rotationChars = true
	main.stageMenu = true
	main.storyboard.credits = true
	main.storyboard.gameover = true
	main.teamMenu[1].ratio = true
	main.teamMenu[1].simul = true
	main.teamMenu[1].single = true
	main.teamMenu[1].tag = true
	main.teamMenu[1].turns = true
	main.teamMenu[2].ratio = true
	main.teamMenu[2].simul = true
	main.teamMenu[2].single = true
	main.teamMenu[2].tag = true
	main.teamMenu[2].turns = true
	textImgSetText(motif.select_info.title.TextSpriteData, motif.select_info.title.text.vs100kumite)
	setGameMode('vs100kumite')
	hook.run("main.t_itemname")
	return start.f_selectMode
end

This is enough to make your external mode functional within engine. Don't forget to also add it to your screenpack DEF file, as explained in this article.

Since external modules code is loaded after default lua scripts, while having access to everything initiated before it, it's also possible to overwrite any function or table present in default script, without touching the file directly. The more intrusive the change is the higher chance that it won't be forward compatible though.

Format: launchFight{args}

Required arguments: none

Return: bool Returns false if further lua script execution should be stopped (based on function parameter and match result), otherwise true

Optional arguments:

continue = bool (true or false) Decides if character is allowed to continue and rematch lost or draw fight. If false the continue screen won't show up but the lua script execution continues. (this can be useful for example for branching storyline on defeat)

• default arcade path: true
• default story mode: true

quickcontinue = bool (true or false) Decides if player is allowed to select new character after continue screen. If false the rematch is done with the same character.

• default arcade path: value heritage from options
• default story mode: true regardless of what is set (select screen is disabled in story mode)

order = num (int) Random selection limited to characters with this order.

• default arcade path: 1
• default story mode: 1

p1char = {list} (table) List of characters (names/paths enclosed in quotation, separated by commas) to assign to p1 team side.

• default arcade path: characters chosen in select screen
• default story mode: previously assigned chars

p1pal = num (int) (nightly build only) Forces particular pal to p1.

p1numchars = num (int) Forces particular team size.

• default arcade path: team size chosen during select screen, but not less than p1char count
• default story mode: at least 1, but not less than p1char count

p1numratio = {numlist} (int) List of ratio settings (1-4) to assign to p1 team side characters if turns team mode is selected. Example for 3 players: p1numratio = {1, 1, 2}

• default arcade path: same as the ratio chosen during select screen, not assigned otherwise
• default story mode: not assigned

p1teammode = "mode" (string) Assigns p1 team mode to single, simul, tag or turns.

• default arcade path: team mode chosen during select screen
• default story mode: single

p1rounds = num (int) Number of rounds p1 has to lose to be considered defeated.

• default arcade path: value heritage from options
• default story mode: value heritage from options

p1orderselect = bool (true or false) Decides if p1 is allowed to switch team order.

• default arcade path: true
• default story mode: false

p2char = {list} (table) List of characters (names/paths enclosed in quotation, separated by commas) to assign to p2 team side.

• default arcade path: random characters with the particular order, up to the team size chosen in the select screen
• default story mode: 1 random characters with the particular order

p2pal = num (int) (nightly build only) Forces particular pal to p2.

p2numchars = num (int) Forces particular team size.

• default arcade path: team size chosen during select screen, but not less than p2char count
• default story mode: at least 1, but not less than p2char count

p2numratio = {numlist} (int) List of ratio settings (1-4) to assign to p2 team side characters if turns team mode is selected. Example for 3 players: p2numratio = {1, 1, 2}

• default arcade path: follows arcade.ratiomatches select.def settings in arcade, if selected, not assigned otherwise
• default story mode: not assigned

p2teammode = "mode" (string) Assigns p2 team mode to single, simul, tag or turns.

• default arcade path: team mode chosen during select screen
• default story mode: single

p2rounds = num (int) Number of rounds p2 has to lose to be considered defeated.

• default arcade path: rounds assigned as select.def parameter or value heritage from options
• default story mode: value heritage from options

p2orderselect = bool (true or false) Decides if p2 is allowed to switch team order.

• default arcade path: true
• default story mode: false

exclude = {list} (table) List of characters (names/paths enclosed in quotation, separated by commas) to exclude from random selection (affects only this match, characters are still available during next function call). Characters that we've already fought against in the current arcade run with this character are automatically excluded.

• default arcade path: empty list
• default story mode: empty list

music = {"path", volume, loopstart, loopend} (table) Music that should be used at the start of round. path string can be optionally followed by volume, loopstart and loopend values.

• default arcade path: music assigned as select.def parameter or default stage music
• default story mode: default stage music

round.music = {"path", volume, loopstart, loopend} (table) Music that should be used at the start of round. path string can be optionally followed by volume, loopstart and loopend values. (typed as number) portion of key name decides round on which the music will be played

• default arcade path: music assigned as select.def parameter or default stage music
• default story mode: default stage music

final.music = {"path", volume, loopstart, loopend} (table) Music used at the start of the final round. path string can be optionally followed by volume, loopstart and loopend values. (typed as number) portion of key name decides round on which the music will be played

• default arcade path: music assigned as select.def parameter or default stage music
• default story mode: default stage music

life.music = {"path", volume, loopstart, loopend} (table) Music that should be used when player's controlled character has (by default) less than 30% life during deciding round. Further adjustments available via stage DEF file. path string can be optionally followed by volume, loopstart and loopend values.

• default arcade path: music assigned as select.def parameter or default stage music
• default story mode: default stage music

victory.music = {"path", volume, loopstart, loopend} (table) Music file that should start right after character scores final round K.O. and continue throughout the victory screen. path string can be optionally followed by volume, loopstart and loopend values, separated by commas.

• default arcade path: music assigned as select.def parameter or default stage music
• default story mode: default stage music

stage = "path" (string) Path to the stage to be used in this match.

• default arcade path: stage assigned as select.def parameter or randomized
• default story mode: randomized

ai = ailevel (float) Set a float value between 1 and 8 to force AI Level regardless of difficulty and AI ramping settings.

• default arcade path: ai assigned as select.def parameter or value following AI ramping settings
• default story mode: value heritage from options

time = num (int) Overwrites round time (in seconds) for this match.

• default arcade path: value heritage from options, adjusted by tag team size
• default story mode: value heritage from options, adjusted by tag team size

vsscreen = bool (true or false) Decides if versus screen should be shown before fight.

• default arcade path: true
• default story mode: false

victoryscreen = bool (true or false) Decides if victory screen should be shown after fight.

• default arcade path: true
• default story mode: false

lua = "code" (string) Lua code that will be executed each frame during match. (e.g. call your custom function to store extra match data gathered via Lua version of CNS/ZSS style triggers)

launchFight{
	p2char = {"Juni", "Juli"},
	p2numchars = 2,
	p2teammode = "simul",
	p2rounds = 1,
	time = 60,
	stage = "stages/dolls.def",
	["victory.music"] = {"sound/kfm.mp3", 100, 0, 0}
}

Format: launchStoryboard(path)

Return: bool Returns false if storyboard doesn't exist, otherwise true

Required arguments: path of the storyboard to execute

launchStoryboard('chars/kfm/intro.def')

Below are the documented embedded Lua functions exposed by the engine.

* marks an optional parameter.

addChar(defpath, params)

Add a character definition to the select screen.

Parameters

Returns

addHotkey(key, ctrl, alt, shift, allowDuringPause, debugOnly, script)

Register a global keyboard shortcut that runs Lua code.

Parameters

Returns

addStage(defpath, params)

Add a stage definition to the select screen.

Parameters

Returns

animAddPos(anim, dx, dy)

Add an offset to an animation's current position.

Parameters

animApplyVel(target, source)

Copy velocity parameters from one animation to another.

Parameters

animCopy(anim)

Create a copy of an animation.

Parameters

Returns

animDebug(anim, prefix)

Print debug information about an animation to the console.

Parameters

animDraw(anim, layer)

Queue drawing of an animation on a render layer.

Parameters

animGetLength(anim)

Get timing information for an animation.

Parameters

Returns

animGetPreloadedCharData(charRef, group, number, keepLoop)

Get a preloaded character animation by sprite group/number.

Parameters

Returns

animGetPreloadedStageData(stageRef, group, number, keepLoop)

Get a preloaded stage animation by sprite group/number.

Parameters

Returns

animGetSpriteInfo(anim, group, number)

Get information about a sprite used by an animation.

Parameters

Returns

animLoadPalettes(anim, param)

Load palettes for an animation's underlying sprite file, if palette usage is enabled.

Parameters

animNew(sff, actOrAnim)

Create a new animation from a sprite file and action definition.

Parameters

Returns

animPaletteGet(anim, paletteId)

Get a palette from an animation.

Parameters

Returns

animPaletteSet(anim, paletteId, palette)

Set colors in an animation palette.

Parameters

animPrepare(anim, charRef)

Prepare an animation so that each character can apply its own palette.

Parameters

Returns

animReset(anim, parts)

Reset an animation to its initial state, fully or partially.

Parameters

animSetAccel(anim, ax, ay)

Set gravity/acceleration applied to an animation.

Parameters

animSetAlpha(anim, src, dst)

Set alpha blending for an animation.

Parameters

animSetAngle(anim, angle)

Set rotation angle for an animation.

Parameters

animSetAnimation(anim, actOrAnim)

Replace an animation's underlying Animation data.

Parameters

animSetColorKey(anim, index)

Set the color key (transparent index) used by an animation.

Parameters

animSetColorPalette(anim, paletteId)

Change the active palette mapping for an animation.

Parameters

Returns

animSetFacing(anim, facing)

Set the facing (horizontal flip) of an animation.

Parameters

animSetFocalLength(anim, fLength)

Set focal length used for perspective projection on an animation.

Parameters

animSetFriction(anim, fx, fy)

Set friction applied to an animation's velocity.

Parameters

animSetLayerno(anim, layer)

Set the render layer used by an animation.

Parameters

animSetLocalcoord(anim, width, height)

Set the local coordinate system for an animation.

Parameters

animSetMaxDist(anim, maxX, maxY)

Set maximum drawing distance (clipping bounds) for an animation.

Parameters

animSetPalFX(anim, palfx)

Configure palette effects for an animation.

Parameters

animSetPos(anim, x, y)

Set animation position, optionally overriding only one axis.

Parameters

animSetProjection(anim, projection)

Set projection mode for an animation.

Parameters

animSetScale(anim, sx, sy)

Set the scale of an animation.

Parameters

animSetTile(anim, tileX, tileY, spacingX, spacingY)

Configure tiling for an animation.

Parameters

animSetVelocity(anim, vx, vy)

Set the base velocity of an animation.

Parameters

animSetWindow(anim, x1, y1, x2, y2)

Set the clipping window for an animation.

Parameters

animSetXAngle(anim, xangle)

Set rotation angle around the X axis for an animation.

Parameters

animSetXShear(anim, shear)

Set the X shear factor applied when drawing an animation.

Parameters

animSetYAngle(anim, yangle)

Set rotation angle around the Y axis for an animation.

Parameters

animUpdate(anim, force)

Advance an animation by one tick. By default, only the first call per frame advances the animation.

Parameters

batchDraw(batch)

Queue drawing of many animations in one call.

Parameters

bgDebug(bg, prefix)

Print debug information about a background definition.

Parameters

bgDraw(bg, layer, x, y, scale)

Queue drawing of a background definition.

Parameters

bgNew(sff, defPath, section, model, defaultLayer)

Load a background definition from a sprite file and configuration.

Parameters

Returns

bgReset(bg)

Reset a background definition to its initial state.

Parameters

changeAnim(animNo, elem, ffx)

[redirectable] Change the character's current animation.

Parameters

Returns

changeState(stateNo)

[redirectable] Change the character's current state or disable it.

Parameters

Returns

clear()

Clear all characters' clipboard text buffers.

clearAllSound()

Stop all currently playing sounds.

clearColor(r, g, b, alpha)

Fill the screen with a solid color (with optional alpha).

Parameters

clearConsole()

Clear text printed to the in-engine console.

clearSelected()

Clear all current select-screen choices (characters, stages, music, game params).

commandAdd(name, command, time, bufferTime, bufferHitpause, bufferPauseend, stepTime)

Register a UI command definition.

Parameters

commandBufReset(playerNo)

Reset command input buffers.

Parameters

commandDebug(playerNo, prefix)

Print debug information about a command list.

Parameters

commandGetState(playerNo, name)

Query the current state of a named command.

Parameters

Returns

computeRanking(mode)

Compute and store ranking data for a mode, returning whether it was cleared.

Parameters

Returns

connected()

Check if the main menu network connection is established.

Returns

continued()

Check whether the current run used a continue.

Returns

endMatch()

Signal that the current match should end (using menu fade-out settings).

enterNetPlay(host)

Enter netplay as client or host.

Parameters

enterReplay(path)

Enter replay playback mode from a replay file.

Parameters

Returns

esc(value)

Get or set the global escape flag.

Parameters

Returns

exitNetPlay()

Exit netplay mode and close any active netplay connection.

exitReplay()

Exit replay mode and restore normal video settings.

fadeInActive()

Check whether the global fade-in effect is active.

Returns

fadeInInit(fade)

Initialize a Fade object using motif fade-in settings.

Parameters

fadeOutActive()

Check whether the global fade-out effect is active.

Returns

fadeOutInit(fade)

Initialize a Fade object using motif fade-out settings.

Parameters

fadeColor(mode, startFrame, length, r, g, b)

Draw a timed screen fade overlay.

Parameters

Returns

fileExists(path)

Test whether a file exists, after engine path resolution.

Parameters

Returns

findEntityByName(text)

Find the next entity whose name contains the given text.

Parameters

findEntityByPlayerId(playerId)

Find the next entity with the given player ID.

Parameters

findHelperById(helperId)

Find the next helper with the given helper ID.

Parameters

fontGetDef(font)

Get basic font definition information.

Parameters

Returns

fontNew(filename, height)

Load a font from file.

Parameters

Returns

frameStep()

Enable single-frame stepping mode.

game()

Execute a full match using the current configuration.

Returns

gameRunning()

Check whether a match is currently running.

Returns

getAnimElemCount()

[redirectable] Get the character's number of elements in the animation.

Returns

getAnimTimeSum()

[redirectable] Get the character's current accumulated time of the animation.

Returns

getCharAttachedInfo(def)

Resolve and read basic information from a character definition file.

Parameters

Returns

getCharFileName(charRef)

Get the definition file path for a character slot.

Parameters

Returns

getCharInfo(charRef)

Get detailed information about a character slot.

Parameters

Returns

getCharMovelist(charRef)

Get the movelist file path for a character slot.

Parameters

Returns

getCharName(charRef)

Get the display name of a character slot.

Parameters

Returns

getCharRandomPalette(charRef)

Get a random valid palette number for a character slot.

Parameters

Returns

getCharSelectParams(charRef)

Get parsed select parameters for a character entry.

Parameters

Returns

getClipboardString()

Get the current system clipboard string.

Returns

getCommandLineFlags()

Get all command-line flags passed to the engine.

Returns

getCommandLineValue(flagName)

Get the value of a specific command-line flag.

Parameters

Returns

getConsecutiveWins(teamSide)

Get the number of consecutive wins for a team.

Parameters

Returns

getCredits()

Get the current credit count.

Returns

getDirectoryFiles(rootPath)

Recursively list all paths under a directory.

Parameters

Returns

getFrameCount()

Get the global frame counter value.

Returns

getGameFPS()

Get the current measured gameplay FPS.

Returns

getGameParams()

Get the current game parameter table.

Returns

getGameSpeed()

Get the current game logic speed as a percentage.

Returns

getGameStats()

Read accumulated game statistics.

Returns

getGameStatsJson()

Get a JSON snapshot of accumulated game statistics.

Returns

getInput(players, ...)

Check raw UI input for one or more players.

Parameters

Returns

getInputTime(players, ...)

Get the hold time of a raw input token for one or more players.

Parameters

Returns

getJoystickGUID(index)

Get a joystick's GUID string.

Parameters

Returns

getJoystickKey(controllerIdx)

Poll joystick input and return the corresponding key string.

Parameters

Returns

getJoystickName(index)

Get a joystick's display name.

Parameters

Returns

getJoystickPresent(index)

Check whether a joystick is present.

Parameters

Returns

getKey(key)

Query or compare the last pressed key.

Parameters

Returns

getKeyText()

Get the last input text associated with the current key event.

Returns

getLastInputController()

Get the last controller that produced UI input.

Returns

getMatchTime()

Get the accumulated match time from completed rounds.

Returns

getRandom()

Return a 32-bit random number, updating the global seed.

Returns

getRemapInput(playerNo)

Get the input remap target for a player.

Parameters

Returns

getRoundTime()

Get the configured round time limit.

Returns

getRuntimeOS()

Get the current runtime operating system identifier.

Returns

getSelectNo()

[redirectable] Get the character's select slot index.

Returns

getSessionWarning()

Pop the current session warning message.

Returns

getStageInfo(stageRef)

Get information about a stage slot.

Parameters

Returns

getStageNo()

Get the currently selected stage slot index.

Returns

getStageSelectParams(stageRef)

Get parsed select parameters for a stage entry.

Parameters

Returns

getStateOwnerId()

[redirectable] Get the character's player ID.

Returns

getStateOwnerName()

[redirectable] Get the character's name of the current state owner.

Returns

getStateOwnerPlayerNo()

[redirectable] Get the character's player number of the current state owner.

Returns

getStoryboardScene()

Get the current storyboard scene index.

Returns

getTimestamp(format)

Get a formatted timestamp string.

Parameters

Returns

getWinnerTeam()

Get the winning team side of the current or last match.

Returns

isUIKeyAction(action)

Check whether a UI action name is currently active.

Parameters

Returns

jsonDecode(path)

Decode a JSON file into Lua values.

Parameters

Returns

jsonEncode(value, path)

Encode a Lua value to JSON and save it to a file.

Parameters

loadAnimTable(path, sff)

Load an AIR/animation definition file and return an animation table.

Parameters

Returns

loadDebugFont(filename, scale)

Load and set the font used by the debug overlay.

Parameters

loadDebugInfo(funcs)

Register Lua functions to be called for debug info display.

Parameters

loadDebugStatus(funcName)

Register the Lua function used to draw debug status.

Parameters

loadGameOption(filename)

Load game options from a config file and return the current config as a table.

Parameters

Returns

loading()

Check whether resources are currently being loaded.

Returns

loadIni(filename)

Load an INI file and convert it to a nested Lua table.

Parameters

Returns

loadLifebar(defPath)

Load the lifebar definition.

Parameters

loadMotif(defPath)

Load a motif and return its configuration as a table.

Parameters

Returns

loadStart(params)

Validate selection and start asynchronous loading of characters and stage.

Parameters

loadState()

Request loading of a previously saved state on the next frame.

loadStoryboard(defPath)

Load a storyboard and set it as the current storyboard.

Parameters

Returns

loadText(path)

Load a text file and return its contents.

Parameters

Returns

mapSet(name, value, mapType)

[redirectable] Set the character's map value.

Parameters

modelNew(filename)

Load a 3D model (glTF) as a Model object.

Parameters

Returns

modifyGameOption(query, value)

Modify a game option using a query string path.

Parameters

modifyMotif(query, value)

Modify a motif using a query string path.

Parameters

modifyStoryboard(query, value)

Modify a currently loaded storyboard using a query string path.

Parameters

netPlay()

Check whether the current session is running in netplay mode.

Returns

panicError(message)

Raise an immediate Lua error with a custom message.

Parameters

paused()

Check whether gameplay is currently paused.

Returns

playBgm(params)

[redirectable] Control background music playback.

Parameters

playerBufReset(playerNo)

Reset player input buffers and disable hardcoded keys.

Parameters

playSnd

[redirectable] Play the character's sound.

Parameters

postMatch()

Check whether post-match processing is active.

Returns

preloadListChar(id, number)

Mark a character sprite or animation for preloading.

Parameters

preloadListStage(id, number)

Mark a stage sprite or animation for preloading.

Parameters

printConsole(text, appendLast)

Print text to the in-game console and standard output.

Parameters

puts(text)

Print text to standard output (stdout) only.

Parameters

rectDebug(rect, prefix)

Print a rectangle's debug information.

Parameters

rectDraw(rect, layer)

Queue drawing of a rectangle.

Parameters

rectNew()

Create a new rectangle object.

Returns

rectReset(rect)

Reset rectangle parameters to defaults.

Parameters

rectSetAlpha(rect, src, dst)

Set rectangle alpha blending values.

Parameters

rectSetAlphaPulse(rect, min, max, time)

Enable pulsing alpha effect for a rectangle.

Parameters

rectSetColor(rect, r, g, b)

Set rectangle RGB color.

Parameters

rectSetLayerno(rect, layer)

Set the rectangle's drawing layer.

Parameters

rectSetLocalcoord(rect, x, y)

Set the rectangle's local coordinate system.

Parameters

rectSetWindow(rect, x1, y1, x2, y2)

Set the rectangle's clipping window.

Parameters

rectUpdate(rect)

Update rectangle animation (alpha pulse, etc.).

Parameters

refresh()

Advance one frame: process logic, drawing and fades.

reload()

Schedule reloading of characters, stage and lifebar.

remapInput(srcPlayer, dstPlayer)

Remap logical player input to another player slot.

Parameters

removeDizzy()

[redirectable] Clear the character's dizzy state.

replayRecord(path)

Start recording rollback/netplay input to a file.

Parameters

replayStop()

Stop input replay recording.

resetAILevel()

Reset AI level for all players to 0 (human control).

resetGameStats()

Clear all accumulated game statistics.

resetKey()

Clear the last captured key and text input.

resetMatchData(fullReset)

Reset match-related runtime data.

Parameters

resetRemapInput()

Reset all input remapping to defaults.

resetRound()

Request a round reset.

resetScore(teamSide)

Reset a team's score to zero.

Parameters

resetTokenGuard()

Reset the UI input token guard.

roundOver()

Check whether the current round is over.

Returns

roundStart()

Check whether the current frame is the start of the round.

Returns

runHiscore(mode, place, endtime, nofade, nobgs, nooverlay)

Run the high-score screen for one frame.

Parameters

Returns

runStoryboard()

Run the currently loaded storyboard for one frame.

Returns

saveGameOption(path)

Save current game options to file.

Parameters

saveState()

Request saving of the current state on the next frame.

screenshot()

Take a screenshot on the next frame.

searchFile(filename, dirs)

Search for a file in a list of directories.

Parameters

Returns

selectChar(teamSide, charRef, palette)