fixed bug with expiring loop sounds for global animations when playing

When playing the game, loop sounds are automatically expired if they
are not "refreshed" at regular intervals (to prevent playing sounds
for game elements that do not exist on the playfield anymore).

However, this also affects loop sounds for global animations played
during the game, so special care has to be taken to prevent them from
accidentally being expired, too.

improved clearing event queue after fading and after door/envelope requests

This is an improvement of commit ba20bcc8, which totally cleared the
event queue after fading and after door/envelope requests, and which
prevented entering multiple key presses by intention (like starting
the game and immediately going to pause mode with the very first
game frame, by quickly pressing "space" twice in the main menu).

This change only removes key presses entered by keyboard auto-repeat
during fading or door/envelope animations, effectively preventing
accidentally entered multiple key events by pressing a key like
"space" or "return" a bit too long (which then triggers auto-repeat),
while it keeps multiple key events that were manually entered.

fixed bug with not recognizing ".mode_loop: false" for music

Before, music was always played in loop mode, even if it was defined
with option "<music>.mode_loop: false".

Now, disabling loop mode for music in config files will indeed cause
music to be played only once.

Note: This commit changed the behaviour of the existing function
"PlayMusic()" (which always played music in loop mode before), which
will now play music only once, while a new function "PlayMusicLoop()"
was added, which always plays music in loop mode.

cleanup of network level function names and parameters

fixed bug with displaying the wrong level number in the game panel

When introducing a global levelset identifier and level number (see
commit b7fe72dc), the level number to be displayed on the game panel
was updated in the main menu and for network games, but not when
selecting another level from the main menu or when automatically
playing the next level after solving a level (and skipping the main
menu before starting the next level), which results in displaying the
wrong level number in the game panel in many cases.

This was fixed now by updating the level number when loading the level
from the level file (moving the function to update the level number to
be displayed from the main menu to the function to load the level).

fixed bug with different global border when playing from level editor

When using different screen border images for the in-game screen
(while playing the game, as defined by "global.border.PLAYING") and
for the level editor (defined by "global.border.EDITOR"), test-playing
a level from the level editor resulted in a graphically broken global
screen border (while everything looks correct when playing from the
main menu).

improved preprocessor macro to determine array size

fixed bug with overwriting level file info from level template

This bug (which was causing crashes due to double free()ing strings)
was a nasty side effect of changing string pointers in the file info
structure from using string references (allocated and freed somewhere
else) to copies of strings allocated and freed for each change, while
still copying the file info from the level template over to the file
info of the level file in function "ActivateLevelTemplate()" (causing
duplicates of string pointers which were therefore freed twice).

This bug was most probably the real cause for the problems fixed by
the changes in commit 759e0bea.

added checking for invalid/malicious packet size in network protocol

added checking for invalid/malicious filenames in network protocol

added using global levelset identifier and level number for network games

This change/addition was required for correctly handling identifiers
and level numbers when playing network games (for which the related
levelset possibly does not exist locally, but was sent by the network
server). This includes showing the correct level number for the level
that is played over the network, and saving the resulting high scores
for the correct level in the correct levelset score directory (again,
even if this levelset or level number does not exist locally).

added (and set) identifier and level number to global levelset structure

fixed bug with accessing string buffer that was already free()'ed

The function "getNetworkLevelDir()" returns a reference to a string
buffer that will be invalidated by each following invocation. As
"InitNetworkLevelDirectory()" also calls this function, it must be
called before "getNetworkLevelDir()".

moved level set info structure to game library layer

added loading custom artwork for network games

added always playing network games in team mode with the EM engine

When playing levels using the Emerald Mine (EM) game engine in network
mode with setup option "team mode" disabled, assume that multi-player
mode should be enabled anyway (just as it is handled with levels using
the R'n'D game engine).

disabled auto-incrementing level number when playing in network mode

disabled auto-playing next level when playing in network mode

swapped condition logic for better readability

