OpenRCT2/src/openrct2/world/MapAnimation.h

/*****************************************************************************
 * Copyright (c) 2014-2018 OpenRCT2 developers
 *
 * For a complete list of all authors, please refer to contributors.md
 * Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2
 *
 * OpenRCT2 is licensed under the GNU General Public License version 3.
 *****************************************************************************/

#ifndef _MAP_ANIMATION_H_
#define _MAP_ANIMATION_H_

#include "../common.h"

#pragma pack(push, 1)
/**
 * Animated object
 * size: 0x06
 */
struct rct_map_animation {
    uint8_t baseZ;
    uint8_t type;
    uint16_t x;
    uint16_t y;
};
assert_struct_size(rct_map_animation, 6);
#pragma pack(pop)

enum {
    MAP_ANIMATION_TYPE_RIDE_ENTRANCE,
    MAP_ANIMATION_TYPE_QUEUE_BANNER,
    MAP_ANIMATION_TYPE_SMALL_SCENERY,
    MAP_ANIMATION_TYPE_PARK_ENTRANCE,
    MAP_ANIMATION_TYPE_TRACK_WATERFALL,
    MAP_ANIMATION_TYPE_TRACK_RAPIDS,
    MAP_ANIMATION_TYPE_TRACK_ONRIDEPHOTO,
    MAP_ANIMATION_TYPE_TRACK_WHIRLPOOL,
    MAP_ANIMATION_TYPE_TRACK_SPINNINGTUNNEL,
    MAP_ANIMATION_TYPE_REMOVE,
    MAP_ANIMATION_TYPE_BANNER,
    MAP_ANIMATION_TYPE_LARGE_SCENERY,
    MAP_ANIMATION_TYPE_WALL_DOOR,
    MAP_ANIMATION_TYPE_WALL,
    MAP_ANIMATION_TYPE_COUNT
};

#define MAX_ANIMATED_OBJECTS 2000

extern uint16_t gNumMapAnimations;
extern rct_map_animation gAnimatedObjects[MAX_ANIMATED_OBJECTS];

void map_animation_create(int32_t type, int32_t x, int32_t y, int32_t z);
void map_animation_invalidate_all();

#endif
add some event handlers for invalidating map objects 2015-03-18 20:52:27 +01:00			`/*****************************************************************************`
Ready copyright notice for clang-format Clang-format sees the text behind `#pragma region` as code and formats it. Instead of stating the copyright and date there, it's now in the comment block right below it. The text "Copyright" is left in the `#pragma region` line, as clang-format sees it as a single identifier. I took the opportunity to normalize the dates, and add the copyright notice to the source files where it was missing them (except for third-party and the generated resources.h file). 2018-06-15 14:07:34 +02:00			`* Copyright (c) 2014-2018 OpenRCT2 developers`
add some event handlers for invalidating map objects 2015-03-18 20:52:27 +01:00			`*`
Ready copyright notice for clang-format Clang-format sees the text behind `#pragma region` as code and formats it. Instead of stating the copyright and date there, it's now in the comment block right below it. The text "Copyright" is left in the `#pragma region` line, as clang-format sees it as a single identifier. I took the opportunity to normalize the dates, and add the copyright notice to the source files where it was missing them (except for third-party and the generated resources.h file). 2018-06-15 14:07:34 +02:00			`* For a complete list of all authors, please refer to contributors.md`
			`* Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2`
add some event handlers for invalidating map objects 2015-03-18 20:52:27 +01:00			`*`
Ready copyright notice for clang-format Clang-format sees the text behind `#pragma region` as code and formats it. Instead of stating the copyright and date there, it's now in the comment block right below it. The text "Copyright" is left in the `#pragma region` line, as clang-format sees it as a single identifier. I took the opportunity to normalize the dates, and add the copyright notice to the source files where it was missing them (except for third-party and the generated resources.h file). 2018-06-15 14:07:34 +02:00			`* OpenRCT2 is licensed under the GNU General Public License version 3.`
add some event handlers for invalidating map objects 2015-03-18 20:52:27 +01:00			`*****************************************************************************/`

			`#ifndef _MAP_ANIMATION_H_`
			`#define _MAP_ANIMATION_H_`

			`#include "../common.h"`

