Files
@ r20131:856d2ee4719d
Branch filter:
Location: cpp/openttd-patchpack/source/src/newgrf_animation_base.h - annotation
r20131:856d2ee4719d
5.6 KiB
text/x-c
(svn r25099) -Fix [FS#5492]: Limit aircraft property 0D to 19, since the conversion result to km-ish/h needs to fit into a byte.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 | r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15934:789c54d0000d r15934:789c54d0000d r15934:789c54d0000d r17267:4f82ca9bd495 r15934:789c54d0000d r15934:789c54d0000d r18876:3403b9c464f9 r15934:789c54d0000d r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r18225:4c81f615ad47 r15929:5d5037945a0e r15929:5d5037945a0e r18225:4c81f615ad47 r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r18225:4c81f615ad47 r15929:5d5037945a0e r18225:4c81f615ad47 r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r18225:4c81f615ad47 r18302:ea9dfce7b13f r18302:ea9dfce7b13f r18302:ea9dfce7b13f r18302:ea9dfce7b13f r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r18225:4c81f615ad47 r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r19891:7fd9bf0868c4 r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r18225:4c81f615ad47 r15929:5d5037945a0e r18225:4c81f615ad47 r15929:5d5037945a0e r18225:4c81f615ad47 r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r15929:5d5037945a0e r19891:7fd9bf0868c4 r15929:5d5037945a0e r15929:5d5037945a0e | /* $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 <http://www.gnu.org/licenses/>.
*/
/** @file newgrf_animation_base.h Function implementations related to NewGRF animation. */
/* No inclusion guards as this file must only be included from .cpp files. */
#include "animated_tile_func.h"
#include "core/random_func.hpp"
#include "date_func.h"
#include "viewport_func.h"
#include "newgrf_animation_type.h"
#include "newgrf_callbacks.h"
#include "tile_map.h"
/**
* Helper class for a unified approach to NewGRF animation.
* @tparam Tbase Instantiation of this class.
* @tparam Tspec NewGRF specification related to the animated tile.
* @tparam Tobj Object related to the animated tile.
* @tparam Textra Custom extra callback data.
* @tparam GetCallback The callback function pointer.
*/
template <typename Tbase, typename Tspec, typename Tobj, typename Textra, uint16 (*GetCallback)(CallbackID callback, uint32 param1, uint32 param2, const Tspec *statspec, Tobj *st, TileIndex tile, Textra extra_data)>
struct AnimationBase {
/**
* Animate a single tile.
* @param cb The callback to actually call.
* @param spec Specification related to the tile.
* @param obj Object related to the tile.
* @param tile Tile to animate changes for.
* @param random_animation Whether to pass random bits to the "next frame" callback.
* @param extra_data Custom extra callback data.
*/
static void AnimateTile(const Tspec *spec, Tobj *obj, TileIndex tile, bool random_animation, Textra extra_data = 0)
{
assert(spec != NULL);
/* Acquire the animation speed from the NewGRF. */
uint8 animation_speed = spec->animation.speed;
if (HasBit(spec->callback_mask, Tbase::cbm_animation_speed)) {
uint16 callback = GetCallback(Tbase::cb_animation_speed, 0, 0, spec, obj, tile, extra_data);
if (callback != CALLBACK_FAILED) {
if (callback >= 0x100 && spec->grf_prop.grffile->grf_version >= 8) ErrorUnknownCallbackResult(spec->grf_prop.grffile->grfid, Tbase::cb_animation_speed, callback);
animation_speed = Clamp(callback & 0xFF, 0, 16);
}
}
/* An animation speed of 2 means the animation frame changes 4 ticks, and
* increasing this value by one doubles the wait. 0 is the minimum value
* allowed for animation_speed, which corresponds to 30ms, and 16 is the
* maximum, corresponding to around 33 minutes. */
if (_tick_counter % (1 << animation_speed) != 0) return;
uint8 frame = GetAnimationFrame(tile);
uint8 num_frames = spec->animation.frames;
bool frame_set_by_callback = false;
if (HasBit(spec->callback_mask, Tbase::cbm_animation_next_frame)) {
uint16 callback = GetCallback(Tbase::cb_animation_next_frame, random_animation ? Random() : 0, 0, spec, obj, tile, extra_data);
if (callback != CALLBACK_FAILED) {
frame_set_by_callback = true;
switch (callback & 0xFF) {
case 0xFF:
DeleteAnimatedTile(tile);
break;
case 0xFE:
frame_set_by_callback = false;
break;
default:
frame = callback & 0xFF;
break;
}
/* If the lower 7 bits of the upper byte of the callback
* result are not empty, it is a sound effect. */
if (GB(callback, 8, 7) != 0 && _settings_client.sound.ambient) PlayTileSound(spec->grf_prop.grffile, GB(callback, 8, 7), tile);
}
}
if (!frame_set_by_callback) {
if (frame < num_frames) {
frame++;
} else if (frame == num_frames && spec->animation.status == ANIM_STATUS_LOOPING) {
/* This animation loops, so start again from the beginning */
frame = 0;
} else {
/* This animation doesn't loop, so stay here */
DeleteAnimatedTile(tile);
}
}
SetAnimationFrame(tile, frame);
MarkTileDirtyByTile(tile);
}
/**
* Check a callback to determine what the next animation step is and
* execute that step. This includes stopping and starting animations
* as well as updating animation frames and playing sounds.
* @param cb The callback to actually call.
* @param spec Specification related to the tile.
* @param obj Object related to the tile.
* @param tile Tile to consider animation changes for.
* @param random_bits Random bits for this update. To be passed as parameter to the NewGRF.
* @param trigger What triggered this update? To be passed as parameter to the NewGRF.
* @param extra_data Custom extra data for callback processing.
*/
static void ChangeAnimationFrame(CallbackID cb, const Tspec *spec, Tobj *obj, TileIndex tile, uint32 random_bits, uint32 trigger, Textra extra_data = 0)
{
uint16 callback = GetCallback(cb, random_bits, trigger, spec, obj, tile, extra_data);
if (callback == CALLBACK_FAILED) return;
switch (callback & 0xFF) {
case 0xFD: /* Do nothing. */ break;
case 0xFE: AddAnimatedTile(tile); break;
case 0xFF: DeleteAnimatedTile(tile); break;
default:
SetAnimationFrame(tile, callback);
AddAnimatedTile(tile);
break;
}
/* If the lower 7 bits of the upper byte of the callback
* result are not empty, it is a sound effect. */
if (GB(callback, 8, 7) != 0 && _settings_client.sound.ambient) PlayTileSound(spec->grf_prop.grffile, GB(callback, 8, 7), tile);
}
};
|