fixed correctly using defined draw order of global animations

Before this change, there was only limited support for the attribute
".draw_order" for global animations, which did not work correctly if
the global animations had different game modes defined (like ".MAIN"),
as global animations were drawn in numerical game mode order, so draw
order was ignored between game modes and also between main animations.

With this change, global animations will really be drawn with their
defined draw order.

fixed setting (and maybe inheriting) draw order for global animations

removed explicitly setting draw order for pointer-style animations

As pointer-style animations are handled specially anyway (always drawn
on top of all other global animations), setting the draw order is not
required anymore.

fixed bug caused by support for only eight global animations in the past

reverted order of processing game modes for global animations clicks

The assumptions that led to the change that is reverted here were
simply wrong: When drawing global animations in a certain order,
checking for mouse clicks must be done in reverse order, to ensure
that the click is processed for the topmost global animation. This
includes processing game modes in reverse order (which are handled
in normal order when drawing global animations).

Processing clicks for a global animation based custom mouse pointer
should be handled separately anyway, to process it independently
from the game mode it was defined for.

This reverts commit e3411dc9.

version number set to 4.3.8.1

version number set to 4.3.8.0

fixed sorting global animation parts by draw order (which was confusing)

fixed "level_nr" style global animations on level selection screen

changed order of processing game modes for global animations clicks

The previous (reversed) order suggested that this had something to do
with draw order, which was not the case. Using the normal (numerical)
order also has the advantage of processing global animations without
a special game mode assigned to them (like ".PLAYING" or ".MAIN") to
be processed first, which is especially important to process pointer
style global animations (which are probably defined to be used on all
game screens in most cases) before all other global animations, which
is required to display an alternative pointer when the mouse button
is pressed (which is defined using ".style: passthrough_clicks" for
such cases).

changed only handling pointer-style animations clicks in request dialogs

As request dialogs are displayed above all other screen elements,
including global animations (except pointer-style global animations),
global animations should not be clickable while request dialogs are
active, with the exception of clickable pointer-style animations,
which is generally used to display a different pointer while the
mouse button is pressed.

fixed handling clickable pointer-style global animations in request dialogs

fixed creating additional click events from global animation events

When handling global animation events that trigger user events handled
as either key, gadget or screen events, prevent creating additional
key or button events to be handled by global animations again, as this
can confuse further button event processing, which may cause buttons
or menu items to be selected by accident.

added support for setting alpha value for envelope style request dialogs

fixed resetting alpha value when preparing envelope request

moved code to separate function

added forcing user to restart program after adding level collection

When adding a level group or an artwork group by dropping a zip file
into the program window, show a request dialog that the program has to
be restarted to activate the new content.

Unfortunately, this is currently required to rebuild the internal
level and artwork set structures (and should be improved to be rebuild
them on-the-fly without a program restart).

Before, the program was just stopped with a user-unfriendly message
reporting a fatal error.

added fallback to narrow font on word length for envelope request dialogs

moved code to separate function

added dynamically calculating text properties for door request dialogs

fixed tile cursor drawing position

minor code cleanup

fixed function signature

moved code to separate function

minor code cleanup

removed unused code

removed code for condition that is always true

moved function call (no functional change)

removed uncommented code

moved duplicate code to separate functions

moved function call for getting door state to variable declaration

renamed variable

added showing game actions after game end when request door opens/closes

added showing game actions after game end when request envelope opens/closes

removed duplicate variable to check if request dialog is active

swapped temporary bitmaps used for request dialog (no functional change)

significant cleanup of envelope style request dialog handling

After this change, the request dialog is not drawn to the back buffer
of the screen anymore, but to a temporary bitmap buffer (with the
request buttons directly being updated there after button events),
which is now only drawn during the final composition of the screen.

Therefore, the back buffer is not touched anymore when handling the
request dialog, and also does not have to be restored afterwards.

fixed invisible envelope request if request background is masked

When using "global.use_envelope_request: true" (to use envelope style
request dialogs instead of door style request dialogs) together with
"background.request.draw_masked: true" (to use a partially transparent
background image for the request dialog), no request dialog is drawn
at all (so the request dialog has to be answered blindly). This change
fixes this problem.

There are a few graphical bugs left (if the request dialog opens after
a game was lost, asking to play again) which still have to be fixed.

added wrapper function to copy SDL surfaces

added random push delay for rocks, nuts and bombs to EM game engine

