Inheritance diagram for Barotrauma.Submarine:

Public Member Functions
override string	ToString ()

int	CalculateBasePrice ()

void	AttemptBallastFloraInfection (Identifier identifier, float deltaTime, float probability)

void	MakeWreck ()

bool	CreateWreckAI ()

bool	CreateTurretAI ()
	Creates an AI that operates all the turrets on a sub, same as Thalamus but only operates the turrets. More...

void	DisableWreckAI ()

Rectangle	GetDockedBorders (bool allowDifferentTeam=true)
	Returns a rect that contains the borders of this sub and all subs docked to it, excluding outposts More...

IEnumerable< Submarine >	GetConnectedSubs ()
	Returns a list of all submarines that are connected to this one via docking ports, including this sub. More...

void	RefreshConnectedSubs ()

Vector2	FindSpawnPos (Vector2 spawnPos, Point? submarineSize=null, float subDockingPortOffset=0.0f, int verticalMoveDir=0)
	Attempt to find a spawn position close to the specified position where the sub doesn't collide with walls/ruins More...

void	UpdateTransform (bool interpolate=true)

Rectangle	CalculateDimensions (bool onlyHulls=true)

void	FlipX (List< Submarine > parents=null)

void	EnableFactionSpecificEntities (Identifier factionIdentifier)

void	Update (float deltaTime)

void	ApplyForce (Vector2 force)

void	EnableMaintainPosition ()

void	NeutralizeBallast ()

void	SetPrevTransform (Vector2 position)

void	SetPosition (Vector2 position, List< Submarine > checkd=null, bool forceUndockFromStaticSubmarines=true)

void	Translate (Vector2 amount)

bool	IsConnectedTo (Submarine otherSub)
	Returns true if the sub is same as the other. More...

List< Hull >	GetHulls (bool alsoFromConnectedSubs)

List< Gap >	GetGaps (bool alsoFromConnectedSubs)

List< Item >	GetItems (bool alsoFromConnectedSubs)

List< WayPoint >	GetWaypoints (bool alsoFromConnectedSubs)

List< Structure >	GetWalls (bool alsoFromConnectedSubs)

List< T >	GetEntities< T > (bool includingConnectedSubs, List< T > list)

List<(ItemContainer container, int freeSlots)>	GetCargoContainers ()

IEnumerable< T >	GetEntities< T > (bool includingConnectedSubs, IEnumerable< T > list)

bool	IsEntityFoundOnThisSub (MapEntity entity, bool includingConnectedSubs, bool allowDifferentTeam=false, bool allowDifferentType=false)

	Submarine (SubmarineInfo info, bool showErrorMessages=true, Func< Submarine, List< MapEntity >> loadEntities=null, IdRemap linkedRemap=null)

bool	CheckFuel ()

void	SaveToXElement (XElement element)

bool	TrySaveAs (string filePath, System.IO.MemoryStream previewImage=null)

override void	Remove ()

void	Dispose ()

void	DisableObstructedWayPoints ()
	Permanently disables obstructed waypoints obstructed by the level. More...

void	DisableObstructedWayPoints (Submarine otherSub)
	Temporarily disables waypoints obstructed by the other sub. More...

void	EnableObstructedWaypoints (Submarine otherSub)
	Only affects temporarily disabled waypoints. More...

void	RefreshOutdoorNodes ()

Item	FindContainerFor (Item item, bool onlyPrimary, bool checkTransferConditions=false, bool allowConnectedSubs=false)

void	CreateMiniMap (GUIComponent parent, IEnumerable< Entity > pointsOfInterest=null, bool ignoreOutpost=false)

void	CheckForErrors ()

void	ClientReadPosition (IReadMessage msg, float sendingTime)

void	ClientEventRead (IReadMessage msg, float sendingTime)

Public Member Functions inherited from Barotrauma.Entity
	Entity (Submarine submarine, ushort id)

void	FreeID ()
	Removes the entity from the entity dictionary and frees up the ID it was using. More...

Static Public Member Functions

static Vector2 VectorToWorldGrid (Vector2 position, Submarine sub=null, bool round=false)

static Rectangle AbsRect (Vector2 pos, Vector2 size)

static RectangleF AbsRectF (Vector2 pos, Vector2 size)

static bool RectContains (Rectangle rect, Vector2 pos, bool inclusive=false)

static bool RectsOverlap (Rectangle rect1, Rectangle rect2, bool inclusive=true)

static bool RectsOverlap (RectangleF rect1, RectangleF rect2, bool inclusive=true)

static Body PickBody (Vector2 rayStart, Vector2 rayEnd, IEnumerable< Body > ignoredBodies=null, Category? collisionCategory=null, bool ignoreSensors=true, Predicate< Fixture > customPredicate=null, bool allowInsideFixture=false)

