OpenTTD Source
20241108-master-g80f628063a
|
Handling of object NewGRFs. More...
#include "stdafx.h"
#include "company_base.h"
#include "company_func.h"
#include "debug.h"
#include "genworld.h"
#include "newgrf_object.h"
#include "newgrf_class_func.h"
#include "newgrf_sound.h"
#include "object_base.h"
#include "object_map.h"
#include "timer/timer_game_calendar.h"
#include "tile_cmd.h"
#include "town.h"
#include "water.h"
#include "newgrf_animation_base.h"
#include "safeguards.h"
Go to the source code of this file.
Data Structures | |
struct | ObjectAnimationBase |
Helper class for animation control. More... | |
Functions | |
void | ResetObjects () |
This function initialize the spec arrays of objects. | |
static uint32_t | GetObjectIDAtOffset (TileIndex tile, uint32_t cur_grfid) |
Make an analysis of a tile and get the object type. More... | |
static uint32_t | GetNearbyObjectTileInformation (uint8_t parameter, TileIndex tile, ObjectID index, bool grf_version8) |
Based on newhouses equivalent, but adapted for newobjects. More... | |
static uint32_t | GetClosestObject (TileIndex tile, ObjectType type, const Object *current) |
Get the closest object of a given type. More... | |
static uint32_t | GetCountAndDistanceOfClosestInstance (uint8_t local_id, uint32_t grfid, TileIndex tile, const Object *current) |
Implementation of var 65. More... | |
uint16_t | GetObjectCallback (CallbackID callback, uint32_t param1, uint32_t param2, const ObjectSpec *spec, Object *o, TileIndex tile, uint8_t view) |
Perform a callback for an object. More... | |
static void | DrawTileLayout (const TileInfo *ti, const TileLayoutSpriteGroup *group, const ObjectSpec *spec) |
Draw an group of sprites on the map. More... | |
void | DrawNewObjectTile (TileInfo *ti, const ObjectSpec *spec) |
Draw an object on the map. More... | |
void | DrawNewObjectTileInGUI (int x, int y, const ObjectSpec *spec, uint8_t view) |
Draw representation of an object (tile) for GUI purposes. More... | |
uint16_t | StubGetObjectCallback (CallbackID callback, uint32_t param1, uint32_t param2, const ObjectSpec *spec, Object *o, TileIndex tile, int) |
Perform a callback for an object. More... | |
void | AnimateNewObjectTile (TileIndex tile) |
Handle the animation of the object tile. More... | |
void | TriggerObjectTileAnimation (Object *o, TileIndex tile, ObjectAnimationTrigger trigger, const ObjectSpec *spec) |
Trigger the update of animation on a single tile. More... | |
void | TriggerObjectAnimation (Object *o, ObjectAnimationTrigger trigger, const ObjectSpec *spec) |
Trigger the update of animation on a whole object. More... | |
Variables | |
ObjectOverrideManager | _object_mngr (NEW_OBJECT_OFFSET, NUM_OBJECTS, INVALID_OBJECT_TYPE) |
The override manager for our objects. | |
const ObjectSpec | _original_objects [NEW_OBJECT_OFFSET] |
std::vector< ObjectSpec > | _object_specs |
All the object specifications. | |
Handling of object NewGRFs.
Definition in file newgrf_object.cpp.
void AnimateNewObjectTile | ( | TileIndex | tile | ) |
Handle the animation of the object tile.
tile | The tile to animate. |
Definition at line 542 of file newgrf_object.cpp.
References AnimationBase< ObjectAnimationBase, ObjectSpec, Object, int, StubGetObjectCallback, TileAnimationFrameAnimationHelper< Object > >::AnimateTile(), ObjectSpec::flags, ObjectSpec::GetByTile(), Object::GetByTile(), OBJECT_FLAG_ANIM_RANDOM_BITS, and OBJECT_FLAG_ANIMATION.
void DrawNewObjectTile | ( | TileInfo * | ti, |
const ObjectSpec * | spec | ||
) |
Draw an object on the map.
ti | Information about the tile to draw on. |
spec | Object spec to draw. |
Definition at line 464 of file newgrf_object.cpp.
References Object::GetByTile(), SpriteGroup::Resolve(), and TileInfo::tile.
void DrawNewObjectTileInGUI | ( | int | x, |
int | y, | ||
const ObjectSpec * | spec, | ||
uint8_t | view | ||
) |
Draw representation of an object (tile) for GUI purposes.
x | Position x of image. |
y | Position y of image. |
spec | Object spec to draw. |
view | The object's view. |
Definition at line 482 of file newgrf_object.cpp.
|
static |
Draw an group of sprites on the map.
ti | Information about the tile to draw on. |
group | The group of sprites to draw. |
spec | Object spec to draw. |
Definition at line 438 of file newgrf_object.cpp.
References ObjectSpec::flags, OBJECT_FLAG_2CC_COLOUR, and TileLayoutSpriteGroup::ProcessRegisters().
|
static |
Get the closest object of a given type.
tile | The tile to start searching from. |
type | The type of the object to search for. |
current | The current object (to ignore). |
Definition at line 210 of file newgrf_object.cpp.
References DistanceManhattan(), and Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_object_pool >::Iterate().
Referenced by GetCountAndDistanceOfClosestInstance().
|
static |
Implementation of var 65.
local_id | Parameter given to the callback, which is the set id, or the local id, in our terminology. |
grfid | The object's GRFID. |
tile | The tile to look from. |
current | Object for which the inquiry is made |
Definition at line 230 of file newgrf_object.cpp.
References _object_mngr, GetClosestObject(), OverrideManagerBase::GetID(), GetRegister(), Object::GetTypeCount(), and NUM_OBJECTS.
Referenced by ObjectScopeResolver::GetVariable().
|
static |
Based on newhouses equivalent, but adapted for newobjects.
parameter | from callback. It's in fact a pair of coordinates |
tile | TileIndex from which the callback was initiated |
index | of the object been queried for |
grf_version8 | True, if we are dealing with a new NewGRF which uses GRF version >= 8. |
Definition at line 195 of file newgrf_object.cpp.
References GetNearbyTile(), GetNearbyTileInformation(), GetObjectIndex(), IsTileType(), and MP_OBJECT.
Referenced by ObjectScopeResolver::GetVariable().
uint16_t GetObjectCallback | ( | CallbackID | callback, |
uint32_t | param1, | ||
uint32_t | param2, | ||
const ObjectSpec * | spec, | ||
Object * | o, | ||
TileIndex | tile, | ||
uint8_t | view | ||
) |
Perform a callback for an object.
callback | The callback to perform. |
param1 | The first parameter to pass to the NewGRF. |
param2 | The second parameter to pass to the NewGRF. |
spec | The specification of the object / the entry point. |
o | The object to call the callback for. |
tile | The tile the callback is called for. |
view | The view of the object (only used when o == nullptr). |
Definition at line 426 of file newgrf_object.cpp.
|
static |
Make an analysis of a tile and get the object type.
tile | TileIndex of the tile to query |
cur_grfid | GRFID of the current callback chain |
Definition at line 166 of file newgrf_object.cpp.
References ObjectSpec::Get(), Object::GetByTile(), ObjectSpec::grf_prop, GRFFilePropsBase< Tcnt >::grffile, IsTileType(), GRFFilePropsBase< Tcnt >::local_id, MP_OBJECT, Object::type, and Object::view.
Referenced by ObjectScopeResolver::GetVariable().
uint16_t StubGetObjectCallback | ( | CallbackID | callback, |
uint32_t | param1, | ||
uint32_t | param2, | ||
const ObjectSpec * | spec, | ||
Object * | o, | ||
TileIndex | tile, | ||
int | |||
) |
Perform a callback for an object.
callback | The callback to perform. |
param1 | The first parameter to pass to the NewGRF. |
param2 | The second parameter to pass to the NewGRF. |
spec | The specification of the object / the entry point. |
o | The object to call the callback for. |
tile | The tile the callback is called for. |
Definition at line 524 of file newgrf_object.cpp.
void TriggerObjectAnimation | ( | Object * | o, |
ObjectAnimationTrigger | trigger, | ||
const ObjectSpec * | spec | ||
) |
Trigger the update of animation on a whole object.
o | The object that got triggered. |
trigger | The trigger that is triggered. |
spec | The spec associated with the object. |
Definition at line 570 of file newgrf_object.cpp.
References ObjectSpec::animation, HasBit(), Object::location, TriggerObjectTileAnimation(), and AnimationInfo::triggers.
void TriggerObjectTileAnimation | ( | Object * | o, |
TileIndex | tile, | ||
ObjectAnimationTrigger | trigger, | ||
const ObjectSpec * | spec | ||
) |
Trigger the update of animation on a single tile.
o | The object that got triggered. |
tile | The location of the triggered tile. |
trigger | The trigger that is triggered. |
spec | The spec associated with the object. |
Definition at line 557 of file newgrf_object.cpp.
References ObjectSpec::animation, CBID_OBJECT_ANIMATION_START_STOP, AnimationBase< ObjectAnimationBase, ObjectSpec, Object, int, StubGetObjectCallback, TileAnimationFrameAnimationHelper< Object > >::ChangeAnimationFrame(), HasBit(), and AnimationInfo::triggers.
Referenced by TriggerObjectAnimation().