API:CSector
From STNE Wiki
(Difference between revisions)
(Added Property-Table) |
(Completed Property-Table) |
||
| Line 27: | Line 27: | ||
|Coordinates | |Coordinates | ||
|The coordinates of this Sector | |The coordinates of this Sector | ||
| - | |Returns an SPoint | + | |Returns an [[API:SPoint|SPoint]] |
| + | |- | ||
| + | |Habitable | ||
| + | |Needs Testing, Guess: Tests for Radioactivity | ||
| + | |Returns an [[API:Boolean|Boolean]] | ||
| + | |- | ||
| + | |isColoniseable | ||
| + | |Tests if a player could found a Colony in the Sector | ||
| + | |Returns an [[API:Boolean|Boolean]] | ||
| + | |- | ||
| + | |isColony | ||
| + | |Tests if there is a Colony in this Sector | ||
| + | |Returns an [[API:Boolean|Boolean]]:True if the test passes | ||
| + | |- | ||
| + | |isFreeSpace | ||
| + | |Needs Testing, Guess: Tests for Space Stations and Colonies | ||
| + | |Returns an [[API:Boolean|Boolean]] | ||
| + | |- | ||
| + | |SectorID | ||
| + | |Returns the Sector-ID, this is one of few ways acquiring these | ||
| + | |Returns an [[API:Integer|Integer]] | ||
| + | |- | ||
| + | |RegionID | ||
| + | |Needs Testing, Guess: Returns IDs for Setllers-Space/Federation or Klingon Territory | ||
| + | |Returns an [[API:Integer|Integer]] | ||
| + | |- | ||
| + | |Type | ||
| + | |Returns the Type of this Field: e.g. Quantum Singularity or Standard Planet | ||
| + | |Returns an [[API:EGalaxyMapItemType|EGalaxyMapItemType]] | ||
| + | |- | ||
| + | |TypeName | ||
| + | |Returns the Name of the .Type Property | ||
| + | |Returns an [[API:String|String]] | ||
|} | |} | ||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 22:05, 27 January 2021
| Scripting Portal | Contents | API Reference | Index |
|---|
With the CSector Class, one can directly access to the actual game data, as it displays a Sector of the universe.
How to create such a Var:
Var sector As New CSector(211,222);
You can define its properties by using coordinates, this will lead the game to use the Standard-Galaxy-Map. Second possibility:
Var sector As New CSector(11111);
Every single Sector has an ID, you can use it. And third possibility: If you want to select a Sector on another map, e.g. an event-map
Var map As New SMap(map-id); Var sector As New CSector(x-coord,y-coord,map);
This Class has no Functions, but a bunch of Properties
| Property | Description | Value |
|---|---|---|
| Coordinates | The coordinates of this Sector | Returns an SPoint |
| Habitable | Needs Testing, Guess: Tests for Radioactivity | Returns an Boolean |
| isColoniseable | Tests if a player could found a Colony in the Sector | Returns an Boolean |
| isColony | Tests if there is a Colony in this Sector | Returns an Boolean:True if the test passes |
| isFreeSpace | Needs Testing, Guess: Tests for Space Stations and Colonies | Returns an Boolean |
| SectorID | Returns the Sector-ID, this is one of few ways acquiring these | Returns an Integer |
| RegionID | Needs Testing, Guess: Returns IDs for Setllers-Space/Federation or Klingon Territory | Returns an Integer |
| Type | Returns the Type of this Field: e.g. Quantum Singularity or Standard Planet | Returns an EGalaxyMapItemType |
| TypeName | Returns the Name of the .Type Property | Returns an String |
