NML:Main

NewGRF Meta Language

Preface

Getting started

Graphics files

Blocks

Units

Expressions

Elementary values

Builtin functions

Language files

Lists of props, vars and CBs

Warnings

Additional references

NewGRF compatibility

Deprecated syntax

Changes from NML 0.2 to 0.3

Changes from NML 0.3 to 0.4

Changes from NML 0.4 to 0.5

Vehicles, Stations, Roadstops, Canals, Towns, Houses, Industries (Tiles), Cargos, Airports+Tiles, Objects, Railtypes, Roadtypes, Tramtypes, Bridges, Badges, Terrain

NML Tutorial

Preface

Changes between NML 0.2 and head / 0.3

Changes between NML 0.3 and head / 0.4

Changes between NML 0.4 and head / 0.5

Getting started

Graphics files

Language structure and block syntax

• GRF and its parameters
• Item (Properties, graphics, livery overrides)

• Defining sprites

  • Realsprites
  • Template
  • Base Graphics
  • Spriteset

    Replacing sprites

    • Replace TTD sprites
    • Replace new sprites
    • Add font glyphs
    • Alternative sprites (32bpp, zoom levels)

    Aranging and grouping sprites

    • Spritegroup (Vehicles, stations)
    • Spritelayout (Houses, industries, airports, objects, stations)
    • Recolour sprites

• Flow control

  • Tilelayout
  • Switch
  • Produce
  • Random switch

• Global scope

  • Cargotable
  • Railtypetable / Roadtypetable / Tramtypetable
  • Badgetable
  • Snow line
  • Setting base costs
  • Parameter assignment
  • If/else
  • While

• Interaction with other grfs

  • Error
  • Disable items
  • Deactivate other NewGRFs
  • Testing for other NewGRFs
  • Overriding vehicles in other NewGRFs

• Misc

  • Town names
  • Town names parts
  • Sorting vehicles in the purchase list

Units

Expressions

• Elementary values
• Builtin functions

Language files

• String Codes
• LanguageIDs

Lists of properties, variables and callbacks

Type	Properties	Variables	Callbacks	Feature
General		variables		FEAT_GLOBALVARS
Vehicles	common properties	variables	callbacks
	train properties			FEAT_TRAINS
	road vehicle properties			FEAT_ROADVEHS
	ship properties			FEAT_SHIPS
	aircraft properties			FEAT_AIRCRAFT
Stations	properties	variables	callbacks	FEAT_STATIONS
Canals	properties	variables	callbacks	FEAT_CANALS
Bridges	properties	variables	callbacks	FEAT_BRIDGES
Badges	properties	variables	callbacks	FEAT_BADGES
Towns
Houses	properties	variables	callbacks	FEAT_HOUSES
Industries		common variables
	industry properties	industry variables	industry callbacks	FEAT_INDUSTRIES
	tile properties	tile variables	tile callbacks	FEAT_INDUSTRYTILES
Cargos	properties	variables	callbacks	FEAT_CARGOS
Airports	properties	variables	callbacks	FEAT_AIRPORTS
	tile properties	tile variables	tile callbacks	FEAT_AIRPORTTILES
Objects	properties	variables	callbacks	FEAT_OBJECTS
Railtypes	properties	variables	callbacks	FEAT_RAILTYPES
Roadtypes	properties	variables	callbacks	FEAT_ROADTYPES
Tramtypes	properties	variables	callbacks	FEAT_TRAMTYPES
Roadstops	properties	variables	callbacks	FEAT_ROADSTOPS
Signals				FEAT_SIGNALS

Compiler Warnings

Additional references

• Animation speed
• Default industries
• Default industry tiles
• Base cost table
• List of sound effects
• List of default vehicle IDs
• List of default house properties
• List of town zones
• List of tile classes
• List of default colour translation palettes
• List of direction constants
• List of tile slopes
• List of tiles
• Default TTD strings
• Deprecated syntax

NewGRF compatibility

Old-style callbacks

Manual of style