Inheritance diagram for Barotrauma.LinkedSubmarine:

Public Member Functions
	LinkedSubmarine (Submarine submarine, ushort id=Entity.NullEntityID)

override bool	IsMouseOn (Vector2 position)

override MapEntity	Clone ()

void	LinkDummyToMainSubmarine ()

void	SetPositionRelativeToMainSub ()

override void	OnMapLoaded ()

override XElement	Save (XElement parentElement)

Public Member Functions inherited from Barotrauma.MapEntity
void	AddLinked (MapEntity entity)

	MapEntity (MapEntityPrefab prefab, Submarine submarine, ushort id)

void	ResolveLinks (IdRemap childRemap)

virtual void	Move (Vector2 amount, bool ignoreContacts=true)

bool	HasUpgrade (Identifier identifier)

Upgrade	GetUpgrade (Identifier identifier)

List< Upgrade >	GetUpgrades ()

void	SetUpgrade (Upgrade upgrade, bool createNetworkEvent=false)

virtual bool	AddUpgrade (Upgrade upgrade, bool createNetworkEvent=false)
	Adds a new upgrade to the item.

MapEntity	Clone ()

virtual void	ShallowRemove ()
	Remove the entity from the entity list without removing links to other entities.

override void	Remove ()

virtual void	Update (float deltaTime, Camera cam)

virtual void	FlipX (bool relativeToSub)
	Flip the entity horizontally.

virtual void	FlipY (bool relativeToSub)
	Flip the entity vertically.

virtual Quad2D	GetTransformedQuad ()

void	RemoveLinked (MapEntity e)

HashSet< T >	GetLinkedEntities< T > (HashSet< T > list=null, int? maxDepth=null, Func< T, bool > filter=null)
	Gets all linked entities of specific type.

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.

Static Public Member Functions
static LinkedSubmarine	CreateDummy (Submarine mainSub, Submarine linkedSub)

static LinkedSubmarine	CreateDummy (Submarine mainSub, string filePath, Vector2 position)

static LinkedSubmarine	CreateDummy (Submarine mainSub, XElement element, Vector2 position, ushort id=Entity.NullEntityID)

static LinkedSubmarine	Load (ContentXElement element, Submarine submarine, IdRemap idRemap)

Static Public Member Functions inherited from Barotrauma.MapEntity
static void	ClearHighlightedEntities ()

static List< MapEntity >	Clone (List< MapEntity > entitiesToClone)

static void	UpdateAll (float deltaTime, Camera cam)
	Call Update() on every object in Entity.list.

static List< MapEntity >	LoadAll (Submarine submarine, XElement parentElement, string filePath, int idOffset)

static void	MapLoaded (List< MapEntity > entities, bool updateHulls)

static void	InitializeLoadedLinks (IEnumerable< MapEntity > entities)

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.

static Entity	FindEntityByID (ushort ID)
	Find an entity based on the ID.

static void	RemoveAll ()

static void	DumpIds (int count, string filename)

Properties
bool	LoadSub `[get]`

ushort	OriginalLinkedToID `[get]`

Submarine	Sub `[get]`

override bool	Linkable `[get]`

int	CargoCapacity `[get]`

Properties inherited from Barotrauma.MapEntity
string	DisallowedUpgrades `[get, set]`

bool	FlippedX `[get]`

bool	FlippedY `[get]`

static IEnumerable< MapEntity >	HighlightedEntities `[get]`

bool	ExternalHighlight `[get, set]`

bool	IsHighlighted `[get, set]`

virtual Rectangle	Rect `[get, set]`

Rectangle	WorldRect `[get]`

virtual Sprite	Sprite `[get]`

virtual bool	DrawBelowWater `[get]`

virtual bool	DrawOverWater `[get]`

virtual bool	Linkable `[get]`

IEnumerable< Identifier >	AllowedLinks `[get]`

bool	ResizeHorizontal `[get]`

bool	ResizeVertical `[get]`

int	RectWidth `[get, set]`

int	RectHeight `[get, set]`

bool	SpriteDepthOverrideIsSet `[get]`

float	SpriteOverrideDepth `[get]`

float	SpriteDepth `[get, set]`

virtual float	Scale = 1 `[get, set]`

bool	HiddenInGame `[get, set]`

bool	IsLayerHidden `[get, set]`
	Is the layer this entity is in currently hidden? If it is, the entity is not updated and should do nothing.

bool	IsHidden `[get]`
	Is the entity hidden due to HiddenInGame being enabled or the layer the entity is in being hidden?

override Vector2	Position `[get]`

override Vector2	SimPosition `[get]`

float	SoundRange `[get, set]`

float	SightRange `[get, set]`

bool	RemoveIfLinkedOutpostDoorInUse = true `[get, protected set]`

string	Layer `[get, set]`

virtual string	Name `[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]`
	Indetectable characters can't be spotted by AIs and aren't visible on the sonar or health scanner.

