Files
tbd-station-14/Content.Server/Shuttles/Systems/EmergencyShuttleSystem.cs
Pieter-Jan Briers 5a6a3371dc Extend shuttle dock time if the shuttle doesn't dock at evac. (#31496)
* Extend shuttle dock time if the shuttle doesn't dock at evac.

If the shuttle can't dock at evac for *some reason*, it will instead try to dock at another port on the station. And if that fails it goes somewhere random on the station.

Because of the chaos and confusion caused by this, many people will frequently not get to the shuttle in time under these circumstances. This sucks for everybody.

To alleviate this, the shuttle launch timer will now be extended if the station doesn't dock at its ideal spot. The default values (controlled via CVar) are 1.667x and 2x respectively for "wrong dock" and "no dock at all" scenarios.

The code around here was a mess, so I fixed that too. "CallEmergencyShuttle" has been renamed to "DockEmergencyShuttle", the overload that did the actual docking has been renamed to DockSingleEmergencyShuttle. Code has been split into separate dock -> announce methods so we can calculate shuttle delay in between the case of multiple stations.

Also made the "shuttle couldn't find a dock" text announce the time until it launches and fix the shuttle timers not triggering for it.

* Minor review

---------
2024-09-09 20:10:28 +02:00

741 lines
26 KiB
C#

