Add: Support for NewGRF badges.

Author: PeterN

nml/actions/action0.py

@@ -211,6 +211,7 @@ def find_unused(self, length):
     BlockAllocation(0, 62, "Roadtype"),
     BlockAllocation(0, 62, "Tramtype"),
     BlockAllocation(0, 0xFFFE, "RoadStop"),  # UINT16_MAX - 1
+    BlockAllocation(0, 64000, "Badge"),
 ]
 
 
@@ -780,13 +781,49 @@ def get_size(self):
         return len(self.id_list) * 4 + 1
 
 
+class StringListProp(BaseAction0Property):
+    def __init__(self, prop_num, string_list):
+        self.prop_num = prop_num
+        self.string_list = string_list
+
+    def write(self, file):
+        file.print_bytex(self.prop_num)
+        for i, string_val in enumerate(self.string_list):
+            if i > 0 and i % 5 == 0:
+                file.newline()
+            file.print_string(string_val.value, True, True)
+        file.newline()
+
+    def get_size(self):
+        size = 1
+        for i, string_val in enumerate(self.string_list):
+            size += grfstrings.get_string_size(string_val.value, True, True)
+        return size
+
+
 def get_cargolist_action(cargo_list):
     action0 = Action0(0x08, 0)
     action0.prop_list.append(IDListProp(0x09, cargo_list))
     action0.num_ids = len(cargo_list)
     return [action0]
 
 
+def get_badgelist_action(badge_list):
+    index = 0
+    actions = []
+    while index < len(badge_list):
+        last = min(index + 250, len(badge_list))
+
+        action0 = Action0(0x08, index)
+        action0.prop_list.append(StringListProp(0x18, badge_list[index:last]))
+        action0.num_ids = last - index
+        actions.append(action0)
+
+        index = last
+
+    return actions
+
+
 def get_tracktypelist_action(table_prop_id, cond_tracktype_not_defined, tracktype_list):
     action6.free_parameters.save()
     act6 = action6.Action6()

nml/actions/action0properties.py

@@ -15,7 +15,7 @@
 
 import itertools
 
-from nml import generic, nmlop, global_constants
+from nml import generic, grfstrings, nmlop, global_constants
 from nml.expression import (
     AcceptCargo,
     Array,
@@ -170,7 +170,7 @@ def get_size(self):
 #
 # 'required' (value doesn't matter) if the property is required for the item to be valid.
 
-properties = 0x15 * [None]
+properties = 0x16 * [None]
 
 #
 # Some helper functions that are used for multiple features
@@ -335,6 +335,24 @@ def VariableByteListProp(prop_num, data, len_size=1):
     return VariableListProp(prop_num, data, 1, len_size)
 
 
+class StringProp(BaseAction0Property):
+    """
+    Property value that is zero-terminated string.
+    """
+
+    def __init__(self, prop_num, string):
+        self.prop_num = prop_num
+        self.string = string
+
+    def write(self, file):
+        file.print_bytex(self.prop_num)
+        file.print_string(self.string.value, True, True)
+        file.newline()
+
+    def get_size(self):
+        return grfstrings.get_string_size(self.string.value) + 1
+
+
 def ctt_list(prop_num, *values):
     # values may have multiple entries, if more than one item ID is set (e.g. multitile houses)
     # Each value is an expression.Array of cargo types
@@ -353,6 +371,38 @@ def VariableWordListProp(num_prop, data, len_size=1):
     return VariableListProp(num_prop, data, 2, len_size)
 
 
+def badge_list(prop_num, *values):
+    # values may have multiple entries, if more than one item ID is set
+    # Each value is an expression.Array of badge labels
+
+    table = global_constants.badge_numbers
+
+    for value in values:
+        if not isinstance(value, Array):
+            raise generic.ScriptError("Value of badgelist property must be an array", value.pos)
+
+        for badge in value.values:
+            if not isinstance(badge, StringLiteral) or badge.value not in table:
+                raise generic.ScriptError(
+                    "Parameter for badges must be a string literal that is also in your badge table", value.pos
+                )
+
+    return [
+        VariableListProp(
+            prop_num,
+            [[table[badge.value] for badge in single_item_array.values] for single_item_array in values],
+            2,
+            2,
+        )
+    ]
+
+
+def string_property(prop_num, value):
+    if not isinstance(value, StringLiteral):
+        raise generic.ScriptError("Value of label property must be a StringLiteral", value.pos)
+    return [StringProp(prop_num, value)]
+
+
 def accepted_cargos(prop_num, *values):
     # values may have multiple entries, if more than one item ID is set (e.g. multitile houses)
     # Each value is an expression.Array of cargo types and amount arrays
@@ -486,6 +536,7 @@ def single_or_list(prop_name, single_num, multiple_num, value):
     "curve_speed_mod":                {"size": 2, "num": 0x2E, "unit_conversion": 256},
     "variant_group":                  {"size": 2, "num": 0x2F},
     "extra_flags":                    {"size": 4, "num": 0x30},
+    "badges":                         {"custom_function": lambda value: badge_list(0x33, value)},
 }
 # fmt: on
 
@@ -564,6 +615,7 @@ def prop15_test(value):
     ],
     "variant_group":                {"size": 2, "num": 0x26},
     "extra_flags":                  {"size": 4, "num": 0x27},
+    "badges":                       {"custom_function": lambda value: badge_list(0x2A, value)},
 }
 # fmt: on
 
@@ -654,6 +706,7 @@ def prop23_test(value):
     "variant_group":                {"size": 2, "num": 0x20},
     "extra_flags":                  {"size": 4, "num": 0x21},
     "acceleration":                 {"size": 1, "num": 0x24},