added sending level file (and level template) for network games

As the level to play may not exist on the receiving side (but only on
the sending side -- the client who initiates the network game), this
change adds sending the level file (and the level template, if needed)
to all receiving network clients, so all clients always play the exact
same level (and do not have to worry about having the same level sets).

prepared level number in game panel for network games

removed storing two strings in function for level filenames

Before, the function "getLevelFilenameFromBasename()" stored two
filenames in static string pointers, one for the level filename, and one
for the corresponding level template filename, because the results were
only used as references before. As they are now stored as string copies
outside if this function, it is sufficient to only store the last result.

This change is directly related to commit 759e0bea.

changed filename string handling for level file info structure

Before, level filenames in the level file info structure (members for
"basename" and "filename") were only handled as references to the
basename/filename strings allocated elsewhere, so if those strings
changed, the references in the level file info structure also pointed
to those changed strings. When determining filenames for both level
files and corresponding level templates, references to level filenames
were replaced by references to template filenames, which resulted in
unexpected/wrong behaviour.

Now, these level filenames are handled as copies of the strings, so if
the strings change, the string copies still stay the same.

added missing check for changed level in editor ("use template for CEs")

fixed extremely nasty bug when using level template in level editor

When checking the checkbox "use template for custom elements" on the
"editor" tab on the level properties page, the playfield area was
replaced with a "broken" level, caused by horrible bugs in the level
initialization function "setLevelInfoToDefaults_MM()". Fixed now.

This bug was introduced with the MM game engine in version 4.1.0.0.

added functions to network code for sending files

added functions to handle network level directories

added function to dump network message buffer (for debugging)

fixed bug which caused wrong level number in "hall of fame" after playing

This bug is related to commit e2260726, which forced displaying the
high score values for the correct level number, but refused to show
the correct level number in the headline of the "hall of fame" (but
displayed the number of the next level to play). This is fixed now.

completely refactored client and server side network protocol code

improved handling network protocol version mismatch

In case of different network protocol versions at network client and
server, show an error message and disable networking instead of
aborting the program with a "fatal error" style message.

changed using network protocol by starting with protocol version check

added support for protocol version check as first protocol command

changed network protocol version from 1.2.0 to 2.0.0

removed unused variables

fixed bug in network mode with pausing game on errors when not playing

fixed warning for missing level template when loading level

added disabling networking when executing command line functionality

Auto-testing solution tapes could cause crashes if network was enabled.

added using counter of players that still have to enter an exit

added counter of players that still have to enter an exit (not used yet)

renamed function

fixed pausing network games if the game already ended

fixed exiting players with custom elements when playing multi-player games

Before, exiting a player using custom element actions only worked in
single-player mode. (In multi-player mode, the level was either
immediately solved if the exited player was the "local player"
(ignoring other players still existing on the playfield), or the
exited player was not removed from the playfield, if it was not the
"local player".)

Now it works correctly also in multi-player games.

fixed solving level when playing multi-player games

Before, solving a level was broken in both local and network
multi-player games:

In local multi-player games, the level was only solved if the player
marked as "local player" (which is only one of all players in a level)
entered the exit (but not if any other player entered the exit). As an
additional bug, the level was *always* solved as soon as the "local
player" entered the exit, regardless if any other player was still on
the playfield.