static float LastPickedBodyDist (Body body)

static IEnumerable< Body > PickBodies (Vector2 rayStart, Vector2 rayEnd, IEnumerable< Body > ignoredBodies=null, Category? collisionCategory=null, bool ignoreSensors=true, Predicate< Fixture > customPredicate=null, bool allowInsideFixture=false)

Returns a list of physics bodies the ray intersects with, sorted according to distance (the closest body is at the beginning of the list). More...

static Body CheckVisibility (Vector2 rayStart, Vector2 rayEnd, bool ignoreLevel=false, bool ignoreSubs=false, bool ignoreSensors=true, bool ignoreDisabledWalls=true, bool ignoreBranches=true, Predicate< Fixture > blocksVisibilityPredicate=null)

Check visibility between two points (in sim units). More...

static ? Vector2 CalculateDockOffset (Submarine sub, Submarine dockedSub)

static Submarine FindClosest (Vector2 worldPosition, bool ignoreOutposts=false, bool ignoreOutsideLevel=true, bool ignoreRespawnShuttle=false, CharacterTeamType? teamType=null)

Parameters

teamType If has value, the sub must match the team type.

More...

static Submarine FindContainingInLocalCoordinates (Vector2 position, float inflate=500.0f)

Finds the sub whose borders contain the position. Note that this method uses the "actual" position of the sub outside the level: only use this if the position is in a submarine's local coordinate space! More...

static Submarine FindContaining (Vector2 worldPosition, float inflate=500.0f)

Finds the sub whose world borders contain the position. More...

static Rectangle GetBorders (XElement submarineElement)

static Submarine Load (SubmarineInfo info, bool unloadPrevious, IdRemap linkedRemap=null)

static void RepositionEntities (Vector2 moveAmount, IEnumerable< MapEntity > entities)

static void Unload ()

static Vector2 GetRelativeSimPosition (ISpatialEntity from, ISpatialEntity to, Vector2? targetWorldPos=null)

static Vector2 GetRelativeSimPositionFromWorldPosition (Vector2 targetWorldPos, Submarine fromSub, Submarine toSub)

static Vector2 GetRelativeSimPosition (Vector2 targetSimPos, Submarine fromSub, Submarine toSub)

static void CullEntities (Camera cam)

static void ForceVisibilityRecheck ()

static void ForceRemoveFromVisibleEntities (MapEntity entity)

static void Draw (SpriteBatch spriteBatch, bool editing=false)

static void DrawFront (SpriteBatch spriteBatch, bool editing=false, Predicate< MapEntity > predicate=null)

static void DrawDamageable (SpriteBatch spriteBatch, Effect damageEffect, bool editing=false, Predicate< MapEntity > predicate=null)

static void DrawPaintedColors (SpriteBatch spriteBatch, bool editing=false, Predicate< MapEntity > predicate=null)

static void DrawBack (SpriteBatch spriteBatch, bool editing=false, Predicate< MapEntity > predicate=null)

static void DrawGrid (SpriteBatch spriteBatch, int gridCells, Vector2 gridCenter, Vector2 roundedGridCenter, float alpha=1.0f)

static MiniMapHullData ConstructLinkedHulls (Hull mainHull, HashSet< Hull > linkedHulls, GUIComponent parent, Rectangle worldBorders)

static int GetLightCount ()

static int GetShadowCastingLightCount ()

static Vector2 MouseToWorldGrid (Camera cam, Submarine sub, Vector2? mousePos=null, bool round=false)

Static Public Member Functions inherited from Barotrauma.Entity

static IReadOnlyCollection< Entity > GetEntities ()

static int FindFreeIdBlock (int minBlockSize)

Finds a contiguous block of free IDs of at least the given size More...

static Entity FindEntityByID (ushort ID)

Find an entity based on the ID More...

static void RemoveAll ()

static void DumpIds (int count, string filename)

Public Attributes
CharacterTeamType	TeamID = CharacterTeamType.None

readonly Dictionary< Submarine, DockingPort >	ConnectedDockingPorts

bool	ShowSonarMarker = true

Public Attributes inherited from Barotrauma.Entity
readonly ushort	ID
	Unique, but non-persistent identifier. Stays the same if the entities are created in the exactly same order, but doesn't persist e.g. between the rounds. More...

readonly string	CreationStackTrace

readonly UInt64	CreationIndex

Static Public Attributes
static readonly Vector2	HiddenSubStartPosition = new Vector2(-50000.0f, 10000.0f)

static bool	LockX

static readonly Vector2	GridSize = new Vector2(16.0f, 16.0f)

static readonly Submarine[]	MainSubs = new Submarine[2]

static float	DamageEffectCutoff

