d09b504bc5
# Conflicts: # .github/workflows/ci-build.yml # .github/workflows/release-linux.yml # .github/workflows/release-macos.yml # .github/workflows/release-source.yml # .github/workflows/release.yml # CMakeLists.txt # COMPILING.md # src/ai/ai_core.cpp # src/ai/ai_gui.cpp # src/bridge_gui.cpp # src/company_gui.cpp # src/console_cmds.cpp # src/core/CMakeLists.txt # src/core/smallmap_type.hpp # src/disaster_vehicle.h # src/effectvehicle_base.h # src/fontcache.cpp # src/game/game_core.cpp # src/game/game_gui.cpp # src/gamelog.cpp # src/gamelog_internal.h # src/group_gui.cpp # src/linkgraph/linkgraph.h # src/misc.cpp # src/network/core/config.h # src/network/core/udp.cpp # src/network/network_chat_gui.cpp # src/network/network_content_gui.cpp # src/network/network_gui.cpp # src/newgrf.cpp # src/newgrf_gui.cpp # src/newgrf_profiling.cpp # src/newgrf_profiling.h # src/object_gui.cpp # src/openttd.cpp # src/openttd.h # src/order_gui.cpp # src/os/windows/font_win32.cpp # src/rail_gui.cpp # src/road.cpp # src/road_gui.cpp # src/saveload/afterload.cpp # src/saveload/saveload.h # src/script/api/script_controller.cpp # src/script/api/script_roadtypelist.cpp # src/script/script_config.cpp # src/script/script_config.hpp # src/script/script_instance.cpp # src/script/script_scanner.cpp # src/script/squirrel.cpp # src/script/squirrel_helper.hpp # src/settings_gui.cpp # src/settings_internal.h # src/settings_type.h # src/table/settings/network_private_settings.ini # src/timetable_gui.cpp # src/vehicle.cpp # src/vehicle_base.h # src/window_gui.h
60 lines
2.2 KiB
C++
60 lines
2.2 KiB
C++
/*
|
|
* This file is part of OpenTTD.
|
|
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
|
|
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/** @file script_log.hpp Everything to handle and issue log messages. */
|
|
|
|
#ifndef SCRIPT_LOG_HPP
|
|
#define SCRIPT_LOG_HPP
|
|
|
|
#include "script_object.hpp"
|
|
|
|
/**
|
|
* Class that handles all log related functions.
|
|
* @api ai game
|
|
*/
|
|
class ScriptLog : public ScriptObject {
|
|
/* ScriptController needs access to Enum and Log, in order to keep the flow from
|
|
* OpenTTD core to script API clear and simple. */
|
|
friend class ScriptController;
|
|
|
|
public:
|
|
/**
|
|
* Print an Info message to the logs.
|
|
* @param message The message to log.
|
|
* @note Special characters such as U+0000-U+0019 and U+E000-U+E1FF are not supported and removed or replaced by a question mark. This includes newlines and tabs.
|
|
*/
|
|
static void Info(const std::string &message);
|
|
|
|
/**
|
|
* Print a Warning message to the logs.
|
|
* @param message The message to log.
|
|
* @note Special characters such as U+0000-U+0019 and U+E000-U+E1FF are not supported and removed or replaced by a question mark. This includes newlines and tabs.
|
|
*/
|
|
static void Warning(const std::string &message);
|
|
|
|
/**
|
|
* Print an Error message to the logs.
|
|
* @param message The message to log.
|
|
* @note Special characters such as U+0000-U+0019 and U+E000-U+E1FF are not supported and removed or replaced by a question mark. This includes newlines and tabs.
|
|
*/
|
|
static void Error(const std::string &message);
|
|
|
|
/**
|
|
* Log this message once.
|
|
* @api -all
|
|
*/
|
|
static void LogOnce(ScriptLogTypes::ScriptLogType level, std::string &&message);
|
|
|
|
private:
|
|
/**
|
|
* Internal command to log the message in a common way.
|
|
*/
|
|
static void Log(ScriptLogTypes::ScriptLogType level, const std::string &message);
|
|
};
|
|
|
|
#endif /* SCRIPT_LOG_HPP */
|