In network multi-player games, the level was always solved for the
first player entering the exit (as this player is always the "local
player" in one of the participating network clients), while the game
was frozen on all other network clients (and had to be manually ended
by using the Escape key or stop button).

With this fix, multi-player games will always be solved (locally or on
all network clients) if the last player on the playfield has entered
the exit.

added function to remove player and cleanup last player field

fixed ignoring mouse actions with MM engine using virtual buttons

As virtual buttons do not make much sense when playing games using the
Mirror Magic game engine, mouse clicks should be handled as usual even
when touch input is set to "virtual buttons" (causing mouse clicks to
be ignored before this change).

added clearing event queue after fading and after door/envelope requests

fixed using private level set if network game level set not found

Before, if a network client started playing a level from a level set
that is not installed for some other network client, that client did
a fallback to playing the default private level set. This caused the
network clients effectively playing completely different levels with
the input actions of the other clients, which does not make any sense.

Now, the network game is stopped for all clients in such a case.

added configurable border size also for drawing network players

added drawing players with level preview when using network or team mode

fixed setting player network flag without being connected to network server

added being able to reconnect after network server was restarted

added clearing network players from main menu screen if server disconnects

added drawing network players (graphics and names) to main menu screen

fixed changing to main menu after stopping network game only when playing

added showing player number if network game was stopped by remote player

added stopping game (with request dialog) if network player disconnected

replaced delay functions with new one that continues updating toons

added delay function that regularly updates the screen (to redraw toons)

changed drawing to playfield when changing network mode setup options

reduced time to wait for UDP broadcast answer to auto-detect network server

improved connecting to local network server

added disconnecting from network server from setup menu

added connecting to network server from setup menu without program restart

added displaying screen messages when connecting to network server

added setting network connection flag for network games

improved handling network errors (show message instead of stopping program)

added setup option to skip displaying the high scores after solving a level

added setup option to directly play the next level after solving a level

Before, the program returned to the main menu after the player solved
a level (and the high score table was displayed). From there, the next
level could be played by starting the game with the incremented level.

Now, the program automatically starts playing the next level after the
previous level was successfully solved.

This new setup option is enabled by default now, changing the previous
default behaviour of the program.

removed duplicate code

added explicit level number parameter to high-score handling functions

deactivated some debug messages

replaced constants using #define with enum values

moved debug output for player status to separate function

fixed showing message request if local player stopped network game (finally)

With the previous fix (see commit with same commit message) for this
problem, the message request was still shown if the local player was
remapped to a different player in the actual level.

fixed selecting correct player in single player mode (after network gaming)

When playing levels that contain more than one player in single player
mode, selecting the actual player when starting the level worked
correctly before only if the game was always played in single player
mode since it was started. It did not work correctly in the following
special case: There was a network multi-player game played before, but
the other (remote) client has disconnected (quit the game), leaving the
other client with a local player that might not be the first player.

In this case, using the first active player (which could be the first
player in the level) for the local player (which could be the second
player, because the network client was started after the now
disconnected client) would result in a broken player mapping, so the
player in the game cannot be moved.

This bugfix solves the problem by not using the first active player,
but the local player.

improved handling network errors (show message instead of stopping program)

removed preprocessor definition for network mode that is always true now

added separate network info structure for network options and setup values

added support for cursor keys and joystick to network player request dialog

re-arranged buttons to select network player in request dialog

added support for keys 1 to 4 to select network player in request dialog

fixed showing message request if local player stopped network game

fixed re-opening request door after stopping network game

moved setting preferred network player from game start to setup menu

When running the game in network game mode (via setup menu option or
command line option), do not ask for the preferred network player on
each start of the game, but use the player that can be configured in
the setup menu now.

added setup option to enable network multi-player games

This is a work-in-progress change: The new setup option to enable
network mode just sets the same flag as using the command-line option
"--network" (without specifying a hostname or a port).

For local network games, and if UDP broadcasting works as it should
to auto-detect a local network server that is already running, this is
already sufficient to play network multi-player games.

What's still missing is a way to explicitly specify a network server
to also be able to play network games with hosts outside of the local
network (or if UDP broadcasting does not work correctly).

added UDP broadcast to auto-detect network server in local network

added some missing error handling and more detailed error messages

code cleanup (handling of network socket activity)

added handling SIGINT (Ctrl-C) to exit standalone network server

added (optional) main menu buttons to insert or play solution tape

There is a difference to the already existing tape buttons to insert
or play a solution tape in that the main menu buttons are only drawn
if the current level really has a solution tape, while the tape buttons
are always drawn, regardless if the level has a solution tape or not.

added the "return" and "escape" key to be simulated by global animations

added event actions (by simulating keyboard input) for global animations

This change adds more event actions to the "anim_event_action" option
for clickable global animations, this time adding simulated keyboard
input by specifying a key symbol for the key to be simulated.

For example, you can now use:

global.anim_1.part_1.MAIN.anim_event:            click
global.anim_1.part_1.MAIN.anim_event_action:     XK_Return

When clicking this global animation (on the main menu screen), the
currently selected/highlighted menu item will be chosen/executed.

To get the key symbol/name for the key to be simulated, just choose
the desired key as a keyboard shortcut in the setup menu (temporarily
only) and look at the resulting entry in the file "setup.conf" in the
game's configuration and personal data directory.

fixed compiler warning due to missing function declaration

added being able to generally set global animations to passthrough clicks

Before, the "passthrough_clicks" option was limited to allow mouse
clicks on global animations to be passed through to the mouse sensitive
screen controls, but not to other global animations.

Now, stacked global animations can all receive mouse clicks if those
global animations overlapping them are set to "passthrough_clicks".

added "multiple_actions" option for clickable global animations

This change adds a new option for the "graphicsinfo.conf" file to be
able to explicitly allow multiple event actions for clickable global
animations, which is deactivated by default to prevent unwanted side
effects. This would make it possible to trigger two actions that make
sense when executed at the same time, like triggering the "play" and
"pause" buttons of the tape recorder together, for example.)

