NML:Builtin functions - Revision history

Andythenorth: Undo revision 5136 by Andythenorth (talk)

2026-01-03T17:38:31Z

Undo revision 5136 by Andythenorth (talk)

← Older revision		Revision as of 17:38, 3 January 2026
Line 138:		Line 138:
	\|-		\|-
	\| sound(''soundfile[, volume]'')		\| sound(''soundfile[, volume]'')
	\| Import sound from .wav-file ''soundfile'' into the grf file and return its numeric ID. Including a file multiple times will not cause it to be duplicated. Loaded sound files ~~can~~ be in WAV format, PCM encoding:		\| Import sound from .wav-file ''soundfile'' into the grf file and return its numeric ID. Including a file multiple times will not cause it to be duplicated. Loaded sound files must be in WAV format, PCM encoding:
	* mono		* mono
	* 8-bit or {{ottdp\|1.0\|no}} 16-bit		* 8-bit or {{ottdp\|1.0\|no}} 16-bit
	* 11025 Hz, 22050 Hz or 44100 Hz.		* 11025 Hz, 22050 Hz or 44100 Hz.
	''volume'' is in the [0, 100] range, the default value (if not set) is 100.		''volume'' is in the [0, 100] range, the default value (if not set) is 100.
	{{ottdp\|15}} Since OpenTTD 15, compressed sound effects are supported in Ogg Opus format, with no restriction on quality, bit depth or sample rate.
	\|-		\|-
	\| import_sound(''grfid, id[, volume]'')		\| import_sound(''grfid, id[, volume]'')

Andythenorth: Undo revision 5137 by Andythenorth (talk)

2026-01-03T17:38:06Z

Undo revision 5137 by Andythenorth (talk)

← Older revision		Revision as of 17:38, 3 January 2026
Line 143:		Line 143:
	* 11025 Hz, 22050 Hz or 44100 Hz.		* 11025 Hz, 22050 Hz or 44100 Hz.
	''volume'' is in the [0, 100] range, the default value (if not set) is 100.		''volume'' is in the [0, 100] range, the default value (if not set) is 100.

	{{ottdp\|15}} Since OpenTTD 15, compressed sound effects are supported in Ogg Opus format, with no restriction on quality, bit depth or sample rate.		{{ottdp\|15}} Since OpenTTD 15, compressed sound effects are supported in Ogg Opus format, with no restriction on quality, bit depth or sample rate.
	\|-		\|-

Andythenorth at 17:37, 3 January 2026

2026-01-03T17:37:20Z

← Older revision		Revision as of 17:37, 3 January 2026
Line 143:		Line 143:
	* 11025 Hz, 22050 Hz or 44100 Hz.		* 11025 Hz, 22050 Hz or 44100 Hz.
	''volume'' is in the [0, 100] range, the default value (if not set) is 100.		''volume'' is in the [0, 100] range, the default value (if not set) is 100.

	{{ottdp\|15}} Since OpenTTD 15, compressed sound effects are supported in Ogg Opus format, with no restriction on quality, bit depth or sample rate.		{{ottdp\|15}} Since OpenTTD 15, compressed sound effects are supported in Ogg Opus format, with no restriction on quality, bit depth or sample rate.
	\|-		\|-

Andythenorth: Note Ogg sound file support

2026-01-03T17:36:50Z

Note Ogg sound file support

← Older revision		Revision as of 17:36, 3 January 2026
Line 138:		Line 138:
	\|-		\|-
	\| sound(''soundfile[, volume]'')		\| sound(''soundfile[, volume]'')
	\| Import sound from .wav-file ''soundfile'' into the grf file and return its numeric ID. Including a file multiple times will not cause it to be duplicated. Loaded sound files ~~must~~ be in WAV format, PCM encoding:		\| Import sound from .wav-file ''soundfile'' into the grf file and return its numeric ID. Including a file multiple times will not cause it to be duplicated. Loaded sound files can be in WAV format, PCM encoding:
	* mono		* mono
	* 8-bit or {{ottdp\|1.0\|no}} 16-bit		* 8-bit or {{ottdp\|1.0\|no}} 16-bit
	* 11025 Hz, 22050 Hz or 44100 Hz.		* 11025 Hz, 22050 Hz or 44100 Hz.
	''volume'' is in the [0, 100] range, the default value (if not set) is 100.		''volume'' is in the [0, 100] range, the default value (if not set) is 100.
			{{ottdp\|15}} Since OpenTTD 15, compressed sound effects are supported in Ogg Opus format, with no restriction on quality, bit depth or sample rate.
	\|-		\|-
	\| import_sound(''grfid, id[, volume]'')		\| import_sound(''grfid, id[, volume]'')

Frosch: add missing accept_cargo and produce_cargo

2025-04-04T10:05:58Z

add missing accept_cargo and produce_cargo

