Barotrauma Client Doc
Barotrauma.LinkedSubmarine Class Reference
Inheritance diagram for Barotrauma.LinkedSubmarine:
Barotrauma.MapEntity Barotrauma.MapEntity Barotrauma.Entity Barotrauma.ISpatialEntity Barotrauma.Entity Barotrauma.Entity Barotrauma.ISpatialEntity Barotrauma.Entity Barotrauma.ISpatialEntity Barotrauma.ISpatialEntity Barotrauma.ISpatialEntity Barotrauma.ISpatialEntity

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)
 
override void Draw (SpriteBatch spriteBatch, bool editing, bool back=true)
 
void Draw (SpriteBatch spriteBatch, Vector2 drawPos, float alpha=1.0f)
 
override void UpdateEditing (Camera cam, float deltaTime)
 
- 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 More...
 
virtual void ShallowRemove ()
 Remove the entity from the entity list without removing links to other entities More...
 
override void Remove ()
 
virtual void Update (float deltaTime, Camera cam)
 
virtual void FlipX (bool relativeToSub)
 Flip the entity horizontally More...
 
virtual void FlipY (bool relativeToSub)
 Flip the entity vertically More...
 
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. More...
 
virtual bool IsVisible (Rectangle worldView)
 
float GetDrawDepth (float baseDepth, Sprite sprite)
 A method that modifies the draw depth to prevent z-fighting between entities with the same sprite depth More...
 
MapEntity GetReplacementOrThis ()
 
virtual void AddToGUIUpdateList (int order=0)
 
virtual void DrawEditing (SpriteBatch spriteBatch, Camera cam)
 
- 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 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< MapEntityClone (List< MapEntity > entitiesToClone)
 
static void UpdateAll (float deltaTime, Camera cam)
 Call Update() on every object in Entity.list More...
 
static List< MapEntityLoadAll (Submarine submarine, XElement parentElement, string filePath, int idOffset)
 
static void MapLoaded (List< MapEntity > entities, bool updateHulls)
 
static void InitializeLoadedLinks (IEnumerable< MapEntity > entities)
 
static void UpdateSelecting (Camera cam)
 Update the selection logic in submarine editor More...
 
static void StopSelection ()
 
static Vector2 GetNudgeAmount (bool doHold=true)
 
static Item GetPotentialContainer (Vector2 position, HashSet< MapEntity > entities=null)
 
static void UpdateHighlighting (List< MapEntity > highlightedEntities, bool wiringMode=false)
 Updates the logic that runs the highlight box when the mouse is sitting still. More...
 
static void AddSelection (MapEntity entity)
 
static void RemoveSelection (MapEntity entity)
 
static void DrawSelecting (SpriteBatch spriteBatch, Camera cam)
 Draw the "selection rectangle" and outlines of entities that are being dragged (if any) More...
 
static void DrawSelectionRect (SpriteBatch spriteBatch, Vector2 pos, Vector2 size, Color color)
 
static void UpdateEditor (Camera cam, float deltaTime)
 
static void DrawEditor (SpriteBatch spriteBatch, Camera cam)
 
static void DeselectAll ()
 
static void SelectEntity (MapEntity entity)
 
static void Copy (List< MapEntity > entities)
 Copy the selected entities to the "clipboard" (copiedList) More...
 
static void Cut (List< MapEntity > entities)
 
static void Paste (Vector2 position)
 
static List< MapEntityCopyEntities (List< MapEntity > entities)
 copies a list of entities to the "clipboard" (copiedList) More...
 
static HashSet< MapEntityFindSelectedEntities (Vector2 pos, Vector2 size)
 Find entities whose rect intersects with the "selection rect" More...
 
- Static Public Member Functions inherited from Barotrauma.Entity
static IReadOnlyCollection< EntityGetEntities ()
 
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)
 

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< MapEntityHighlightedEntities [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< IdentifierAllowedLinks [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]
 
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]
 
static Vector2 StartMovingPos [get]
 
static Vector2 SelectionPos [get]
 
static bool Resizing [get]
 
static HashSet< MapEntitySelectedList = new HashSet<MapEntity>() [get]
 
static GUIListBox HighlightedListBox [get]
 
