Functions related to NewGRF objects. More...

#include "newgrf_callbacks.h"
#include "newgrf_spritegroup.h"
#include "newgrf_town.h"
#include "economy_func.h"
#include "timer/timer_game_calendar.h"
#include "object_type.h"
#include "newgrf_animation_type.h"
#include "newgrf_badge_type.h"
#include "newgrf_class.h"
#include "newgrf_commons.h"

Data Structures
struct	ObjectSpec
	Allow incrementing of ObjectClassID variables. More...

struct	ObjectScopeResolver
	Object scope resolver. More...

struct	ObjectResolverObject
	A resolver object to be used with feature 0F spritegroups. More...

Typedefs
using	ObjectFlags = EnumBitSet< ObjectFlag, uint16_t >

using	ObjectClass = NewGRFClass< ObjectSpec, ObjectClassID, OBJECT_CLASS_MAX >
	Class containing information relating to object classes.

Enumerations
enum class	ObjectFlag : uint8_t { OnlyInScenedit = 0 , CannotRemove = 1 , Autoremove = 2 , BuiltOnWater = 3 , ClearIncome = 4 , HasNoFoundation = 5 , Animation = 6 , OnlyInGame = 7 , Uses2CC = 8 , NotOnLand = 9 , DrawWater = 10 , AllowUnderBridge = 11 , AnimRandomBits = 12 , ScaleByWater = 13 }
	Various object behaviours. More...

enum	ObjectClassID : uint16_t { OBJECT_CLASS_BEGIN = 0 , OBJECT_CLASS_MAX = UINT16_MAX , INVALID_OBJECT_CLASS = UINT16_MAX }
	Class IDs for objects. More...

Functions
void	ResetObjects ()
	This function initialize the spec arrays of objects.

uint16_t	GetObjectCallback (CallbackID callback, uint32_t param1, uint32_t param2, const ObjectSpec spec, Object o, TileIndex tile, std::span< int32_t > regs100={}, uint8_t view=0)
	Perform a callback for an object.

void	DrawNewObjectTile (TileInfo ti, const ObjectSpec spec)
	Draw an object on the map.

void	DrawNewObjectTileInGUI (int x, int y, const ObjectSpec *spec, uint8_t view)
	Draw representation of an object (tile) for GUI purposes.

void	AnimateNewObjectTile (TileIndex tile)
	Handle the animation of the object tile.

bool	TriggerObjectTileAnimation (Object o, TileIndex tile, ObjectAnimationTrigger trigger, const ObjectSpec spec)
	Trigger the update of animation on a single tile.

bool	TriggerObjectAnimation (Object o, ObjectAnimationTrigger trigger, const ObjectSpec spec)
	Trigger the update of animation on a whole object.

Variables
static const uint8_t	OBJECT_SIZE_1X1 = 0x11
	The value of a NewGRF's size property when the object is 1x1 tiles: low nibble for X, high nibble for Y.

Detailed Description

Functions related to NewGRF objects.

Definition in file newgrf_object.h.

Typedef Documentation

◆ ObjectClass

using ObjectClass = NewGRFClass<ObjectSpec, ObjectClassID, OBJECT_CLASS_MAX>

Class containing information relating to object classes.

Definition at line 166 of file newgrf_object.h.

◆ ObjectFlags

using ObjectFlags = EnumBitSet<ObjectFlag, uint16_t>

Definition at line 41 of file newgrf_object.h.

Enumeration Type Documentation

◆ ObjectClassID

enum ObjectClassID : uint16_t

Class IDs for objects.

Enumerator
OBJECT_CLASS_BEGIN	The lowest valid value.
OBJECT_CLASS_MAX	Maximum number of classes.
INVALID_OBJECT_CLASS	Class for the less fortunate.

Definition at line 48 of file newgrf_object.h.

◆ ObjectFlag

enum class ObjectFlag : uint8_t

strong

Various object behaviours.

Enumerator
OnlyInScenedit	Object can only be constructed in the scenario editor.
CannotRemove	Object can not be removed.
Autoremove	Object get automatically removed (like "owned land").
BuiltOnWater	Object can be built on water (not required).
ClearIncome	When object is cleared a positive income is generated instead of a cost.
HasNoFoundation	Do not display foundations when on a slope.
Animation	Object has animated tiles.
OnlyInGame	Object can only be built in game.
Uses2CC	Object wants 2CC colour mapping.
NotOnLand	Object can not be on land, implicitly sets ObjectFlag::BuiltOnWater.
DrawWater	Object wants to be drawn on water.
AllowUnderBridge	Object can built under a bridge.
AnimRandomBits	Object wants random bits in "next animation frame" callback.
ScaleByWater	Object count is roughly scaled by water amount at edges.

Definition at line 25 of file newgrf_object.h.

Function Documentation

◆ AnimateNewObjectTile()