static Color	DamageEffectColor

Static Public Attributes inherited from Barotrauma.Entity
const ushort	NullEntityID = 0

const ushort	EntitySpawnerID = ushort.MaxValue

const ushort	RespawnManagerID = ushort.MaxValue - 1

const ushort	DummyID = ushort.MaxValue - 2

const ushort	ReservedIDStart = ushort.MaxValue - 3

const ushort	MaxEntityCount = ushort.MaxValue - 4

static EntitySpawner	Spawner

Protected Member Functions
override ushort	DetermineID (ushort id, Submarine submarine)

Properties
SubmarineInfo	Info `[get]`

Vector2	HiddenSubPosition `[get]`

ushort	IdOffset `[get]`

static Submarine	MainSub `[get, set]`

static IEnumerable< MapEntity >	VisibleEntities `[get]`

IEnumerable< Submarine >	DockedTo `[get]`

static Vector2	LastPickedPosition `[get]`

static float	LastPickedFraction `[get]`

static Fixture	LastPickedFixture `[get]`

static Vector2	LastPickedNormal `[get]`

bool	Loading `[get]`

bool	GodMode `[get, set]`

static List< Submarine >	Loaded `[get]`

SubmarineBody	SubBody `[get]`

PhysicsBody?	PhysicsBody `[get]`

Rectangle?	Borders `[get]`
	Extents of the solid items/structures (ones with a physics body) and hulls More...

Rectangle?	VisibleBorders `[get]`
	Extents of all the visible items/structures/hulls (including ones without a physics body) More...

override Vector2?	Position `[get]`

override Vector2?	WorldPosition `[get]`

float	RealWorldCrushDepth `[get, set]`

float?	RealWorldDepth `[get]`
	How deep down the sub is from the surface of Europa in meters (affected by level type, does not correspond to "actual" coordinate systems) More...

bool	AtEndExit `[get]`

bool	AtStartExit `[get]`

bool	AtEitherExit `[get]`

new Vector2	DrawPosition `[get]`

override Vector2	SimPosition `[get]`

Vector2?	Velocity `[get, set]`

List< Vector2 >?	HullVertices `[get]`

int???	SubmarineSpecificIDTag `[get]`

bool	AtDamageDepth `[get]`

IReadOnlyList< WayPoint >	ExitPoints `[get]`

bool	ImmuneToBallastFlora `[get, set]`

WreckAI	WreckAI `[get]`

SubmarineTurretAI	TurretAI `[get]`

bool	FlippedX `[get]`

static bool	Unloading `[get]`

Properties inherited from Barotrauma.Entity
static int	EntityCount `[get]`

bool	Removed `[get]`

bool	IdFreed `[get]`

virtual Vector2	SimPosition `[get]`

virtual Vector2	Position `[get]`

virtual Vector2	WorldPosition `[get]`

virtual Vector2	DrawPosition `[get]`

Submarine	Submarine `[get, set]`

AITarget	AiTarget `[get]`

bool	InDetectable `[get, set]`

double	SpawnTime `[get]`

string	ErrorLine `[get]`

Properties inherited from Barotrauma.ISpatialEntity
Vector2	Position `[get]`

Vector2	WorldPosition `[get]`

Vector2	SimPosition `[get]`

Submarine	Submarine `[get]`

Additional Inherited Members
Protected Attributes inherited from Barotrauma.Entity
AITarget	aiTarget

Detailed Description

Definition at line 22 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

Constructor & Destructor Documentation

◆ Submarine()

Barotrauma.Submarine.Submarine	(	SubmarineInfo	info,
		bool	showErrorMessages = `true`,
		Func< Submarine, List< MapEntity >>	loadEntities = `null`,
		IdRemap	linkedRemap = `null`
	)

Definition at line 1483 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

Member Function Documentation

◆ AbsRect()

static Rectangle Barotrauma.Submarine.AbsRect	(	Vector2	pos,
		Vector2	size
	)

static

Definition at line 710 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ AbsRectF()

static RectangleF Barotrauma.Submarine.AbsRectF	(	Vector2	pos,
		Vector2	size
	)

static

Definition at line 726 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ ApplyForce()

void Barotrauma.Submarine.ApplyForce ( Vector2 force )

Definition at line 1193 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ AttemptBallastFloraInfection()

void Barotrauma.Submarine.AttemptBallastFloraInfection	(	Identifier	identifier,
		float	deltaTime,
		float	probability
	)

Definition at line 347 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ CalculateBasePrice()

int Barotrauma.Submarine.CalculateBasePrice ( )

Definition at line 335 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ CalculateDimensions()

Rectangle Barotrauma.Submarine.CalculateDimensions ( bool onlyHulls = true )