← Older revision		Revision as of 10:05, 4 April 2025
Line 175:		Line 175:
	\| Defines either an old industry (using the global ID) or a new industry from your grf (using the grf-local ID). Used only by ''conflicting_ind_types'' on [[NML:Industries]].		\| Defines either an old industry (using the global ID) or a new industry from your grf (using the grf-local ID). Used only by ''conflicting_ind_types'' on [[NML:Industries]].
	''ind_type'' must be either <code style="color:darkgreen">IND_TYPE_OLD</code> or <code style="color:darkgreen">IND_TYPE_NEW</code>. ''ID'' must be in the [0, 127] range.		''ind_type'' must be either <code style="color:darkgreen">IND_TYPE_OLD</code> or <code style="color:darkgreen">IND_TYPE_NEW</code>. ''ID'' must be in the [0, 127] range.
			\|-
			\| accept_cargo(''cargotype'', produce_cargo(''cargotype'', ''factor'')...)<br>produce_cargo(''cargotype'', ''amount'')
			\| Helper functions used to set industry production in the [[NML:Industries#Cargo_types_array\|''cargo_types'' property]].
	\|}		\|}

Frosch: add missing visual_effect

2025-04-04T09:56:45Z

add missing visual_effect

← Older revision		Revision as of 09:56, 4 April 2025
Line 74:		Line 74:
	* ''z_offset'': Z position of the effect.		* ''z_offset'': Z position of the effect.
	\|-		\|-
	\| visual_effect_and_powered(''effect'', ''offset'', ''powered''		\| visual_effect_and_powered(''effect'', ''offset'', ''powered'')
	\| Helper function for the train property ~~visual_effect_and_powered~~ and ~~the~~ ~~VEH_CB_VISUAL_EFFECT_AND_POWERED callback~~.		\| Helper function for the train property and callback visual_effect_and_powered.
			\|-
			\| visual_effect(''effect'', ''offset'')
			\| Helper function for the road vehicle and ship property and callback visual_effect.
	\|-		\|-
	\| str2number(''4-byte long string'')		\| str2number(''4-byte long string'')

Dawdledeer: Document industry_type, fix typo

2025-04-03T22:59:30Z

Document industry_type, fix typo

← Older revision		Revision as of 22:59, 3 April 2025
Line 164:		Line 164:
	\|-		\|-
	\| vehicle_curv_info(''prev_cur'', ''cur_next'')		\| vehicle_curv_info(''prev_cur'', ''cur_next'')
	\| Returns the curvature state of a vehicle, given the direction differences between the (previous-current) and (current-next) vehicle pairs. For use with the vehicle variable <code style="color:darkgreen">curv_info</code>		\| Returns the curvature state of a vehicle, given the direction differences between the (previous-current) and (current-next) vehicle pairs. For use with the vehicle variable <code style="color:darkgreen">curv_info</code>.
	\|-		\|-
	\| format_string(''format'', args)		\| format_string(''format'', args)
	\| Use the python string formatting functions to create a literal string. Keep in mind that the output is a literal string which cannot be used by string(). This function can however be used to create filenames.		\| Use the python string formatting functions to create a literal string. Keep in mind that the output is a literal string which cannot be used by string(). This function can however be used to create filenames.
			\|-
			\| industry_type(''ind_type'', ''ID'')
			\| Defines either an old industry (using the global ID) or a new industry from your grf (using the grf-local ID). Used only by ''conflicting_ind_types'' on [[NML:Industries]].
			''ind_type'' must be either <code style="color:darkgreen">IND_TYPE_OLD</code> or <code style="color:darkgreen">IND_TYPE_NEW</code>. ''ID'' must be in the [0, 127] range.
	\|}		\|}

Athenarises: clarified bitmask bit indexing

2024-10-26T08:17:27Z

clarified bitmask bit indexing

← Older revision		Revision as of 08:17, 26 October 2024
Line 20:		Line 20:
	\|-		\|-
	\| bitmask(''bitpos1'', ...)		\| bitmask(''bitpos1'', ...)
	\| Compose an integer by switching the bits at the given positions on.		\| Compose an integer by switching the bits at the given positions on (indexed starting at 1).
	\|-		\|-
	\| STORE_TEMP(''value'', ''address'')		\| STORE_TEMP(''value'', ''address'')

Frosch: update for OpenTTD version schema since version 12

2023-06-27T21:26:08Z

update for OpenTTD version schema since version 12

← Older revision		Revision as of 21:26, 27 June 2023
Line 40:		Line 40:
	\| {{nml\|0.4.1}} Extract some bits from a value. Result is (value >> first) & (1 << amount - 1)		\| {{nml\|0.4.1}} Extract some bits from a value. Result is (value >> first) & (1 << amount - 1)
	\|-		\|-
	\| version_openttd(''major'', ''minor'', ''revision''[, ''build''])		\| {{ottd\|≤1.11}} version_openttd(''major'', ''minor'', ''revision''[, ''build'']) <br> {{ottd\|≥12}} version_openttd(''major'', ''minor'')
	\| Return the constant representing an OpenTTD version		\| Return the constant representing an OpenTTD version, for example
			* OpenTTD 1.4.0: "version_openttd(1, 4, 0)"
			* OpenTTD 13.0: "version_openttd(13, 0)"
			{{ottd\|≤1.8}} Old versions before OpenTTD 1.9 also could check for specific SVN revisions. This is no longer available.
	\|-		\|-
	\| cargotype_available(''cargotype'')		\| cargotype_available(''cargotype'')

Heresy: Changed from table to sortable.

2022-08-30T21:30:04Z

Changed from table to sortable.

← Older revision		Revision as of 21:30, 30 August 2022
Line 3:		Line 3:
	Available builtin functions are		Available builtin functions are

	{\| class="t"		{\| class="wikitable sortable"
	! Function		! Function
	! Description		! Description