NML:Badges

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

Props, Vars and CBs

General

• variables

Vehicles

• common props | vars | CBs
• train | roadveh | ship | aircr props

Stations

• properties | variables | callbacks

Roadstops

• properties | variables | callbacks

Canals

• properties | variables | callbacks

Towns

Houses

• properties | variables | callbacks

Industries

• common variables
• industry props | vars | CBs
• tile props | vars | CBs

Cargos

• properties | variables | callbacks

Airports

• airport props | vars | CBs
• tile props | vars | CBs

Objects

• properties | variables | callbacks

Railtypes

• properties | variables | callbacks

Roadtypes

• properties | variables | callbacks

Tramtypes

• properties | variables | callbacks

Bridges

• properties | variables | callbacks

Badges

• properties | variables |callbacks

Since 15.0 NML 0.9.0

 item (FEAT_BADGES, item_name) { ... }

Badge properties

property	value range	comment
label	string with / as delimiter	For sake of compatibility and user experience, consider using labels already introduced by other NewGRFs. Badges with label without / are considered to be classes. Labels for other badges should match following syntax: "label_of_class_they_belong_to/label_for_the_badge"
name	string	Name of this badge or badge class.
flags	bitmask(BADGE_FLAG_XXX, ...);	COPY_TO_RELATED_ENTITY Badge can be copied to related entity (e.g. badge on a railtype can be copied to rail vehicles of that railtype.) NAME_LIST_STOP Stops adding more names to the visible name list. NAME_LIST_FIRST_ONLY Add this name to the visible name list only if this is the first name. USE_COMPANY_COLOUR Recolour badge depending on company that player currently controls. NAME_SKIP Allow the badge to be excluded from the badge name list.

Badge variables

name	value range	comment
intro_date	date(yyyy, mm, dd)	Introduction date of entity (or current date if entity type does not have an introduction date). See introduction_date in vehicle properties.

Badge callbacks

Note: By design badges are meant to only be up to 12 pixels tall, and up to 24 pixels wide. Sprites larger than this may overlap or be clipped.

callback	return value	comment
default	spriteset	Graphics for the badge or badge class.
aircraft airports airporttiles houses industries industrytiles objects railtypes roadstops roadtypes roadvehs ships stations trains tramtypes	spriteset	Override default graphics when used by other specific feature.

Prerequisites

A badgetable is required to reference badges (e.g. to refer to a badge from an item block). No badgetable is required for NewGRFs that only define sets of badges, but do not use them.

Eg for power/diesel to be used in the badges property for a vehicle, the badge table must contain an entry for power/diesel

Example code

 badgetable {
     "power",
     "power/diesel",
     "power/steam"
 }

item (FEAT_BADGES, power) {
    property {
        label: "power";
        name: string(STR_POWER);
    }
}

# This badge will not show a sprite in the purchase menu
item (FEAT_BADGES, diesel) {
    property {
        label: "power/diesel";
        name: string(STR_POWER_DIESEL);
    }
}

# This badge will show a sprite in the purchase menu
item (FEAT_BADGES, steam) {
    property {
        label: "power/steam";
        name: string(STR_POWER_STEAM);
    }
    graphics {
        default: sprite_steam;
    }
}