Resource Configuration

Resource configuration files act as relays for the GameObject resource ODF command. When multiple resources are specified in the configuration file and when the Freighter (and resource GameObject) can handle multiple resources, the Freighter will mine a given resource in this order of preference: dilithium > latinum > metal > biomatter.

Planet, LatinumNebula, and Scrap GameObjects use amt{resource} to determine the initial amount of resources, tooltips and (for the latter two classes) model sizing purposes.

All non Planet, LatinumNebula, or Scrap resource GameObjects also use amt{resource} commands to determine the initial amount of resources of this type that the GameObject has. They do not display a "resource bar" or tooltip.

If Planet, LatinumNebula, and Scrap GameObjects have more than one resource specified, their "resource bars" will appear partially emptied dependent on the ratio of dilithium to all the other resources summed (even if they aren't valid for that GameObject type).

Note that because the BZN file saves the ODF information, if amt{resource} is changed without replacing the resource GameObject ODF for the map, graphical errors can result: the resource amounts for LatinumNebula and Scrap will display resources remaining as old amt{resource} out of changed amt{resource}. Planet resource amounts can cause the "resource bar" to duplicate across the screen. Likewise, if a new resource is specified it will be considered invalid if the original ODF did not define it.

Stock Configuration ODF Commands

isInfinite

Boolean, Default: FALSE

When set to true (1), this Resource cannot be depleted. Hovering over the resource bar of the GameObject will display a different tooltip (GUI_SD_BAR_{resource string} from the Dynamic_Localized_Strings.h, if set) compared to if isInfinite = 0.

When set to false (0), this Resource can be depleted and when depleted, the GUI of the resource turns red.

miningRate

Float, Default: 10

The base rate at which Freighters mine the Resource object. Amount of resources mined from a Resource object for every second the MiningBeam is active is determined by:

For PlanetMiningBase: miningMultiplicator * lifeSpan (of the MiningBeam Ordnance) * miningRate.

For Freighters: lifeSpan (of the MiningBeam Ordnance) * miningRate.

amtMetal

Integer, Default: 0

Determines that this Resource contains this amount of metal. Determines the default color of the resource bar for Planet GameObjects (when set in the GUI files).

amtLatinum

Integer, Default: 0

Determines that this Resource contains this amount of latinum. If amtDilithium is unspecified it determines the default color of the resource bar for Scrap GameObjects (when set in the GUI files).

amtDilithium

Integer, Default: 0

Determines that this Resource contains this amount of dilithium. Determines the default color of the resource bar for Scrap GameObjects (when set in the GUI files).

amtBiomatter

Integer, Default: 0

Determines that this Resource contains this amount of biomatter. If amtMetal is unspecified it determines the default color of the resource bar for Scrap GameObjects (when set in the GUI files).

trickleAmount

Integer, Default: Null

Determines the amount of resources that must be left before the Resource is affected by trickleAmount. The Resource is treated as infinite after reaching trickleAmount.

trickleMiningRateFraction

Float, Default:

Modifies the miningRate (speed at which resources can be mined from the Resource) once maxHealth reaches trickleAmount (1.0 = 100%).

trickleminingratefraction = 0.3 // If miningRate = 10, once the command takes effect, miningRate will be reduced to 3

canHaveOrbitalStation

Boolean, Default: TRUE

When set to false (0), a PlanetMiningBase may not be built on the Resource. Only Planet GameObjects are affected by this command.