multiplayer: Adds option to pause server #6838

tobiaskohlbau · 2017-12-17T12:35:12Z

OpenRCT2 does not provide a simple function to pause a server
while no client is connected. This patch adds a so called "pause_server_if_no_clients"
flag within network section of config.ini. By default this flag is set
to false to be backward compatible with running servers. After setting
this flag to true the game is paused on launch and gets unpaused on
first connection.

Broxzier

Works nicely, only issue is that the game toggles pause without checking wether the game is paused or not before doing so.

Broxzier · 2017-12-26T12:23:02Z

src/openrct2/network/Network.cpp

@@ -1502,6 +1506,9 @@ void Network::EnqueueGameAction(const GameAction *action)

 void Network::AddClient(ITcpSocket * socket)
 {
+    if (gConfigNetwork.pause_server && client_connection_list.size() == 0) {


Since the server is able to pause and unpause at will, it'd be safer to check if the game is paused here.

Good catch didn't know that there exists a function to get current game status 🙈 First time dealing with openrct2 sources, many thanks!

Broxzier · 2017-12-26T12:23:50Z

src/openrct2/network/Network.cpp

@@ -1540,6 +1547,9 @@ void Network::RemoveClient(std::unique_ptr<NetworkConnection>& connection)
                          return player.get() == connection_player;
                      }), player_list.end());
    client_connection_list.remove(connection);
