Ufos are objects produced by add-on programs. PCC also handles PHost's wormholes as Ufos.
The following properties are available for each Ufo. You can access them through the search and print functions, and using `ForEach', and the `Ufo(id).FIELD' context.
There are some restrictions regarding Ufos, mostly related to the fact that (using PHost's `general object' interface) there can be many Ufos with the same Id, as long as they belong to different add-on programs. PCC does not attempt to sort the Ufo list in any meaningful order. Because we can't make any assumption on the lifetime of an Ufo, a script which currently is in Ufo context can't suspend (using `Stop') - we would not know where to wake it up later. NOTE: This is not my final word, it will likely be improved.
| Color | |
|
Color of this Ufo. This value is compatible to NewMarker and its relatives | |
| Color.Ega | |
|
Color code of this Ufo. This is a value between 1 and 15, corresponding to the appropriate color slot on an EGA card. This is the value which is actually stored in the UFO file, but it is NOT compatible to the NewMarker function and its relatives | |
| Heading | |
|
Heading, a compass point. May be NULL if not known or not moving See also: Compass | |
| Heading$ | |
|
Heading in degrees, 0 to 360. May be NULL if not known. | |
| Id | |
|
Id number. Native Ufos, that's those which are actually displayed as Ufos in Winplan, have Id numbers between 1 and 1000. PHost's `General Objects' can have Ids outside this range | |
| Id2 | |
|
Real Id number, or 0. Some add-ons send their own objects, which may have different Id numbers, to Ufos to make them visible to players. This field is to support these add-ons. Currently, this field is used with PHost's wormholes, where it holds the real Id number of the wormhole, using the usual rules (even Id = entry, odd Id = exit). You can assign to this field | |
| Info1, Info2 | |
|
Up to 20 characters explanatory text for the Ufo | |
| Keep | |
|
If true, this Ufo will be kept in the starchart file and also displayed next turn. Can be assigned to | |
| LastScan | |
|
Turn when this object was last scanned | |
| Loc.X | |
|
X coordinate of center | |
| Loc.Y | |
|
Y coordinate of center | |
| Move.DX | |
|
Estimated per-turn movement in X direction. Can be assigned to. Permitted range is -500 to +500 | |
| Move.DY | |
|
Estimated per-turn movement in Y direction. Can be assigned to. Permitted range is -500 to +500 | |
| Name | |
|
Name, up to 20 characters | |
| Radius | |
|
Radius in light years | |
| Speed | |
|
Speed of the Ufo, in the form "Warp X". The official range for this value is Warp 0 to Warp 15 | |
| Speed$ | |
|
Warp factor. Official range is 0 to 15 | |
| Type | |
|
Type-code of this Ufo. This is an integer value which associates the Ufo with a particular controlling add-on program, the documentation of the add-on should contain the used Ufo types. Wormholes have type 1 | |
| Visible.Planet | |
|
How far planets can see this Ufo, in light years. 0 to 5000 | |
| Visible.Ship | |
|
How far ships can see this Ufo, in light years. 0 to 5000 | |