Drop `PACKED` attribute 2016-06-02 23:22:08 +02:00			`#pragma pack(push, 1)`
add some event handlers for invalidating map objects 2015-03-18 20:52:27 +01:00			`/**`
			`* Animated object`
			`* size: 0x06`
			`*/`
Remove and replace C typedefs `typedef struct/union/enum name { ... } name_again;` is not needed whe compiling C++, moving the name at the back to be in front of the object and removing `typedef` makes it usable the very same way. This also replaces typedefs with the using keyword. They have better readability, especially for function pointer types, and would allow more flexibility when used with templates. 2018-02-14 09:42:26 +01:00			`struct rct_map_animation {`
Replace our own integer types with standard ones 2018-06-20 17:28:51 +02:00			`uint8_t baseZ;`
			`uint8_t type;`
			`uint16_t x;`
			`uint16_t y;`
Remove and replace C typedefs `typedef struct/union/enum name { ... } name_again;` is not needed whe compiling C++, moving the name at the back to be in front of the object and removing `typedef` makes it usable the very same way. This also replaces typedefs with the using keyword. They have better readability, especially for function pointer types, and would allow more flexibility when used with templates. 2018-02-14 09:42:26 +01:00			`};`
Change macro to assert_struct_size 2016-06-03 10:54:44 +02:00			`assert_struct_size(rct_map_animation, 6);`
Drop `PACKED` attribute 2016-06-02 23:22:08 +02:00			`#pragma pack(pop)`
add some event handlers for invalidating map objects 2015-03-18 20:52:27 +01:00
implement remaining map animation invalidate event handlers and create map animation 2015-03-22 02:19:23 +01:00			`enum {`
Expand tabs to spaces This commit expands tabs to spaces (ts=4) in all the files under src/ and test/. Until now we had two wildly different code styles with C using tabs and new C++ using spaces. It is painful to maintain as none of the commonly used tools support this kind of setup and in reality is needless, as we can simply convert all the sources to spaces and have opened PRs do the same, where needed. Additionally, trailing whitespace has been removed. 2017-06-06 23:24:18 +02:00			`MAP_ANIMATION_TYPE_RIDE_ENTRANCE,`
			`MAP_ANIMATION_TYPE_QUEUE_BANNER,`
			`MAP_ANIMATION_TYPE_SMALL_SCENERY,`
			`MAP_ANIMATION_TYPE_PARK_ENTRANCE,`
			`MAP_ANIMATION_TYPE_TRACK_WATERFALL,`
			`MAP_ANIMATION_TYPE_TRACK_RAPIDS,`
			`MAP_ANIMATION_TYPE_TRACK_ONRIDEPHOTO,`
			`MAP_ANIMATION_TYPE_TRACK_WHIRLPOOL,`
			`MAP_ANIMATION_TYPE_TRACK_SPINNINGTUNNEL,`
			`MAP_ANIMATION_TYPE_REMOVE,`
			`MAP_ANIMATION_TYPE_BANNER,`
			`MAP_ANIMATION_TYPE_LARGE_SCENERY,`
			`MAP_ANIMATION_TYPE_WALL_DOOR,`
			`MAP_ANIMATION_TYPE_WALL,`
			`MAP_ANIMATION_TYPE_COUNT`
implement remaining map animation invalidate event handlers and create map animation 2015-03-22 02:19:23 +01:00			`};`
add some event handlers for invalidating map objects 2015-03-18 20:52:27 +01:00
Integrate animation objects 2016-08-20 23:38:50 +02:00			`#define MAX_ANIMATED_OBJECTS 2000`
add global macros for a few more things, ride rating related and misc 2016-05-09 23:54:22 +02:00
Replace our own integer types with standard ones 2018-06-20 17:28:51 +02:00			`extern uint16_t gNumMapAnimations;`
Integrate animation objects 2016-08-20 23:38:50 +02:00			`extern rct_map_animation gAnimatedObjects[MAX_ANIMATED_OBJECTS];`
implement remaining map animation invalidate event handlers and create map animation 2015-03-22 02:19:23 +01:00
Replace our own integer types with standard ones 2018-06-20 17:28:51 +02:00			`void map_animation_create(int32_t type, int32_t x, int32_t y, int32_t z);`
add some event handlers for invalidating map objects 2015-03-18 20:52:27 +01:00			`void map_animation_invalidate_all();`

Added newlines at end of files 2015-12-21 05:03:37 +01:00			`#endif`