Just like in the original Emerald Mine game, there is now a random
delay when trying to push a rock, a nut or a bomb. While the chance
for rocks being successfully pushed at first attempt will be around
50 %, the chance for nuts will be a bit lower than that for rocks,
and the chance for bombs will be a bit lower than that for nuts,
with a roughly similar overall delay as in the original game.

fixed bug with loading artwork if only one special artwork set exists

R'n'D supports using additional special artwork, like "ECS" and "AGA"
graphics sets or "default" and "lowpass" sound sets, which can be
selected from the game engines setup menu. This works fine if both
artwork sets are defined (and also if no special artwork is defined).

However, it did not work correctly if only one special artwork set was
defined, in addition to the "standard" artwork set, like this:

graphics_set:                   gfx_bond_mine_01
graphics_set.aga:               gfx_bond_mine_01.aga

In this case, it was not possible to use the "standard" graphics set,
but only the "AGA" graphics set (because the "standard" graphics set
was internally overridden by the "AGA" graphics set when selecting to
use "AGA" graphics in the game engines setup menu, and selecting to
use "ECS" graphics later could not recover this). (This bug could be
seen in level set "emc_bond_mine_01" when starting the game with "AGA"
graphics preferred in the setup menu, which resulted in not being able
to select the "standard" graphics by setting graphics preference to
"ECS" in the game engines setup menu.)

This is fixed now (by internally setting the "ECS" artwork set, which
is not explicitly defined, to the "standard" artwork before internally
overriding it with either the "ECS" or "AGA" graphics set).

This bug was caused by commit 4bc6719c.

moved code to separate function

fixed warning when encountering obsolete graphics configuration option

added support for fading in and fading out global animations

To fade global animations in or out, use the attribute ".fade_mode"
with value "fade_in" or "fade_out" and the attribute ".fade_delay"
with the number of video frames to use for fading in or out. (Note
that this attribute expects frames when used with global animations,
while it expects milliseconds when used with screens and menus.)

added support for setting alpha value for global animations

To set alpha value for global animation graphics, just use the new
attribute ".alpha" for the global animation's graphics definition,
where the value "0" means transparent and "255" means "opaque".

fixed using masked elements when using element graphic for empty space

fixed state of global animation parts waiting for initial event

fixed bug with triggering global animations in certain cases

This fixes a bug that prevents global animations (that have defined
an initial (start) event using ".init_event") from being triggered by
other animation states or by custom element changes if they have
either no parts defined (like "global.anim_1"), or if they have parts
defined (like "global.anim_1.part_1"), but have the "main" animation
defined to play all parts at the same time (which means that there is
a definition "global.anim_1.anim_mode: all").

This bug was caused by the fact that animations waiting for an initial
event should be in state "waiting", which was not checked in case of
an event (as parts defined for global animations that are not defined
to be played all at the same time are in state "running" even if they
are waiting for an initial event, which should also be fixed).

fixed bug with events defined to start and stop global animations

This fixes a bug where global animations could be started by an event
defined using ".anim_event" instead of ".init_event", as long as there
is some other ".init_event" definition (even if it never happens).

version number set to 4.3.7.2

added pausing global animations on doors if game engine is paused

added using trigger element position for CE triggered global animations

When using global animations that are triggered by custom elements,
using ".position: ce_trigger" instead of ".position: ce" will use
the position of the CE trigger element instead of the CE itself.

version number set to 4.3.7.1

fixed bug with using wrong global border when restarting the game

fixed bug with global animation at wrong playfield position for one frame

This fixes a bug that should have been fixed with commit 03202ac7.

While the above commit fixes the problem for some cases, it still does
not work correctly if a global animation with ".position: ce" has two
"ce_change" events defined with ".init_event" and ".anim_event". While
the first one starts the animation (and should therefore place the
animation at the CE position), the second one stops the animation (and
starts the next part of the animation, if existing), so it should not
change the position to the second CE (which would only be used for one
single game frame and then changed to the animation position defined
by the next part of the animation).

fixed half-tile shifting when teleporting between playfield borders

When relocating the player without centering the screen and without
scrolling ("teleporting" to a different playfield area, but keeping
the screen position), shifting the visible part of the playfield by
half a tile may happen if the screen width or height is even.

This is especially true when teleporting from and to an area that is
directly aligned with the border of the playfield (regardless of the
tiles at the playfield border being only half or fully visible, which
only happens with even sized screen width or height, depending on the
current player scroll position).