Definition at line 665 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ CalculateDockOffset()

static ? Vector2 Barotrauma.Submarine.CalculateDockOffset	(	Submarine	sub,
		Submarine	dockedSub
	)

static

Definition at line 1332 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ CheckForErrors()

void Barotrauma.Submarine.CheckForErrors ( )

Definition at line 475 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ CheckFuel()

bool Barotrauma.Submarine.CheckFuel ( )

Definition at line 1737 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ CheckVisibility()

static Body Barotrauma.Submarine.CheckVisibility	(	Vector2	rayStart,
		Vector2	rayEnd,
		bool	ignoreLevel = `false`,
		bool	ignoreSubs = `false`,
		bool	ignoreSensors = `true`,
		bool	ignoreDisabledWalls = `true`,
		bool	ignoreBranches = `true`,
		Predicate< Fixture >	blocksVisibilityPredicate = `null`
	)

static

Check visibility between two points (in sim units).

Parameters

ignoreBranches	Should plants' branches be ignored?
blocksVisibilityPredicate	If the predicate returns false, the fixture is ignored even if it would normally block visibility.

Returns: A physics body that was between the points (or null)

Definition at line 958 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ ClientEventRead()

void Barotrauma.Submarine.ClientEventRead	(	IReadMessage	msg,
		float	sendingTime
	)

Implements Barotrauma.Networking.IServerSerializable.

Definition at line 750 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ ClientReadPosition()

void Barotrauma.Submarine.ClientReadPosition	(	IReadMessage	msg,
		float	sendingTime
	)

Implements Barotrauma.Networking.IServerPositionSync.

Definition at line 733 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ ConstructLinkedHulls()

static MiniMapHullData Barotrauma.Submarine.ConstructLinkedHulls	(	Hull	mainHull,
		HashSet< Hull >	linkedHulls,
		GUIComponent	parent,
		Rectangle	worldBorders
	)

static

Definition at line 417 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ CreateMiniMap()

void Barotrauma.Submarine.CreateMiniMap	(	GUIComponent	parent,
		IEnumerable< Entity >	pointsOfInterest = `null`,
		bool	ignoreOutpost = `false`
	)

Definition at line 269 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ CreateTurretAI()

bool Barotrauma.Submarine.CreateTurretAI ( )

Creates an AI that operates all the turrets on a sub, same as Thalamus but only operates the turrets.

Definition at line 407 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ CreateWreckAI()

bool Barotrauma.Submarine.CreateWreckAI ( )

Definition at line 398 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ CullEntities()

static void Barotrauma.Submarine.CullEntities ( Camera cam )

static

Definition at line 34 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ DetermineID()

override ushort Barotrauma.Submarine.DetermineID	(	ushort	id,
		Submarine	submarine
	)

protectedvirtual

Reimplemented from Barotrauma.Entity.

Definition at line 1708 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ DisableObstructedWayPoints() [1/2]

void Barotrauma.Submarine.DisableObstructedWayPoints ( )

Permanently disables obstructed waypoints obstructed by the level.

Definition at line 2032 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ DisableObstructedWayPoints() [2/2]

void Barotrauma.Submarine.DisableObstructedWayPoints ( Submarine otherSub )

Temporarily disables waypoints obstructed by the other sub.

Definition at line 2060 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ DisableWreckAI()

void Barotrauma.Submarine.DisableWreckAI ( )

Definition at line 413 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Dispose()

void Barotrauma.Submarine.Dispose ( )

Definition at line 2003 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Draw()

static void Barotrauma.Submarine.Draw	(	SpriteBatch	spriteBatch,
		bool	editing = `false`
	)

static

Definition at line 105 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ DrawBack()

static void Barotrauma.Submarine.DrawBack	(	SpriteBatch	spriteBatch,
		bool	editing = `false`,
		Predicate< MapEntity >	predicate = `null`
	)

static

Definition at line 223 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ DrawDamageable()

static void Barotrauma.Submarine.DrawDamageable	(	SpriteBatch	spriteBatch,
		Effect	damageEffect,
		bool	editing = `false`,
		Predicate< MapEntity >	predicate = `null`
	)

static

Definition at line 164 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ DrawFront()

static void Barotrauma.Submarine.DrawFront	(	SpriteBatch	spriteBatch,
		bool	editing = `false`,
		Predicate< MapEntity >	predicate = `null`
	)

static

Definition at line 115 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ DrawGrid()

static void Barotrauma.Submarine.DrawGrid	(	SpriteBatch	spriteBatch,
		int	gridCells,
		Vector2	gridCenter,
		Vector2	roundedGridCenter,
		float	alpha = `1.0f`
	)

static

Definition at line 240 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ DrawPaintedColors()

