RemoteTech

https://remotetechnologiesgroup.github.io/RemoteTech/
Admin
RemoteTech is a modification for Kerbal Space Program that overhauls unmanned spaceflight by...
Tokens:30,981
Snippets:194
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### bool API.HasFlightComputer(Guid id)

Source: https://remotetechnologiesgroup.github.io/RemoteTech/modders/api

Tests whether a vessel has a flight computer on board.

```APIDOC
## bool API.HasFlightComputer(Guid id)

### Description
Tests whether a vessel has a flight computer on board.

### Method
Function call

### Parameters
- **id** (Guid) - Required - The pid value of the vessel being tested.

### Return Value
True if `id` is the id of a known vessel with a flight computer; false otherwise. In particular, returns false if `id` is not a vessel.

### Exception Guarantee
Does not throw exceptions.
```

--------------------------------

### bool API.HasAnyConnection(Guid id)

Source: https://remotetechnologiesgroup.github.io/RemoteTech/modders/api

Tests whether a vessel can receive commands from a ground station or command station.

```APIDOC
## bool API.HasAnyConnection(Guid id)

### Description
Tests whether a vessel can receive commands from a ground station or command station.

### Method
Function call

### Parameters
- **id** (Guid) - Required - The pid value of the vessel being tested.

### Return Value
True if `id` is the id of a known vessel with a working connection; false otherwise. In particular, returns false if `id` is not a vessel.

### Exception Guarantee
Does not throw exceptions.
```

--------------------------------

### bool API.HasConnectionToKSC(Guid id)

Source: https://remotetechnologiesgroup.github.io/RemoteTech/modders/api

Tests whether a vessel can transmit science data to a ground station.

```APIDOC
## bool API.HasConnectionToKSC(Guid id)

### Description
Tests whether a vessel can transmit science data to a ground station. Despite the name, if the game has multiple ground stations then any of them will qualify.

### Method
Function call

### Parameters
- **id** (Guid) - Required - The pid value of the vessel being tested.

### Return Value
True if `id` is the id of a known vessel with a working connection to a ground station; false otherwise. In particular, returns false if `id` is not a vessel, or if the vessel designated by `id` can connect only to a vessel command station.

### Exception Guarantee
Does not throw exceptions.
```

--------------------------------

### void API.AddSanctionedPilot(Guid id, Action<FlightCtrlState> autopilot)

Source: https://remotetechnologiesgroup.github.io/RemoteTech/modders/api

Allows an external function to bypass signal delay and apply control input to a vessel in real time.

```APIDOC
## void API.AddSanctionedPilot(Guid id, Action<FlightCtrlState> autopilot)

### Description
Allows an external function to bypass signal delay and apply control input to a vessel in real time.

### Method
Function call

### Parameters
- **id** (Guid) - Required - The pid value of the vessel being controlled.
- **autopilot** (Action<FlightCtrlState>) - Required - A function that takes a `FlightCtrlState` as an argument and updates it according to a piloting algorithm.

### PostCondition
All flight computers on board vessel `id` will allow `autopilot` real-time control of the vessel. `autopilot` will be run _after_ RemoteTech’s flight computer has made its own changes to a vessel’s controls.

### Exception Guarantee
Atomic guarantee: the program state in the event of an exception is unchanged from before the function call.
```

--------------------------------

### double API.GetSignalDelayToKSC(Guid id)

Source: https://remotetechnologiesgroup.github.io/RemoteTech/modders/api

Measures the signal delay experienced by a vessel were commands to be sent from a ground station.

```APIDOC
## double API.GetSignalDelayToKSC(Guid id)

### Description
Measures the signal delay experienced by a vessel were commands to be sent from a ground station. Despite the name, if the game has multiple ground stations then any of them will qualify.

### Method
Function call

### Parameters
- **id** (Guid) - Required - The pid value of the vessel whose signal delay is desired.

### Return Value
The number of seconds of signal delay introduced.

### Exception Guarantee
Atomic guarantee: the program state in the event of an exception is unchanged from before the function call.
```

--------------------------------

### double API.GetSignalDelayToSatellite(Guid a, Guid b)

Source: https://remotetechnologiesgroup.github.io/RemoteTech/modders/api

Measures the signal delay between two arbitrary vessels or ground stations.

```APIDOC
## double API.GetSignalDelayToSatellite(Guid a, Guid b)

### Description
Measures the signal delay between two arbitrary vessels or ground stations.

### Method
Function call

### Parameters
- **a** (Guid) - Required - The pid value of the first vessel or ground station.
- **b** (Guid) - Required - The pid value of the second vessel or ground station.

### Return Value
The number of seconds of signal delay introduced.

### Exception Guarantee
Atomic guarantee: the program state in the event of an exception is unchanged from before the function call.
```

--------------------------------

### Precedence order with FOR prefixes

Source: https://remotetechnologiesgroup.github.io/RemoteTech/modders/settings

Three patches showing lexicographic ordering: AsteroidFactory, zSuperRangeAntennas, and zzSolarSystem. The z prefix ensures the SuperRangeAntennas patch is applied between the other two.

```plaintext
@RemoteTechSettings:FOR[AsteroidFactory] {...}
```

```plaintext
@RemoteTechSettings:FOR[zSuperRangeAntennas] {...}
```

```plaintext
@RemoteTechSettings:FOR[zzSolarSystem] {...}
```

--------------------------------

### double API.GetShortestSignalDelay(Guid id)

Source: https://remotetechnologiesgroup.github.io/RemoteTech/modders/api

Measures the signal delay experienced by a vessel when sending commands.

```APIDOC
## double API.GetShortestSignalDelay(Guid id)

### Description
Measures the signal delay experienced by a vessel when sending commands.

### Method
Function call

### Parameters
- **id** (Guid) - Required - The pid value of the vessel whose signal delay is desired.

### Return Value
The number of seconds of signal delay introduced.

### Exception Guarantee
Atomic guarantee: the program state in the event of an exception is unchanged from before the function call.
```
Tokens:
Raw