NML:Objects - Revision history

Rito12: /* Object variables */ rail type -> object

2026-01-04T14:31:22Z

Object variables: rail type -> object

← Older revision		Revision as of 14:31, 4 January 2026
Line 295:		Line 295:
	\| Label from the [[NML:Badgetable\|badgetable]].		\| Label from the [[NML:Badgetable\|badgetable]].
	\| [0 <nowiki>\|</nowiki> 1]		\| [0 <nowiki>\|</nowiki> 1]
	\| {{ottd\|15.0}} Check if the ~~rail type~~ has that specific badge attached.		\| {{ottd\|15.0}} Check if the object has that specific badge attached.
	\|}		\|}

Rito12: /* Object variables */ has_badge

2026-01-04T14:30:38Z

Object variables: has_badge

← Older revision		Revision as of 14:30, 4 January 2026
Line 291:		Line 291:
	\|		\|
	Manhattan distance to the closest object of the given type. Grfid is the grfid of the newgrf you want to check the minimum object distance of (default is current grf). Use the [[NML:Builtin functions\|builtin function]] <code style="color:darkgreen">str2number()</code> to convert a grfid to its numeric representation. If the given object type is not yet built, this will return 0xFFFF		Manhattan distance to the closest object of the given type. Grfid is the grfid of the newgrf you want to check the minimum object distance of (default is current grf). Use the [[NML:Builtin functions\|builtin function]] <code style="color:darkgreen">str2number()</code> to convert a grfid to its numeric representation. If the given object type is not yet built, this will return 0xFFFF
			\|-
			\| has_badge
			\| Label from the [[NML:Badgetable\|badgetable]].
			\| [0 <nowiki>\|</nowiki> 1]
			\| {{ottd\|15.0}} Check if the rail type has that specific badge attached.
	\|}		\|}

Rito12: /* Object properties */ badges property

2026-01-03T21:47:47Z

Object properties: badges property

← Older revision		Revision as of 21:47, 3 January 2026
Line 16:		Line 16:
	{\| class="wikitable sortable"		{\| class="wikitable sortable"
	! property		! property
			! <p style="margin-left: 150px; margin-right: 150px"></p>value range<br><p style="margin-left: 150px; margin-right: 150px"></p>
	! value range
	! comment		! comment
	\|-		\|-
Line 83:		Line 83:
	\| 0..255		\| 0..255
	\| Height of the object / 8. For example if your object is 16 pixels height you should set height to 2. In OpenTTD this property is used to determine the height of the build object window; the height for the object preview is set to 32 + "value of property" * 8. The property is also used to determine how high a bridge must be if it is allowed by the bit in object_flags.		\| Height of the object / 8. For example if your object is 16 pixels height you should set height to 2. In OpenTTD this property is used to determine the height of the build object window; the height for the object preview is set to 32 + "value of property" * 8. The property is also used to determine how high a bridge must be if it is allowed by the bit in object_flags.
			\|-
			\| badges
			\| Array of badge labels from the [[NML:Badgetable\|badgetable]].
			\| Since {{ottd\|15.0}}
	\|-		\|-
	\| num_views		\| num_views

Andythenorth: /* Object callbacks */ anim trigger var 0x10 Lower 16 bits are random per tile. Upper 16 bits are the same for all tiles, if the trigger applies to multiple tiles.

2026-01-03T19:54:33Z

Object callbacks: anim trigger var 0x10 Lower 16 bits are random per tile. Upper 16 bits are the same for all tiles, if the trigger applies to multiple tiles.

← Older revision		Revision as of 19:54, 3 January 2026
Line 314:		Line 314:
	\|		\|
	Called whenever an object animation trigger happens. Return the animation frame to show, or CB_RESULT_XXX with XXX = [CB_RESULT_START_ANIMATION <nowiki>\|</nowiki> STOP_ANIMATION <nowiki>\|</nowiki> DO_NOTHING] to respectively start the animation in its current frame, stop the animation or do nothing. Returning a sound effect in the high byte will cause that sound effect to be played.		Called whenever an object animation trigger happens. Return the animation frame to show, or CB_RESULT_XXX with XXX = [CB_RESULT_START_ANIMATION <nowiki>\|</nowiki> STOP_ANIMATION <nowiki>\|</nowiki> DO_NOTHING] to respectively start the animation in its current frame, stop the animation or do nothing. Returning a sound effect in the high byte will cause that sound effect to be played.
	* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the ~~object~~ ~~flag~~ ~~OBJ_FLAG_RANDOM_ANIMATION~~ is ~~set~~.		* <code style="color:darkgreen">extra_callback_info1</code>: if the object flag OBJ_FLAG_RANDOM_ANIMATION is set, 32 random bits. {{ottdp\|15\|no}} Lower 16 bits are random per tile. Upper 16 bits are the same for all tiles, if the trigger applies to multiple tiles.
	* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers\| table]] below.		* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers\| table]] below.
	Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.		Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.

