From 55de5d336c2b82aa2393a28e09b64f72f4661a25 Mon Sep 17 00:00:00 2001 From: truebrain Date: Mon, 19 Dec 2011 20:58:59 +0000 Subject: (svn r23618) -Add: ScriptGame::Pause, ScriptGame::Unpause, and ScriptGame::GetLandscape (GameScript only) --- src/game/game_instance.cpp | 2 + src/lang/english.txt | 2 + src/misc_cmd.cpp | 1 + src/network/network.cpp | 4 ++ src/openttd.h | 1 + src/script/api/game/game_game.hpp.sq | 36 +++++++++++++++ src/script/api/script_game.cpp | 46 +++++++++++++++++++ src/script/api/script_game.hpp | 68 ++++++++++++++++++++++++++++ src/script/api/template/template_game.hpp.sq | 25 ++++++++++ 9 files changed, 185 insertions(+) create mode 100644 src/script/api/game/game_game.hpp.sq create mode 100644 src/script/api/script_game.cpp create mode 100644 src/script/api/script_game.hpp create mode 100644 src/script/api/template/template_game.hpp.sq (limited to 'src') diff --git a/src/game/game_instance.cpp b/src/game/game_instance.cpp index 87cb2e68c..9d9129b41 100644 --- a/src/game/game_instance.cpp +++ b/src/game/game_instance.cpp @@ -40,6 +40,7 @@ #include "../script/api/game/game_error.hpp.sq" #include "../script/api/game/game_event.hpp.sq" #include "../script/api/game/game_execmode.hpp.sq" +#include "../script/api/game/game_game.hpp.sq" #include "../script/api/game/game_gamesettings.hpp.sq" #include "../script/api/game/game_industry.hpp.sq" #include "../script/api/game/game_industrylist.hpp.sq" @@ -109,6 +110,7 @@ void GameInstance::RegisterAPI() SQGSEvent_Register(this->engine); SQGSEventController_Register(this->engine); SQGSExecMode_Register(this->engine); + SQGSGame_Register(this->engine); SQGSGameSettings_Register(this->engine); SQGSIndustry_Register(this->engine); SQGSIndustryList_Register(this->engine); diff --git a/src/lang/english.txt b/src/lang/english.txt index d50228701..f8e726fb6 100644 --- a/src/lang/english.txt +++ b/src/lang/english.txt @@ -1826,10 +1826,12 @@ STR_NETWORK_SERVER_MESSAGE_GAME_PAUSED :Game paused ({S STR_NETWORK_SERVER_MESSAGE_GAME_STILL_PAUSED_1 :Game still paused ({STRING}) STR_NETWORK_SERVER_MESSAGE_GAME_STILL_PAUSED_2 :Game still paused ({STRING}, {STRING}) STR_NETWORK_SERVER_MESSAGE_GAME_STILL_PAUSED_3 :Game still paused ({STRING}, {STRING}, {STRING}) +STR_NETWORK_SERVER_MESSAGE_GAME_STILL_PAUSED_4 :Game still paused ({STRING}, {STRING}, {STRING}, {STRING}) STR_NETWORK_SERVER_MESSAGE_GAME_UNPAUSED :Game unpaused ({STRING}) STR_NETWORK_SERVER_MESSAGE_GAME_REASON_NOT_ENOUGH_PLAYERS :number of players STR_NETWORK_SERVER_MESSAGE_GAME_REASON_CONNECTING_CLIENTS :connecting clients STR_NETWORK_SERVER_MESSAGE_GAME_REASON_MANUAL :manual +STR_NETWORK_SERVER_MESSAGE_GAME_REASON_GAME_SCRIPT :game script ############ End of leave-in-this-order STR_NETWORK_MESSAGE_CLIENT_LEAVING :leaving STR_NETWORK_MESSAGE_CLIENT_JOINED :*** {RAW_STRING} has joined the game diff --git a/src/misc_cmd.cpp b/src/misc_cmd.cpp index ff16c9272..c2a4ee8a8 100644 --- a/src/misc_cmd.cpp +++ b/src/misc_cmd.cpp @@ -148,6 +148,7 @@ CommandCost CmdPause(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, case PM_PAUSED_SAVELOAD: case PM_PAUSED_ERROR: case PM_PAUSED_NORMAL: + case PM_PAUSED_GAME_SCRIPT: break; #ifdef ENABLE_NETWORK diff --git a/src/network/network.cpp b/src/network/network.cpp index 52c6cb464..e4dafe096 100644 --- a/src/network/network.cpp +++ b/src/network/network.cpp @@ -336,6 +336,7 @@ void NetworkHandlePauseChange(PauseMode prev_mode, PauseMode changed_mode) switch (changed_mode) { case PM_PAUSED_NORMAL: case PM_PAUSED_JOIN: + case PM_PAUSED_GAME_SCRIPT: case PM_PAUSED_ACTIVE_CLIENTS: { bool changed = ((_pause_mode == PM_UNPAUSED) != (prev_mode == PM_UNPAUSED)); bool paused = (_pause_mode != PM_UNPAUSED); @@ -344,14 +345,17 @@ void NetworkHandlePauseChange(PauseMode prev_mode, PauseMode changed_mode) StringID str; if (!changed) { int i = -1; + if ((_pause_mode & PM_PAUSED_NORMAL) != PM_UNPAUSED) SetDParam(++i, STR_NETWORK_SERVER_MESSAGE_GAME_REASON_MANUAL); if ((_pause_mode & PM_PAUSED_JOIN) != PM_UNPAUSED) SetDParam(++i, STR_NETWORK_SERVER_MESSAGE_GAME_REASON_CONNECTING_CLIENTS); + if ((_pause_mode & PM_PAUSED_GAME_SCRIPT) != PM_UNPAUSED) SetDParam(++i, STR_NETWORK_SERVER_MESSAGE_GAME_REASON_GAME_SCRIPT); if ((_pause_mode & PM_PAUSED_ACTIVE_CLIENTS) != PM_UNPAUSED) SetDParam(++i, STR_NETWORK_SERVER_MESSAGE_GAME_REASON_NOT_ENOUGH_PLAYERS); str = STR_NETWORK_SERVER_MESSAGE_GAME_STILL_PAUSED_1 + i; } else { switch (changed_mode) { case PM_PAUSED_NORMAL: SetDParam(0, STR_NETWORK_SERVER_MESSAGE_GAME_REASON_MANUAL); break; case PM_PAUSED_JOIN: SetDParam(0, STR_NETWORK_SERVER_MESSAGE_GAME_REASON_CONNECTING_CLIENTS); break; + case PM_PAUSED_GAME_SCRIPT: SetDParam(0, STR_NETWORK_SERVER_MESSAGE_GAME_REASON_GAME_SCRIPT); break; case PM_PAUSED_ACTIVE_CLIENTS: SetDParam(0, STR_NETWORK_SERVER_MESSAGE_GAME_REASON_NOT_ENOUGH_PLAYERS); break; default: NOT_REACHED(); } diff --git a/src/openttd.h b/src/openttd.h index a4c94995e..7df5a39b1 100644 --- a/src/openttd.h +++ b/src/openttd.h @@ -61,6 +61,7 @@ enum PauseMode { PM_PAUSED_JOIN = 1 << 2, ///< A game paused for 'pause_on_join' PM_PAUSED_ERROR = 1 << 3, ///< A game paused because a (critical) error PM_PAUSED_ACTIVE_CLIENTS = 1 << 4, ///< A game paused for 'min_active_clients' + PM_PAUSED_GAME_SCRIPT = 1 << 5, ///< A game paused by a game script /** Pause mode bits when paused for network reasons. */ PMB_PAUSED_NETWORK = PM_PAUSED_ACTIVE_CLIENTS | PM_PAUSED_JOIN, diff --git a/src/script/api/game/game_game.hpp.sq b/src/script/api/game/game_game.hpp.sq new file mode 100644 index 000000000..ca7bb7a1d --- /dev/null +++ b/src/script/api/game/game_game.hpp.sq @@ -0,0 +1,36 @@ +/* $Id$ */ + +/* + * 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 . + */ + +/* THIS FILE IS AUTO-GENERATED; PLEASE DO NOT ALTER MANUALLY */ + +#include "../script_game.hpp" +#include "../template/template_game.hpp.sq" + + +template <> const char *GetClassName() { return "GSGame"; } + +void SQGSGame_Register(Squirrel *engine) +{ + DefSQClass SQGSGame("GSGame"); + SQGSGame.PreRegister(engine); + SQGSGame.AddConstructor(engine, "x"); + + SQGSGame.DefSQConst(engine, ScriptGame::LT_TEMPERATE, "LT_TEMPERATE"); + SQGSGame.DefSQConst(engine, ScriptGame::LT_ARCTIC, "LT_ARCTIC"); + SQGSGame.DefSQConst(engine, ScriptGame::LT_TROPIC, "LT_TROPIC"); + SQGSGame.DefSQConst(engine, ScriptGame::LT_TOYLAND, "LT_TOYLAND"); + + SQGSGame.DefSQStaticMethod(engine, &ScriptGame::Pause, "Pause", 1, "."); + SQGSGame.DefSQStaticMethod(engine, &ScriptGame::Unpause, "Unpause", 1, "."); + SQGSGame.DefSQStaticMethod(engine, &ScriptGame::IsPaused, "IsPaused", 1, "."); + SQGSGame.DefSQStaticMethod(engine, &ScriptGame::GetLandscape, "GetLandscape", 1, "."); + SQGSGame.DefSQStaticMethod(engine, &ScriptGame::IsMultiplayer, "IsMultiplayer", 1, "."); + + SQGSGame.PostRegister(engine); +} diff --git a/src/script/api/script_game.cpp b/src/script/api/script_game.cpp new file mode 100644 index 000000000..a6fd5da69 --- /dev/null +++ b/src/script/api/script_game.cpp @@ -0,0 +1,46 @@ +/* $Id$ */ + +/* + * 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 . + */ + +/** @file script_game.cpp Implementation of ScriptGame. */ + +#include "../../stdafx.h" +#include "script_game.hpp" +#include "../../command_type.h" +#include "../../settings_type.h" +#include "../../openttd.h" +#include "../../network/network.h" + +/* static */ bool ScriptGame::Pause() +{ + return ScriptObject::DoCommand(0, PM_PAUSED_GAME_SCRIPT, 1, CMD_PAUSE); +} + +/* static */ bool ScriptGame::Unpause() +{ + return ScriptObject::DoCommand(0, PM_PAUSED_GAME_SCRIPT, 0, CMD_PAUSE); +} + +/* static */ bool ScriptGame::IsPaused() +{ + return !!_pause_mode; +} + +/* static */ ScriptGame::LandscapeType ScriptGame::GetLandscape() +{ + return (ScriptGame::LandscapeType)_settings_game.game_creation.landscape; +} + +/* static */ bool ScriptGame::IsMultiplayer() +{ +#ifdef ENABLE_NETWORK + return _network_server; +#else + return false; +#endif +} diff --git a/src/script/api/script_game.hpp b/src/script/api/script_game.hpp new file mode 100644 index 000000000..3b66ba1f8 --- /dev/null +++ b/src/script/api/script_game.hpp @@ -0,0 +1,68 @@ +/* $Id$ */ + +/* + * 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 . + */ + +/** @file script_game.hpp Everything to manipulate the current running game. */ + +#ifndef SCRIPT_GAME_HPP +#define SCRIPT_GAME_HPP + +#include "script_object.hpp" +#include "../../landscape_type.h" + +/** + * Class that handles some game related functions. + * @api game + */ +class ScriptGame : public ScriptObject { +public: + /** + * Type of landscapes known in the game. + */ + enum LandscapeType { + /* Note: these values represent part of the in-game LandscapeType enum */ + LT_TEMPERATE = ::LT_TEMPERATE, ///< Temperate climiate. + LT_ARCTIC = ::LT_ARCTIC, ///< Arctic climate. + LT_TROPIC = ::LT_TROPIC, ///< Tropic climate. + LT_TOYLAND = ::LT_TOYLAND, ///< Toyland climate. + }; + + /** + * Pause the server. + * @return True if the action succeeded. + */ + static bool Pause(); + + /** + * Unpause the server. + * @return True if the action succeeded. + */ + static bool Unpause(); + + /** + * Check if the game is paused. + * @return True if and only if the game is paused (by which-ever means). + * @note That a game is paused, doesn't always means you can unpause it. If + * the game has been manually paused, or because of the pause_on_join in + * Multiplayer for example, you cannot unpause the game. + */ + static bool IsPaused(); + + /** + * Get the current landscape. + */ + static LandscapeType GetLandscape(); + + /** + * Is this a multiplayer game? + * @return True if this is a server in a multiplayer game. + */ + static bool IsMultiplayer(); +}; + +#endif /* SCRIPT_GAME_HPP */ diff --git a/src/script/api/template/template_game.hpp.sq b/src/script/api/template/template_game.hpp.sq new file mode 100644 index 000000000..495aeada4 --- /dev/null +++ b/src/script/api/template/template_game.hpp.sq @@ -0,0 +1,25 @@ +/* $Id$ */ + +/* + * 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 . + */ + +/* THIS FILE IS AUTO-GENERATED; PLEASE DO NOT ALTER MANUALLY */ + +#include "../script_game.hpp" + +namespace SQConvert { + /* Allow enums to be used as Squirrel parameters */ + template <> inline ScriptGame::LandscapeType GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQInteger tmp; sq_getinteger(vm, index, &tmp); return (ScriptGame::LandscapeType)tmp; } + template <> inline int Return(HSQUIRRELVM vm, ScriptGame::LandscapeType res) { sq_pushinteger(vm, (int32)res); return 1; } + + /* Allow ScriptGame to be used as Squirrel parameter */ + template <> inline ScriptGame *GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (ScriptGame *)instance; } + template <> inline ScriptGame &GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(ScriptGame *)instance; } + template <> inline const ScriptGame *GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (ScriptGame *)instance; } + template <> inline const ScriptGame &GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(ScriptGame *)instance; } + template <> inline int Return(HSQUIRRELVM vm, ScriptGame *res) { if (res == NULL) { sq_pushnull(vm); return 1; } res->AddRef(); Squirrel::CreateClassInstanceVM(vm, "Game", res, NULL, DefSQDestructorCallback, true); return 1; } +} // namespace SQConvert -- cgit v1.2.3-54-g00ecf