Hull

Barotrauma.Hull

Functions

AddDecal(decalName, worldPosition, scale, isNetworkEvent, spriteIndex)

AddDecal

Parameters

  • worldPosition Microsoft.Xna.Framework.Vector2

  • scale number

  • isNetworkEvent bool

  • spriteIndex optional Int32

Returns

  • Decal

AddDecal(decalId, worldPosition, scale, isNetworkEvent, spriteIndex)

AddDecal

Parameters

  • decalId number

  • worldPosition Microsoft.Xna.Framework.Vector2

  • scale number

  • isNetworkEvent bool

  • spriteIndex optional Int32

Returns

  • Decal

AddFireSource(fireSource)

AddFireSource

Parameters

  • fireSource FireSource

AddLinked(entity)

AddLinked

Parameters

  • entity MapEntity

AddToGUIUpdateList(order)

AddToGUIUpdateList

Parameters

  • order number

AddToGrid(submarine)

AddToGrid

Parameters

AddUpgrade(upgrade, createNetworkEvent)

AddUpgrade

Parameters

  • upgrade Upgrade

  • createNetworkEvent bool

Returns

  • bool

ApplyFlowForces(deltaTime, item)

ApplyFlowForces

Parameters

  • deltaTime number

  • item Item

CleanSection(section, cleanVal, updateRequired)

CleanSection

Parameters

  • section BackgroundSection

  • cleanVal number

  • updateRequired bool

ClientEventRead(msg, sendingTime)

ClientEventRead

Parameters

  • msg Networking.IReadMessage

  • sendingTime number

ClientEventWrite(msg, extraData)

ClientEventWrite

Parameters

  • msg Networking.IWriteMessage

  • extraData Networking.IData

Clone()

Clone

Returns

  • MapEntity

CreateRoomName()

CreateRoomName

Returns

DoesSectionMatch(index, row)

DoesSectionMatch

Parameters

  • index number

  • row number

Returns

  • bool

Draw(spriteBatch, editing, back)

Draw

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

  • editing bool

  • back bool

DrawEditing(spriteBatch, cam)

DrawEditing

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

  • cam Camera

DrawSectionColors(spriteBatch)

DrawSectionColors

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

Equals(obj)

Equals

Parameters

  • obj Object

Returns

  • bool

Extinguish(deltaTime, amount, position, extinguishRealFires, extinguishFakeFires)

Extinguish

Parameters

  • deltaTime number

  • amount number

  • position Microsoft.Xna.Framework.Vector2

  • extinguishRealFires bool

  • extinguishFakeFires bool

FlipX(relativeToSub)

FlipX

Parameters

  • relativeToSub bool

FlipY(relativeToSub)

FlipY

Parameters

  • relativeToSub bool

FreeID()

FreeID

GetApproximateDistance(startPos, endPos, targetHull, maxDistance, distanceMultiplierPerClosedDoor)

GetApproximateDistance

Parameters

  • startPos Microsoft.Xna.Framework.Vector2

  • endPos Microsoft.Xna.Framework.Vector2

  • maxDistance number

  • distanceMultiplierPerClosedDoor number

Returns

  • number

GetBackgroundSection(worldPosition)

GetBackgroundSection

Parameters

  • worldPosition Microsoft.Xna.Framework.Vector2

Returns

  • BackgroundSection

GetBackgroundSectionsViaContaining(rectArea)

GetBackgroundSectionsViaContaining

Parameters

  • rectArea Microsoft.Xna.Framework.Rectangle

Returns

  • IEnumerable

GetConnectedHulls(includingThis, searchDepth, ignoreClosedGaps)

GetConnectedHulls

Parameters

  • includingThis bool

  • searchDepth optional Int32

  • ignoreClosedGaps bool

Returns

  • IEnumerable

GetDrawDepth(baseDepth, sprite)

GetDrawDepth

Parameters

  • baseDepth number

Returns

  • number

GetDrawDepth()

GetDrawDepth

Returns

  • number

GetHashCode()

GetHashCode

Returns

  • number

GetLinkedEntities(list, maxDepth, filter)

GetLinkedEntities

Parameters

  • list HashSet

  • maxDepth optional Int32

  • filter function

Returns

  • HashSet

GetReplacementOrThis()

GetReplacementOrThis

Returns

  • MapEntity

GetTransformedQuad()

GetTransformedQuad

Returns

  • Quad2D

GetType()

GetType

Returns

  • Type