Peter1138: /* Object properties */

2025-06-06T11:15:02Z

Object properties

← Older revision		Revision as of 11:15, 6 June 2025
Line 86:		Line 86:
	\| num_views		\| num_views
	\| 1, 2 or 4		\| 1, 2 or 4
	\| Objects may have "views", i.e. different graphical representations, e.g. used to show rotated views of an object. Number of views may be 1, 2, or 4. Default value is 1. For non-square objects, x and y sizes are swapped for odd views. Use variable <code style="color:darkgreen">view</code> to determine the view of a built object. Views should be used for rotations or minor variations, not for objects of different types as those should just be different object types which provides a better experience for players.		\| Objects may have "views", i.e. different graphical representations, e.g. used to show rotated views of an object. Number of views may be 1, 2, or 4. Default value is 1. For non-square objects, x and y sizes are swapped for odd views. Use variable <code style="color:darkgreen">view</code> to determine the view of a built object. Views should be used for rotations or minor variations, not for objects of different types as those should just be different object types which provides a better experience for players. Using separate objects is better for discoverability, naming, filtering, used state, favourite state, and badges.
	\|-		\|-
	\| count_per_map256		\| count_per_map256

Peter1138: /* Object properties */

2025-05-17T12:46:50Z

Object properties

← Older revision		Revision as of 12:46, 17 May 2025
Line 86:		Line 86:
	\| num_views		\| num_views
	\| 1, 2 or 4		\| 1, 2 or 4
	\| Objects may have "views", i.e. different graphical representations, e.g. used to show rotated views of an object. Number of views may be 1, 2, or 4. Default value is 1. For non-square objects, x and y sizes are swapped for odd views. Use variable <code style="color:darkgreen">view</code> to determine the view of a built object. Views should be used for rotations or minor variations, not for objects of different types as those should just be different object types which ~~providers~~ a better experience for players.		\| Objects may have "views", i.e. different graphical representations, e.g. used to show rotated views of an object. Number of views may be 1, 2, or 4. Default value is 1. For non-square objects, x and y sizes are swapped for odd views. Use variable <code style="color:darkgreen">view</code> to determine the view of a built object. Views should be used for rotations or minor variations, not for objects of different types as those should just be different object types which provides a better experience for players.
	\|-		\|-
	\| count_per_map256		\| count_per_map256

Peter1138: /* Object properties */

2025-05-17T12:46:25Z

Object properties

← Older revision		Revision as of 12:46, 17 May 2025
Line 86:		Line 86:
	\| num_views		\| num_views
	\| 1, 2 or 4		\| 1, 2 or 4
	\| Objects may have "views", i.e. different graphical representations, e.g. used to show rotated views of an object. Number of views may be 1, 2, or 4. Default value is 1. For non-square objects, x and y sizes are swapped for odd views. Use variable <code style="color:darkgreen">view</code> to determine the view of a built object.		\| Objects may have "views", i.e. different graphical representations, e.g. used to show rotated views of an object. Number of views may be 1, 2, or 4. Default value is 1. For non-square objects, x and y sizes are swapped for odd views. Use variable <code style="color:darkgreen">view</code> to determine the view of a built object. Views should be used for rotations or minor variations, not for objects of different types as those should just be different object types which providers a better experience for players.
	\|-		\|-
	\| count_per_map256		\| count_per_map256

