NMLTutorial/Glossary

NML Tutorial

Installation

Graphics files

Language files

NML Syntax

Starting an NML file (grf block)

• Creating a road vehicle

Item blocks

• • Item definition

Spriteset & spritegroup blocks

• • Adding the graphics

Template blocks

• • Templating the graphics

Cargotable block

• • Cargo-dependent graphics

Callbacks and switch blocks

• Creating a tram

• • Make it articulated

• • Adding the graphics

• • Fix the purchase menu

• Creating a train

Railtypetable block

• • Single engine

• • Three part articulated

• • Four part refit

GRF Parameters

• • Real life recolour scheme

• Creating an object

Spritelayout blocks

• • Adding the graphics

Version checks

• • Objects on slopes

32 bit sprites

• Adding 32 bit sprites

Base graphics replacement

• 32 bit base graphics

Conclusion

Glossary

NML Documentation

Here you find a list of terms used throughout the NML tutorial with an explanation of their meaning.

Argument

Variable added to a block to provide the block with certain information needed for the block to function correctly.

Block

A grouped instruction to do certain things. NML mainly consists from blocks. Block contents are grouped between curly brackets { and }.

Feature

Means of telling NML what type of item you want to add or modify. Supplied to certain blocks as argument.

Identifier

The name of a block or template. All identifiers are self-chosen an must be unique throughout the NML file, even if they are used by different block types. May contain lowercase and uppercase letters A to Z, numbers 0 to 9 and underscore _ but may not start with a number. It's recommended to start an identifier with the name of the block type.

Parameter

A special user-defined variable. Can be hidden in the NML file or user-configurable through the game's parameter settings.

Sprite

A single graphic to be used by the game, together with it's blue background. A graphics file can contain multiple sprites.

Template

Special block to allow making sprite definitions variable and reusable.

Variable

A named value that can change depending on certain conditions in the game or NML code.