This change makes sure that both the source and destination area of
the playfield are displayed either aligned by half a tile or a full
tile when doing a "teleporting" player relocation in such a case.

added options "game.forced_scroll_x" and "game.forced_scroll_y"

This adds the above two "graphicsinfo.conf" options to override the
automatically calculated playfield scroll values when starting a game.

The purpose of these options is to force an initial scroll position
(which is used for all levels), which means that the visible part of
the playfield when the game is started is not determined by the player
position, but by the values defined using the above options.

This may be useful in combination with a large value for the option
"game.forced_scroll_delay_value" to limit the visible part of the
playfield to a smaller, screen-sized area, while the remaining part of
the playfield contains some control elements. It may also be useful
for levels using teleportation from one area to another area while
still controlling which parts of the playfield entered by the player
are visible. It can also be used to force a certain initial visible
part of the playfield, regardless of the exact position of the player
within that area. And it is currently the only way to force showing
levels with an even width or even height with the player near the
border of the playfield with half-tile border elements, which would
also be needed for teleporting the player to a different part of the
playfield without scrolling the playfield relative to the player's
screen position.

Therefore, this feature should probably be considered experimental.

fixed bug with limiting forced scroll delay value to lower default value

fixed broken player option "no centering when relocating"

fixed bug with global animation at top left playfield corner for one frame

moved code to set global animation to CE position to separate function

fixed bug with CE replacing exploding player, causing half-dead player

This bug could happen when a player was just exploding (for whatever
reason) and an adjacent CE replaced the explosion's center element
with something else, leading to the player not being totally removed,
potentially causing some strange effects afterwards.

This change adds some cleanup required to prevent such cases.

fixed bug with causing explosion instead of killing player directly

While the final effect is the same (player is killed), the player was
killed by an explosion before (causing a "double explosion" when the
player itself exploded when being killed by the explosion), while the
player is killed directly now, preventing the double explosion.

fixed bug with CE change setting the player to its current position

This change fixes a bug where a CE change places the player at the
current player position, causing an explosion at that playfield
position, which should not happen.

In other words, such an event would normally relocate the player, but
to a playfield position which is identical to the current playfield
position of the player, which should therefore have no effect at all.

The bug occured because it was not checked if the new element to be
created is the player itself, but only checks if an element that is
not walkable by the player is created at the players current position.

added selecting element for group elements according to current level

This change works similar to the previous commit, but not selecting an
animation frame according to the current level, but selecting a game
element from a number of elements in a group element (selecting the
first element for the first level, the second element for the second
level, and so on, again overwrapping if there are more levels than
game elements defined for the group element). That way, different game
elements can be used in different levels which all use the same group
elements.

added new animation mode "level_nr" to select frame according to level

This change adds a new animation mode "level_nr" which selects a
single animation frame from a number of frames that corresponds to the
current level. That is, the first frame is used for the first level,
the second frame is used for the second level and so on (overwrapping
frames if there are more levels than animation frames). This animation
mode can therefore only be used for non-animated game graphics, like
walls. So this animation mode can be used to have different graphics
in different levels for certain game elements, while still using the
same game elements in each level.

fixed bug with CE triggered global animations treated as "off-screen"

added pausing global animations on playfield if game engine is paused

fixed drawing envelope request to be always on top of global animations

fixed drawing envelope request to be always on top of tile cursor

moved code to draw envelope request over global animations

fixed bug with shifted global playfield animations during envelope requests

fixed CE condition that checks touching the player at some side

In the level editor on the "change" tab of a custom element, when
using the CE condition "[x] element changes ..." in combination with
"[x][touching] element [<element>]" with "at [<side>] side", there
was wrong behaviour in some cases when "<element>" was the player.

This was caused by not checking the side of the player (that was being
touched by the custom element), but by checking the side of the custom
element (touching the player), which is the exact opposite side here.

This change fixes the bug, now always checking the correct side as it
is configured in the level editor. (Regarding to the game engine test
suite, this functional game engine change did not break any tapes.)

fixed calculating position of global animations triggered by CE change

fixed bug with forced restart of global animations when restarting game

This fixes a bug which occured if the game was restarted (by loading a
tape during the game, or by playing again after a game was lost) and
if a custom artwork set was active that used cross-fading for the game
screen. In this case, global animations displayed during the game were
stopped, but not restarted again,

improved forced restart of global animations when restarting game

