Inheritance diagram for Barotrauma.WayPoint:

Public Types
enum class	Type { WayPoint , SpawnPoint }

Public Member Functions
void	OnGapStateChanged (bool open, Gap gap)
	Only called by a Gap when the state changes. So in practice used like an event callback, although technically just a method (It would be cleaner to use an actual event in Gap.cs, but event registering and unregistering might cause an extra hassle) More...

	WayPoint (Vector2 position, SpawnType spawnType, Submarine submarine, Gap gap=null)

	WayPoint (MapEntityPrefab prefab, Rectangle rectangle)

	WayPoint (Rectangle newRect, Submarine submarine)

	WayPoint (Type type, Rectangle newRect, Submarine submarine, ushort id=Entity.NullEntityID)

override MapEntity	Clone ()

void	ConnectTo (WayPoint wayPoint2)

void	FindHull ()

override void	OnMapLoaded ()

void	InitializeLinks ()

override XElement	Save (XElement parentElement)

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

override void	Remove ()

override bool	IsVisible (Rectangle worldView)

override void	Draw (SpriteBatch spriteBatch, bool editing, bool back=true)

void	Draw (SpriteBatch spriteBatch, Vector2 drawPos)

override bool	IsMouseOn (Vector2 position)

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

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 bool	GenerateSubWaypoints (Submarine submarine)

static WayPoint	GetRandom (SpawnType spawnType=SpawnType.Human, JobPrefab assignedJob=null, Submarine sub=null, bool useSyncedRand=false, string spawnPointTag=null, bool ignoreSubmarine=false)

static WayPoint[]	SelectCrewSpawnPoints (List< CharacterInfo > crew, Submarine submarine)

static WayPoint	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 More...

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 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< MapEntity >	CopyEntities (List< MapEntity > entities)
	copies a list of entities to the "clipboard" (copiedList) More...

static HashSet< MapEntity >	FindSelectedEntities (Vector2 pos, Vector2 size)
	Find entities whose rect intersects with the "selection rect" More...

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
Ladder	Ladders

Structure	Stairs

bool	IsObstructed

Level.Tunnel	Tunnel

RuinGeneration.Ruin	Ruin

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) 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
static List< WayPoint >	WayPointList = new List<WayPoint>()

static bool	ShowWayPoints = true

const float	LadderWaypointInterval = 75.0f

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

static int	MapEntityUpdateInterval = 1

static int	PoweredUpdateInterval = 1

static bool	SelectionChanged

static List< MapEntity >	CopiedList = 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 Attributes
SpawnType	spawnType

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

Properties
bool	IsInWater `[get]`

bool	IsTraversable `[get]`

Gap	ConnectedGap `[get, set]`

Door?	ConnectedDoor `[get]`

Hull	CurrentHull `[get]`

SpawnType	SpawnType `[get, set]`

Point	ExitPointSize `[get]`

Rectangle	ExitPointWorldRect `[get]`

Action< WayPoint >	OnLinksChanged `[get, set]`

override string?	Name `[get]`

string	IdCardDesc `[get]`

string[]	IdCardTags `[get]`

IEnumerable< Identifier >	Tags `[get]`

JobPrefab	AssignedJob `[get]`

override bool	SelectableInEditor `[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]`

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< MapEntity >	SelectedList = 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< MapEntity >	FilteredSelectedList = 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
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 ()

Static Protected Attributes inherited from Barotrauma.MapEntity
static readonly HashSet< MapEntity >	highlightedEntities = 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

Definition at line 16 of file BarotraumaShared/SharedSource/Map/WayPoint.cs.

Member Enumeration Documentation

◆ Type

enum Barotrauma.WayPoint.Type

strong

Enumerator
WayPoint
SpawnPoint

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

Constructor & Destructor Documentation

◆ WayPoint() [1/4]

Barotrauma.WayPoint.WayPoint	(	Vector2	position,
		SpawnType	spawnType,
		Submarine	submarine,
		Gap	gap = `null`
	)

