mirror of
https://github.com/TombEngine/TombEngine.git
synced 2025-05-13 14:07:04 +03:00
Rename GameFlowScript to Flow. Make Flow and Objects take parent tables and add their stuff to said tables.
This commit is contained in:
hispidence
parent
f0295af4fa
commit
4b6b733558
13 changed files with 93 additions and 88 deletions
306
Scripting/src/Flow/Flow.cpp
Normal file
306
Scripting/src/Flow/Flow.cpp
Normal file
|
|
@ -0,0 +1,306 @@
|
|||
#include "frameworkandsol.h"
|
||||
#include "Flow.h"
|
||||
#include "ReservedScriptNames.h"
|
||||
#include "Sound/sound.h"
|
||||
#include "Game/savegame.h"
|
||||
#include "GameScriptInventoryObject.h"
|
||||
#include "InventorySlots.h"
|
||||
#include "Game/gui.h"
|
||||
#include "Objects/ScriptInterfaceObjectsHandler.h"
|
||||
|
||||
/***
|
||||
Functions for use in Flow.lua, settings.lua and strings.lua
|
||||
@tentable Flow
|
||||
@pragma nostrip
|
||||
*/
|
||||
|
||||
using std::string;
|
||||
using std::vector;
|
||||
using std::unordered_map;
|
||||
|
||||
ScriptInterfaceGame* g_GameScript;
|
||||
ScriptInterfaceObjectsHandler* g_GameScriptEntities;
|
||||
ScriptInterfaceStringsHandler* g_GameStringsHandler;
|
||||
ScriptInterfaceFlow* g_GameFlow;
|
||||
|
||||
Flow::Flow(sol::state* lua, sol::table & parent) : LuaHandler{ lua }
|
||||
{
|
||||
GameScriptLevel::Register(m_lua);
|
||||
GameScriptSkyLayer::Register(m_lua);
|
||||
GameScriptFog::Register(m_lua);
|
||||
GameScriptMirror::Register(m_lua);
|
||||
GameScriptInventoryObject::Register(m_lua);
|
||||
GameScriptSettings::Register(m_lua);
|
||||
GameScriptAnimations::Register(m_lua);
|
||||
GameScriptAudioTrack::Register(m_lua);
|
||||
GameScriptColor::Register(m_lua);
|
||||
GameScriptRotation::Register(m_lua);
|
||||
|
||||
/*** Flow.lua.
|
||||
These functions are called in Flow.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 table_flow{ m_lua->lua_state(), sol::create };
|
||||
parent.set(ScriptReserved_Flow, table_flow);
|
||||
|
||||
/***
|
||||
Add a level to the Flow.
|
||||
@function AddLevel
|
||||
@tparam Level level a level object
|
||||
*/
|
||||
table_flow.set_function(ScriptReserved_AddLevel, &Flow::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 exe
|
||||
*/
|
||||
table_flow.set_function(ScriptReserved_SetIntroImagePath, &Flow::SetIntroImagePath, 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 exe
|
||||
*/
|
||||
table_flow.set_function(ScriptReserved_SetTitleScreenImagePath, &Flow::SetTitleScreenImagePath, this);
|
||||
|
||||
/*** Maximum draw distance.
|
||||
The maximum draw distance, in sectors (blocks), of any level in the game.
|
||||
This is equivalent to TRNG's WorldFarView variable.
|
||||
__(not yet implemented)__
|
||||
@function SetFarView
|
||||
@tparam byte farview Number of sectors. Must be in the range [1, 127].
|
||||
*/
|
||||
table_flow.set_function(ScriptReserved_SetFarView, &Flow::SetGameFarView, this);
|
||||
|
||||
/*** 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.
|
||||
@section settingslua
|
||||
*/
|
||||
/***
|
||||
@function SetSettings
|
||||
@tparam Settings settings a settings object
|
||||
*/
|
||||
table_flow.set_function(ScriptReserved_SetSettings, &Flow::SetSettings, this);
|
||||
|
||||
/***
|
||||
@function SetAnimations
|
||||
@tparam Animations animations an animations object
|
||||
*/
|
||||
table_flow.set_function(ScriptReserved_SetAnimations, &Flow::SetAnimations, this);
|
||||
|
||||
/*** strings.lua.
|
||||
These functions used in strings.lua, which is generated by TombIDE.
|
||||
You will not need to call them manually.
|
||||
@section stringslua
|
||||
*/
|
||||
/*** Set string variable keys and their translations.
|
||||
@function SetStrings
|
||||
@tparam tab table array-style table with strings
|
||||
*/
|
||||
table_flow.set_function(ScriptReserved_SetStrings, &Flow::SetStrings, this);
|
||||
|
||||
/*** Set language names for translations.
|
||||
Specify which translations in the strings table correspond to which languages.
|
||||
@function SetLanguageNames
|
||||
@tparam tab table array-style table with language names
|
||||
*/
|
||||
table_flow.set_function(ScriptReserved_SetLanguageNames, &Flow::SetLanguageNames, this);
|
||||
|
||||
MakeReadOnlyTable(ScriptReserved_WeatherType, kWeatherTypes);
|
||||
MakeReadOnlyTable(ScriptReserved_LaraType, kLaraTypes);
|
||||
MakeReadOnlyTable(ScriptReserved_InvItem, kInventorySlots);
|
||||
MakeReadOnlyTable(ScriptReserved_RotationAxis, kRotAxes);
|
||||
MakeReadOnlyTable(ScriptReserved_ItemAction, kItemActions);
|
||||
MakeReadOnlyTable(ScriptReserved_ErrorMode, kErrorModes);
|
||||
}
|
||||
|
||||
Flow::~Flow()
|
||||
{
|
||||
for (auto& lev : Levels)
|
||||
{
|
||||
delete lev;
|
||||
}
|
||||
}
|
||||
|
||||
void Flow::SetLanguageNames(sol::as_table_t<std::vector<std::string>> && src)
|
||||
{
|
||||
m_languageNames = std::move(src);
|
||||
}
|
||||
|
||||
void Flow::SetStrings(sol::nested<std::unordered_map<std::string, std::vector<std::string>>> && src)
|
||||
{
|
||||
m_translationsMap = std::move(src);
|
||||
}
|
||||
|
||||
void Flow::SetSettings(GameScriptSettings const & src)
|
||||
{
|
||||
m_settings = src;
|
||||
}
|
||||
|
||||
void Flow::SetAnimations(GameScriptAnimations const& src)
|
||||
{
|
||||
Animations = src;
|
||||
}
|
||||
|
||||
void Flow::AddLevel(GameScriptLevel const& level)
|
||||
{
|
||||
Levels.push_back(new GameScriptLevel{ level });
|
||||
}
|
||||
|
||||
void Flow::SetIntroImagePath(std::string const& path)
|
||||
{
|
||||
IntroImagePath = path;
|
||||
}
|
||||
|
||||
void Flow::SetTitleScreenImagePath(std::string const& path)
|
||||
{
|
||||
TitleScreenImagePath = path;
|
||||
}
|
||||
|
||||
void Flow::SetGameFarView(byte val)
|
||||
{
|
||||
bool cond = val <= 127 && val >= 1;
|
||||
std::string msg{ "Game far view value must be in the range [1, 127]." };
|
||||
if (!ScriptAssert(cond, msg))
|
||||
{
|
||||
ScriptWarn("Setting game far view to 32.");
|
||||
GameFarView = 32;
|
||||
}
|
||||
else
|
||||
{
|
||||
GameFarView = val;
|
||||
}
|
||||
}
|
||||
|
||||
void Flow::LoadFlowScript()
|
||||
{
|
||||
ExecuteScript("Scripts/Enums.lua");
|
||||
ExecuteScript("Scripts/Flow.lua");
|
||||
ExecuteScript("Scripts/Strings.lua");
|
||||
ExecuteScript("Scripts/Settings.lua");
|
||||
|
||||
SetScriptErrorMode(GetSettings()->ErrorMode);
|
||||
}
|
||||
|
||||
char const * Flow::GetString(const char* id) const
|
||||
{
|
||||
if (!ScriptAssert(m_translationsMap.find(id) != m_translationsMap.end(), std::string{ "Couldn't find string " } + id))
|
||||
{
|
||||
return "String not found";
|
||||
}
|
||||
else
|
||||
return m_translationsMap.at(string(id)).at(0).c_str();
|
||||
}
|
||||
|
||||
GameScriptSettings* Flow::GetSettings()
|
||||
{
|
||||
return &m_settings;
|
||||
}
|
||||
|
||||
GameScriptLevel* Flow::GetLevel(int id)
|
||||
{
|
||||
return Levels[id];
|
||||
}
|
||||
|
||||
int Flow::GetNumLevels() const
|
||||
{
|
||||
return Levels.size();
|
||||
}
|
||||
|
||||
bool Flow::IsFlyCheatEnabled() const
|
||||
{
|
||||
return FlyCheat;
|
||||
}
|
||||
|
||||
bool Flow::DoFlow()
|
||||
{
|
||||
// We start with the title level
|
||||
CurrentLevel = 0;
|
||||
SelectedLevelForNewGame = 0;
|
||||
SelectedSaveGame = 0;
|
||||
SaveGameHeader header;
|
||||
|
||||
// We loop indefinitely, looking for return values of DoTitle or DoLevel
|
||||
bool loadFromSavegame = false;
|
||||
|
||||
while (true)
|
||||
{
|
||||
// First we need to fill some legacy variables in PCTomb5.exe
|
||||
GameScriptLevel* level = Levels[CurrentLevel];
|
||||
|
||||
GAME_STATUS status;
|
||||
|
||||
if (CurrentLevel == 0)
|
||||
{
|
||||
status = DoTitle(0, level->AmbientTrack);
|
||||
}
|
||||
else
|
||||
{
|
||||
// Prepare inventory objects table
|
||||
for (size_t i = 0; i < level->InventoryObjects.size(); i++)
|
||||
{
|
||||
GameScriptInventoryObject* obj = &level->InventoryObjects[i];
|
||||
if (obj->slot >= 0 && obj->slot < INVENTORY_TABLE_SIZE)
|
||||
{
|
||||
InventoryObject* invObj = &inventry_objects_list[obj->slot];
|
||||
|
||||
invObj->objname = obj->name.c_str();
|
||||
invObj->scale1 = obj->scale;
|
||||
invObj->yoff = obj->yOffset;
|
||||
invObj->xrot = FROM_DEGREES(obj->rot.x);
|
||||
invObj->yrot = FROM_DEGREES(obj->rot.y);
|
||||
invObj->zrot = FROM_DEGREES(obj->rot.z);
|
||||
invObj->meshbits = obj->meshBits;
|
||||
invObj->opts = obj->action;
|
||||
invObj->rot_flags = obj->rotationFlags;
|
||||
}
|
||||
}
|
||||
|
||||
status = DoLevel(CurrentLevel, level->AmbientTrack, loadFromSavegame);
|
||||
loadFromSavegame = false;
|
||||
}
|
||||
|
||||
switch (status)
|
||||
{
|
||||
case GAME_STATUS::GAME_STATUS_EXIT_GAME:
|
||||
return true;
|
||||
case GAME_STATUS::GAME_STATUS_EXIT_TO_TITLE:
|
||||
CurrentLevel = 0;
|
||||
break;
|
||||
case GAME_STATUS::GAME_STATUS_NEW_GAME:
|
||||
CurrentLevel = (SelectedLevelForNewGame != 0 ? SelectedLevelForNewGame : 1);
|
||||
SelectedLevelForNewGame = 0;
|
||||
InitialiseGame = true;
|
||||
break;
|
||||
case GAME_STATUS::GAME_STATUS_LOAD_GAME:
|
||||
// Load the header of the savegame for getting the level to load
|
||||
SaveGame::LoadHeader(SelectedSaveGame, &header);
|
||||
|
||||
// Load level
|
||||
CurrentLevel = header.Level;
|
||||
loadFromSavegame = true;
|
||||
|
||||
break;
|
||||
case GAME_STATUS::GAME_STATUS_LEVEL_COMPLETED:
|
||||
if (LevelComplete == Levels.size())
|
||||
{
|
||||
// TODO: final credits
|
||||
}
|
||||
else
|
||||
CurrentLevel++;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool Flow::CanPlayAnyLevel() const
|
||||
{
|
||||
return PlayAnyLevel;
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue