NML:Badges

2026-01-12T21:44:26Z

Audigex:

{{NMLNavPropVarCB}}

'''Since''' {{ottd|15.0}}

item (FEAT_BADGES, item_name) { ... }

==Badge properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| label
| string with <code style="color:green">/</code> as delimiter
| ''' For sake of compatibility and user experience, consider using [[NML:Badge labels|labels already introduced]] by other NewGRFs.'''
Badges with label without <code style="color:green">/</code> are considered to be classes.
Labels for other badges should match following syntax:
<code style="color:green">"label_of_class_they_belong_to/label_for_the_badge"</code>
|-
| 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 ==

{| class="wikitable sortable"
! 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 <code style="color: green">introduction_date</code> in [[NML:Vehicles#Properties common to all vehicle types|vehicle properties]].
|}

== Badge callbacks ==

{| class="wikitable sortable"
! 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 ==

Badges require a [[NML:Badgetable|badgetable]] to be defined for most common usage scenarios (eg to refer to a badge from an item block). This is not a hard requirement and can be omitted if you are, for example, creating badges that other newGRFs can later refer to

Eg for `power/diesel` to be used in the badges property for a vehicle, the badge table must contain entries for both `power` and `power/diesel`

== Example code ==

<pre style="color:blue">

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;
}
}
</pre>

NML:Badges

2026-01-12T16:19:38Z

Audigex:

{{NMLNavPropVarCB}}

'''Since''' {{ottd|15.0}}

item (FEAT_BADGES, item_name) { ... }

==Badge properties==

{| class="wikitable sortable"
! property
! value range
! comment
|-
| label
| string with <code style="color:green">/</code> as delimiter
| ''' For sake of compatibility and user experience, consider using [[NML:Badge labels|labels already introduced]] by other NewGRFs.'''
Badges with label without <code style="color:green">/</code> are considered to be classes.
Labels for other badges should match following syntax:
<code style="color:green">"label_of_class_they_belong_to/label_for_the_badge"</code>
|-
| 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 ==

{| class="wikitable sortable"
! 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 <code style="color: green">introduction_date</code> in [[NML:Vehicles#Properties common to all vehicle types|vehicle properties]].
|}

== Badge callbacks ==

{| class="wikitable sortable"
! 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 ==

Badges require a [[NML:Badgetable|badgetable]] to be defined. Eg for `power/diesel` to be used, the badge table must contain entries for both `power` and `power/diesel`

== Example code ==

<pre style="color:blue">

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;
}
}
</pre>

GRFSpecs - User contributions [en-gb]

NML:Badges

NML:Badges