using System.Linq;
using System.Numerics;
using System.Threading;
using Content.Server.Access.Systems;
using Content.Server.Administration.Logs;
using Content.Server.Administration.Managers;
using Content.Server.Chat.Systems;
using Content.Server.Communications;
using Content.Server.DeviceNetwork.Components;
using Content.Server.DeviceNetwork.Systems;
using Content.Server.GameTicking.Events;
using Content.Server.Pinpointer;
using Content.Server.Popups;
using Content.Server.RoundEnd;
using Content.Server.Screens.Components;
using Content.Server.Shuttles.Components;
using Content.Server.Shuttles.Events;
using Content.Server.Station.Components;
using Content.Server.Station.Events;
using Content.Server.Station.Systems;
using Content.Shared.Access.Systems;
using Content.Shared.CCVar;
using Content.Shared.Database;
using Content.Shared.DeviceNetwork;
using Content.Shared.GameTicking;
using Content.Shared.Localizations;
using Content.Shared.Shuttles.Components;
using Content.Shared.Shuttles.Events;
using Content.Shared.Tag;
using Content.Shared.Tiles;
using Robust.Server.GameObjects;
using Robust.Server.Maps;
using Robust.Shared.Audio.Systems;
using Robust.Shared.Configuration;
using Robust.Shared.Map;
using Robust.Shared.Map.Components;
using Robust.Shared.Player;
using Robust.Shared.Random;
using Robust.Shared.Timing;
using Robust.Shared.Utility;
namespace Content.Server.Shuttles.Systems;
public sealed partial class EmergencyShuttleSystem : EntitySystem
{
/*
* Handles the escape shuttle + CentCom.
*/
[Dependency] private readonly IAdminLogManager _logger = default!;
[Dependency] private readonly IAdminManager _admin = default!;
[Dependency] private readonly IConfigurationManager _configManager = default!;
[Dependency] private readonly IGameTiming _timing = default!;
[Dependency] private readonly IRobustRandom _random = default!;
[Dependency] private readonly SharedMapSystem _mapSystem = default!;
[Dependency] private readonly AccessReaderSystem _reader = default!;
[Dependency] private readonly ChatSystem _chatSystem = default!;
[Dependency] private readonly CommunicationsConsoleSystem _commsConsole = default!;
[Dependency] private readonly DeviceNetworkSystem _deviceNetworkSystem = default!;
[Dependency] private readonly DockingSystem _dock = default!;
[Dependency] private readonly IdCardSystem _idSystem = default!;
[Dependency] private readonly NavMapSystem _navMap = default!;
[Dependency] private readonly MapLoaderSystem _map = default!;
[Dependency] private readonly MetaDataSystem _metaData = default!;
[Dependency] private readonly PopupSystem _popup = default!;
[Dependency] private readonly RoundEndSystem _roundEnd = default!;
[Dependency] private readonly SharedAudioSystem _audio = default!;
[Dependency] private readonly ShuttleSystem _shuttle = default!;
[Dependency] private readonly StationSystem _station = default!;
[Dependency] private readonly TransformSystem _transformSystem = default!;
[Dependency] private readonly UserInterfaceSystem _uiSystem = default!;
private const float ShuttleSpawnBuffer = 1f;
private bool _emergencyShuttleEnabled;
[ValidatePrototypeId<TagPrototype>]
private const string DockTag = "DockEmergency";
public override void Initialize()
{
_emergencyShuttleEnabled = _configManager.GetCVar(CCVars.EmergencyShuttleEnabled);
// Don't immediately invoke as roundstart will just handle it.
Subs.CVar(_configManager, CCVars.EmergencyShuttleEnabled, SetEmergencyShuttleEnabled);
SubscribeLocalEvent<RoundStartingEvent>(OnRoundStart);
SubscribeLocalEvent<RoundRestartCleanupEvent>(OnRoundCleanup);
SubscribeLocalEvent<StationEmergencyShuttleComponent, StationPostInitEvent>(OnStationStartup);
SubscribeLocalEvent<StationCentcommComponent, ComponentShutdown>(OnCentcommShutdown);
SubscribeLocalEvent<StationCentcommComponent, MapInitEvent>(OnStationInit);
SubscribeLocalEvent<EmergencyShuttleComponent, FTLStartedEvent>(OnEmergencyFTL);
SubscribeLocalEvent<EmergencyShuttleComponent, FTLCompletedEvent>(OnEmergencyFTLComplete);
SubscribeNetworkEvent<EmergencyShuttleRequestPositionMessage>(OnShuttleRequestPosition);
InitializeEmergencyConsole();
}
private void OnRoundStart(RoundStartingEvent ev)
{
CleanupEmergencyConsole();
_roundEndCancelToken = new CancellationTokenSource();
}
private void OnRoundCleanup(RoundRestartCleanupEvent ev)
{
_roundEndCancelToken?.Cancel();
_roundEndCancelToken = null;
}
private void OnCentcommShutdown(EntityUid uid, StationCentcommComponent component, ComponentShutdown args)
{
ClearCentcomm(component);
}
private void ClearCentcomm(StationCentcommComponent component)
{
QueueDel(component.Entity);
QueueDel(component.MapEntity);
component.Entity = null;
component.MapEntity = null;
}
/// <summary>
/// Attempts to get the EntityUid of the emergency shuttle
/// </summary>
public EntityUid? GetShuttle()
{
AllEntityQuery<EmergencyShuttleComponent>().MoveNext(out var shuttle, out _);
return shuttle;
}
private void SetEmergencyShuttleEnabled(bool value)
{
if (_emergencyShuttleEnabled == value)
return;
_emergencyShuttleEnabled = value;
if (value)
{
SetupEmergencyShuttle();
}
else
{
CleanupEmergencyShuttle();
}
}
private void CleanupEmergencyShuttle()
{
var query = AllEntityQuery<StationCentcommComponent>();
while (query.MoveNext(out var uid, out _))
{
RemCompDeferred<StationCentcommComponent>(uid);
}
}
public override void Update(float frameTime)
{
base.Update(frameTime);
UpdateEmergencyConsole(frameTime);
}
/// <summary>
/// If the client is requesting debug info on where an emergency shuttle would dock.
/// </summary>
private void OnShuttleRequestPosition(EmergencyShuttleRequestPositionMessage msg, EntitySessionEventArgs args)
{
if (!_admin.IsAdmin(args.SenderSession))
return;
var player = args.SenderSession.AttachedEntity;
if (player is null)
return;
var station = _station.GetOwningStation(player.Value);
if (!TryComp<StationEmergencyShuttleComponent>(station, out var stationShuttle) ||
!HasComp<ShuttleComponent>(stationShuttle.EmergencyShuttle))
{
return;
}
var targetGrid = _station.GetLargestGrid(Comp<StationDataComponent>(station.Value));
if (targetGrid == null)
return;
var config = _dock.GetDockingConfig(stationShuttle.EmergencyShuttle.Value, targetGrid.Value, DockTag);
if (config == null)
return;
RaiseNetworkEvent(new EmergencyShuttlePositionMessage()
{
StationUid = GetNetEntity(targetGrid),
Position = config.Area,
});
}
/// <summary>
/// Escape shuttle FTL event handler. The only escape shuttle FTL transit should be from station to centcomm at round end
/// </summary>
private void OnEmergencyFTL(EntityUid uid, EmergencyShuttleComponent component, ref FTLStartedEvent args)
{
var ftlTime = TimeSpan.FromSeconds
(
TryComp<FTLComponent>(uid, out var ftlComp) ? ftlComp.TravelTime : _shuttle.DefaultTravelTime
);
if (TryComp<DeviceNetworkComponent>(uid, out var netComp))
{
var payload = new NetworkPayload
{
[ShuttleTimerMasks.ShuttleMap] = uid,
[ShuttleTimerMasks.SourceMap] = args.FromMapUid,
[ShuttleTimerMasks.DestMap] = _transformSystem.GetMap(args.TargetCoordinates),
[ShuttleTimerMasks.ShuttleTime] = ftlTime,
[ShuttleTimerMasks.SourceTime] = ftlTime,
[ShuttleTimerMasks.DestTime] = ftlTime
};
_deviceNetworkSystem.QueuePacket(uid, null, payload, netComp.TransmitFrequency);
}
}
/// <summary>
/// When the escape shuttle finishes FTL (docks at centcomm), have the timers display the round end countdown
/// </summary>
private void OnEmergencyFTLComplete(EntityUid uid, EmergencyShuttleComponent component, ref FTLCompletedEvent args)
{
var countdownTime = TimeSpan.FromSeconds(_configManager.GetCVar(CCVars.RoundRestartTime));
var shuttle = args.Entity;
if (TryComp<DeviceNetworkComponent>(shuttle, out var net))
{
var payload = new NetworkPayload
{
[ShuttleTimerMasks.ShuttleMap] = shuttle,
[ShuttleTimerMasks.SourceMap] = _roundEnd.GetCentcomm(),
[ShuttleTimerMasks.DestMap] = _roundEnd.GetStation(),
[ShuttleTimerMasks.ShuttleTime] = countdownTime,
[ShuttleTimerMasks.SourceTime] = countdownTime,
[ShuttleTimerMasks.DestTime] = countdownTime,
};
// by popular request
// https://discord.com/channels/310555209753690112/770682801607278632/1189989482234126356
if (_random.Next(1000) == 0)
{
payload.Add(ScreenMasks.Text, ShuttleTimerMasks.Kill);
payload.Add(ScreenMasks.Color, Color.Red);
}
else
payload.Add(ScreenMasks.Text, ShuttleTimerMasks.Bye);
_deviceNetworkSystem.QueuePacket(shuttle, null, payload, net.TransmitFrequency);
}
}
/// <summary>
/// Attempts to dock a station's emergency shuttle.
/// </summary>
/// <seealso cref="DockEmergencyShuttle"/>
public ShuttleDockResult? DockSingleEmergencyShuttle(EntityUid stationUid, StationEmergencyShuttleComponent? stationShuttle = null)
{
if (!Resolve(stationUid, ref stationShuttle))
return null;
if (!TryComp(stationShuttle.EmergencyShuttle, out TransformComponent? xform) ||
!TryComp<ShuttleComponent>(stationShuttle.EmergencyShuttle, out var shuttle))
{
Log.Error($"Attempted to call an emergency shuttle for an uninitialized station? Station: {ToPrettyString(stationUid)}. Shuttle: {ToPrettyString(stationShuttle.EmergencyShuttle)}");
return null;
}
var targetGrid = _station.GetLargestGrid(Comp<StationDataComponent>(stationUid));
// UHH GOOD LUCK
if (targetGrid == null)
{
_logger.Add(
LogType.EmergencyShuttle,
LogImpact.High,
$"Emergency shuttle {ToPrettyString(stationUid)} unable to dock with station {ToPrettyString(stationUid)}");
return new ShuttleDockResult
{
Station = (stationUid, stationShuttle),
ResultType = ShuttleDockResultType.GoodLuck,
};
}
ShuttleDockResultType resultType;
if (_shuttle.TryFTLDock(stationShuttle.EmergencyShuttle.Value, shuttle, targetGrid.Value, out var config, DockTag))
{
_logger.Add(
LogType.EmergencyShuttle,
LogImpact.High,
$"Emergency shuttle {ToPrettyString(stationUid)} docked with stations");
resultType = _dock.IsConfigPriority(config, DockTag)
? ShuttleDockResultType.PriorityDock
: ShuttleDockResultType.OtherDock;
}
else
{
_logger.Add(
LogType.EmergencyShuttle,
LogImpact.High,
$"Emergency shuttle {ToPrettyString(stationUid)} unable to find a valid docking port for {ToPrettyString(stationUid)}");
resultType = ShuttleDockResultType.NoDock;
}
return new ShuttleDockResult
{
Station = (stationUid, stationShuttle),
DockingConfig = config,
ResultType = resultType,
TargetGrid = targetGrid,
};
}
/// <summary>
/// Do post-shuttle-dock setup. Announce to the crew and set up shuttle timers.
/// </summary>
public void AnnounceShuttleDock(ShuttleDockResult result, bool extended)
{
var shuttle = result.Station.Comp.EmergencyShuttle;
DebugTools.Assert(shuttle != null);
if (result.ResultType == ShuttleDockResultType.GoodLuck)
{
_chatSystem.DispatchStationAnnouncement(
result.Station,
Loc.GetString("emergency-shuttle-good-luck"),
playDefaultSound: false);
// TODO: Need filter extensions or something don't blame me.
_audio.PlayGlobal("/Audio/Misc/notice1.ogg", Filter.Broadcast(), true);
return;
}
DebugTools.Assert(result.TargetGrid != null);
// Send station announcement.
var targetXform = Transform(result.TargetGrid.Value);
var angle = _dock.GetAngle(
shuttle.Value,
Transform(shuttle.Value),
result.TargetGrid.Value,
targetXform);
var direction = ContentLocalizationManager.FormatDirection(angle.GetDir());
var location = FormattedMessage.RemoveMarkupPermissive(
_navMap.GetNearestBeaconString((shuttle.Value, Transform(shuttle.Value))));
var extendedText = extended ? Loc.GetString("emergency-shuttle-extended") : "";
var locKey = result.ResultType == ShuttleDockResultType.NoDock
? "emergency-shuttle-nearby"
: "emergency-shuttle-docked";
_chatSystem.DispatchStationAnnouncement(
result.Station,
Loc.GetString(
locKey,
("time", $"{_consoleAccumulator:0}"),
("direction", direction),
("location", location),
("extended", extendedText)),
playDefaultSound: false);
// Trigger shuttle timers on the shuttle.
var time = TimeSpan.FromSeconds(_consoleAccumulator);
if (TryComp<DeviceNetworkComponent>(shuttle, out var netComp))
{
var payload = new NetworkPayload
{
[ShuttleTimerMasks.ShuttleMap] = shuttle,
[ShuttleTimerMasks.SourceMap] = targetXform.MapUid,
[ShuttleTimerMasks.DestMap] = _roundEnd.GetCentcomm(),
[ShuttleTimerMasks.ShuttleTime] = time,
[ShuttleTimerMasks.SourceTime] = time,
[ShuttleTimerMasks.DestTime] = time + TimeSpan.FromSeconds(TransitTime),
[ShuttleTimerMasks.Docked] = true,
};
_deviceNetworkSystem.QueuePacket(shuttle.Value, null, payload, netComp.TransmitFrequency);
}
// Play announcement audio.
var audioFile = result.ResultType == ShuttleDockResultType.NoDock
? "/Audio/Misc/notice1.ogg"
: "/Audio/Announcements/shuttle_dock.ogg";
// TODO: Need filter extensions or something don't blame me.
_audio.PlayGlobal(audioFile, Filter.Broadcast(), true);
}
private void OnStationInit(EntityUid uid, StationCentcommComponent component, MapInitEvent args)
{
// This is handled on map-init, so that centcomm has finished initializing by the time the StationPostInitEvent
// gets raised
if (!_emergencyShuttleEnabled)
return;
// Post mapinit? fancy
if (TryComp(component.Entity, out TransformComponent? xform))
{
component.MapEntity = xform.MapUid;
return;
}
AddCentcomm(uid, component);
}
private void OnStationStartup(Entity<StationEmergencyShuttleComponent> ent, ref StationPostInitEvent args)
{
AddEmergencyShuttle((ent, ent));
}
/// <summary>
/// Teleports the emergency shuttle to its station and starts the countdown until it launches.
/// </summary>
/// <remarks>
/// If the emergency shuttle is disabled, this immediately ends the round.
/// </remarks>
public void DockEmergencyShuttle()
{
if (EmergencyShuttleArrived)
return;
if (!_emergencyShuttleEnabled)
{
_roundEnd.EndRound();
return;
}
_consoleAccumulator = _configManager.GetCVar(CCVars.EmergencyShuttleDockTime);
EmergencyShuttleArrived = true;
var query = AllEntityQuery<StationEmergencyShuttleComponent>();
var dockResults = new List<ShuttleDockResult>();
while (query.MoveNext(out var uid, out var comp))
{
if (DockSingleEmergencyShuttle(uid, comp) is { } dockResult)
dockResults.Add(dockResult);
}
// Make the shuttle wait longer if it couldn't dock in the normal spot.
// We have to handle the possibility of there being multiple stations, so since the shuttle timer is global,
// use the WORST value we have.
var worstResult = dockResults.Max(x => x.ResultType);
var multiplier = worstResult switch
{
ShuttleDockResultType.OtherDock => _configManager.GetCVar(
CCVars.EmergencyShuttleDockTimeMultiplierOtherDock),
ShuttleDockResultType.NoDock => _configManager.GetCVar(
CCVars.EmergencyShuttleDockTimeMultiplierNoDock),
// GoodLuck doesn't get a multiplier.
// Quite frankly at that point the round is probably so fucked that you'd rather it be over ASAP.
_ => 1,
};
_consoleAccumulator *= multiplier;
foreach (var shuttleDockResult in dockResults)
{
AnnounceShuttleDock(shuttleDockResult, multiplier > 1);
}
_commsConsole.UpdateCommsConsoleInterface();
}
private void SetupEmergencyShuttle()
{
if (!_emergencyShuttleEnabled)
return;
var centcommQuery = AllEntityQuery<StationCentcommComponent>();
while (centcommQuery.MoveNext(out var uid, out var centcomm))
{
AddCentcomm(uid, centcomm);
}
var query = AllEntityQuery<StationEmergencyShuttleComponent>();
while (query.MoveNext(out var uid, out var comp))
{
AddEmergencyShuttle((uid, comp));
}
}
private void AddCentcomm(EntityUid station, StationCentcommComponent component)
{
DebugTools.Assert(LifeStage(station) >= EntityLifeStage.MapInitialized);
if (component.MapEntity != null || component.Entity != null)
{
Log.Warning("Attempted to re-add an existing centcomm map.");
return;
}
// Check for existing centcomms and just point to that
var query = AllEntityQuery<StationCentcommComponent>();
while (query.MoveNext(out var otherComp))
{
if (otherComp == component)
continue;
if (!Exists(otherComp.MapEntity) || !Exists(otherComp.Entity))
{
Log.Error($"Discovered invalid centcomm component?");
ClearCentcomm(otherComp);
continue;
}
component.MapEntity = otherComp.MapEntity;
component.Entity = otherComp.Entity;
component.ShuttleIndex = otherComp.ShuttleIndex;
return;
}
if (string.IsNullOrEmpty(component.Map.ToString()))
{
Log.Warning("No CentComm map found, skipping setup.");
return;
}
var map = _mapSystem.CreateMap(out var mapId);
var grid = _map.LoadGrid(mapId, component.Map.ToString(), new MapLoadOptions()
{
LoadMap = false,
});
if (!Exists(map))
{
Log.Error($"Failed to set up centcomm map!");
QueueDel(grid);
return;
}
if (!Exists(grid))
{
Log.Error($"Failed to set up centcomm grid!");
QueueDel(map);
return;
}
var xform = Transform(grid.Value);
if (xform.ParentUid != map || xform.MapUid != map)
{
Log.Error($"Centcomm grid is not parented to its own map?");
QueueDel(map);
QueueDel(grid);
return;
}
component.MapEntity = map;
_metaData.SetEntityName(map, Loc.GetString("map-name-centcomm"));
component.Entity = grid;
_shuttle.TryAddFTLDestination(mapId, true, out _);
Log.Info($"Created centcomm grid {ToPrettyString(grid)} on map {ToPrettyString(map)} for station {ToPrettyString(station)}");
}
public HashSet<EntityUid> GetCentcommMaps()
{
var query = AllEntityQuery<StationCentcommComponent>();
var maps = new HashSet<EntityUid>(Count<StationCentcommComponent>());
while (query.MoveNext(out var comp))
{
if (comp.MapEntity != null)
maps.Add(comp.MapEntity.Value);
}
return maps;
}
private void AddEmergencyShuttle(Entity<StationEmergencyShuttleComponent?, StationCentcommComponent?> ent)
{
if (!Resolve(ent.Owner, ref ent.Comp1, ref ent.Comp2))
return;
if (!_emergencyShuttleEnabled)
return;
if (ent.Comp1.EmergencyShuttle != null)
{
if (Exists(ent.Comp1.EmergencyShuttle))
{
Log.Error($"Attempted to add an emergency shuttle to {ToPrettyString(ent)}, despite a shuttle already existing?");
return;
}
Log.Error($"Encountered deleted emergency shuttle during initialization of {ToPrettyString(ent)}");
ent.Comp1.EmergencyShuttle = null;
}
if (!TryComp(ent.Comp2.MapEntity, out MapComponent? map))
{
Log.Error($"Failed to add emergency shuttle - centcomm has not been initialized? {ToPrettyString(ent)}");
return;
}
// Load escape shuttle
var shuttlePath = ent.Comp1.EmergencyShuttlePath;
var shuttle = _map.LoadGrid(map.MapId, shuttlePath.ToString(), new MapLoadOptions()
{
// Should be far enough... right? I'm too lazy to bounds check CentCom rn.
Offset = new Vector2(500f + ent.Comp2.ShuttleIndex, 0f),
// fun fact: if you just fucking yeet centcomm into nullspace anytime you try to spawn the shuttle, then any distance is far enough. so lets not do that
LoadMap = false,
});
if (shuttle == null)
{
Log.Error($"Unable to spawn emergency shuttle {shuttlePath} for {ToPrettyString(ent)}");
return;
}
ent.Comp2.ShuttleIndex += Comp<MapGridComponent>(shuttle.Value).LocalAABB.Width + ShuttleSpawnBuffer;
// Update indices for all centcomm comps pointing to same map
var query = AllEntityQuery<StationCentcommComponent>();
while (query.MoveNext(out var comp))
{
if (comp == ent.Comp2 || comp.MapEntity != ent.Comp2.MapEntity)
continue;
comp.ShuttleIndex = ent.Comp2.ShuttleIndex;
}
ent.Comp1.EmergencyShuttle = shuttle;
EnsureComp<ProtectedGridComponent>(shuttle.Value);
EnsureComp<PreventPilotComponent>(shuttle.Value);
EnsureComp<EmergencyShuttleComponent>(shuttle.Value);
Log.Info($"Added emergency shuttle {ToPrettyString(shuttle)} for station {ToPrettyString(ent)} and centcomm {ToPrettyString(ent.Comp2.Entity)}");
}
/// <summary>
/// Returns whether a target is escaping on the emergency shuttle, but only if evac has arrived.
/// </summary>
public bool IsTargetEscaping(EntityUid target)
{
// if evac isn't here then sitting in a pod doesn't return true
if (!EmergencyShuttleArrived)
return false;
// check each emergency shuttle
var xform = Transform(target);
foreach (var stationData in EntityQuery<StationEmergencyShuttleComponent>())
{
if (stationData.EmergencyShuttle == null)
continue;
if (IsOnGrid(xform, stationData.EmergencyShuttle.Value))
{
return true;
}
}
return false;
}
private bool IsOnGrid(TransformComponent xform, EntityUid shuttle, MapGridComponent? grid = null, TransformComponent? shuttleXform = null)
{
if (!Resolve(shuttle, ref grid, ref shuttleXform))
return false;
return _transformSystem.GetWorldMatrix(shuttleXform).TransformBox(grid.LocalAABB).Contains(_transformSystem.GetWorldPosition(xform));
}
/// <summary>
/// A result of a shuttle dock operation done by <see cref="EmergencyShuttleSystem.DockSingleEmergencyShuttle"/>.
/// </summary>
/// <seealso cref="ShuttleDockResultType"/>
public sealed class ShuttleDockResult
{
/// <summary>
/// The station for which the emergency shuttle got docked.
/// </summary>
public Entity<StationEmergencyShuttleComponent> Station;
/// <summary>
/// The target grid of the station that the shuttle tried to dock to.
/// </summary>
/// <remarks>
/// Not present if <see cref="ResultType"/> is <see cref="ShuttleDockResultType.GoodLuck"/>.
/// </remarks>
public EntityUid? TargetGrid;
/// <summary>
/// Enum code describing the dock result.
/// </summary>
public ShuttleDockResultType ResultType;
/// <summary>
/// The docking config used to actually dock to the station.
/// </summary>
/// <remarks>
/// Only present if <see cref="ResultType"/> is <see cref="ShuttleDockResultType.PriorityDock"/>
/// or <see cref="ShuttleDockResultType.NoDock"/>.
/// </remarks>
public DockingConfig? DockingConfig;
}
/// <summary>
/// Emergency shuttle dock result codes used by <see cref="ShuttleDockResult"/>.
/// </summary>
public enum ShuttleDockResultType : byte
{
// This enum is ordered from "best" to "worst". This is used to sort the results.
/// <summary>
/// The shuttle was docked at a priority dock, which is the intended destination.
/// </summary>
PriorityDock,
/// <summary>
/// The shuttle docked at another dock on the station then the intended priority dock.
/// </summary>
OtherDock,
/// <summary>
/// The shuttle couldn't find any suitable dock on the station at all, it did not dock.
/// </summary>
NoDock,
/// <summary>
/// No station grid was found at all, shuttle did not get moved.
/// </summary>
GoodLuck,
}
}