void AnimateNewObjectTile ( TileIndex tile )

Handle the animation of the object tile.

Parameters

tile	The tile to animate.

Definition at line 553 of file newgrf_object.cpp.

References AnimationBase< ObjectAnimationBase, ObjectSpec, Object, int, StubGetObjectCallback, TileAnimationFrameAnimationHelper< Object > >::AnimateTile(), Animation, AnimRandomBits, ObjectSpec::flags, ObjectSpec::GetByTile(), Object::GetByTile(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

◆ DrawNewObjectTile()

void DrawNewObjectTile	(	TileInfo *	ti,
		const ObjectSpec *	spec
	)

Draw an object on the map.

Parameters

ti	Information about the tile to draw on.
spec	Object spec to draw.

Definition at line 472 of file newgrf_object.cpp.

References DrawTileLayout, Object::GetByTile(), SpriteLayoutProcessor::GetLayout(), TileLayoutSpriteGroup::ProcessRegisters(), and TileInfo::tile.

◆ DrawNewObjectTileInGUI()

void DrawNewObjectTileInGUI	(	int	x,
		int	y,
		const ObjectSpec *	spec,
		uint8_t	view
	)

Draw representation of an object (tile) for GUI purposes.

Parameters

x	Position x of image.
y	Position y of image.
spec	Object spec to draw.
view	The object's view.

Definition at line 492 of file newgrf_object.cpp.

References _local_company, Livery::colour1, Livery::colour2, DrawNewGRFTileSeqInGUI(), DrawSprite(), ObjectSpec::flags, GB(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::Get(), GetCompanyPalette(), SpriteLayoutProcessor::GetLayout(), GroundSpritePaletteTransform(), INVALID_TILE, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::IsValidID(), PALETTE_RECOLOUR_START, TileLayoutSpriteGroup::ProcessRegisters(), SPRITE_WIDTH, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), and Uses2CC.

Referenced by ObjectPickerCallbacks::DrawType(), and BuildObjectWindow::DrawWidget().

◆ GetObjectCallback()

uint16_t GetObjectCallback	(	CallbackID	callback,
		uint32_t	param1,
		uint32_t	param2,
		const ObjectSpec *	spec,
		Object *	o,
		TileIndex	tile,
		std::span< int32_t >	regs100,
		uint8_t	view
	)

Perform a callback for an object.

Parameters

	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).
[out]	regs100	Additional result values from registers 100+

Returns: The result of the callback.

Definition at line 435 of file newgrf_object.cpp.

Referenced by BuildObject(), CmdBuildObject(), BuildObjectWindow::DrawWidget(), and StubGetObjectCallback().

◆ ResetObjects()

void ResetObjects ( )

This function initialize the spec arrays of objects.

Definition at line 125 of file newgrf_object.cpp.

References _object_specs, NewGRFClass< Tspec, Tindex, Tmax >::Allocate(), ObjectSpec::grf_prop, lengthof, GRFFilePropsBase::local_id, OBJECT_LIGHTHOUSE, and OBJECT_TRANSMITTER.

Referenced by ResetNewGRFData().

◆ TriggerObjectAnimation()

bool TriggerObjectAnimation	(	Object *	o,
		ObjectAnimationTrigger	trigger,
		const ObjectSpec *	spec
	)

Trigger the update of animation on a whole object.

Parameters

o	The object that got triggered.
trigger	The trigger that is triggered.
spec	The spec associated with the object.

Definition at line 587 of file newgrf_object.cpp.

References ObjectSpec::animation, Object::location, Random, and SB().

Referenced by BuildObject().

◆ TriggerObjectTileAnimation()

bool TriggerObjectTileAnimation	(	Object *	o,
		TileIndex	tile,
		ObjectAnimationTrigger	trigger,
		const ObjectSpec *	spec
	)

Trigger the update of animation on a single tile.

Parameters

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 576 of file newgrf_object.cpp.

References Random.

Variable Documentation

◆ OBJECT_SIZE_1X1

const uint8_t OBJECT_SIZE_1X1 = 0x11

static

The value of a NewGRF's size property when the object is 1x1 tiles: low nibble for X, high nibble for Y.

Definition at line 43 of file newgrf_object.h.

Referenced by CmdBuildObjectArea(), ObjectChangeInfo(), and BuildObjectWindow::OnPlaceObject().

Data Structures

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ ObjectClass

◆ ObjectFlags

Enumeration Type Documentation

◆ ObjectClassID

◆ ObjectFlag

Function Documentation

◆ AnimateNewObjectTile()

◆ DrawNewObjectTile()

◆ DrawNewObjectTileInGUI()

◆ GetObjectCallback()

◆ ResetObjects()

◆ TriggerObjectAnimation()

◆ TriggerObjectTileAnimation()

Variable Documentation

◆ OBJECT_SIZE_1X1