NMLTutorial/Object slopes - Revision history

Planetmaker: off by one

2013-05-24T13:17:11Z

off by one

← Older revision		Revision as of 13:17, 24 May 2013
Line 3:		Line 3:


	This continues and concludes the [[NMLTutorial/Object graphics\|second part]] of the object example. In this last part we'll make the object compatible with sloped terrain as well as snow and desert terrain. For this some recent features of OpenTTD will be used, which makes this last part of the example '''incompatible with OpenTTD 1.2.0 (r22723) ~~or earlier~~'''.		This continues and concludes the [[NMLTutorial/Object graphics\|second part]] of the object example. In this last part we'll make the object compatible with sloped terrain as well as snow and desert terrain. For this some recent features of OpenTTD will be used, which makes this last part of the example '''incompatible with OpenTTD earlier than 1.2.0 (r22723)'''.

Planetmaker: simplify some wording

2013-05-24T13:16:02Z

simplify some wording

← Older revision		Revision as of 13:16, 24 May 2013
Line 3:		Line 3:


	This continues and concludes the [[NMLTutorial/Object graphics\|second part]] of the object example. In this last part we'll make the object compatible with sloped terrain as well as snow and desert terrain. For this some recent features of OpenTTD will be used, which makes this last part of the example '''incompatible with ~~anything other than~~ OpenTTD 1.2.0 (r22723) or ~~higher~~'''.		This continues and concludes the [[NMLTutorial/Object graphics\|second part]] of the object example. In this last part we'll make the object compatible with sloped terrain as well as snow and desert terrain. For this some recent features of OpenTTD will be used, which makes this last part of the example '''incompatible with OpenTTD 1.2.0 (r22723) or earlier'''.

FooBar: next part is now 32 bit sprites

2012-06-26T11:20:58Z

next part is now 32 bit sprites

← Older revision		Revision as of 11:20, 26 June 2012
Line 375:		Line 375:
	</pre>		</pre>

			The next part of the tutorial will teach you some things about adding 32 bit sprites to your NewGRFs.
	This is the end of this example and in fact the end of the series. Only thing left for you to skip is a useless conclusion.


	{{NMLTutorialNavbar\|Version check\|~~Conclusion~~}}		{{NMLTutorialNavbar\|Version check\|32 bit sprites}}

FooBar at 21:06, 30 August 2011

2011-08-30T21:06:12Z

← Older revision		Revision as of 21:06, 30 August 2011
Line 1:		Line 1:
	{{NMLTutorial}}		{{NMLTutorial}}
	''The example used here is from the [http://dev.openttdcoop.org/projects/dutchroadfurniture/repository Dutch Road Furniture]. The original graphics for this are by FooBar. The code is by FooBar, based on code for the object example from the [http://dev.openttdcoop.org/projects/nml/repository/show/examples NML source] by planetmaker and ~~Hirundu~~. Code and graphics are both licensed according to the GPL v2 or later. The code has been modified for the purpose of this tutorial.''		''The example used here is from the [http://dev.openttdcoop.org/projects/dutchroadfurniture/repository Dutch Road Furniture]. The original graphics for this are by FooBar. The code is by FooBar, based on code for the object example from the [http://dev.openttdcoop.org/projects/nml/repository/show/examples NML source] by planetmaker and Hirundo. Code and graphics are both licensed according to the GPL v2 or later. The code has been modified for the purpose of this tutorial.''

FooBar: use expression consistently

2011-08-30T09:43:04Z

use expression consistently

← Older revision		Revision as of 09:43, 30 August 2011
Line 96:		Line 96:
	* In case of the arctic climate, we need to choose between grass and snow depending on the <code>terrain_type</code> variable. If grass, use the storage we already had, otherwise change the storage: <code>STORE_TEMP(terrain_type == TILETYPE_SNOW ? GROUNDSPRITE_SNOW : LOAD_TEMP(1), 1)</code>. What this does is store in register 1: if the terrain is snow the sprite number of the snow flat ground sprite from <code>GROUNDSPRITE_SNOW</code> and if the terrain is not snow what we already had in register 1.		* In case of the arctic climate, we need to choose between grass and snow depending on the <code>terrain_type</code> variable. If grass, use the storage we already had, otherwise change the storage: <code>STORE_TEMP(terrain_type == TILETYPE_SNOW ? GROUNDSPRITE_SNOW : LOAD_TEMP(1), 1)</code>. What this does is store in register 1: if the terrain is snow the sprite number of the snow flat ground sprite from <code>GROUNDSPRITE_SNOW</code> and if the terrain is not snow what we already had in register 1.

	These three ~~commands~~ need to be put somewhere in our NML file. Each ~~command~~ can go in a separate switch block all linked together, but luckily we may provide an array of ~~command~~ as ~~expession~~ ~~in the~~ switch block. This is done by separating each command by a comma and grouping them together between straight brackets. The decision of the switch block is based on the last ~~command~~ in the chain (but in this case not important as we only have a default).		These three expressions need to be put somewhere in our NML file. Each expression can go in a separate switch block all linked together, but luckily we may provide an array of expressions in a single switch block. This is done by separating each command by a comma and grouping them together between straight brackets. The decision of the switch block is based on the last expression in the chain (but that is in this case not important as we only have a default return for the switch block).

	Change the switch block we made earlier on this page:		Change the switch block we made earlier on this page:

FooBar: when translating, make sure to translate everything

2011-08-28T18:36:23Z

when translating, make sure to translate everything

← Older revision		Revision as of 18:36, 28 August 2011
Line 335:		Line 335:
	class: "NLRF";		class: "NLRF";
	classname: string(STR_NLRF);		classname: string(STR_NLRF);
	name: string(~~STR_HANDWIJZER_3~~);		name: string(STR_FINGERPOST_3);
	climates_available: ALL_CLIMATES;		climates_available: ALL_CLIMATES;
	size: [1,1];		size: [1,1];

FooBar: complete page

2011-08-28T12:02:29Z

complete page

Show changes

FooBar: intermediate save

2011-08-27T21:49:38Z

intermediate save

New page

{{NMLTutorial}}
''The example used here is from the [http://dev.openttdcoop.org/projects/dutchroadfurniture/repository Dutch Road Furniture]. The original graphics for this are by FooBar. The code is by FooBar, based on code for the object example from the [http://dev.openttdcoop.org/projects/nml/repository/show/examples NML source] by planetmaker and Hirundu. Code and graphics are both licensed according to the GPL v2 or later. The code has been modified for the purpose of this tutorial.''

This continues and concludes the [[NMLTutorial/Object graphics|second part]] of the object example. In this last part we'll make the object compatible with sloped terrain as well as snow and desert terrain. For this some recent features of OpenTTD will be used, which makes this last part of the example '''incompatible with anything other than OpenTTD 1.2.0 (r22723) or higher'''.

{{Note|This page is incomplete. It will be completed very soon.}}

== Version check ==

<pre style="color:darkblue; white-space: pre-wrap;">
if (version_openttd(1,2,0,22723) > openttd_version) {
error(FATAL, REQUIRES_OPENTTD, string(STR_OPENTTD_VERSION));
}
</pre>

<pre style="color:darkblue; white-space: pre-wrap;">
STR_OPENTTD_VERSION :1.2.0 (r22723)
</pre>

== Sloped ground sprites ==

<pre style="color:darkblue; white-space: pre-wrap;">
default: switch_fingerpost_3_object;
purchase: switch_fingerpost_3_purchase;
autoslope: return(CB_RESULT_AUTOSLOPE);
</pre>

<pre style="color:darkblue; white-space: pre-wrap;">
switch (FEAT_OBJECTS, SELF, switch_fingerpost_3_object, [
//tile slope offset in storage register 0
STORE_TEMP(slope_to_sprite_offset(tile_slope), 0),
//terrain type in storage register 1
STORE_TEMP(GROUNDSPRITE_NORMAL, 1),
STORE_TEMP(terrain_type == TILETYPE_DESERT ? GROUNDSPRITE_DESERT : LOAD_TEMP(1), 1),
STORE_TEMP(terrain_type == TILETYPE_SNOW ? GROUNDSPRITE_SNOW : LOAD_TEMP(1), 1)
]) {
switch_fingerpost_3_build_date;
}
</pre>

<pre style="color:darkblue; white-space: pre-wrap;">
//calculate ground sprite for purchase menu
switch (FEAT_OBJECTS, SELF, switch_fingerpost_3_purchase, [
//use flat gound sprite for purchase menu
STORE_TEMP(0, 0),
//use normal terrain for purchase menu
STORE_TEMP(GROUNDSPRITE_NORMAL, 1),
]) {
switch_fingerpost_3_build_date;
}
</pre>

With this the end of the object example is reached. You can now encode this as a NewGRF.

== The complete code ==
If you put everything in the correct order, this will be the complete NML file:

<pre style="color:darkblue; white-space: pre-wrap; max-height: 200px; overflow:scroll">
// define the newgrf
grf {
grfid: "\FB\FB\05\01";
name: string(STR_GRF_NAME);
desc: string(STR_GRF_DESCRIPTION);
version: 0;
min_compatible_version: 0;
}

//check OpenTTD version
//parameterized spritelayout is only supported since OpenTTD 1.2.0 r22723
if (version_openttd(1,2,0,22723) > openttd_version) {
error(FATAL, REQUIRES_OPENTTD, string(STR_OPENTTD_VERSION));
}

//templates
template template_fingerpost(x,y,filename) {
[x, y, 20, 32, -10, -28, filename]
[x+30, y, 20, 32, -10, -28, filename]
[x+60, y, 20, 32, -10, -28, filename]
[x+90, y, 20, 32, -10, -28, filename]
}

//spriteset with four directions
spriteset (spriteset_fingerpost_3) {
template_fingerpost(0,0,"gfx/dutch_fingerpost.png")
}

/* spritelayouts */

//south east
spritelayout spritelayout_fingerpost_3_SE {
ground {
sprite: LOAD_TEMP(0) + LOAD_TEMP(1);
}
building {
sprite: spriteset_fingerpost_3(0);
xextent: 4;
yextent: 4;
zextent: 24;
xoffset: 6; //from NE edge
yoffset: 12; //from NW edge
zoffset: 0;
}
}

//south west
spritelayout spritelayout_fingerpost_3_SW {
ground {
sprite: LOAD_TEMP(0) + LOAD_TEMP(1);
}
building {
sprite: spriteset_fingerpost_3(1);
xextent: 4;
yextent: 4;
zextent: 24;
xoffset: 12; //from NE edge
yoffset: 6; //from NW edge
zoffset: 0;
}
}

//north west
spritelayout spritelayout_fingerpost_3_NW {
ground {
sprite: LOAD_TEMP(0) + LOAD_TEMP(1);
}
building {
sprite: spriteset_fingerpost_3(2);
xextent: 4;
yextent: 4;
zextent: 24;
xoffset: 6; //from NE edge
yoffset: 0; //from NW edge
zoffset: 0;
}
}

//north east
spritelayout spritelayout_fingerpost_3_NE {
ground {
sprite: LOAD_TEMP(0) + LOAD_TEMP(1);
}
building {
sprite: spriteset_fingerpost_3(3);
xextent: 4;
yextent: 4;
zextent: 24;
xoffset: 0; //from NE edge
yoffset: 6; //from NW edge
zoffset: 0;
}
}

//decide spritelayout for each of the 4 views
switch (FEAT_OBJECTS, SELF, switch_fingerpost_3_view, view) {
1: spritelayout_fingerpost_3_SW;
2: spritelayout_fingerpost_3_NW;
3: spritelayout_fingerpost_3_NE;
spritelayout_fingerpost_3_SE;
}

//calculate ground sprite for object
switch (FEAT_OBJECTS, SELF, switch_fingerpost_3_object, [
//tile slope offset in storage register 0
STORE_TEMP(slope_to_sprite_offset(tile_slope), 0),
//terrain type in storage register 1
STORE_TEMP(GROUNDSPRITE_NORMAL, 1),
STORE_TEMP(terrain_type == TILETYPE_DESERT ? GROUNDSPRITE_DESERT : LOAD_TEMP(1), 1),
STORE_TEMP(terrain_type == TILETYPE_SNOW ? GROUNDSPRITE_SNOW : LOAD_TEMP(1), 1)
]) {
switch_fingerpost_3_build_date;
}

//calculate ground sprite for purchase menu
switch (FEAT_OBJECTS, SELF, switch_fingerpost_3_purchase, [
//use flat gound sprite for purchase menu
STORE_TEMP(0, 0),
//use normal terrain for purchase menu
STORE_TEMP(GROUNDSPRITE_NORMAL, 1),
]) {
switch_fingerpost_3_build_date;
}

item (FEAT_OBJECTS, fingerpost_3) {
property {
class: "NLRF";
classname: string(STR_NLRF);
name: string(STR_HANDWIJZER_3);
climates_available: ALL_CLIMATES;
size: [1,1];
build_cost_multiplier: 2;
remove_cost_multiplier: 8;
introduction_date: date(1961,1,1);
end_of_life_date: 0xFFFFFFFF;
object_flags: bitmask(OBJ_FLAG_REMOVE_IS_INCOME, OBJ_FLAG_NO_FOUNDATIONS, OBJ_FLAG_ALLOW_BRIDGE);
height: 2;
num_views: 4;
}
graphics {
default: switch_fingerpost_3_object;
purchase: switch_fingerpost_3_purchase;
autoslope: return(CB_RESULT_AUTOSLOPE);
additional_text: string(STR_FINGERPOST_3_PURCHASE);
}
}
</pre>

The language file will now contain:

<pre style="color:darkblue; white-space: pre-wrap; max-height: 200px; overflow:scroll">
##grflangid 0x01

#Main grf title and description
STR_GRF_NAME :{TITLE}
STR_GRF_DESCRIPTION :Description: {SILVER}Dutch Road Furniture is an eyecandy object NewGRF that features road furniture that can be found alongside Dutch roads. {}(c)2011 FooBar. {}{BLACK}License: {SILVER}GPLv2 or higher.

#error messages
STR_OPENTTD_VERSION :1.2.0 (r22723)

#object classes
STR_NLRF :Dutch Road Furniture

#object name and description
STR_FINGERPOST_3 :Dutch Fingerpost three-way
STR_FINGERPOST_3_PURCHASE :The three-way fingerpost is centered at one side of the tile and facing outward. Intended to be placed directly opposite of the secondary road at a three-way junction.
</pre>

This is the end of this example and the end of the series. Only thing left for you to skip is a useless conclusion

{{NMLTutorialNavbar|Version check|Conclusion}}