Planet Properties

This section describes all planet properties. These can be accessed using `Planet(id).FIELD', using a `ForEach' loop, and with the search and print functions.

Many planet properties are only known for own planets. If not, they yield EMPTY, even if not explicitly stated here. Some properties are also known and remembered for planets you visit, scan or otherwise get information about.

Starbase properties are also accessible from planets and all yield EMPTY if there is no base. They are described on a different page.

Planet properties can be prefixed with `Planet.'. This makes it possible to refer to a planet property which is currently shadowed by an equally-named property of another object.

Base

One of "present", "being built" or "-", EMPTY if not known

Base.YesNo

TRUE if base present, FALSE if not. Presence of a base is also sometimes known for scanned planets

Colonists

Number of colonist clans on the planet. Also known for some scanned planets

Colonists.Change

Colonist happiness change as a string

See also: Happiness Change

Colonists.Change$

Numerical happiness change for colonists

See also: Happiness Change

Colonists.Happy

Happiness of the colonists, as a string. EMPTY if no colonists or not known

See also: Happiness

Colonists.Happy$

Numerical colonist happiness

See also: Happiness

Colonists.Supported

Number of colonist clans of your race supported by this planet (maximum population). This value depends on the planet's climate, and is EMPTY if the temperature is not known.

Note that this property always yields the maximum for your race, even if the planet belongs someone else.

Colonists.Tax

Colonist tax rate. This property can be assigned to (0 to 100)

Comment

Your comment as entered with [F9]. Since PCC 1.0.8, this is a normal property (which can, for example, be assigned to using the `:=' operator)

See also: CreateShipProperty, CreatePlanetProperty

Defense

Number of defense posts

Defense.Base.Want

Auto-build goal for starbase defense posts. Known for all planets. This property can be assigned to (0..1000)

Defense.Max

Maximum number of defense posts under current conditions. Also known for planets for which a population is known

Defense.Want

Auto-build goal for defense posts. Known for all planets. This property can be assigned to (0..1000)

Density.D

Duranium density. Also known for some scanned planets

Density.M

Molybdenum density. Also known for some scanned planets

Density.N

Neutronium density. Also known for some scanned planets

Density.T

Tritanium density. Also known for some scanned planets

Factories

Number of factories

Factories.Max

Maximum number of factories under current conditions. Also known for planets for which a population is known

Factories.Want

Auto-build goal for factories. Known for all planets. This property can be assigned to (0..1000)

FCode

The friendly code. This property can be assigned to.

Ground.D

Duranium in ground. Also known for some scanned planets

Ground.M

Molybdenum in ground. Also known for some scanned planets

Ground.N

Neutronium in ground. Also known for some scanned planets

Ground.T

Tritanium in ground. Also known for some scanned planets

Id

Id number

Industry

Industry level, in English

See also: Industry Levels

Industry$

Industry level, number between 0 and 5

See also: Industry Levels

Level

Experience level, if PHost experience system in use and level is known. EMPTY otherwise.

Level.Gain

Experience level gain, if PHost experience system in use. For ships, honors a possible Training mission. For planets, honors the planet's happiness. For both, includes general aging. EMPTY if not applicable.

Level.Name

Name of experience level, if PHost experience system in use and level is known. EMPTY otherwise.

Level.Points

Experience points, if PHost experience system in use and points are known. EMPTY otherwise.

Loc.X

X coordinate. Known for all planets, except on Explore Map games (where unexplored planets count as non-existent)

Loc.Y

Y coordinate. Known for all planets, except on Explore Map games (where unexplored planets count as non-existent)

Marked

TRUE if the planet is marked, FALSE else. Known for all planets

Mined.D

Mined Duranium. Also known for some scanned planets

Mined.M

Mined Molybdenum. Also known for some scanned planets

Mined.N

Mined Neutronium. Also known for some scanned planets

Mined.Str

Mined minerals as a cargo set, e.g. "10N 30T 15D 19M".

Mined.T

Mined Tritanium. Also known for some scanned planets

Mines

Number of mineral mines

Mines.Max

Maximum number of mineral mines under current conditions. Also known for planets for which a population is known

Mines.Want

Auto-build goal for mineral mines. Known for all planets. This property can be assigned to (0..1000)

Money

Money on planet

Name

Name of the planet, known for all planets

Natives

Number of native clans on planet. Also known for some scanned planets

Natives.Change

Native happiness change as a string, EMPTY if no natives or not known

See also: Happiness Change

Natives.Change$

Numerical happiness change for natives

See also: Happiness Change

Natives.Gov

Native government type, EMPTY if no natives or not known. Known for own planets and some scanned ones

See also: Governments

Natives.Gov$

Native government, as a number (SPI, socio-political index). Also known for some scanned planets

See also: Governments

Natives.Happy

Native happiness, as a string. EMPTY if no natives or not known. Known for own planets and some scanned ones

See also: Happiness

Natives.Happy$

Native happiness, as number

See also: Happiness

Natives.Race

Native race, or "none". Known for own planets and some scanned ones

See also: Natives

Natives.Race$

Native race, or 0. Also known for some scanned planets

See also: Natives

Natives.Tax

Native tax rate. This property can be assigned to (0 to 1000)

Orbit

Number of ships in orbit

Orbit.Enemy

Number of other-race ships in orbit

Orbit.Own

Number of own ships in orbit

Owner

Owner race name, EMPTY if unowned or not known. Known for own planets and some scanned ones

Owner$

Owner of the planet, player number. 0 if unowned. Also known for some scanned planets

Owner.Adj

Owner race adjective, EMPTY if unowned or not known. Known for own planets and some scanned ones

Played

True if this unit is played, false if it is a foreign or unknown unit

Score(x)

PHost can associate various scores with ships and planets (UTIL.DAT records 49 and 50). This property makes these scores available to scripts. Valid parameters can be found in the PHost documentation. As of PHost 4.1, the following values are valid:

  • Score(1): experience level (same as `Level')
  • Score(2): experience points (same as `Level.Points')

This property yields EMPTY if the respective score does not exist or is not known.

Supplies

Supplies on planet

Temp

Climate type, one of "arctic", "cool", "warm", "tropical" or "desert". Known for own planets and some scanned ones

See also: Climate

Temp$

Temperature, in Fahrenheit degrees

See also: Climate

Type

Always "Planet" for planets. Exists for symmetry with the `Type' property for ships.

Type.Short

Always "P" for planets. Exists for symmetry with the `Type.Short' property for ships.


[ << Previous | Up | Next >> ]

Stefan Reuther <Streu@gmx.de>