Class ShuttleSystem

Inheritance
System.Object
SharedShuttleSystem
ShuttleSystem
Namespace: Content.Server.Shuttles.Systems
Assembly: Content.Server.dll
Syntax
public sealed class ShuttleSystem : SharedShuttleSystem

Fields

| Improve this Doc View Source

DefaultArrivalTime

Declaration
public const float DefaultArrivalTime = null
Field Value
Type Description
System.Single
| Improve this Doc View Source

DefaultStartupTime

Declaration
public const float DefaultStartupTime = null
Field Value
Type Description
System.Single
| Improve this Doc View Source

DefaultTravelTime

Declaration
public const float DefaultTravelTime = null
Field Value
Type Description
System.Single
| Improve this Doc View Source

FTLDestinationMass

Minimum mass for an FTL destination

Declaration
public const float FTLDestinationMass = null
Field Value
Type Description
System.Single
| Improve this Doc View Source

ShuttleFTLMassThreshold

Minimum mass a grid needs to be to block a shuttle recall.

Declaration
public const float ShuttleFTLMassThreshold = null
Field Value
Type Description
System.Single
| Improve this Doc View Source

TileMassMultiplier

Declaration
public const float TileMassMultiplier = null
Field Value
Type Description
System.Single

Methods

| Improve this Doc View Source

AddFTLDestination(EntityUid, Boolean)

Adds a target for hyperspace to every shuttle console.

Declaration
public FTLDestinationComponent AddFTLDestination(EntityUid uid, bool enabled)
Parameters
Type Name Description
EntityUid uid
System.Boolean enabled
Returns
Type Description
FTLDestinationComponent
| Improve this Doc View Source

CanFTL(Nullable<EntityUid>, out Nullable<String>)

Declaration
public bool CanFTL(EntityUid? uid, out string? reason)
Parameters
Type Name Description
System.Nullable<EntityUid> uid
System.Nullable<System.String> reason
Returns
Type Description
System.Boolean
| Improve this Doc View Source

FTLDock(DockingConfig, TransformComponent)

Forces an FTL dock.

Declaration
public void FTLDock(DockingConfig config, TransformComponent shuttleXform)
Parameters
Type Name Description
DockingConfig config
TransformComponent shuttleXform
| Improve this Doc View Source

FTLTravel(EntityUid, ShuttleComponent, EntityUid, Single, Single, Boolean, Nullable<String>)

Moves a shuttle from its current position to docked on the target one. Goes through the hyperspace map while the timer is running.

Declaration
public void FTLTravel(EntityUid shuttleUid, ShuttleComponent component, EntityUid target, float startupTime = null, float hyperspaceTime = null, bool dock = false, string? priorityTag = null)
Parameters
Type Name Description
EntityUid shuttleUid
ShuttleComponent component
EntityUid target
System.Single startupTime
System.Single hyperspaceTime
System.Boolean dock
System.Nullable<System.String> priorityTag
| Improve this Doc View Source

FTLTravel(EntityUid, ShuttleComponent, EntityCoordinates, Single, Single, Nullable<String>)

Moves a shuttle from its current position to the target one. Goes through the hyperspace map while the timer is running.

Declaration
public void FTLTravel(EntityUid shuttleUid, ShuttleComponent component, EntityCoordinates coordinates, float startupTime = null, float hyperspaceTime = null, string? priorityTag = null)
Parameters
Type Name Description
EntityUid shuttleUid
ShuttleComponent component
Robust.Shared.Map.EntityCoordinates coordinates
System.Single startupTime
System.Single hyperspaceTime
System.Nullable<System.String> priorityTag
| Improve this Doc View Source

Initialize()

Declaration
public override void Initialize()
| Improve this Doc View Source

RemoveFTLDestination(EntityUid)

Declaration
public void RemoveFTLDestination(EntityUid uid)
Parameters
Type Name Description
EntityUid uid
| Improve this Doc View Source

Shutdown()

Declaration
public override void Shutdown()
| Improve this Doc View Source

Toggle(EntityUid, ShuttleComponent)

Declaration
public void Toggle(EntityUid uid, ShuttleComponent component)
Parameters
Type Name Description
EntityUid uid
ShuttleComponent component
| Improve this Doc View Source

TryFTLDock(EntityUid, ShuttleComponent, EntityUid, Nullable<String>)

Tries to dock with the target grid, otherwise falls back to proximity.

Declaration
public bool TryFTLDock(EntityUid shuttleUid, ShuttleComponent component, EntityUid targetUid, string? priorityTag = null)
Parameters
Type Name Description
EntityUid shuttleUid
ShuttleComponent component
EntityUid targetUid
System.Nullable<System.String> priorityTag
Returns
Type Description
System.Boolean
| Improve this Doc View Source

TryFTLProximity(EntityUid, ShuttleComponent, EntityUid, Nullable<TransformComponent>, Nullable<TransformComponent>)

Tries to arrive nearby without overlapping with other grids.

Declaration
public bool TryFTLProximity(EntityUid shuttleUid, ShuttleComponent component, EntityUid targetUid, TransformComponent? xform = null, TransformComponent? targetXform = null)
Parameters
Type Name Description
EntityUid shuttleUid
ShuttleComponent component
EntityUid targetUid
System.Nullable<TransformComponent> xform
System.Nullable<TransformComponent> targetXform
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Update(Single)

Declaration
public override void Update(float frameTime)
Parameters
Type Name Description
System.Single frameTime
| Improve this Doc View Source

UpdateIFFInterfaces(EntityUid, IFFComponent)

Declaration
protected override void UpdateIFFInterfaces(EntityUid gridUid, IFFComponent component)
Parameters
Type Name Description
EntityUid gridUid
IFFComponent component