GetUpgrade(identifier)

GetUpgrade

Parameters

  • identifier Identifier

Returns

  • Upgrade

GetUpgrades()

GetUpgrades

Returns

GetWaveIndex(position)

GetWaveIndex

Parameters

  • position Microsoft.Xna.Framework.Vector2

Returns

  • number

GetWaveIndex(xPos)

GetWaveIndex

Parameters

  • xPos number

Returns

  • number

HasUpgrade(identifier)

HasUpgrade

Parameters

  • identifier Identifier

Returns

  • bool

Hull(rectangle)

Hull

Parameters

  • rectangle Microsoft.Xna.Framework.Rectangle

Hull(rectangle, submarine, id)

Hull

Parameters

  • rectangle Microsoft.Xna.Framework.Rectangle

  • id number

Hull.DetectItemVisibility(c)

DetectItemVisibility

Parameters

  • c Character

Hull.FindHull(position, guess, useWorldCoordinates, inclusive)

FindHull

Parameters

  • position Microsoft.Xna.Framework.Vector2

  • useWorldCoordinates bool

  • inclusive bool

Returns

Hull.FindHullUnoptimized(position, guess, useWorldCoordinates, inclusive)

FindHullUnoptimized

Parameters

  • position Microsoft.Xna.Framework.Vector2

  • useWorldCoordinates bool

  • inclusive bool

Returns

Hull.GenerateEntityGrid(worldRect)

GenerateEntityGrid

Parameters

  • worldRect Microsoft.Xna.Framework.Rectangle

Returns

  • EntityGrid

Hull.GenerateEntityGrid(submarine)

GenerateEntityGrid

Parameters

Returns

  • EntityGrid

Hull.GetBorders()

GetBorders

Returns

  • Microsoft.Xna.Framework.Rectangle

Hull.GetCleanTarget(worldPosition)

GetCleanTarget

Parameters

  • worldPosition Microsoft.Xna.Framework.Vector2

Returns

Hull.Load(element, submarine, idRemap)

Load

Parameters

  • element ContentXElement

  • idRemap IdRemap

Returns

Hull.UpdateCheats(deltaTime, cam)

UpdateCheats

Parameters

  • deltaTime number

  • cam Camera

Hull.UpdateVertices(cam, renderer)

UpdateVertices

Parameters

  • cam Camera

  • renderer WaterRenderer

IncreaseSectionColorOrStrength(section, color, strength, requiresUpdate, isCleaning)

IncreaseSectionColorOrStrength

Parameters

  • section BackgroundSection

  • color optional Microsoft.Xna.Framework.Color

  • strength optional Single

  • requiresUpdate bool

  • isCleaning bool

IsMouseOn(position)

IsMouseOn

Parameters

  • position Microsoft.Xna.Framework.Vector2

Returns

  • bool

IsVisible(worldView)

IsVisible

Parameters

  • worldView Microsoft.Xna.Framework.Rectangle

Returns

  • bool

LeadsOutside(character)

LeadsOutside

Parameters

  • character Character

Returns

  • bool

Move(amount, ignoreContacts)

Move

Parameters

  • amount Microsoft.Xna.Framework.Vector2

  • ignoreContacts bool

OnMapLoaded()

OnMapLoaded

Remove()

Remove

RemoveFire(fire)

RemoveFire

Parameters

  • fire FireSource

RemoveLinked(e)

RemoveLinked

Parameters

  • e MapEntity

Save(parentElement)

Save

Parameters

  • parentElement Xml.Linq.XElement

Returns

  • Xml.Linq.XElement

ServerEventRead(msg, c)

ServerEventRead

Parameters

  • msg Networking.IReadMessage

  • c Networking.Client

ServerEventWrite(msg, c, extraData)

ServerEventWrite

Parameters

  • msg Networking.IWriteMessage

  • c Networking.Client

  • extraData Networking.IData

SetModuleTags(tags)

SetModuleTags

Parameters

  • tags IEnumerable

SetSectionColorOrStrength(section, color, strength)

SetSectionColorOrStrength

Parameters

  • section BackgroundSection

  • color optional Microsoft.Xna.Framework.Color

  • strength optional Single

SetUpgrade(upgrade, createNetworkEvent)

SetUpgrade

Parameters

  • upgrade Upgrade

  • createNetworkEvent bool

ShallowRemove()

ShallowRemove

ToString()

ToString

Returns

Update(deltaTime, cam)

Update

Parameters

  • deltaTime number

  • cam Camera

UpdateEditing(cam, deltaTime)

UpdateEditing

Parameters

  • cam Camera

  • deltaTime number

Fields

AiTarget

AiTarget, field of type AITarget

  • AiTarget

AmbientLight

AmbientLight, field of type Microsoft.Xna.Framework.Color

  • AmbientLight

AveragePaintedColor

AveragePaintedColor, field of type Microsoft.Xna.Framework.Color

  • AveragePaintedColor

AvoidStaying

AvoidStaying, field of type bool

  • AvoidStaying

BackgroundSections

BackgroundSections, field of type table

  • BackgroundSections

BallastFlora

BallastFlora, field of type MapCreatures.Behavior.BallastFloraBehavior

  • BallastFlora

CeilingHeight

CeilingHeight, field of type number

  • CeilingHeight

ConnectedGaps

ConnectedGaps, field of type table

  • ConnectedGaps

CreationIndex

CreationIndex, field of type number

  • CreationIndex

CreationStackTrace

CreationStackTrace, field of type string

  • CreationStackTrace

DisallowedUpgradeSet

DisallowedUpgradeSet, field of type HashSet

  • DisallowedUpgradeSet

DisallowedUpgrades

DisallowedUpgrades, field of type string

  • DisallowedUpgrades

DisplayName

DisplayName, field of type LocalizedString

  • DisplayName

DrawBelowWater

DrawBelowWater, field of type bool

  • DrawBelowWater

DrawOverWater

DrawOverWater, field of type bool

  • DrawOverWater

DrawPosition

DrawPosition, field of type Microsoft.Xna.Framework.Vector2

  • DrawPosition

DrawSurface

DrawSurface, field of type number

  • DrawSurface

ErrorLine

ErrorLine, field of type string

  • ErrorLine

ExternalHighlight

ExternalHighlight, field of type bool

  • ExternalHighlight

FakeFireSources

FakeFireSources, field of type table

  • FakeFireSources

FireCount

FireCount, field of type number

  • FireCount

FireSources

FireSources, field of type table

  • FireSources

FlippedX

FlippedX, field of type bool

  • FlippedX

FlippedY

FlippedY, field of type bool

  • FlippedY

HiddenInGame

HiddenInGame, field of type bool

  • HiddenInGame

Hull.BackgroundSectionSize

Hull.BackgroundSectionSize, field of type number

Hull.BackgroundSectionsPerNetworkEvent

Hull.BackgroundSectionsPerNetworkEvent, field of type number

Hull.EditFire

Hull.EditFire, field of type bool

Hull.EditWater

Hull.EditWater, field of type bool

Hull.EntityGrids

Hull.EntityGrids, field of type table

Hull.HullList

Hull.HullList, field of type table

Hull.MaxCompress

Hull.MaxCompress, field of type number

Hull.MaxDecalsPerHull

Hull.MaxDecalsPerHull, field of type number

Hull.OxygenConsumptionSpeed

Hull.OxygenConsumptionSpeed, field of type number

Hull.OxygenDeteriorationSpeed

Hull.OxygenDeteriorationSpeed, field of type number

Hull.OxygenDistributionSpeed

Hull.OxygenDistributionSpeed, field of type number

Hull.PressureBuildUpSpeed

Hull.PressureBuildUpSpeed, field of type number

Hull.PressureDropSpeed

Hull.PressureDropSpeed, field of type number

Hull.ShowHulls

Hull.ShowHulls, field of type bool

Hull.WaveDampening

Hull.WaveDampening, field of type number

Hull.WaveSpread

Hull.WaveSpread, field of type number

Hull.WaveStiffness

Hull.WaveStiffness, field of type number

Hull.WaveWidth

Hull.WaveWidth, field of type number

ID

ID, field of type number

  • ID

IdFreed

IdFreed, field of type bool

  • IdFreed

InDetectable

InDetectable, field of type bool

  • InDetectable

IsAirlock

IsAirlock, field of type bool

  • IsAirlock

IsBlue

IsBlue, field of type bool

  • IsBlue

IsGreen

IsGreen, field of type bool

  • IsGreen

IsHidden

IsHidden, field of type bool

  • IsHidden

IsHighlighted

IsHighlighted, field of type bool

  • IsHighlighted

IsIncludedInSelection

IsIncludedInSelection, field of type bool

  • IsIncludedInSelection

IsLayerHidden

