Table Flow
Functions for use in Flow.lua, settings.lua and strings.lua
gameflow.lua
AddLevel(level) | Add a level to the Flow. |
SetIntroImagePath(path) | Image to show when loading the game. |
SetTitleScreenImagePath(path) | Image to show in the background of the title screen. |
settings.lua
SetSettings(settings) | |
SetAnimations(animations) |
strings.lua
SetStrings(table) | Set string variable keys and their translations. |
GetString(string) | Get translated string |
SetLanguageNames(table) | Set language names for translations. |
gameflow.lua
These functions are called in gameflow.lua, a file loosely equivalent to winroomedit's SCRIPT.DAT.
They handle a game's 'metadata'; i.e., things such as level titles, loading screen paths, and default
ambient tracks.
- AddLevel(level)
-
Add a level to the Flow.
Parameters:
- level Level a level object
- SetIntroImagePath(path)
-
Image to show when loading the game.
Must be a .jpg or .png image.
Parameters:
- path string the path to the image, relative to the TombEngine exe
- SetTitleScreenImagePath(path)
-
Image to show in the background of the title screen.
Must be a .jpg or .png image.
(not yet implemented)
Parameters:
- path string the path to the image, relative to the TombEngine exe
settings.lua
These functions are called in settings.lua, a file which holds your local settings.
settings.lua shouldn't be bundled with any finished levels/games.
- SetSettings(settings)
-
Parameters:
- settings Settings a settings object
- SetAnimations(animations)
-
Parameters:
- animations Animations an animations object
strings.lua
These functions used in strings.lua, which is generated by TombIDE.
You will not need to call them manually.
- SetStrings(table)
-
Set string variable keys and their translations.
Parameters:
- table tab array-style table with strings
- GetString(string)
-
Get translated string
Parameters:
- string key key for translated string
- SetLanguageNames(table)
-
Set language names for translations.
Specify which translations in the strings table correspond to which languages.
Parameters:
- table tab array-style table with language names