STNE Wiki - User contributions [en]

API:CSector

2021-01-27T22:05:10Z

Little Faeries: Completed Property-Table

{{apiMenu}}

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 [[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]]

API:CSector

2021-01-27T21:50:18Z

Little Faeries: Added Property-Table

API:CSector

2021-01-27T21:46:34Z

Little Faeries: Added Page and Creation options

Player:Little Faeries

2021-01-26T09:30:13Z

Little Faeries: Edited own Page

Little Faeries,

We are the faeries.
We are very good at using a keyboard, everyone has one character, only a few jump around to hard sometimes.

You can contact us for any questions related with things we did and the Scripting Engine.

Currently building up in EN-1

API:SPoint

2021-01-25T20:10:31Z

Little Faeries: Added Properties and Code Example

{{apiMenu}}

The SPoint structure represents a Coordinate in a 2-dimensional-grid.

It is defined with a X-Coordinate and a Y-Coordinate, both as Integers.

Example:
Var point As New SPoint(5,5);

It has also a few Functions and Properties.

{|
!Function
!Parameter
!Description
!Return
|-
|FromString
|String
|Creates a new SPoint from a String Value, e.g. "155<nowiki>|</nowiki>155"
|Returns a SPoint on success
|-
|op_Equality
|SPoint,SPoint
|Tests if the Paramaters are identic
|If the Test passes, it returns True (Boolean), otherwise False
|-
|op_Inequality
|SPoint,SPoint
|Inversion of op_Equality, tests on differencesf
|If there are differences, Return True (Boolean), otherwise False
|-
|RectangleDiff
|SPoint
|Calculates the distance to the given Point by adding the X and Y Difference.
|Returns the Distance as an Integer
|}

{|
!Property
!Description
!Return Value
|-
|X
|The X-Coordinate of the SPoint
|Returns the X-Coordinate as Integer
|-
|Y
|The Y-Coordinate of the SPoint
|Returns the Y-Coordinate as Integer
|}

Code Example:
Var pos1 As New SPoint(208,221);
Var pos2 As New SPoint(199,222);
Var pos3 As New SPoint(250,666);
If(pos1.op_Inequality(pos2,pos3)) {
WriteLine(pos2.X);
WriteLine("Inequal Points");
If(pos1.op_Equality(pos2,pos2)) {
WriteLine("pos2 is Equal to pos2");
}
}
WriteLine(pos3.Y);

Output:
199
Inequal Points
pos2 is Equal to pos2
666

[[Category:API]]

API:SPoint

2021-01-25T20:00:30Z

Little Faeries:

API:SPoint

2021-01-25T19:59:31Z

Little Faeries: Added Functions

API:SPoint

2021-01-25T19:49:44Z

Little Faeries:

API:SPoint

2021-01-25T19:44:28Z

Little Faeries: New Entry to the API-Category

{{apimenu}}

The SPoint structure represents a Coordinate in a 2-dimensional-grid.

It is defined with a X-Coordinate and a Y-Coordinate, both as Integers.

Example:
Var point As New SPoint(5,5);

It has also a few Functions and Properties.

Functions

[[Category:API]]