static GUIComponent EditingHUD [get]
 
static bool DisableSelect [get, set]
 
virtual bool SelectableInEditor [get]
 
static bool SelectedAny [get]
 
bool IsSelected [get]
 
bool IsIncludedInSelection [get, set]
 
static List< MapEntityFilteredSelectedList = new List<MapEntity>() [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

- Public Attributes inherited from Barotrauma.MapEntity
readonly MapEntityPrefab Prefab
 
List< ushort > unresolvedLinkedToID
 
readonly HashSet< IdentifierDisallowedUpgradeSet = new HashSet<Identifier>()
 
readonly List< MapEntitylinkedTo = 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) More...
 
int OriginalContainerIndex = -1
 
MapEntity ReplacedBy
 Used for undo/redo to determine what this item has been replaced with More...
 
- 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 inherited from Barotrauma.MapEntity
static readonly List< MapEntityMapEntityList = new List<MapEntity>()
 
static int MapEntityUpdateInterval = 1
 
static int PoweredUpdateInterval = 1
 
static bool SelectionChanged
 
static List< MapEntityCopiedList = new List<MapEntity>()
 
- 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 ()
 
Vector2 GetCollapseEffectOffset ()
 
- Protected Member Functions inherited from Barotrauma.Entity
virtual ushort DetermineID (ushort id, Submarine submarine)
 
- Static Protected Member Functions inherited from Barotrauma.MapEntity
static void ColorFlipButton (GUIButton btn, bool flip)
 
static void PositionEditingHUD ()
 
- Protected Attributes inherited from Barotrauma.MapEntity
List< ushort > linkedToID
 
readonly List< Upgrade > Upgrades = new List<Upgrade>()
 List of upgrades this item has More...
 
bool flippedX
 
Rectangle rect
 
- Protected Attributes inherited from Barotrauma.Entity
AITarget aiTarget
 
- Static Protected Attributes inherited from Barotrauma.MapEntity
static readonly HashSet< MapEntityhighlightedEntities = new HashSet<MapEntity>()
 
static Vector2 selectionPos = Vector2.Zero
 
static Vector2 selectionSize = Vector2.Zero
 
static GUIComponent editingHUD
 
- Events inherited from Barotrauma.MapEntity
Action< Rectangle > Resized
 

Detailed Description

Constructor & Destructor Documentation

◆ LinkedSubmarine()

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

Member Function Documentation

◆ Clone()

override MapEntity Barotrauma.LinkedSubmarine.Clone ( )
virtual

◆ 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

◆ Draw() [1/2]

override void Barotrauma.LinkedSubmarine.Draw ( SpriteBatch  spriteBatch,
bool  editing,
bool  back = true 
)
virtual

Reimplemented from Barotrauma.MapEntity.

Definition at line 15 of file BarotraumaClient/ClientSource/Map/LinkedSubmarine.cs.

◆ Draw() [2/2]

void Barotrauma.LinkedSubmarine.Draw ( SpriteBatch  spriteBatch,
Vector2  drawPos,
float  alpha = 1.0f 
)

◆ IsMouseOn()

override bool Barotrauma.LinkedSubmarine.IsMouseOn ( Vector2  position)
virtual

Reimplemented from Barotrauma.MapEntity.

Definition at line 146 of file BarotraumaShared/SharedSource/Map/LinkedSubmarine.cs.

◆ 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.

Definition at line 263 of file BarotraumaShared/SharedSource/Map/LinkedSubmarine.cs.

◆ Save()

override XElement Barotrauma.LinkedSubmarine.Save ( XElement  parentElement)
virtual

Reimplemented from Barotrauma.MapEntity.

Definition at line 425 of file BarotraumaShared/SharedSource/Map/LinkedSubmarine.cs.

◆ SetPositionRelativeToMainSub()

void Barotrauma.LinkedSubmarine.SetPositionRelativeToMainSub ( )

◆ UpdateEditing()

override void Barotrauma.LinkedSubmarine.UpdateEditing ( Camera  cam,
float  deltaTime 
)
virtual

Reimplemented from Barotrauma.MapEntity.

Definition at line 60 of file BarotraumaClient/ClientSource/Map/LinkedSubmarine.cs.

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