NML:Badges - Revision history

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.)

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.


   
  |}
   
  |}


   
  
   
  




Rito12: Add missing parts.
2026-01-04T11:23:52Z
Add missing parts.

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

  Line 21:
  Line 21:


   
  | string
   
  | string


   
  | Name of this badge or badge class.
   
  | Name of this badge or badge class.


   
  +
  |-


   
  +
  | flags


   
  +
  | bitmask(BADGE_FLAG_XXX, ...);


   
  +
  |


   
  +
  ; COPY_TO_RELATED_ENTITY


   
  +
  ; NAME_LIST_STOP


   
  +
  ; NAME_LIST_FIRST_ONLY


   
  +
  ; USE_COMPANY_COLOUR


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


   
  +
  ; NAME_SKIP


   
  |}
   
  |}


   
  
   
  


  Line 29:
  Line 39:


   
  ! value range
   
  ! value range


   
  ! comment
   
  ! comment


   
  +
  |-


   
  +
  | intro_date


   
  +
  | 


   
  +
  | IDK


   
  |}
   
  |}


   
  
   
  


  Line 41:
  Line 55:


   
  | spriteset
   
  | spriteset


   
  | Graphics for the badge or badge class.
   
  | Graphics for the badge or badge class.


   
  +
  |-


   
  +
  |


   
  +
  aircraft<br>


   
  +
  airports<br>


   
  +
  airporttiles<br>


   
  +
  houses<br>


   
  +
  industries<br>


   
  +
  industrytiles<br>


   
  +
  objects<br>


   
  +
  railtypes<br>


   
  +
  roadstops<br>


   
  +
  roadtypes<br>


   
  +
  roadvehs<br>


   
  +
  ships<br>


   
  +
  stations<br>


   
  +
  trains<br>


   
  +
  tramtypes<br>


   
  +
  | spriteset


   
  +
  | Override default graphics when used by other specific feature.


   
  |}
   
  |}


   
  
   
  




Rito12: Simple site for badges
2026-01-04T10:54:41Z
Simple site for badges
New page
{{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

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

|}



== Badge variables ==



{| class="wikitable sortable"

! name

! value range

! comment

|}



== Badge callbacks ==



{| class="wikitable sortable"

! callback

! return value

! comment

|-

| default

| spriteset

| Graphics for the badge or badge class.

|}



== Example code ==



<pre style="color:blue">

item (FEAT_BADGES, power) {

    property {

        label: "power";

        name: string(STR_POWER);

    }

}



item (FEAT_BADGES, diesel) {

    property {

        label: "power/diesel";

        name: string(STR_POWER_DIESEL);

    }

}



item (FEAT_BADGES, steam) {

    property {

        label: "power/steam";

        name: string(STR_POWER_STEAM);

    }

    graphics {

        default: sprite_steam;

    }

}

</pre>

← 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"