NML:Badges - Revision history

Peter1138: /* Badge callbacks */ Add comment about maximum badge width

2026-05-05T20:48:00Z

Badge callbacks: Add comment about maximum badge width

← Older revision		Revision as of 20:48, 5 May 2026
Line 52:		Line 52:
	== Badge callbacks ==		== Badge callbacks ==

	'''Note: By design badges are meant to only be up to 12 pixels tall.'''		'''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.'''

	{\| class="wikitable sortable"		{\| class="wikitable sortable"

Peter1138: /* Prerequisites */ Remove misinformation about having to define badge classes in badge tables

2026-05-05T20:46:20Z

Prerequisites: Remove misinformation about having to define badge classes in badge tables

← Older revision		Revision as of 20:46, 5 May 2026
Line 85:		Line 85:
	== Prerequisites ==		== 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~~		A [[NML:Badgetable\|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 <code style="color:green">power/diesel</code> to be used in the badges property for a vehicle, the badge table must contain ~~entries~~ for ~~both <code style="color:green">power</code> and~~ <code style="color:green">power/diesel</code>		Eg for <code style="color:green">power/diesel</code> to be used in the badges property for a vehicle, the badge table must contain an entry for <code style="color:green">power/diesel</code>

	== Example code ==		== Example code ==

Rito12: Add nml since.

2026-04-15T14:34:13Z

Add nml since.

← Older revision		Revision as of 14:34, 15 April 2026
Line 1:		Line 1:
	{{NMLNavPropVarCB}}		{{NMLNavPropVarCB}}

	'''Since''' {{ottd\|15.0}}		'''Since''' {{ottd\|15.0}} {{nml\|0.9.0}}

	item (FEAT_BADGES, item_name) { ... }		item (FEAT_BADGES, item_name) { ... }

Rito12: /* Badge callbacks */ By the way, by design badges are meant to only be up to 12 pixels tall. That's why these look bad in lists. (Probably didn't mention it in the specs.)

2026-02-12T13:58:59Z

Badge callbacks: By the way, by design badges are meant to only be up to 12 pixels tall. That's why these look bad in lists. (Probably didn't mention it in the specs.)

← Older revision		Revision as of 13:58, 12 February 2026
Line 51:		Line 51:

	== Badge callbacks ==		== Badge callbacks ==

			'''Note: By design badges are meant to only be up to 12 pixels tall.'''

	{\| class="wikitable sortable"		{\| class="wikitable sortable"

Rito12: /* Prerequisites */ Use


2026-01-14T15:26:32Z
Prerequisites:  Use <code style="color:green">

				
				
				
				
				
				← Older revision
				Revision as of 15:26, 14 January 2026
				

  Line 85:
  Line 85:


  
  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
  
  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`
  
  Eg for <code style="color:green">power/diesel</code> to be used in the badges property for a vehicle, the badge table must contain entries for both <code style="color:green">power</code> and <code style="color:green">power/diesel</code>


  
  

  
  



  
  == Example code ==
  
  == Example code ==



Audigex at 21:44, 12 January 2026
2026-01-12T21:44:26Z


				
				
				
				
				
				← Older revision
				Revision as of 21:44, 12 January 2026
				

  Line 83:
  Line 83:


  
  == Prerequisites ==
  
  == 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`
  
  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 ==
  
  == Example code ==




Audigex at 16:19, 12 January 2026
2026-01-12T16:19:38Z


				
				
				
				
				
				← Older revision
				Revision as of 16:19, 12 January 2026
				

  Line 80:
  Line 80:


  
  | Override default graphics when used by other specific feature.
  
  | 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 ==
  
  == Example code ==


  
  

  
  



  
  <pre style="color:blue">
  
  <pre style="color:blue">


  
  
  



  
  
   badgetable {


  
  
       "power",


  
  
       "power/diesel",


  
  
       "power/steam"


  
  
   }


  
  
  



  
  item (FEAT_BADGES, power) {
  
  item (FEAT_BADGES, power) {


  
      property {
  
      property {


  Line 91:
  Line 102:


  
  }
  
  }


  
  

  
  



  
  
  # This badge will not show a sprite in the purchase menu


  
  item (FEAT_BADGES, diesel) {
  
  item (FEAT_BADGES, diesel) {


  
      property {
  
      property {


  Line 98:
  Line 110:


  
  }
  
  }


  
  

  
  



  
  
  # This badge will show a sprite in the purchase menu


  
  item (FEAT_BADGES, steam) {
  
  item (FEAT_BADGES, steam) {


  
      property {
  
      property {




Rito12: /* Badge properties */ For sake of compatibility and user experience.
2026-01-04T15:52:15Z
Badge properties:  For sake of compatibility and user experience.

				
				
				
				
				
				← Older revision
				Revision as of 15:52, 4 January 2026
				

  Line 14:
  Line 14:


  
  | label
  
  | label


  
  | string with <code style="color:green">/</code> as delimiter
  
  | 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.
  
  Badges with label without <code style="color:green">/</code> are considered to be classes.


  
  Labels for other badges should match following syntax:
  
  Labels for other badges should match following syntax:


  
  <code style="color:green">"label_of_class_they_belong_to/label_for_the_badge"</code>
  
  <code style="color:green">"label_of_class_they_belong_to/label_for_the_badge"</code>




Rito12: /* Badge variables */  docs for intro_date
2026-01-04T12:02:43Z
Badge variables:   docs for intro_date

				
				
				
				
				
				← Older revision
				Revision as of 12:02, 4 January 2026
				

  Line 45:
  Line 45:


  
  |-
  
  |-


  
  | intro_date
  
  | 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]].


  
  | IDK
  


  
  |}
  
  |}


  
  

  
  





Rito12: Docs for flags
2026-01-04T11:35:18Z
Docs for flags

				
				
				
				
				
				← Older revision
				Revision as of 11:35, 4 January 2026
				

  Line 26:
  Line 26:


  
  |
  
  |


  
  ; COPY_TO_RELATED_ENTITY
  
  ; 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
  
  ; NAME_LIST_STOP


  
  
  : Stops adding more names to the visible name list.


  
  ; NAME_LIST_FIRST_ONLY
  
  ; NAME_LIST_FIRST_ONLY


  
  
  : Add this name to the visible name list only if this is the first name.


  
  ; USE_COMPANY_COLOUR
  
  ; USE_COMPANY_COLOUR


  
  : Recolour badge depending on company that player currently controls.
  
  : Recolour badge depending on company that player currently controls.


  
  ; NAME_SKIP
  
  ; NAME_SKIP


  
  
  : Allow the badge to be excluded from the badge name list.


  
  |}
  
  |}

← Older revision		Revision as of 15:26, 14 January 2026
Line 85:		Line 85:
	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		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`		Eg for <code style="color:green">power/diesel</code> to be used in the badges property for a vehicle, the badge table must contain entries for both <code style="color:green">power</code> and <code style="color:green">power/diesel</code>

	== Example code ==		== Example code ==

← Older revision		Revision as of 21:44, 12 January 2026
Line 83:		Line 83:
	== Prerequisites ==		== 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`~~		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 ==		== Example code ==

← Older revision		Revision as of 16:19, 12 January 2026
Line 80:		Line 80:
	\| Override default graphics when used by other specific feature.		\| 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 ==		== Example code ==

	<pre style="color:blue">		<pre style="color:blue">

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

	item (FEAT_BADGES, power) {		item (FEAT_BADGES, power) {
	property {		property {
Line 91:		Line 102:
	}		}

			# This badge will not show a sprite in the purchase menu
	item (FEAT_BADGES, diesel) {		item (FEAT_BADGES, diesel) {
	property {		property {
Line 98:		Line 110:
	}		}

			# This badge will show a sprite in the purchase menu
	item (FEAT_BADGES, steam) {		item (FEAT_BADGES, steam) {
	property {		property {

← Older revision		Revision as of 15:52, 4 January 2026
Line 14:		Line 14:
	\| label		\| label
	\| string with <code style="color:green">/</code> as delimiter		\| 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.		Badges with label without <code style="color:green">/</code> are considered to be classes.
	Labels for other badges should match following syntax:		Labels for other badges should match following syntax:
	<code style="color:green">"label_of_class_they_belong_to/label_for_the_badge"</code>		<code style="color:green">"label_of_class_they_belong_to/label_for_the_badge"</code>

← Older revision		Revision as of 12:02, 4 January 2026
Line 45:		Line 45:
	\|-		\|-
	\| intro_date		\| 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]].
	\| IDK
	\|}		\|}

← Older revision		Revision as of 11:35, 4 January 2026
Line 26:		Line 26:
	\|		\|
	; COPY_TO_RELATED_ENTITY		; 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		; NAME_LIST_STOP
			: Stops adding more names to the visible name list.
	; NAME_LIST_FIRST_ONLY		; NAME_LIST_FIRST_ONLY
			: Add this name to the visible name list only if this is the first name.
	; USE_COMPANY_COLOUR		; USE_COMPANY_COLOUR
	: Recolour badge depending on company that player currently controls.		: Recolour badge depending on company that player currently controls.
	; NAME_SKIP		; NAME_SKIP
			: Allow the badge to be excluded from the badge name list.
	\|}		\|}