IsLayerHidden, field of type bool

  • IsLayerHidden

IsRed

IsRed, field of type bool

  • IsRed

IsSelected

IsSelected, field of type bool

  • IsSelected

IsWetRoom

IsWetRoom, field of type bool

  • IsWetRoom

Layer

Layer, field of type string

  • Layer

LethalPressure

LethalPressure, field of type number

  • LethalPressure

Linkable

Linkable, field of type bool

  • Linkable

Name

Name, field of type string

  • Name

OriginalAmbientLight

OriginalAmbientLight, field of type ?Microsoft.Xna.Framework.Color

  • OriginalAmbientLight

OriginalContainerIndex

OriginalContainerIndex, field of type number

  • OriginalContainerIndex

OriginalModuleIndex

OriginalModuleIndex, field of type number

  • OriginalModuleIndex

OutpostModuleTags

OutpostModuleTags, field of type IEnumerable

  • OutpostModuleTags

Oxygen

Oxygen, field of type number

  • Oxygen

OxygenPercentage

OxygenPercentage, field of type number

  • OxygenPercentage

Position

Position, field of type Microsoft.Xna.Framework.Vector2

  • Position

Prefab

Prefab, field of type MapEntityPrefab

  • Prefab

Pressure

Pressure, field of type number

  • Pressure

Rect

Rect, field of type Microsoft.Xna.Framework.Rectangle

  • Rect

RectHeight

RectHeight, field of type number

  • RectHeight

RectWidth

RectWidth, field of type number

  • RectWidth

RemoveIfLinkedOutpostDoorInUse

RemoveIfLinkedOutpostDoorInUse, field of type bool

  • RemoveIfLinkedOutpostDoorInUse

Removed

Removed, field of type bool

  • Removed

ReplacedBy

ReplacedBy, field of type MapEntity

  • ReplacedBy

ResizeHorizontal

ResizeHorizontal, field of type bool

  • ResizeHorizontal

ResizeVertical

ResizeVertical, field of type bool

  • ResizeVertical

RoomName

RoomName, field of type string

  • RoomName

Scale

Scale, field of type number

  • Scale

SelectableInEditor

SelectableInEditor, field of type bool

  • SelectableInEditor

SerializableProperties

SerializableProperties, field of type table

  • SerializableProperties

ShouldBeSaved

ShouldBeSaved, field of type bool

  • ShouldBeSaved

SightRange

SightRange, field of type number

  • SightRange

SimPosition

SimPosition, field of type Microsoft.Xna.Framework.Vector2

  • SimPosition

Size

Size, field of type Microsoft.Xna.Framework.Vector2

  • Size

SoundRange

SoundRange, field of type number

  • SoundRange

SpawnTime

SpawnTime, field of type number

  • SpawnTime

Sprite

Sprite, field of type Sprite

  • Sprite

SpriteDepth

SpriteDepth, field of type number

  • SpriteDepth

SpriteDepthOverrideIsSet

SpriteDepthOverrideIsSet, field of type bool

  • SpriteDepthOverrideIsSet

SpriteOverrideDepth

SpriteOverrideDepth, field of type number

  • SpriteOverrideDepth

Submarine

Submarine, field of type Submarine

  • Submarine

SupportsPaintedColors

SupportsPaintedColors, field of type bool

  • SupportsPaintedColors

Surface

Surface, field of type number

  • Surface

Visible

Visible, field of type bool

  • Visible

Volume

Volume, field of type number

  • Volume

WaterPercentage

WaterPercentage, field of type number

  • WaterPercentage

WaterVolume

WaterVolume, field of type number

  • WaterVolume

WaveVel

WaveVel, field of type Single[]

  • WaveVel

WaveY

WaveY, field of type Single[]

  • WaveY

WorldPosition

WorldPosition, field of type Microsoft.Xna.Framework.Vector2

  • WorldPosition

WorldRect

WorldRect, field of type Microsoft.Xna.Framework.Rectangle

  • WorldRect

WorldSurface

WorldSurface, field of type number

  • WorldSurface

linkedTo

linkedTo, field of type table

  • linkedTo

properties

properties, field of type table

  • properties

unresolvedLinkedToID

unresolvedLinkedToID, field of type table

  • unresolvedLinkedToID

xBackgroundMax

xBackgroundMax, field of type number

  • xBackgroundMax

yBackgroundMax

yBackgroundMax, field of type number

  • yBackgroundMax