double	SpawnTime `[get]`

string	ErrorLine `[get]`

Properties inherited from Barotrauma.ISpatialEntity

Additional Inherited Members
Public Attributes inherited from Barotrauma.MapEntity
readonly MapEntityPrefab	Prefab

List< ushort >	unresolvedLinkedToID

readonly HashSet< Identifier >	DisallowedUpgradeSet = new HashSet<Identifier>()

readonly List< MapEntity >	linkedTo = new List<MapEntity>()

bool	ShouldBeSaved = true

int	OriginalModuleIndex = -1
	The index of the outpost module this entity originally spawned in (-1 if not an outpost item)

int	OriginalContainerIndex = -1

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.

readonly string	CreationStackTrace

readonly UInt64	CreationIndex

Static Public Attributes inherited from Barotrauma.MapEntity
static readonly List< MapEntity >	MapEntityList = new List<MapEntity>()

static int	MapEntityUpdateInterval = 1

static int	PoweredUpdateInterval = 1

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 inherited from Barotrauma.MapEntity
void	ParseLinks (XElement element, IdRemap idRemap)

virtual void	CheckIsHighlighted ()

void	InsertToList ()

Protected Member Functions inherited from Barotrauma.Entity
virtual ushort	DetermineID (ushort id, Submarine submarine)

Protected Attributes inherited from Barotrauma.MapEntity
List< ushort >	linkedToID

readonly List< Upgrade >	Upgrades = new List<Upgrade>()
	List of upgrades this item has.

bool	flippedX

bool	flippedY

Rectangle	rect

Protected Attributes inherited from Barotrauma.Entity
AITarget	aiTarget

Static Protected Attributes inherited from Barotrauma.MapEntity
static readonly HashSet< MapEntity >	highlightedEntities = new HashSet<MapEntity>()

Constructor & Destructor Documentation

◆ LinkedSubmarine()

Barotrauma.LinkedSubmarine.LinkedSubmarine	(	Submarine	submarine,
		ushort	id = Entity::NullEntityID )

Member Function Documentation

◆ Clone()

override MapEntity Barotrauma.LinkedSubmarine.Clone ( )

◆ CreateDummy() [1/3]

static LinkedSubmarine Barotrauma.LinkedSubmarine.CreateDummy	(	Submarine	mainSub,
		string	filePath,
		Vector2	position )

static

◆ CreateDummy() [2/3]

static LinkedSubmarine Barotrauma.LinkedSubmarine.CreateDummy	(	Submarine	mainSub,
		Submarine	linkedSub )

static

◆ CreateDummy() [3/3]

static LinkedSubmarine Barotrauma.LinkedSubmarine.CreateDummy	(	Submarine	mainSub,
		XElement	element,
		Vector2	position,
		ushort	id = Entity::NullEntityID )

static

◆ IsMouseOn()

override bool Barotrauma.LinkedSubmarine.IsMouseOn ( Vector2 position )

virtual

Reimplemented from Barotrauma.MapEntity.

◆ LinkDummyToMainSubmarine()

void Barotrauma.LinkedSubmarine.LinkDummyToMainSubmarine ( )

◆ Load()

static LinkedSubmarine Barotrauma.LinkedSubmarine.Load	(	ContentXElement	element,
		Submarine	submarine,
		IdRemap	idRemap )

static

◆ OnMapLoaded()

override void Barotrauma.LinkedSubmarine.OnMapLoaded ( )

virtual

Reimplemented from Barotrauma.MapEntity.

◆ Save()

override XElement Barotrauma.LinkedSubmarine.Save ( XElement parentElement )

virtual

Reimplemented from Barotrauma.MapEntity.

◆ SetPositionRelativeToMainSub()

void Barotrauma.LinkedSubmarine.SetPositionRelativeToMainSub ( )

Property Documentation

◆ CargoCapacity

int Barotrauma.LinkedSubmarine.CargoCapacity

get

◆ Linkable

override bool Barotrauma.LinkedSubmarine.Linkable

get

◆ LoadSub

bool Barotrauma.LinkedSubmarine.LoadSub

get

◆ OriginalLinkedToID

ushort Barotrauma.LinkedSubmarine.OriginalLinkedToID

get

◆ Sub

Submarine Barotrauma.LinkedSubmarine.Sub

get

The documentation for this class was generated from the following file:

/home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Map/LinkedSubmarine.cs

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Constructor & Destructor Documentation

◆ LinkedSubmarine()

Member Function Documentation

◆ Clone()

◆ CreateDummy() [1/3]

◆ CreateDummy() [2/3]

◆ CreateDummy() [3/3]

◆ IsMouseOn()

◆ LinkDummyToMainSubmarine()

◆ Load()

◆ OnMapLoaded()

◆ Save()

◆ SetPositionRelativeToMainSub()

Property Documentation

◆ CargoCapacity

◆ Linkable

◆ LoadSub

◆ OriginalLinkedToID

◆ Sub