static void Barotrauma.Submarine.DrawPaintedColors	(	SpriteBatch	spriteBatch,
		bool	editing = `false`,
		Predicate< MapEntity >	predicate = `null`
	)

static

Definition at line 203 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ EnableFactionSpecificEntities()

void Barotrauma.Submarine.EnableFactionSpecificEntities ( Identifier factionIdentifier )

Definition at line 1115 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ EnableMaintainPosition()

void Barotrauma.Submarine.EnableMaintainPosition ( )

Definition at line 1198 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ EnableObstructedWaypoints()

void Barotrauma.Submarine.EnableObstructedWaypoints ( Submarine otherSub )

Only affects temporarily disabled waypoints.

Definition at line 2108 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ FindClosest()

static Submarine Barotrauma.Submarine.FindClosest	(	Vector2	worldPosition,
		bool	ignoreOutposts = `false`,
		bool	ignoreOutsideLevel = `true`,
		bool	ignoreRespawnShuttle = `false`,
		CharacterTeamType?	teamType = `null`
	)

static

Parameters

teamType If has value, the sub must match the team type.

Definition at line 1349 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ FindContainerFor()

Item Barotrauma.Submarine.FindContainerFor	(	Item	item,
		bool	onlyPrimary,
		bool	checkTransferConditions = `false`,
		bool	allowConnectedSubs = `false`
	)

Definition at line 2120 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ FindContaining()

static Submarine Barotrauma.Submarine.FindContaining	(	Vector2	worldPosition,
		float	inflate = `500.0f`
	)

static

Finds the sub whose world borders contain the position.

Definition at line 1447 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ FindContainingInLocalCoordinates()

static Submarine Barotrauma.Submarine.FindContainingInLocalCoordinates	(	Vector2	position,
		float	inflate = `500.0f`
	)

static

Finds the sub whose borders contain the position. Note that this method uses the "actual" position of the sub outside the level: only use this if the position is in a submarine's local coordinate space!

Definition at line 1431 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ FindSpawnPos()

Vector2 Barotrauma.Submarine.FindSpawnPos	(	Vector2	spawnPos,
		Point?	submarineSize = `null`,
		float	subDockingPortOffset = `0.0f`,
		int	verticalMoveDir = `0`
	)

Attempt to find a spawn position close to the specified position where the sub doesn't collide with walls/ruins

Definition at line 494 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ FlipX()

void Barotrauma.Submarine.FlipX ( List< Submarine > parents = null )

Definition at line 1025 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ ForceRemoveFromVisibleEntities()

static void Barotrauma.Submarine.ForceRemoveFromVisibleEntities ( MapEntity entity )

static

Definition at line 100 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ ForceVisibilityRecheck()

static void Barotrauma.Submarine.ForceVisibilityRecheck ( )

static

Definition at line 95 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ GetBorders()

static Rectangle Barotrauma.Submarine.GetBorders ( XElement submarineElement )

static

Definition at line 1460 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ GetCargoContainers()

List<(ItemContainer container, int freeSlots)> Barotrauma.Submarine.GetCargoContainers ( )

Definition at line 1389 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ GetConnectedSubs()

IEnumerable<Submarine> Barotrauma.Submarine.GetConnectedSubs ( )

Returns a list of all submarines that are connected to this one via docking ports, including this sub.

Definition at line 469 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ GetDockedBorders()

Rectangle Barotrauma.Submarine.GetDockedBorders ( bool allowDifferentTeam = true )

Returns a rect that contains the borders of this sub and all subs docked to it, excluding outposts

Definition at line 431 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ GetEntities< T >() [1/2]

IEnumerable<T> Barotrauma.Submarine.GetEntities< T >	(	bool	includingConnectedSubs,
		IEnumerable< T >	list
	)

Type Constraints

T

:

MapEntity

Definition at line 1410 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ GetEntities< T >() [2/2]

List<T> Barotrauma.Submarine.GetEntities< T >	(	bool	includingConnectedSubs,
		List< T >	list
	)

Type Constraints

T

:

MapEntity

Definition at line 1384 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ GetGaps()

List<Gap> Barotrauma.Submarine.GetGaps ( bool alsoFromConnectedSubs )

◆ GetHulls()

List<Hull> Barotrauma.Submarine.GetHulls ( bool alsoFromConnectedSubs )

◆ GetItems()

List<Item> Barotrauma.Submarine.GetItems ( bool alsoFromConnectedSubs )

◆ GetLightCount()

static int Barotrauma.Submarine.GetLightCount ( )

static

Definition at line 701 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ GetRelativeSimPosition() [1/2]

static Vector2 Barotrauma.Submarine.GetRelativeSimPosition	(	ISpatialEntity	from,
		ISpatialEntity	to,
		Vector2?	targetWorldPos = `null`
	)