The new option works like this (with "global.anim_1.part_1.MAIN" also
being defined):

global.anim_2.part_1.MAIN.anim_event:            click:anim_1.part_1
global.anim_2.part_1.MAIN.anim_event_action:     some.action
global.anim_2.part_1.MAIN.style:                 multiple_actions

global.anim_3.part_1.MAIN.anim_event:            click:anim_1.part_1
global.anim_3.part_1.MAIN.anim_event_action:     another.action

When clicking the first global animation (on the main menu screen),
there might be two or more other global animation which are triggered
by clicking the first animation and which each execute their own event
action when triggered. (The style "multiple_actions" must be defined
for all animations that should *not* stop the chain of event actions
to be executed, so it's easiest to just define it for all animations
that should execute their event actions together when triggered.)

This option can be combined with "passthrough_clicks".

added ignoring gadgets if click already caused animation event action

Before, even though executing more than one event action triggered by
clickable global animations was already prevented, further processing
of mouse clicks by gadgets at the same position was still performed if
the global animation style was set to "passthrough_clicks", which could
lead to more than one gadgets being triggered at the same time by a
single click on a clickable global animation, with potentially unwanted
side effects.

Now, mouse clicks that already triggered an event action (which could
be a gadget) are not processed by the standard gadget handling anymore.

fixed order of handling mouse clicks on gadgets and on global animations

Before, gadgets were checked for clicks before global animations, which
caused clickable global animations to not be clicked if a gadget at the
same position was successfully clicked (because mouse events are forced
to be off-screen afterwards).

Now, clickable global animations are checked for mouse clicks before
gadgets, and they either consume the mouse click (so a gadget at the
same position will not receive the mouse click anymore), or they are
set to "passthrough_clicks" style (so a gadget at the same position
will still receive the mouse click).

fixed potential bug with default step size when increasing/decreasing level

added event actions (active screen elements) for global animations

This change adds more event actions to the "anim_event_action" option
for clickable global animations, this time adding active screen elements
(currently limited to a selection of screen elements in the main menu).

For example, you can now use:

global.anim_1.part_1.MAIN.anim_event:            click
global.anim_1.part_1.MAIN.anim_event_action:     menu.button_game

When clicking this global animation (on the main menu screen), the
game will be started (by triggering the "start game" menu button).

To dump a list of all available event actions for global animations,
blindly type the "cheat mode" style shortcut ":dump-event-actions" or
":dea" in the main menu.