Frosch: /* List of object flags */

2025-04-04T10:34:12Z

List of object flags

← Older revision		Revision as of 10:34, 4 April 2025
Line 114:		Line 114:
	\| OBJ_FLAG_ON_WATER		\| OBJ_FLAG_ON_WATER
	\| Allow construction of the object on water. Note that if an object is allowed to be built both on land and on water, then it will resist being flooded and will not flood adjacent tiles.		\| Allow construction of the object on water. Note that if an object is allowed to be built both on land and on water, then it will resist being flooded and will not flood adjacent tiles.
			This flag has the same effect as using ''GROUNDSPRITE_WATER'' for the ground sprite in the spritelayout.
	\|-		\|-
	\| OBJ_FLAG_REMOVE_IS_INCOME		\| OBJ_FLAG_REMOVE_IS_INCOME

Peter1138: /* Object callbacks */

2024-08-02T13:19:22Z

Object callbacks

← Older revision		Revision as of 13:19, 2 August 2024
Line 307:		Line 307:
	\| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. Returning a sound effect in the high byte will cause that sound effect to be played (e.g. <code>return (sound("mysound.wav") << 8) <nowiki>\|</nowiki> CB_RESULT_NEXT_FRAME;</code>).		\| Called for every animation frame, returns the next frame to display. Alternatively, return CB_RESULT_NEXT_FRAME or CB_RESULT_STOP_ANIMATION to show the next frame or stop animation, respectively. Returning a sound effect in the high byte will cause that sound effect to be played (e.g. <code>return (sound("mysound.wav") << 8) <nowiki>\|</nowiki> CB_RESULT_NEXT_FRAME;</code>).
	* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the object flag OBJ_FLAG_RANDOM_ANIMATION is set.		* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the object flag OBJ_FLAG_RANDOM_ANIMATION is set.
			Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.
	\|-		\|-
	\| anim_control		\| anim_control
Line 314:		Line 315:
	* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the object flag OBJ_FLAG_RANDOM_ANIMATION is set.		* <code style="color:darkgreen">extra_callback_info1</code>: 32 random bits, if the object flag OBJ_FLAG_RANDOM_ANIMATION is set.
	* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers\| table]] below.		* <code style="color:darkgreen">getbits(extra_callback_info2, 0, 8)</code>: Reason for the callback trigger, see the [[#Animation triggers\| table]] below.
			Note: Every time the animation frame is changed the map tile will be refreshed, even if the selected graphics stay the same. Therefore using the animation frame as a timer should be avoided, and animation triggers should be preferred instead.
	\|-		\|-
	\| anim_speed		\| anim_speed

Andythenorth: /* Object IDs */ updated to reflect 64000 objects in OpenTTD 14.0

2023-09-10T07:03:18Z

Object IDs: updated to reflect 64000 objects in OpenTTD 14.0

← Older revision		Revision as of 07:03, 10 September 2023
Line 2:		Line 2:

	==Object IDs==		==Object IDs==
			OpenTTD supports 64000 object types per game, and 255 object IDs per grf file.
	Object IDs are NewGRF-local and can therefore freely be chosen in the 0..255 range. An object is allocated by setting the 'class'-property, which should therefore be set first. Overriding the default objects (e.g. transmitter, lighthouse) is not (yet) possible.

			{{ottdp\|14.0\|no}} 64000 object IDs per grf file are supported since OpenTTD 14.0.

			Object IDs are NewGRF-local and can therefore freely be chosen within the ID ranges.

			An object is allocated by setting the 'class'-property, which should therefore be set first.

			Overriding the default objects (e.g. transmitter, lighthouse) is not (yet) possible.

	==Object properties==		==Object properties==