Barotrauma.WayPoint Class Reference

Inheritance diagram for Barotrauma.WayPoint:

Public Types
enum	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)
	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.
override void	Remove ()
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)
virtual bool	IsMouseOn (Vector2 position)
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	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 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.
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)

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)
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
static List< WayPoint >	WayPointList = new List<WayPoint>()
static bool	ShowWayPoints = true
static bool	ShowSpawnPoints = 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 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.
bool	flippedX
bool	flippedY
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]
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
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)
Static Protected Attributes inherited from Barotrauma.MapEntity
static readonly HashSet< MapEntity >	highlightedEntities = new HashSet<MapEntity>()

Member Enumeration Documentation

Type

enum Barotrauma.WayPoint.Type

Enumerator
WayPoint
SpawnPoint

Constructor & Destructor Documentation

WayPoint() [1/4]

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

WayPoint() [2/4]

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

WayPoint() [3/4]

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

WayPoint() [4/4]

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

Member Function Documentation

Clone()

override MapEntity Barotrauma.WayPoint.Clone

(

)

ConnectTo()

void Barotrauma.WayPoint.ConnectTo

(

WayPoint

wayPoint2

)

FindHull()

void Barotrauma.WayPoint.FindHull

(

)

GenerateSubWaypoints()

static bool Barotrauma.WayPoint.GenerateSubWaypoints ( Submarine submarine )

static

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

InitializeLinks()

void Barotrauma.WayPoint.InitializeLinks

(

)

Load()

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

static

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)

OnMapLoaded()

override void Barotrauma.WayPoint.OnMapLoaded ( )

virtual

Reimplemented from Barotrauma.MapEntity.

Remove()

override void Barotrauma.WayPoint.Remove ( )

virtual

Reimplemented from Barotrauma.MapEntity.

Save()

override XElement Barotrauma.WayPoint.Save ( XElement parentElement )

virtual

Reimplemented from Barotrauma.MapEntity.

SelectCrewSpawnPoints()

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

static

ShallowRemove()

override void Barotrauma.WayPoint.ShallowRemove ( )

virtual

Remove the entity from the entity list without removing links to other entities.

Reimplemented from Barotrauma.MapEntity.

Member Data Documentation

IsObstructed

bool Barotrauma.WayPoint.IsObstructed

Ladders

Ladder Barotrauma.WayPoint.Ladders

LadderWaypointInterval

const float Barotrauma.WayPoint.LadderWaypointInterval = 75.0f

static

Ruin

RuinGeneration.Ruin Barotrauma.WayPoint.Ruin

ShowSpawnPoints

bool Barotrauma.WayPoint.ShowSpawnPoints = true

static

ShowWayPoints

bool Barotrauma.WayPoint.ShowWayPoints = true

static

spawnType

SpawnType Barotrauma.WayPoint.spawnType

protected

Stairs

Structure Barotrauma.WayPoint.Stairs

Tunnel

Level.Tunnel Barotrauma.WayPoint.Tunnel

WayPointList

List<WayPoint> Barotrauma.WayPoint.WayPointList = new List<WayPoint>()

static

Property Documentation

AssignedJob

JobPrefab Barotrauma.WayPoint.AssignedJob

get

ConnectedDoor

Door Barotrauma.WayPoint.ConnectedDoor

get

ConnectedGap

Gap Barotrauma.WayPoint.ConnectedGap

getset

CurrentHull

Hull Barotrauma.WayPoint.CurrentHull

get

ExitPointSize

Point Barotrauma.WayPoint.ExitPointSize

get

ExitPointWorldRect

Rectangle Barotrauma.WayPoint.ExitPointWorldRect

get

IdCardDesc

string Barotrauma.WayPoint.IdCardDesc

get

IdCardTags

string [] Barotrauma.WayPoint.IdCardTags

get

IsInWater

bool Barotrauma.WayPoint.IsInWater

get

IsTraversable

bool Barotrauma.WayPoint.IsTraversable

get

Name

override string Barotrauma.WayPoint.Name

get

OnLinksChanged

Action<WayPoint> Barotrauma.WayPoint.OnLinksChanged

getset

SpawnType

SpawnType Barotrauma.WayPoint.SpawnType

getset

Tags

IEnumerable<Identifier> Barotrauma.WayPoint.Tags

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/WayPoint.cs