Variable; Build - HWRM/KarosGraveyard GitHub Wiki

Syntax

  • To be completed.

Description

  • The variables defined in the entries in the build.lua file specify the different units that can be built for a particular race, as well as any requirements to build those units.

Example

{
Type = Ship,
ThingToBuild = "Hgn_IonTurret",
RequiredResearch = "PlatformIonWeapons",
RequiredShipSubSystems = "PlatformProduction",
DisplayPriority = 2,
DisplayedName = "$7064",
Description = "$7065",
},

Variables

  • Type = <sType>: The type of the unit. Possible values are: Ship and SubSystem.
  • ThingToBuild = <sUnitName>: The unit to be built. The value is the base name of the ".ship" file. For example, the Hiigaran Ion Turret has a .ship file name of hgn_ionturret.ship, and thus ThingToBuild would have a value of Hgn_IonTurret.
  • RequiredResearch = <sResearch>: The names of any research required before this item can be built. <sResearch> can be a list of multiple items, with "or" and "and" statements, represented by | and &, respectively. You can also use ! to negate a term and ( and ) to control operator precedence. See RequiredSubSystems for an example.
  • RequiredSubSystems = <sSubsystems>: The names of any subsystems required before this item can be built. <sSubsystems> can be a list of multiple items, with "or" and "and" statements, represented by | and &, respectively. You can also use ! to negate a term and ( and ) to control operator precedence. For example, if a unit requires the Research subsystem or the AdvancedResearch subsystem, and the FrigateProduction subsystem in order to be built, RequiredShipSubSystems would have a value of "Research | AdvancedResearch & FrigateProduction".
  • DisplayPriority = <iPriority>: Determines the order in which the units are displayed in the Build Manager. It is important to note that no units within the same family can have the same DisplayPriority value. If they do, only one of the units will be displayed. Units in different families can have the same DisplayPriority value.
  • DisplayedName = <sName>: The name of the unit that is displayed in the Build Manager. Normally, the name is a reference to text in the buildresearch.ucs file, referenced by using a value of "$1234", where 1234 is some number. You may also input a normal text string if you wish.
  • Description = <sDescription>: The description of the unit. See DisplayedName regarding the value.

Related Pages

Variable Reference

Comments

Page Status

Updated Formatting? Yes
Updated for HWRM? Initial

⚠️ **GitHub.com Fallback** ⚠️