Skip to content
OpenTS Manual

FreeUnit

Changed in 0.2.0

The vehicle, infantry or aircraft type a structure gives its owner when its buildup finishes.

Specification
Applies to
BuildingType
File
rules.ini
Section
[<ObjectType ID>]
Value
UnitType, InfantryType or AircraftType
When omitted
none
rules.ini
[MYPROC]        ; example refinery BuildingType
Cost=2000       ; already includes MYHARV
FreeUnit=MYHARV ; example harvester UnitType; an InfantryType or AircraftType also works

The name is looked up among vehicle types first, then infantry types, then aircraft types, so a name used by more than one kind gives the vehicle. A name that matches none of them gives nothing.

Where the unit appears

Section titled “Where the unit appears”

A vehicle or infantryman appears on the cell south of the structure’s center, or on a free cell nearby. If no nearby cell can take it, the owner receives the unit’s Cost= in credits instead, without the owner’s price multipliers. A Harvester=yes or Weeder=yes vehicle starts harvesting; any other unit takes its type’s usual idle mission.

An aircraft appears on the structure itself, facing PoseDir=, and is set to guard. A HoverPad=yes or Helipad=yes structure docks it as if it had landed there; any other structure leaves it undocked. If the aircraft cannot be placed, the owner receives its Cost= in credits instead. A structure whose FreeUnit is an aircraft never receives a PadAircraft= aircraft, even when its own could not be placed.

When the owner receives it

Section titled “When the owner receives it”

The unit is given once, when the structure finishes its buildup. A structure present when the scenario starts gives nothing, and capturing a structure gives the new owner nothing.

Effect on the structure’s price

Section titled “Effect on the structure’s price”

Include the unit’s price in the structure’s Cost=. Naming a free unit then leaves what the structure costs to buy, what selling it refunds and what destroying it is worth unchanged, apart from a few credits of rounding under a price multiplier. It lowers the structure’s repair cost and the anger that damage to it raises. What a structure gives away gives the reduced price behind these effects, and the exception for a Cost= below what the structure gives away.

See also — production, HoverPad, PadAircraft

History

  1. Changed0.2.0In development

    Always give a structure's free unit

  2. Changed0.2.0In development

    Hand out an infantryman or an aircraft as a free unit