Method FlowHandler

TombEngine/Scripting/Internal/TEN/Flow/FlowHandler.cpp:50–382

ScriptInterfaceFlowHandler* g_GameFlow;

FlowHandler::FlowHandler(sol::state* lua, sol::table& parent) : _handler(lua)
{
/*** 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.
@section Flowlua
*/
	sol::table tableFlow{ _handler.GetState()->lua_state(), sol::create };
	parent.set(ScriptReserved_Flow, tableFlow);

/***
Add a level to the Flow.
@function AddLevel
@tparam Flow.Level level A level object.
*/
	tableFlow.set_function(ScriptReserved_AddLevel, &FlowHandler::AddLevel, this);

/*** Image to show when loading the game. Must be a .jpg or .png image.
@function SetIntroImagePath
@tparam string path The path to the image, relative to the TombEngine executable.
*/
	tableFlow.set_function(ScriptReserved_SetIntroImagePath, &FlowHandler::SetIntroImagePath, this);

/*** Video to show when loading the game. Must be a common video format, such as mp4, mkv, mov or avi.
@function SetIntroVideoPath
@tparam string path the path to the video, relative to the TombEngine exe
*/
	tableFlow.set_function(ScriptReserved_SetIntroVideoPath, &FlowHandler::SetIntroVideoPath, this);

/*** Image to show in the background of the title screen. Must be a .jpg or .png image. _Not yet implemented._
@function SetTitleScreenImagePath
@tparam string path The path to the image, relative to the TombEngine executable.
*/
	tableFlow.set_function(ScriptReserved_SetTitleScreenImagePath, &FlowHandler::SetTitleScreenImagePath, this);

/*** Enable or disable Lara drawing in title flyby.
Must be true or false
@function EnableLaraInTitle
@tparam bool enabled True or false.
*/
	tableFlow.set_function(ScriptReserved_EnableLaraInTitle, &FlowHandler::EnableLaraInTitle, this);

/*** Enable or disable level selection in title flyby.
Must be true or false
@function EnableLevelSelect
@tparam bool enabled True or false.
*/
	tableFlow.set_function(ScriptReserved_EnableLevelSelect, &FlowHandler::EnableLevelSelect, this);

/*** Enable or disable Home Level entry in the main menu.
@function EnableHomeLevel
@tparam bool enabled True or false.
*/
	tableFlow.set_function(ScriptReserved_EnableHomeLevel, &FlowHandler::EnableHomeLevel, this);

/*** Enable or disable saving and loading of savegames.
@function EnableLoadSave