+    "badges":                       {"custom_function": lambda value: badge_list(0x26, value)},
 }
 # fmt: on
 
@@ -715,6 +768,7 @@ def aircraft_is_large(value):
     "range":                        {"size": 2, "num": 0x1F},
     "variant_group":                {"size": 2, "num": 0x20},
     "extra_flags":                  {"size": 4, "num": 0x21},
+    "badges":                       {"custom_function": lambda value: badge_list(0x24, value)},
 }
 # fmt: on
 
@@ -857,6 +911,7 @@ def station_tile_list(value, prop_num, description):
     "name":                  {"size": 2, "num": (256, -1, 0x1C), "string": (256, 0xC5, 0xDC), "required": True},
     "classname":             {"size": 2, "num": (256, -1, 0x1D), "string": (256, 0xC4, 0xDC)},
     "tile_flags":            {"custom_function": station_tile_flags},  # = prop 1E
+    "badges":                {"custom_function": lambda value: badge_list(0x1F, value)},
     "heights":               {"custom_function": lambda x: station_tile_list(x, 0x20, "Station height")},
     "blocked_pillars":       {"custom_function": lambda x: station_tile_list(x, 0x21, "Station blocked pillar")},
 }
@@ -1067,6 +1122,7 @@ def mt_house_class(value, num_ids, size_bit):
         "multitile_function": mt_house_same,
         "custom_function": lambda *values: accepted_cargos(0x23, *values),
     },
+    "badges":                  {"custom_function": lambda value: badge_list(0x24, value)},
 }
 # fmt: on
 
@@ -1088,6 +1144,7 @@ def mt_house_class(value, num_ids, size_bit):
     "animation_triggers":  {"size": 1, "num": 0x11},
     "special_flags":       {"size": 1, "num": 0x12},
     "accepted_cargos":     {"custom_function": lambda value: accepted_cargos(0x13, value)},
+    "badges":              {"custom_function": lambda value: badge_list(0x14, value)},
 }
 # fmt: on
 
@@ -1360,6 +1417,7 @@ def check_accept(acp):
     "nearby_station_name":    {"size": 2, "num": 0x24, "string": 0xDC},
     # prop 25+26+27+28 combined in one structure
     "cargo_types":            {"custom_function": industry_cargo_types},
+    "badges":                 {"custom_function": lambda value: badge_list(0x29, value)},
 }
 # fmt: on
 
@@ -1463,6 +1521,7 @@ def airport_layouts(value):
     "noise_level":      {"size": 1, "num": 0x0F},
     "name":             {"size": 2, "num": 0x10, "string": 0xDC},
     "maintenance_cost": {"size": 2, "num": 0x11},
+    "badges":           {"custom_function": lambda value: badge_list(0x12, value)},
 }
 # fmt: on
 
@@ -1503,6 +1562,7 @@ def object_size(value):
     "height":                 {"size": 1, "num": 0x16},
     "num_views":              {"size": 1, "num": 0x17},
     "count_per_map256":       {"size": 1, "num": 0x18},
+    "badges":                 {"custom_function": lambda value: badge_list(0x19, value)},
 }
 # fmt: on
 
@@ -1549,6 +1609,7 @@ def label_list(value, prop_num, description):
     "sort_order":           {"size": 1, "num": 0x1A},
     "name":                 {"size": 2, "num": 0x1B, "string": 0xDC},
     "maintenance_cost":     {"size": 2, "num": 0x1C},
+    "badges":               {"custom_function": lambda value: badge_list(0x1E, value)},
 }
 
 #
@@ -1587,6 +1648,7 @@ def label_list(value, prop_num, description):
     "animation_info":     {"size": 2, "num": 0x0F, "value_function": animation_info},
     "animation_speed":    {"size": 1, "num": 0x10},
     "animation_triggers": {"size": 1, "num": 0x11},
+    "badges":             {"custom_function": lambda value: badge_list(0x12, value)},
 }
 
 #
@@ -1675,4 +1737,15 @@ def byte_sequence_list(value, prop_num, description, expected_count):
     "heights":                   {"custom_function": lambda x: station_tile_list(x, 0x13, "Station height")},
     "blocked_pillars":           {"custom_function": lambda x: station_tile_list(x, 0x14, "Station blocked pillar")},
     "cost_multipliers":          {"custom_function": lambda x: byte_sequence_list(x, 0x15, "Cost multipliers", 2)},
+    "badges":                    {"custom_function": lambda value: badge_list(0x16, value)},
+}
+
+#
+# Feature 0x15 (Badges)
+#
+
+properties[0x15] = {
+    'label':                     {'custom_function': lambda x: string_property(0x08, x), "required": True},
+    'flags':                     {'size': 4, 'num': 0x09},
+    'name':                      {'num': -1, 'string': None},
 }

nml/actions/action2.py

@@ -217,8 +217,9 @@ def free_references(source_action):
             free_action2_ids.append(act2.id)
 
 
-# Features using sprite groups directly: vehicles, stations, canals, cargos, railtypes, airports, roadtypes, tramtypes
-features_sprite_group = [0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x0B, 0x0D, 0x10, 0x12, 0x13]
+# Features using sprite groups directly: vehicles, stations, canals, cargos, railtypes, airports, roadtypes, tramtypes,
+# badges
+features_sprite_group = [0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x0B, 0x0D, 0x10, 0x12, 0x13, 0x15]
 # Features using sprite layouts: houses, industry tiles, objects, airport tiles, and road stops
 features_sprite_layout = [0x07, 0x09, 0x0F, 0x11, 0x14]
 # All features that need sprite sets