When forcing a restart of global animations when restarting the game,
a full screen redraw is neither required nor desired. Therefore, this
change only restarts global animations according to the game status
passed to function "RestartGlobalAnimsByStatus()", but does not redraw
the screen (including global animations, so nothing is drawn at all).

removed redundant code

fixed one-frame delay when global animations leave "init" state

This fixes a bug for global animations which either have an initial
delay or an initial event defined, causing a delay of one screen frame
after the initial waiting state has ended and before the running state
(which displays the global animation) is started.

This can especially be visible if a changing CE is graphically replaced
with a global animation triggered by the CE change.

changed global animations to handle only one CE change event per frame

Before, several (same) CEs could change within the same game frame,
triggering the same global animation several times (each time with the
new/next CE, with different CE position for each change. for example).

This bugfix results in each global animation being triggered exactly
one time for each change of the same CE in the same frame (which is
especially important if there are several global animations being
triggered by the change of the same CE, to display several animations
for several same CEs changing in the same game frame).

added option to not trigger further animations if CE change event consumed

This adds the parameter "consume_ce_event" to the ".style" option of
global animations to prevent any further global animation to be
triggered by "ce_change" events (".init_event" or ".anim_event") if
the event was already recognized by any other global animation (which
therefore "consumes" this event).

Using this option, several similar global animations can be defined
that are triggered one after another by several custom element changes
to make it possible to show several similar global animations for
multiple CE changes at the same time.

added setting scroll offset to global animation position triggered by CE

fixed bug when handling init and anim events for global animations

Before, defining ".init_event" as "click:anim_X" and ".anim_event" as
"click" resulted in the global animation being started by clicking
global animation "anim_X" (which is correct), but resulted in stopping
it by clicking the animation itself (which is correct), but also by
clicking global animation "anim_X" (which is not correct).

fixed bugs when parsing global animation parameter values

The previous code recognized the value "click" in the parameter string
"click,click:anim_X", but did not in string "click:anim_X,click".

added setting global animation position from CE triggering that animation

fixed setting global animation sync frame when started with ".init_event"

The previous code only handled adjusting the initial animation sync
frame when starting the animation using an "init delay" configuration
(starting the animation after a delay), but did not handle starting
the animation using an "init event" configuration (like triggering by
a click event or by a custom element change), in which case the sync
frame should also be reset.

added support for CE change pages triggering global animations

This commit extends the previous commit to not only be able to trigger
global animations using "ce_change:custom_X" (by any CE change page),
but also by specifying change page using "ce_change:custom_X.page_Y".

added support for custom elements triggering global animations

For the global animation options ".init_event" or "anim_event" in file
"graphicsinfo.conf", the new value "ce_change:custom_xxx" can be used
to trigger (initiate or continue) the corresponding global animation
whenever custom element "custom_xxx" changes.

fixed bug with re-initialized variables when reading multiple config files

added wrapper functions to initialize and set variables

moved code to check redefined screen positions to separate function

fixed stopping music if global anim music differs from current music

As there is only one single music channel, the following edge case
could happen before this commit: The current screen plays music from
a global animation, while the next screen plays background music as
defined for this screen (as it might happen with two title screens).
When going from one screen to the other screen, the global animation
music from the first screen is stopped and the background music for
the second screen is started.

If there is a delay between both screens (typically by fading from one
screen to the next one), the first music is stopped and the second
music is started shortly after. Everything works as expected.

However, if there is no delay between both screens (if fading is
disabled by setup menu or by graphics configuration), stopping and
starting old and new music happens in the same screen frame. But as
global animations (including music) are applied *after* the screen is
prepared (also including music), the music for the new screen is
started and immediately stopped again by the global animation code,
which notices the screen change and stops the global animation for the
previous screen (including stopping music for it).

This is fixed now by only stoping the global animation's music if it
is still the same as the currently playing music (which would not be
the case in the edge case described above).

fixed playfield redraw bug when closing envelope after asking to play again

This reverts commit 3df902ff.

For currently unknown reason, the above commit does not fix the
described bug, but introduces it. As long as this is not sorted out,
the commit will be reverted.

fixed bug with checking for mouse events used by custom elements

fixed using full image size for initial images if not specified

moved code for getting size of initial images to corresponding function

moved code to handle mouse actions to separate function

fixed sending key release events to animation event handling

fixed sending button press/release events to animation event handling

added variables to prevent repeating expression

changed global animation events to use more practical bit range