Class DockingSystem

Inheritance

System.Object

DockingSystem

Namespace: Content.Server.Shuttles.Systems

Assembly: Content.Server.dll

Syntax

public sealed class DockingSystem : EntitySystem

Methods

| Improve this Doc View Source

CanDock(DockingComponent, TransformComponent, DockingComponent, TransformComponent, Box2, Angle, FixturesComponent, MapGridComponent, Boolean, out Matrix3, out Box2, out Angle)

Checks if 2 docks can be connected by moving the shuttle directly onto docks.

Declaration

public bool CanDock(DockingComponent shuttleDock, TransformComponent shuttleDockXform, DockingComponent gridDock, TransformComponent gridDockXform, Box2 shuttleAABB, Angle targetGridRotation, FixturesComponent shuttleFixtures, MapGridComponent grid, bool isMap, out Matrix3 matty, out Box2 shuttleDockedAABB, out Angle gridRotation)

Parameters

Type	Name	Description
DockingComponent	shuttleDock
TransformComponent	shuttleDockXform
DockingComponent	gridDock
TransformComponent	gridDockXform
Box2	shuttleAABB
Angle	targetGridRotation
Robust.Shared.Physics.FixturesComponent	shuttleFixtures
Robust.Shared.Map.Components.MapGridComponent	grid
System.Boolean	isMap
Matrix3	matty
Box2	shuttleDockedAABB
Angle	gridRotation

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

Dock(EntityUid, DockingComponent, EntityUid, DockingComponent)

Docks 2 ports together and assumes it is valid.

Declaration

public void Dock(EntityUid dockAUid, DockingComponent dockA, EntityUid dockBUid, DockingComponent dockB)

Parameters

Type	Name	Description
EntityUid	dockAUid
DockingComponent	dockA
EntityUid	dockBUid
DockingComponent	dockB

| Improve this Doc View Source

GetAngle(EntityUid, TransformComponent, EntityUid, TransformComponent, EntityQuery<TransformComponent>)

Declaration

public Angle GetAngle(EntityUid uid, TransformComponent xform, EntityUid targetUid, TransformComponent targetXform, EntityQuery<TransformComponent> xformQuery)

Parameters

Type	Name	Description
EntityUid	uid
TransformComponent	xform
EntityUid	targetUid
TransformComponent	targetXform
EntityQuery<TransformComponent>	xformQuery

Returns

Type	Description
Angle

| Improve this Doc View Source

GetDockingConfig(EntityUid, EntityUid, EntityUid, DockingComponent, EntityUid, DockingComponent)

Gets docking config between 2 specific docks.

Declaration

public DockingConfig GetDockingConfig(EntityUid shuttleUid, EntityUid targetGrid, EntityUid shuttleDockUid, DockingComponent shuttleDock, EntityUid gridDockUid, DockingComponent gridDock)

Parameters

Type	Name	Description
EntityUid	shuttleUid
EntityUid	targetGrid
EntityUid	shuttleDockUid
DockingComponent	shuttleDock
EntityUid	gridDockUid
DockingComponent	gridDock

Returns

Type	Description
DockingConfig

| Improve this Doc View Source

GetDockingConfig(EntityUid, EntityUid, Nullable<String>)

Tries to get a valid docking configuration for the shuttle to the target grid.

Declaration

public DockingConfig GetDockingConfig(EntityUid shuttleUid, EntityUid targetGrid, string? priorityTag = null)

Parameters

Type	Name	Description
EntityUid	shuttleUid
EntityUid	targetGrid
System.Nullable<System.String>	priorityTag	Priority docking tag to prefer, e.g. for emergency shuttle

Returns

Type	Description
DockingConfig

| Improve this Doc View Source

GetDocks(EntityUid)

Declaration

public List<(EntityUid Uid, DockingComponent Component)> GetDocks(EntityUid uid)

Parameters

Type	Name	Description
EntityUid	uid

Returns

Type	Description
List<System.ValueTuple<EntityUid, DockingComponent>>

| Improve this Doc View Source

Initialize()

Declaration

public override void Initialize()

| Improve this Doc View Source

Undock(EntityUid, DockingComponent)

Declaration

public void Undock(EntityUid dockUid, DockingComponent dock)

Parameters

Type	Name	Description
EntityUid	dockUid
DockingComponent	dock

| Improve this Doc View Source

Update(Single)

Declaration

public override void Update(float frameTime)

Parameters

Type	Name	Description
System.Single	frameTime