NML:Produce - Revision history

Jfs: /* NML 0.5 syntax */

2019-05-08T21:01:16Z

NML 0.5 syntax

← Older revision		Revision as of 21:01, 8 May 2019
Line 21:		Line 21:

	Up to 16 ''consume_cargo: consume_amount'' pairs and 16 ''produce_cargo: produce_amount'' pairs may be given, and either of the consume and produce lists may also be empty.		Up to 16 ''consume_cargo: consume_amount'' pairs and 16 ''produce_cargo: produce_amount'' pairs may be given, and either of the consume and produce lists may also be empty.

			All cargo labels used in the produce block must appear in the industry's [[NML:Industries#Cargo_types_array\|cargo_types array]].

	== Example ==		== Example ==

Jfs: More clarification of semicolons in the syntax

2019-05-01T20:33:16Z

More clarification of semicolons in the syntax

← Older revision		Revision as of 20:33, 1 May 2019
Line 5:		Line 5:
	{{nml\|0.5}} {{ottd\|1.9}} The <code style="color:darkgreen">produce</code> block is only available for industries and describes how the industry consumes incoming and creates outgoing cargo. The syntax can be one of the following:		{{nml\|0.5}} {{ottd\|1.9}} The <code style="color:darkgreen">produce</code> block is only available for industries and describes how the industry consumes incoming and creates outgoing cargo. The syntax can be one of the following:

	produce (<ID>, [ <consume_cargo>: <consume_amount>; <...> ], [ <produce_cargo>: <produce_amount>; <...> ]);		produce (<ID>, [ <consume_cargo>: <consume_amount>; <...> ], [ <produce_cargo>: <produce_amount>; <...> ])

	produce (<ID>, [ <consume_cargo>: <consume_amount>; <...> ], [ <produce_cargo>: <produce_amount>; <...> ], <run_again>);		produce (<ID>, [ <consume_cargo>: <consume_amount>; <...> ], [ <produce_cargo>: <produce_amount>; <...> ], <run_again>)

	Note that the square brackets <code>[ ]</code> are part of the syntax and must be typed. See the example below.		Note that the square brackets <code>[ ]</code> are part of the syntax and must be typed. The semicolon <code>;</code> after each pair must also be included even after the last pair in a list. See the example below.

	NML 0.5 will always generate production callback version 2 in the final GRF file, this is only understood by OpenTTD 1.9 and later.		NML 0.5 will always generate production callback version 2 in the final GRF file, this is only understood by OpenTTD 1.9 and later.

Jfs: NML 0.5 new produce syntax

2019-05-01T20:31:40Z

NML 0.5 new produce syntax

@@ Line 1: / Line 1: @@
 {{NMLNavBlocksyntax}}
  produce (&lt;ID&gt;, &lt;consume_1&gt;, &lt;consume_2&gt;, &lt;consume_3&gt;, &lt;produce_1&gt;, &lt;produce_2&gt; [, run_again]);
@@ Line 22: / Line 133: @@
  /* When we receive cargo, the counter is reset. */
- produce(power_plant_cargo_arrive_produce, 0, 0, 0, 0, STORE_PERM(0, 0x00));
+ produce(power_plant_cargo_arrive_produce, 0, 0, 0, 0, STORE_PERM(0, 0x00))
  /* Every month the counter is increased. */
@@ Line 43: / Line 154: @@
+ }
 </pre>

FooBar: add nav template

2011-08-21T16:33:00Z

add nav template

← Older revision		Revision as of 16:33, 21 August 2011
Line 1:		Line 1:
			{{NMLNavBlocksyntax}}

	The <code style="color:darkgreen">produce</code> block is only available for industries and describes how the industry consumes incoming and creates outgoing cargo. The syntax is:		The <code style="color:darkgreen">produce</code> block is only available for industries and describes how the industry consumes incoming and creates outgoing cargo. The syntax is:

FooBar: content of nml r1625

2011-08-21T11:30:18Z

content of nml r1625

New page

The <code style="color:darkgreen">produce</code> block is only available for industries and describes how the industry consumes incoming and creates outgoing cargo. The syntax is:

produce (<ID>, <consume_1>, <consume_2>, <consume_3>, <produce_1>, <produce_2> [, run_again]);

where

* <code style="color:darkgreen">ID</code> is a unique name of the block
* <code style="color:darkgreen">consume_1</code>, <code style="color:darkgreen">consume_2</code>, <code style="color:darkgreen">consume_3</code> are expressions which give the amount of the respective input cargo consumed during this call of the produce block. The given amounts are subtracted from the stockpile of cargo waiting to be processed.
* <code style="color:darkgreen">produce_1</code>, <code style="color:darkgreen">produce_2</code> are expressions which give the amount of the produced (outgoing) cargos in the produce block.
* <code style="color:darkgreen">run_again</code> is a boolean expression which evaluates to either 0 or 1. It indicates whether the produce block shall be called again. This is optional, with a default value of 0.

Note that industry variables can be used in the produce-block, so you can for example query the amount of waiting cargo directly and use that in your expression.

The produce block should be the result of the production callback of an industry. An example on how it can be used without actually processing cargo but counting the time an industry exists unserviced:

<pre style="color:blue">
/* Every month, the counter is increased. The counter is reset to zero whenever the power plant
* receives cargo. When the counter reaches 61, the industry will close when the random production
* change callback is called. */

/* When we receive cargo, the counter is reset. */
produce(power_plant_cargo_arrive_produce, 0, 0, 0, 0, STORE_PERM(0, 0x00));

/* Every month the counter is increased. */
switch (FEAT_INDUSTRIES, SELF, power_plant_monthly_prod_change_switch, STORE_PERM(LOAD_PERM(0x00) + 1, 0x00)) {
return CB_RESULT_IND_PROD_NO_CHANGE;
}

/* Only check industry closure if the counter is greater than 60. */
switch (FEAT_INDUSTRIES, SELF, power_plant_random_prod_change_switch, LOAD_PERM(0x00)) {
0..60: return CB_RESULT_IND_PROD_NO_CHANGE;
return CB_RESULT_IND_PROD_CLOSE;
}

item(FEAT_INDUSTRIES, industry_power_plant, INDUSTRYTYPE_POWER_PLANT) {
graphics {
produce_cargo_arrival: power_plant_cargo_arrive_produce;
monthly_prod_change: power_plant_monthly_prod_change_switch;
random_prod_change: power_plant_random_prod_change_switch;
}
}
</pre>