OpenTTD Source: src/newgrf_animation_base.h Source File

OpenTTD Source 14.0-RC3

newgrf_animation_base.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10 /* No inclusion guards as this file must only be included from .cpp files. */
11
12 #include "animated_tile_func.h"
13 #include "core/random_func.hpp"
14 #include "timer/timer_game_tick.h"
15 #include "viewport_func.h"
16 #include "newgrf_animation_type.h"
17 #include "newgrf_callbacks.h"
18 #include "tile_map.h"
19
20 template <typename Tobj>
21 struct TileAnimationFrameAnimationHelper {
22 static byte Get(Tobj *, TileIndex tile) { return GetAnimationFrame(tile); }
23 static void Set(Tobj *, TileIndex tile, byte frame) { SetAnimationFrame(tile, frame); }
24 };
25
35 template <typename Tbase, typename Tspec, typename Tobj, typename Textra, uint16_t (*GetCallback)(CallbackID callback, uint32_t param1, uint32_t param2, const Tspec *statspec, Tobj *st, TileIndex tile, Textra extra_data), typename Tframehelper>
36 struct AnimationBase {
45 static void AnimateTile(const Tspec *spec, Tobj *obj, TileIndex tile, bool random_animation, Textra extra_data = 0)
46 {
47 assert(spec != nullptr);
48
49 /* Acquire the animation speed from the NewGRF. */
50 uint8_t animation_speed = spec->animation.speed;
51 if (HasBit(spec->callback_mask, Tbase::cbm_animation_speed)) {
52 uint16_t callback = GetCallback(Tbase::cb_animation_speed, 0, 0, spec, obj, tile, extra_data);
53 if (callback != CALLBACK_FAILED) {
54 if (callback >= 0x100 && spec->grf_prop.grffile->grf_version >= 8) ErrorUnknownCallbackResult(spec->grf_prop.grffile->grfid, Tbase::cb_animation_speed, callback);
55 animation_speed = Clamp(callback & 0xFF, 0, 16);
56 }
57 }
58
59 /* An animation speed of 2 means the animation frame changes 4 ticks, and
60 * increasing this value by one doubles the wait. 0 is the minimum value
61 * allowed for animation_speed, which corresponds to 30ms, and 16 is the
62 * maximum, corresponding to around 33 minutes. */
63 if (TimerGameTick::counter % (1ULL << animation_speed) != 0) return;
64
65 uint8_t frame = Tframehelper::Get(obj, tile);
66 uint8_t num_frames = spec->animation.frames;
67
68 bool frame_set_by_callback = false;
69
70 if (HasBit(spec->callback_mask, Tbase::cbm_animation_next_frame)) {
71 uint16_t callback = GetCallback(Tbase::cb_animation_next_frame, random_animation ? Random() : 0, 0, spec, obj, tile, extra_data);
72
73 if (callback != CALLBACK_FAILED) {
74 frame_set_by_callback = true;
75
76 switch (callback & 0xFF) {
77 case 0xFF:
78 DeleteAnimatedTile(tile);
79 break;
80
81 case 0xFE:
82 frame_set_by_callback = false;
83 break;
84
85 default:
86 frame = callback & 0xFF;
87 break;
88 }
89
90 /* If the lower 7 bits of the upper byte of the callback
91 * result are not empty, it is a sound effect. */
92 if (GB(callback, 8, 7) != 0 && _settings_client.sound.ambient) PlayTileSound(spec->grf_prop.grffile, GB(callback, 8, 7), tile);
93 }
94 }
95
96 if (!frame_set_by_callback) {
97 if (frame < num_frames) {
98 frame++;
99 } else if (frame == num_frames && spec->animation.status == ANIM_STATUS_LOOPING) {
100 /* This animation loops, so start again from the beginning */
101 frame = 0;
102 } else {
103 /* This animation doesn't loop, so stay here */
104 DeleteAnimatedTile(tile);
105 }
106 }
107
108 Tframehelper::Set(obj, tile, frame);
109 MarkTileDirtyByTile(tile);
110 }
111
124 static void ChangeAnimationFrame(CallbackID cb, const Tspec *spec, Tobj *obj, TileIndex tile, uint32_t random_bits, uint32_t trigger, Textra extra_data = 0)
125 {
126 uint16_t callback = GetCallback(cb, random_bits, trigger, spec, obj, tile, extra_data);
127 if (callback == CALLBACK_FAILED) return;
128
129 switch (callback & 0xFF) {
130 case 0xFD: /* Do nothing. */ break;
131 case 0xFE: AddAnimatedTile(tile); break;
132 case 0xFF: DeleteAnimatedTile(tile); break;
133 default:
134 Tframehelper::Set(obj, tile, callback);
135 AddAnimatedTile(tile);
136 break;
137 }
138
139 /* If the lower 7 bits of the upper byte of the callback
140 * result are not empty, it is a sound effect. */
141 if (GB(callback, 8, 7) != 0 && _settings_client.sound.ambient) PlayTileSound(spec->grf_prop.grffile, GB(callback, 8, 7), tile);
142 }
143 };
TimerGameTick::counter
static TickCounter counter
Monotonic counter, in ticks, since start of game.
Definition: timer_game_tick.h:33
GB
constexpr static debug_inline uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:54
newgrf_callbacks.h
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
CallbackID
CallbackID
List of implemented NewGRF callbacks.
Definition: newgrf_callbacks.h:20
TileAnimationFrameAnimationHelper
Definition: newgrf_animation_base.h:21
SoundSettings::ambient
bool ambient
Play ambient, industry and town sounds.
Definition: settings_type.h:244
tile_map.h
PlayTileSound
void PlayTileSound(const GRFFile *file, SoundID sound_id, TileIndex tile)
Play a NewGRF sound effect at the location of a specific tile.
Definition: newgrf_sound.cpp:220
ClientSettings::sound
SoundSettings sound
sound effect settings
Definition: settings_type.h:638
ANIM_STATUS_LOOPING
static const uint8_t ANIM_STATUS_LOOPING
Animation is looping.
Definition: newgrf_animation_type.h:14
timer_game_tick.h
AnimationBase::ChangeAnimationFrame
static void ChangeAnimationFrame(CallbackID cb, const Tspec *spec, Tobj *obj, TileIndex tile, uint32_t random_bits, uint32_t trigger, Textra extra_data=0)
Check a callback to determine what the next animation step is and execute that step.
Definition: newgrf_animation_base.h:124
SetAnimationFrame
void SetAnimationFrame(Tile t, byte frame)
Set a new animation frame.
Definition: tile_map.h:262
viewport_func.h
animated_tile_func.h
CALLBACK_FAILED
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
Definition: newgrf_callbacks.h:420
DeleteAnimatedTile
void DeleteAnimatedTile(TileIndex tile)
Removes the given tile from the animated tile table.
Definition: animated_tile.cpp:25
MarkTileDirtyByTile
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
Definition: viewport.cpp:2051
AnimationBase::AnimateTile
static void AnimateTile(const Tspec *spec, Tobj *obj, TileIndex tile, bool random_animation, Textra extra_data=0)
Animate a single tile.
Definition: newgrf_animation_base.h:45
ErrorUnknownCallbackResult
void ErrorUnknownCallbackResult(uint32_t grfid, uint16_t cbid, uint16_t cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
Definition: newgrf_commons.cpp:499
AnimationBase
Helper class for a unified approach to NewGRF animation.
Definition: newgrf_animation_base.h:36
GetAnimationFrame
byte GetAnimationFrame(Tile t)
Get the current animation frame.
Definition: tile_map.h:250
random_func.hpp
Clamp
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:79
newgrf_animation_type.h
AddAnimatedTile
void AddAnimatedTile(TileIndex tile)
Add the given tile to the animated tile table (if it does not exist on that table yet).
Definition: animated_tile.cpp:40
HasBit
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103