static

Definition at line 2157 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ GetRelativeSimPosition() [2/2]

static Vector2 Barotrauma.Submarine.GetRelativeSimPosition	(	Vector2	targetSimPos,
		Submarine	fromSub,
		Submarine	toSub
	)

static

Definition at line 2174 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ GetRelativeSimPositionFromWorldPosition()

static Vector2 Barotrauma.Submarine.GetRelativeSimPositionFromWorldPosition	(	Vector2	targetWorldPos,
		Submarine	fromSub,
		Submarine	toSub
	)

static

Definition at line 2164 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ GetShadowCastingLightCount()

static int Barotrauma.Submarine.GetShadowCastingLightCount ( )

static

Definition at line 712 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ GetWalls()

List<Structure> Barotrauma.Submarine.GetWalls ( bool alsoFromConnectedSubs )

◆ GetWaypoints()

List<WayPoint> Barotrauma.Submarine.GetWaypoints ( bool alsoFromConnectedSubs )

◆ IsConnectedTo()

bool Barotrauma.Submarine.IsConnectedTo ( Submarine otherSub )

Returns true if the sub is same as the other.

◆ IsEntityFoundOnThisSub()

bool Barotrauma.Submarine.IsEntityFoundOnThisSub	(	MapEntity	entity,
		bool	includingConnectedSubs,
		bool	allowDifferentTeam = `false`,
		bool	allowDifferentType = `false`
	)

Definition at line 1415 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ LastPickedBodyDist()

static float Barotrauma.Submarine.LastPickedBodyDist ( Body body )

static

Definition at line 844 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Load()

static Submarine Barotrauma.Submarine.Load	(	SubmarineInfo	info,
		bool	unloadPrevious,
		IdRemap	linkedRemap = `null`
	)

static

Definition at line 1713 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ MakeWreck()

void Barotrauma.Submarine.MakeWreck ( )

Definition at line 386 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ MouseToWorldGrid()

static Vector2 Barotrauma.Submarine.MouseToWorldGrid	(	Camera	cam,
		Submarine	sub,
		Vector2?	mousePos = `null`,
		bool	round = `false`
	)

static

Definition at line 723 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ NeutralizeBallast()

void Barotrauma.Submarine.NeutralizeBallast ( )

Definition at line 1231 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ PickBodies()

static IEnumerable<Body> Barotrauma.Submarine.PickBodies	(	Vector2	rayStart,
		Vector2	rayEnd,
		IEnumerable< Body >	ignoredBodies = `null`,
		Category?	collisionCategory = `null`,
		bool	ignoreSensors = `true`,
		Predicate< Fixture >	customPredicate = `null`,
		bool	allowInsideFixture = `false`
	)

static

Returns a list of physics bodies the ray intersects with, sorted according to distance (the closest body is at the beginning of the list).

Parameters

customPredicate	Can be used to filter the bodies based on some condition. If the predicate returns false, the body isignored.
allowInsideFixture	Should fixtures that the start of the ray is inside be returned

Definition at line 855 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ PickBody()

static Body Barotrauma.Submarine.PickBody	(	Vector2	rayStart,
		Vector2	rayEnd,
		IEnumerable< Body >	ignoredBodies = `null`,
		Category?	collisionCategory = `null`,
		bool	ignoreSensors = `true`,
		Predicate< Fixture >	customPredicate = `null`,
		bool	allowInsideFixture = `false`
	)

static

Definition at line 782 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ RectContains()

static bool Barotrauma.Submarine.RectContains	(	Rectangle	rect,
		Vector2	pos,
		bool	inclusive = `false`
	)

static

Definition at line 742 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ RectsOverlap() [1/2]

static bool Barotrauma.Submarine.RectsOverlap	(	Rectangle	rect1,
		Rectangle	rect2,
		bool	inclusive = `true`
	)

static

Definition at line 756 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ RectsOverlap() [2/2]

static bool Barotrauma.Submarine.RectsOverlap	(	RectangleF	rect1,
		RectangleF	rect2,
		bool	inclusive = `true`
	)

static

Definition at line 770 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ RefreshConnectedSubs()

void Barotrauma.Submarine.RefreshConnectedSubs ( )

Definition at line 474 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ RefreshOutdoorNodes()

void Barotrauma.Submarine.RefreshOutdoorNodes ( )

◆ Remove()

override void Barotrauma.Submarine.Remove ( )

virtual

Reimplemented from Barotrauma.Entity.

Definition at line 1968 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ RepositionEntities()

static void Barotrauma.Submarine.RepositionEntities	(	Vector2	moveAmount,
		IEnumerable< MapEntity >	entities
	)

static

Definition at line 1724 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ SaveToXElement()

