TombEngine/TR5Main/Scripting/ScriptAssert.h

#pragma once

#include <string>
#include <optional>

enum class ERROR_MODE
{
	SILENT,
	WARN,
	TERMINATE
};

bool ScriptAssert(bool cond, std::string const& msg, std::optional<ERROR_MODE> forceMode = std::nullopt);
Add ScriptAssert. This is to be used when an error is discovered in a Lua Script. The var ScriptErrorMode refers to the error mode the user has chosen (silent, warn, terminate). At the moment this is hardcoded but will soon become editable to a LD via settings. ScriptAssert will read this variable and take the appropriate action when an assert is failed. IGNORE will do nothing (we should make a note in the documentation that this should almost certainly not be used by the LD if they can avoid it). WARN will call TENLog with LogLevel::Warn. TERMINATE will throw a TENScriptException, where it will be caught at GameMain, where TENLog will be called. There are circumstances where we will HAVE to terminate, even if the user has opted not to (i.e. errors where there is nothing sensible that can be done, such as syntax errors that would terminate Lua anyway). For these, we can pass in ERROR_MODE::TERMINATE as the last variable. 2021-08-04 16:18:52 +01:00			`#pragma once`

			`#include <string>`
			`#include <optional>`

			`enum class ERROR_MODE`
			`{`
			`SILENT,`
			`WARN,`
			`TERMINATE`
			`};`

			`bool ScriptAssert(bool cond, std::string const& msg, std::optional<ERROR_MODE> forceMode = std::nullopt);`