Definition at line 116 of file BarotraumaShared/SharedSource/Map/WayPoint.cs.

◆ WayPoint() [2/4]

Barotrauma.WayPoint.WayPoint	(	MapEntityPrefab	prefab,
		Rectangle	rectangle
	)

Definition at line 123 of file BarotraumaShared/SharedSource/Map/WayPoint.cs.

◆ WayPoint() [3/4]

Barotrauma.WayPoint.WayPoint	(	Rectangle	newRect,
		Submarine	submarine
	)

Definition at line 149 of file BarotraumaShared/SharedSource/Map/WayPoint.cs.

◆ WayPoint() [4/4]

Barotrauma.WayPoint.WayPoint	(	Type	type,
		Rectangle	newRect,
		Submarine	submarine,
		ushort	id = `Entity.NullEntityID`
	)

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

Member Function Documentation

◆ Clone()

override MapEntity Barotrauma.WayPoint.Clone ( )

virtual

Implements Barotrauma.MapEntity.

Definition at line 189 of file BarotraumaShared/SharedSource/Map/WayPoint.cs.

◆ ConnectTo()

void Barotrauma.WayPoint.ConnectTo ( WayPoint wayPoint2 )

Definition at line 916 of file BarotraumaShared/SharedSource/Map/WayPoint.cs.

◆ Draw() [1/2]

override void Barotrauma.WayPoint.Draw	(	SpriteBatch	spriteBatch,
		bool	editing,
		bool	back = `true`
	)

virtual

Reimplemented from Barotrauma.MapEntity.

Definition at line 26 of file BarotraumaClient/ClientSource/Map/WayPoint.cs.

◆ Draw() [2/2]

void Barotrauma.WayPoint.Draw	(	SpriteBatch	spriteBatch,
		Vector2	drawPos
	)

Definition at line 38 of file BarotraumaClient/ClientSource/Map/WayPoint.cs.

◆ FindHull()

void Barotrauma.WayPoint.FindHull ( )

Definition at line 1003 of file BarotraumaShared/SharedSource/Map/WayPoint.cs.

◆ GenerateSubWaypoints()

static bool Barotrauma.WayPoint.GenerateSubWaypoints ( Submarine submarine )

static

Definition at line 203 of file BarotraumaShared/SharedSource/Map/WayPoint.cs.

◆ GetRandom()

static WayPoint Barotrauma.WayPoint.GetRandom	(	SpawnType	spawnType = `SpawnType.Human`,
		JobPrefab	assignedJob = `null`,
		Submarine	sub = `null`,
		bool	useSyncedRand = `false`,
		string	spawnPointTag = `null`,
		bool	ignoreSubmarine = `false`
	)

static

Definition at line 931 of file BarotraumaShared/SharedSource/Map/WayPoint.cs.

◆ InitializeLinks()

void Barotrauma.WayPoint.InitializeLinks ( )

Definition at line 1039 of file BarotraumaShared/SharedSource/Map/WayPoint.cs.

◆ IsMouseOn()

override bool Barotrauma.WayPoint.IsMouseOn ( Vector2 position )

virtual

Reimplemented from Barotrauma.MapEntity.

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

◆ IsVisible()

override bool Barotrauma.WayPoint.IsVisible ( Rectangle worldView )

virtual

Reimplemented from Barotrauma.MapEntity.

Definition at line 16 of file BarotraumaClient/ClientSource/Map/WayPoint.cs.

◆ Load()

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

static

Definition at line 1053 of file BarotraumaShared/SharedSource/Map/WayPoint.cs.

◆ OnGapStateChanged()

void Barotrauma.WayPoint.OnGapStateChanged	(	bool	open,
		Gap	gap
	)

Only called by a Gap when the state changes. So in practice used like an event callback, although technically just a method (It would be cleaner to use an actual event in Gap.cs, but event registering and unregistering might cause an extra hassle)

Definition at line 46 of file BarotraumaShared/SharedSource/Map/WayPoint.cs.