void Barotrauma.Submarine.SaveToXElement ( XElement element )

Definition at line 1744 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ SetPosition()

void Barotrauma.Submarine.SetPosition	(	Vector2	position,
		List< Submarine >	checkd = `null`,
		bool	forceUndockFromStaticSubmarines = `true`
	)

Definition at line 1303 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ SetPrevTransform()

void Barotrauma.Submarine.SetPrevTransform ( Vector2 position )

Definition at line 1298 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ ToString()

override string Barotrauma.Submarine.ToString ( )

Definition at line 330 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Translate()

void Barotrauma.Submarine.Translate ( Vector2 amount )

Definition at line 1341 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ TrySaveAs()

bool Barotrauma.Submarine.TrySaveAs	(	string	filePath,
		System.IO.MemoryStream	previewImage = `null`
	)

Definition at line 1867 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Unload()

static void Barotrauma.Submarine.Unload ( )

static

Definition at line 1903 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Update()

void Barotrauma.Submarine.Update ( float deltaTime )

Definition at line 1139 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ UpdateTransform()

void Barotrauma.Submarine.UpdateTransform ( bool interpolate = true )

Definition at line 634 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ VectorToWorldGrid()

static Vector2 Barotrauma.Submarine.VectorToWorldGrid	(	Vector2	position,
		Submarine	sub = `null`,
		bool	round = `false`
	)

static

Definition at line 644 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

Member Data Documentation

◆ ConnectedDockingPorts

readonly Dictionary<Submarine, DockingPort> Barotrauma.Submarine.ConnectedDockingPorts

Definition at line 65 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ DamageEffectColor

Color Barotrauma.Submarine.DamageEffectColor

static

Definition at line 161 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ DamageEffectCutoff

float Barotrauma.Submarine.DamageEffectCutoff

static

Definition at line 160 of file BarotraumaClient/ClientSource/Map/Submarine.cs.

◆ GridSize

readonly Vector2 Barotrauma.Submarine.GridSize = new Vector2(16.0f, 16.0f)

static

Definition at line 45 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ HiddenSubStartPosition

readonly Vector2 Barotrauma.Submarine.HiddenSubStartPosition = new Vector2(-50000.0f, 10000.0f)

static

Definition at line 28 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ LockX

bool Barotrauma.Submarine.LockX

static

Definition at line 43 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ MainSubs

readonly Submarine [] Barotrauma.Submarine.MainSubs = new Submarine[2]

static

Definition at line 47 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ ShowSonarMarker

bool Barotrauma.Submarine.ShowSonarMarker = true

Definition at line 91 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ TeamID

CharacterTeamType Barotrauma.Submarine.TeamID = CharacterTeamType.None

Definition at line 26 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

Property Documentation

◆ AtDamageDepth

bool Barotrauma.Submarine.AtDamageDepth

get

Definition at line 318 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ AtEitherExit

bool Barotrauma.Submarine.AtEitherExit

get

Definition at line 254 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ AtEndExit

bool Barotrauma.Submarine.AtEndExit

get

Definition at line 209 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ AtStartExit

bool Barotrauma.Submarine.AtStartExit

get

Definition at line 234 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Borders

Rectangle? Barotrauma.Submarine.Borders

get

Extents of the solid items/structures (ones with a physics body) and hulls

Definition at line 143 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ DockedTo

IEnumerable<Submarine> Barotrauma.Submarine.DockedTo

get

Definition at line 66 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ DrawPosition

new Vector2 Barotrauma.Submarine.DrawPosition

get

Definition at line 278 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ ExitPoints

IReadOnlyList<WayPoint> Barotrauma.Submarine.ExitPoints

get

Definition at line 328 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ FlippedX

bool Barotrauma.Submarine.FlippedX

get

Definition at line 1020 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ GodMode

bool Barotrauma.Submarine.GodMode

getset

Definition at line 119 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ HiddenSubPosition

Vector2 Barotrauma.Submarine.HiddenSubPosition

get

Definition at line 31 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ HullVertices

List<Vector2>? Barotrauma.Submarine.HullVertices

get

Definition at line 302 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ IdOffset

ushort Barotrauma.Submarine.IdOffset

get

Definition at line 37 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ ImmuneToBallastFlora

bool Barotrauma.Submarine.ImmuneToBallastFlora

getset

Definition at line 346 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Info

SubmarineInfo Barotrauma.Submarine.Info

get

Definition at line 24 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ LastPickedFixture

Fixture Barotrauma.Submarine.LastPickedFixture

staticget

Definition at line 103 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ LastPickedFraction

float Barotrauma.Submarine.LastPickedFraction

staticget

Definition at line 98 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ LastPickedNormal

