NMLTutorial/Object - Revision history

FooBar at 21:05, 30 August 2011

2011-08-30T21:05:46Z

← Older revision		Revision as of 21:05, 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.''

Yexo: use consistent naming throughout tutorial

2011-08-27T22:05:16Z

use consistent naming throughout tutorial

← Older revision		Revision as of 22:05, 27 August 2011
Line 41:		Line 41:

	<pre style="color:darkblue; white-space: pre-wrap">		<pre style="color:darkblue; white-space: pre-wrap">
	item (FEAT_OBJECTS, ~~fingerpost_3~~) {		item (FEAT_OBJECTS, item_fingerpost_3) {
	property {		property {
	class: "NLRF";		class: "NLRF";
Line 80:		Line 80:
	=== graphics block ===		=== graphics block ===
	We'll add the graphics later, so for now we only define a [http://newgrf-specs.tt-wiki.net/wiki/NML:Objects#Object_callbacks callback] here to show a description of the object in the purchase menu. The callback used for this is <code>additional_text</code> and can directly return a string from the graphics block.		We'll add the graphics later, so for now we only define a [http://newgrf-specs.tt-wiki.net/wiki/NML:Objects#Object_callbacks callback] here to show a description of the object in the purchase menu. The callback used for this is <code>additional_text</code> and can directly return a string from the graphics block.


	== Language file ==		== Language file ==

FooBar: add item block

2011-08-27T19:08:51Z

add item block

@@ Line 19: / Line 19: @@
   |- custom_tags.txt
   |- example_object.nml
@@ Line 49: / Line 35: @@
 Nothing fancy there, just like we used to do and starting at version 0.

FooBar: page contents

2011-08-27T15:30:14Z

page contents

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.''

== Introduction ==
Objects, as well as stations, houses, industry tiles and airport tiles are coded slightly differently than vehicles. This difference mainly has to do with how sprites are defined. Item blocks and callbacks with switch blocks are still used as before, so our focus will be mainly on the graphics part. Stations are currently not yet possible in NML.

In this example we will make an object with four views to be used on flat ground tiles. After that we'll also make this object work on slopes, using some advanced features available in OpenTTD.

== Folder structure ==
For this example we'll assume the following folder structure. There will be one language file in the ''lang'' folder, one graphics file in the ''gfx'' folder. These two folders sit together with the main NML file in one project folder:

object_example
|- lang
| |- english.lng
|- gfx
| |- dutch_fingerpost.png
|- custom_tags.txt
|- example_object.nml

== Language files ==
Only English as default language with NewGRF name and description already defined. More things will be added to the language file as we go.

<pre style="color:darkblue; white-space: pre-wrap">
##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.
</pre>

custom_tags.txt this time contains the title of the NewGRF, see the introduction to [[NMLTutorial/Language_files#Custom_string_codes|language files]] for more details about the usage of custom_tags.txt.

== NML file ==
Start the NML file by adding a grf block.

<pre style="color:darkblue; white-space: pre-wrap">
grf {
grfid: "\FB\FB\05\01";
name: string(STR_GRF_NAME);
desc: string(STR_GRF_DESCRIPTION);
version: 0;
min_compatible_version: 0;
}
</pre>

Nothing fancy there, just like we used to do and starting at version 0.

That should have you started nicely. Next we'll look into spritelayout blocks which are used for the graphics of objects.

{{NMLTutorialNavbar|Train recolour|Spritelayout}}