+    if (gConfigNetwork.pause_server && client_connection_list.size() == 0) {


And here check if the game is not paused already.

tobiaskohlbau · 2017-12-28T08:58:28Z

I've messed up this MR a little bit sorry. Could you review again and maybe run travis once more as it got canceled by mistake.

Broxzier · 2017-12-29T16:45:06Z

I think this feature is worth mentioning in the changelog, so that players will know it exists.

Gymnasiast · 2017-12-29T20:50:35Z

src/openrct2/network/Network.cpp

@@ -1502,6 +1506,9 @@ void Network::EnqueueGameAction(const GameAction *action)

 void Network::AddClient(ITcpSocket * socket)
 {
+    if (gConfigNetwork.pause_server && game_is_paused()) {


Could you put the braces in their own lines (code style)? (Also applies to other places in this PR, but you only need to fix code you touch.)

I've looked around the other style within this file and adopted this. For sure I will fix this.

Yeah, many files do not adhere to it yet, unfortunately.

I've not found a strict rule within contribution guideline for braces. What's about single line if statement it's allowed to drop the curly braces?

Edit:
Never mind I found the Wiki entry about Coding Style. (Contribution Guide should link there)

Gymnasiast · 2017-12-29T20:54:10Z

src/openrct2/config/Config.cpp

@@ -380,6 +380,7 @@ namespace Config
            model->known_keys_only = reader->GetBoolean("known_keys_only", false);
            model->log_chat = reader->GetBoolean("log_chat", false);
            model->log_server_actions = reader->GetBoolean("log_server_actions", false);
+            model->pause_server = reader->GetBoolean("pause_server", false);


I think this option should be renamed to make its meaning clearer.
I'd suggest pause_server_if_no_clients.

What's about merging this with @janisozaur suggestion for bots. Maybe pause_server_at_client?

Hmm, I don't think that's clear enough. Moreover, it suggests the server is paused clientside, which is not what's happening. I think @Gymnasiast's suggestion is better.

@tobiaskohlbau
Currently there are no bots, and I doubt they'll come soon - not until after the scripting support, I'd say. I would argue it's best to follow the YAGNI principle and keep the feature as you have it currently, only fixing the option name and code style.

Gymnasiast

Overall it looks reasonable to me, but I have a few suggestions and I'd like the OK of a team member who knows more about multiplayer.

janisozaur · 2017-12-29T21:03:48Z

FWIW: OpenTTD has an option to set amount of players, below which the server gets auto-paused. The benefit to that is you could have bots connected as players and not trigger the unpause event. Or only unpause the server when all players are connected, but that might make more sense only in competitive mode, which don't have yet.

I can't bring myself to saying this is better, but still worth pointing out.

OpenRCT2 does not provide a simple function to pause a server while no client is connected. This patch adds a so called "pause_server_if_no_clients" flag within network section of config.ini. By default this flag is set to false to be backward compatible with running servers. After setting this flag to true the game is paused on launch and gets unpaused on first connection. Signed-off-by: Tobias Kohlbau <tobias@kohlbau.de>

- Feature: [#2893] Object selection filters for items from RCT1, Added Attractions and Loopy Landscapes. - Feature: [#3505] Allow up to 1024 items per scenery tab. - Feature: [#3510] Auto-append extension if none is specified. - Feature: [#3994] Show bottom toolbar with map tooltip (theme option). - Feature: [#4184] Add command and cheat to alter the date. - Feature: [#4906] Add follow sprite command to title sequences. - Feature: [#4984] Add option to highlight path issues: full bins, vandalism & vomit. - Feature: [#5826] Add the show_limits command to show map data counts and limits. - Feature: [#6078] Game now converts mp.dat to SC21.SC4 (Mega Park) automatically. - Feature: [#6125] Path can now be placed in park entrances. - Feature: [#6181] Map generator now allows adjusting random terrain and tree placement in Simplex Noise tab. - Feature: [#6235] Add drawing debug option for showing visuals when and where blocks of the screen are painted. - Feature: [#6290] Arabic translation (experimental). - Feature: [#6292] Allow building queue lines in the Scenario Editor. - Feature: [#6295] TrueType fonts are now rendered with light font hinting by default. - Feature: [#6307] Arrows are now shown when placing park entrances. - Feature: [#6313] Add keyboard shortcut for toggle gridlines. - Feature: [#6324] Add command to deselect unused objects from the object selection. - Feature: [#6325] Allow using g1.dat from RCT Classic. - Feature: [#6329] Render level crossings when the Miniature Railway crossed a path. - Feature: [#6338] Virtual floor to help positioning objects vertically. - Feature: [#6353] Show custom RCT1 scenarios in New Scenario window. - Feature: [#6411] Add command to remove the park fence. - Feature: [#6414] Raise maximum launch speed of the Corkscrew RC back to 96 km/h (for RCT1 parity). - Feature: [#6433] Turn 'unlock all prices' into a regular (non-cheat, persistent) option. - Feature: [#6516] Ability to search by filename in the object selection window. - Feature: [#6530] Land rights tool no longer blocks when a tile is not for purchase. - Feature: [#6568] Add smooth nearest neighbour scaling. - Feature: [#6651, #6658] Integrate Discord Rich Presence. - Feature: [#6709] The New Ride window now shows available vehicles for a ride type. - Feature: [#6731] Object indexing progress is now reported via command line output. - Feature: [#6779] On-ride photo segment for Splash Boats. - Feature: [#6838] Ability to auto-pause server when no clients are connected. - Feature: [#7031] Better support for displaced ride entrances and exits. - Feature: Add search box to track design window. - Feature: Allow using object files from RCT Classic. - Feature: Title sequences now testable in-game. - Feature: Vehicles with matching capabilities are now always switchable. - Feature: Add search box to track design window. - Feature: Add load scenario command to title sequences. - Fix: [#816] In the map window, there are more peeps flickering than there are selected (original bug). - Fix: [#996, #2589, #2875] Viewport scrolling no longer shakes or gets stuck. - Fix: [#1185] Close button colour of prompt windows does not match. - Fix: [#1833, #4937, #6138] 'Too low!' warning when building rides and shops on the lowest land level (original bug). - Fix: [#2254] Edge scrolling horizontally now has the same speed as vertical edge scrolling. - Fix: [#2607] Rain rendered incorrectly in additional viewport. - Fix: [#3171] Guests entering from the corner of the tile in Amity Airfield (original bug). - Fix: [#3330] Current number of passengers overflows when over 255 (original bug). - Fix: [#4760] Asia - Great Wall of China and South America - Rio Carnival have incorrect guest entry points (original bug). - Fix: [#4953, #6277] Unable to advertise to master servers over IPv6. - Fix: [#4991] Inverted helices can be built on the Lay Down RC, but are not drawn. - Fix: [#5190] Cannot build Wild Mouse - Flying Dutchman Gold Mine. - Fix: [#5224] Multiplayer window is not closed when server shuts down. - Fix: [#5228] Top toolbar disappears when opening SC4 file. - Fix: [#5261] Deleting a banner sign after copy/pasting it will crash the game. - Fix: [#5398] Attempting to place Mini Maze.TD4 results in weird behaviour and crashes. - Fix: [#5417] Hacked Crooked House tracked rides do not dispatch vehicles. - Fix: [#5445] Patrol area not imported from RCT1 saves and scenarios. - Fix: [#5585] Inconsistent zooming with mouse wheel. - Fix: [#5609] Vehicle switching may cause '0 cars per train' to be set. - Fix: [#5636] Pausing the game shows mute button as active. - Fix: [#5741] Land rights indicators disappear when switching views. - Fix: [#5761] Mini coaster doesn't appear despite being selected. - Fix: [#5788] Empty scenario names cause invisible entries in scenario list. - Fix: [#5809] Support Steam RCT1 file layout when loading CSG images. - Fix: [#5838] Crash when saving very large track designs. - Fix: [#5901] Placing peep spawn not synced across multiplayer. - Fix: [#6101] Rides remain in ride list window briefly after demolition. - Fix: [#6114] Crash when using a non-LL CSG1.DAT. - Fix: [#6115] Random title screen music not random on launch. - Fix: [#6118, #6245, #6366] Tracked animated vehicles not animating. - Fix: [#6129] Guest List summary not updating after a ride rename. - Fix: [#6133] Construction rights not shown after selecting buy mode. - Fix: [#6188] Viewports not being clipped properly when zoomed out in OpenGL mode. - Fix: [#6193] All rings in Space Rings use the same secondary colour. - Fix: [#6196, #6223] Guest's energy underflows and never decreases. - Fix: [#6198] You cannot cancel RCT1 directory selection. - Fix: [#6199] Inverted Hairpin Coaster vehicle tab is not centred. - Fix: [#6202] Guests can break occupied benches (original bug). - Fix: [#6251] Splash Boats renders flat-to-25-degree pieces in tunnels incorrectly. - Fix: [#6261, #6344, #6520] Broken pathfinding after removing park entrances with the tile inspector. - Fix: [#6271] Wrong booster speed tooltip text. - Fix: [#6293] Restored interface sounds while gameplay is paused. - Fix: [#6301] Track list freezes after deleting track in Track Manager. - Fix: [#6308] Cannot create title sequence if title sequences folder does not exist. - Fix: [#6314] Imported SV4 files do not mark their scenarios as completed. - Fix: [#6318] Cannot sack staff that have not been placed. - Fix: [#6320] Crash when CSS1.DAT is absent. - Fix: [#6331] Scenery costs nothing in track designs. - Fix: [#6358] HTTP requests can point to invalid URL string. - Fix: [#6360] Off-by-one filenames when exporting all sprites. - Fix: [#6388] Construction rights tool erroneously enabled in some RCT1 scenarios even when no rights are available. - Fix: [#6413] Maze previews only showing scenery. - Fix: [#6423] Importing parks containing names with Polish characters. - Fix: [#6423] Polish characters now correctly drawn when using the sprite font. - Fix: [#6445] Guests' favourite ride improperly set when importing from RCT1 or AA. - Fix: [#6452] Scenario text cut off when switching between 32 and 64-bit builds. - Fix: [#6460] Crash when reading corrupt object files. - Fix: [#6481] Can't take screenshots of parks with colons in the name. - Fix: [#6500] Failure to load resources when config file is missing. - Fix: [#6547] The server log is not logged if the server name contains CJK. - Fix: [#6593] Cannot hire entertainers when default scenery groups are not selected (original bug). - Fix: [#6657] Guest list is missing tracking icon after reopening. - Fix: [#6803] Symbolic links to directories are not descended by FileScanner. - Fix: [#6830] Crash when using mountain tool due to ride with no ride entry. - Fix: [#6833] Shops in corrupted files not imported correctly. - Fix: [#6846] Zoom level in some ride overview windows was erroneously set too high. - Fix: [#6904] Manually added multiplayer servers not saved. - Fix: [#7003] Building sloped paths through flat paths with clearance checks off causes glitches. - Fix: [#7011] Swinging and bobsleigh cars going backwards swing in the wrong direction (original bug). - Fix: [#7042, #7077] Paths sometimes disconnect when building them with clearance checks off. - Fix: [#7125] No entry signs not correctly handled in pathfinding. - Fix: [#7223] Vehicle mass not correctly recalculated when using remove all guests cheat. - Fix: [#7229] Exploding guests cheat causes rides to get stuck and freezes game. - Fix: [#7295] peep_should_go_on_ride_again() checked balloon colour instead of toilet need. - Fix: [#7301] Sprite compiler dithering checks transparency of wrong pixel. - Fix: Infinite loop when removing scenery elements with >127 base height. - Fix: Ghosting of transparent map elements when the viewport is moved in OpenGL mode. - Fix: Clear IME buffer after committing composed text. - Fix: RCT1 mazes with wooden fences not imported correctly. - Fix: Title sequence editor now gracefully fails to preview a title sequence and lets the user know with an error message. - Fix: When preset title sequence fails to load, the preset will forcibly be changed to the first sequence to successfully load. - Fix: Remove consecutive thoughts about a ride being demolished. - Fix: Water raft vehicles stop spinning when going up slopes. - Fix: Incorrect spin is applied to coasters on S-bends and other turns. - Improved: [#5962] Use AVX2 instruction set where supported, resulting in a performance boost. - Improved: [#5964] Use SSE 4.1 instruction set where supported, resulting in a performance boost. - Improved: [#6186] Transparent menu items now draw properly in OpenGL mode. - Improved: [#6218] Speed up game start up time by saving scenario index to file. - Improved: [#6242] Prevent scenery aging and grass growth causing tile invalidation unless necessary - slight performance boost. - Improved: [#6423] Polish is now rendered using the sprite font, rather than TTF. - Improved: [#6746] Draw friction wheels instead of chain lift on Looping Roller Coaster stations. - Improved: Load/save window now refreshes list if native file dialog is closed/cancelled. - Improved: Major translation updates for Japanese and Polish. - Improved: Added 24x24, 48x48, and 96x96 icon resolutions. - Technical: [#6384] On macOS, address NSFileHandlingPanel deprecation by using NSModalResponse instead. - Technical: [#6772] RCT2 interop removed.

Broxzier requested changes Dec 26, 2017

View reviewed changes

OpenRCT2 deleted a comment Dec 27, 2017

tobiaskohlbau closed this Dec 28, 2017

tobiaskohlbau force-pushed the develop branch from 3d3c21a to a29c4f4 Compare December 28, 2017 08:55

tobiaskohlbau reopened this Dec 28, 2017

Broxzier approved these changes Dec 29, 2017

View reviewed changes

Gymnasiast reviewed Dec 29, 2017

View reviewed changes

Gymnasiast requested changes Dec 29, 2017

View reviewed changes

tobiaskohlbau force-pushed the develop branch from e477201 to 802a7d0 Compare December 31, 2017 10:38

Gymnasiast approved these changes Dec 31, 2017

View reviewed changes

Gymnasiast merged commit 7a8c5c2 into OpenRCT2:develop Dec 31, 2017

tobiaskohlbau mentioned this pull request Jan 1, 2018

Automatically Pause When No Clients Are Connected #2552

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

multiplayer: Adds option to pause server #6838

multiplayer: Adds option to pause server #6838

tobiaskohlbau commented Dec 17, 2017 •

edited

Loading

Broxzier left a comment

Broxzier Dec 26, 2017

tobiaskohlbau Dec 28, 2017

Broxzier Dec 26, 2017

tobiaskohlbau commented Dec 28, 2017 •

edited

Loading

Broxzier commented Dec 29, 2017

Gymnasiast Dec 29, 2017 •

edited

Loading

tobiaskohlbau Dec 30, 2017

Gymnasiast Dec 30, 2017

tobiaskohlbau Dec 31, 2017 •

edited

Loading

Gymnasiast Dec 29, 2017

tobiaskohlbau Dec 30, 2017

AaronVanGeffen Dec 30, 2017

Gymnasiast Dec 30, 2017 •

edited

Loading

Gymnasiast left a comment

janisozaur commented Dec 29, 2017

multiplayer: Adds option to pause server #6838

multiplayer: Adds option to pause server #6838

Conversation

tobiaskohlbau commented Dec 17, 2017 • edited Loading

Broxzier left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tobiaskohlbau commented Dec 28, 2017 • edited Loading

Broxzier commented Dec 29, 2017

Gymnasiast Dec 29, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tobiaskohlbau Dec 31, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Gymnasiast Dec 30, 2017 • edited Loading

Choose a reason for hiding this comment

Gymnasiast left a comment

Choose a reason for hiding this comment

janisozaur commented Dec 29, 2017

tobiaskohlbau commented Dec 17, 2017 •

edited

Loading

tobiaskohlbau commented Dec 28, 2017 •

edited

Loading

Gymnasiast Dec 29, 2017 •

edited

Loading

tobiaskohlbau Dec 31, 2017 •

edited

Loading

Gymnasiast Dec 30, 2017 •

edited

Loading