Vector2 Barotrauma.Submarine.LastPickedNormal

staticget

Definition at line 108 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ LastPickedPosition

Vector2 Barotrauma.Submarine.LastPickedPosition

staticget

Definition at line 93 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Loaded

List<Submarine> Barotrauma.Submarine.Loaded

staticget

Definition at line 125 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Loading

bool Barotrauma.Submarine.Loading

get

Definition at line 113 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ MainSub

Submarine Barotrauma.Submarine.MainSub

staticgetset

Definition at line 48 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ PhysicsBody

PhysicsBody? Barotrauma.Submarine.PhysicsBody

get

Definition at line 135 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Position

override Vector2? Barotrauma.Submarine.Position

get

Definition at line 162 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ RealWorldCrushDepth

float Barotrauma.Submarine.RealWorldCrushDepth

getset

Definition at line 176 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ RealWorldDepth

float? Barotrauma.Submarine.RealWorldDepth

get

How deep down the sub is from the surface of Europa in meters (affected by level type, does not correspond to "actual" coordinate systems)

Definition at line 197 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ SimPosition

override Vector2 Barotrauma.Submarine.SimPosition

get

Definition at line 284 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ SubBody

SubmarineBody Barotrauma.Submarine.SubBody

get

Definition at line 130 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ SubmarineSpecificIDTag

int??? Barotrauma.Submarine.SubmarineSpecificIDTag

get

Definition at line 308 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ TurretAI

SubmarineTurretAI Barotrauma.Submarine.TurretAI

get

Definition at line 396 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Unloading

bool Barotrauma.Submarine.Unloading

staticget

Definition at line 1897 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ Velocity

Vector2? Barotrauma.Submarine.Velocity

getset

Definition at line 292 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ VisibleBorders

Rectangle? Barotrauma.Submarine.VisibleBorders

get

Extents of all the visible items/structures/hulls (including ones without a physics body)

Definition at line 154 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ VisibleEntities

IEnumerable<MapEntity> Barotrauma.Submarine.VisibleEntities

staticget

Definition at line 58 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ WorldPosition

override Vector2? Barotrauma.Submarine.WorldPosition

get

Definition at line 167 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

◆ WreckAI

WreckAI Barotrauma.Submarine.WreckAI

get

Definition at line 395 of file BarotraumaShared/SharedSource/Map/Submarine.cs.

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Submarine()

Member Function Documentation

◆ AbsRect()

◆ AbsRectF()

◆ ApplyForce()

◆ AttemptBallastFloraInfection()

◆ CalculateBasePrice()

◆ CalculateDimensions()

◆ CalculateDockOffset()

◆ CheckForErrors()

◆ CheckFuel()

◆ CheckVisibility()

◆ ClientEventRead()

◆ ClientReadPosition()

◆ ConstructLinkedHulls()

◆ CreateMiniMap()

◆ CreateTurretAI()

◆ CreateWreckAI()

◆ CullEntities()

◆ DetermineID()

◆ DisableObstructedWayPoints() [1/2]

◆ DisableObstructedWayPoints() [2/2]

◆ DisableWreckAI()

◆ Dispose()

◆ Draw()

◆ DrawBack()

◆ DrawDamageable()

◆ DrawFront()

◆ DrawGrid()

◆ DrawPaintedColors()

◆ EnableFactionSpecificEntities()

◆ EnableMaintainPosition()

◆ EnableObstructedWaypoints()

◆ FindClosest()

◆ FindContainerFor()

◆ FindContaining()

◆ FindContainingInLocalCoordinates()

◆ FindSpawnPos()

◆ FlipX()

◆ ForceRemoveFromVisibleEntities()

◆ ForceVisibilityRecheck()

◆ GetBorders()

◆ GetCargoContainers()

◆ GetConnectedSubs()

◆ GetDockedBorders()

◆ GetEntities< T >() [1/2]

◆ GetEntities< T >() [2/2]

◆ GetGaps()

◆ GetHulls()

◆ GetItems()

◆ GetLightCount()

◆ GetRelativeSimPosition() [1/2]

◆ GetRelativeSimPosition() [2/2]

◆ GetRelativeSimPositionFromWorldPosition()

◆ GetShadowCastingLightCount()

◆ GetWalls()

◆ GetWaypoints()

◆ IsConnectedTo()

◆ IsEntityFoundOnThisSub()

◆ LastPickedBodyDist()

◆ Load()

◆ MakeWreck()

◆ MouseToWorldGrid()

◆ NeutralizeBallast()

◆ PickBodies()

◆ PickBody()

◆ RectContains()

◆ RectsOverlap() [1/2]

◆ RectsOverlap() [2/2]

◆ RefreshConnectedSubs()

◆ RefreshOutdoorNodes()