Barotrauma.LocationType Class Reference

Inheritance diagram for Barotrauma.LocationType:

Public Member Functions
override string	ToString ()
	LocationType (ContentXElement element, LocationTypesFile file)
IEnumerable< JobPrefab >	GetHireablesMissingFromCrew ()
JobPrefab	GetRandomHireable ()
Sprite	GetPortrait (int randomSeed)
Identifier	GetRandomNameId (Random rand, IEnumerable< Location > existingLocations)
string	GetRandomRawName (Random rand, IEnumerable< Location > existingLocations)
	For backwards compatibility. Chooses a random name from the names defined in the .txt name files (rawNamePaths).
OutpostGenerationParams	GetForcedOutpostGenerationParams ()
override void	Dispose ()
Public Member Functions inherited from Barotrauma.Prefab
	Prefab (ContentFile file, Identifier identifier)
	Prefab (ContentFile file, ContentXElement element)
void	Dispose ()

Static Public Member Functions
static LocationType	Random (Random rand, int? zone=null, bool requireOutpost=false, Func< LocationType, bool > predicate=null)
Static Public Member Functions inherited from Barotrauma.Prefab
static void	DisallowCallFromConstructor ()

Public Attributes
readonly Dictionary< int, float >	CommonnessPerZone = new Dictionary<int, float>()
readonly Dictionary< int, int >	MinCountPerZone = new Dictionary<int, int>()
readonly LocalizedString	Name
readonly LocalizedString	Description
readonly Identifier	ForceLocationName
readonly float	BeaconStationChance
readonly CharacterTeamType	OutpostTeam
readonly List< LocationTypeChange >	CanChangeTo = new List<LocationTypeChange>()
readonly ImmutableArray< Identifier >	MissionIdentifiers
readonly ImmutableArray< Identifier >	MissionTags
readonly List< string >	HideEntitySubcategories = new List<string>()
readonly bool	ShowSonarMarker = true
Public Attributes inherited from Barotrauma.Prefab
readonly Identifier	Identifier
readonly ContentFile	ContentFile

Static Public Attributes
static readonly PrefabCollection< LocationType >	Prefabs = new PrefabCollection<LocationType>()
Static Public Attributes inherited from Barotrauma.Prefab
static readonly ImmutableHashSet< Type >	Types

Properties
bool	IsEnterable [get]
bool	AllowAsBiomeGate [get]
bool	AllowInRandomLevels [get]
	Can this location type be used in the random, non-campaign levels that don't take place in any specific zone.
bool	UsePortraitInRandomLoadingScreens [get]
IReadOnlyList< string >	NameFormats [get]
bool	HasHireableCharacters [get]
bool	HasOutpost [get]
Identifier	ReplaceInRadiation [get]
Identifier	Faction [get]
	If set, forces the location to be assigned to this faction. Set to "None" if you don't want the location to be assigned to any faction.
Identifier	SecondaryFaction [get]
	If set, forces the location to be assigned to this secondary faction. Set to "None" if you don't want the location to be assigned to any secondary faction.
Sprite	Sprite [get]
Sprite	RadiationSprite [get]
bool	IgnoreGenericEvents [get]
	If set to true, only event sets that explicitly define this location type in EventSet.LocationTypeIdentifiers can be selected at this location. Defaults to false.
Color	SpriteColor [get]
float	StoreMaxReputationModifier = 0.1f [get]
float	StoreSellPriceModifier = 0.3f [get]
float	DailySpecialPriceModifier = 0.5f [get]
float	RequestGoodPriceModifier = 2f [get]
int	StoreInitialBalance = 5000 [get]
int	StorePriceModifierRange = 5 [get]
	In percentages.
int	DailySpecialsCount = 1 [get]
int	RequestedGoodsCount = 1 [get]
Properties inherited from Barotrauma.PrefabWithUintIdentifier
UInt32	UintIdentifier [get, set]
Properties inherited from Barotrauma.Prefab
ContentPackage?	ContentPackage [get]
ContentPath	FilePath [get]

Additional Inherited Members
Protected Member Functions inherited from Barotrauma.PrefabWithUintIdentifier
	PrefabWithUintIdentifier (ContentFile file, Identifier identifier)
	PrefabWithUintIdentifier (ContentFile file, ContentXElement element)
Protected Member Functions inherited from Barotrauma.Prefab
virtual Identifier	DetermineIdentifier (XElement element)

Constructor & Destructor Documentation

LocationType()

Barotrauma.LocationType.LocationType	(	ContentXElement	element,
		LocationTypesFile	file )

Member Function Documentation

Dispose()

override void Barotrauma.LocationType.Dispose

(

)

GetForcedOutpostGenerationParams()

OutpostGenerationParams Barotrauma.LocationType.GetForcedOutpostGenerationParams

(

)

GetHireablesMissingFromCrew()

IEnumerable< JobPrefab > Barotrauma.LocationType.GetHireablesMissingFromCrew

(

)

GetPortrait()

Sprite Barotrauma.LocationType.GetPortrait

(

int

randomSeed

)

GetRandomHireable()

JobPrefab Barotrauma.LocationType.GetRandomHireable

(

)

GetRandomNameId()

Identifier Barotrauma.LocationType.GetRandomNameId	(	Random	rand,
		IEnumerable< Location >	existingLocations )

GetRandomRawName()

string Barotrauma.LocationType.GetRandomRawName	(	Random	rand,
		IEnumerable< Location >	existingLocations )

For backwards compatibility. Chooses a random name from the names defined in the .txt name files (rawNamePaths).

Random()

static LocationType Barotrauma.LocationType.Random ( Random rand, int? zone = null, bool requireOutpost = false, Func< LocationType, bool > predicate = null )

static

ToString()

override string Barotrauma.LocationType.ToString

(

)

Member Data Documentation

BeaconStationChance

readonly float Barotrauma.LocationType.BeaconStationChance

CanChangeTo

readonly List<LocationTypeChange> Barotrauma.LocationType.CanChangeTo = new List<LocationTypeChange>()

CommonnessPerZone

readonly Dictionary<int, float> Barotrauma.LocationType.CommonnessPerZone = new Dictionary<int, float>()

Description

readonly LocalizedString Barotrauma.LocationType.Description

ForceLocationName

readonly Identifier Barotrauma.LocationType.ForceLocationName

HideEntitySubcategories

readonly List<string> Barotrauma.LocationType.HideEntitySubcategories = new List<string>()

MinCountPerZone

readonly Dictionary<int, int> Barotrauma.LocationType.MinCountPerZone = new Dictionary<int, int>()

MissionIdentifiers

readonly ImmutableArray<Identifier> Barotrauma.LocationType.MissionIdentifiers

MissionTags

readonly ImmutableArray<Identifier> Barotrauma.LocationType.MissionTags

Name

readonly LocalizedString Barotrauma.LocationType.Name

OutpostTeam

readonly CharacterTeamType Barotrauma.LocationType.OutpostTeam

Prefabs

readonly PrefabCollection<LocationType> Barotrauma.LocationType.Prefabs = new PrefabCollection<LocationType>()

static

ShowSonarMarker

readonly bool Barotrauma.LocationType.ShowSonarMarker = true

Property Documentation

AllowAsBiomeGate

bool Barotrauma.LocationType.AllowAsBiomeGate

get

AllowInRandomLevels

bool Barotrauma.LocationType.AllowInRandomLevels

get

Can this location type be used in the random, non-campaign levels that don't take place in any specific zone.

DailySpecialPriceModifier

float Barotrauma.LocationType.DailySpecialPriceModifier = 0.5f

get

DailySpecialsCount

int Barotrauma.LocationType.DailySpecialsCount = 1

get

Faction

Identifier Barotrauma.LocationType.Faction

get

If set, forces the location to be assigned to this faction. Set to "None" if you don't want the location to be assigned to any faction.

HasHireableCharacters

bool Barotrauma.LocationType.HasHireableCharacters

get

HasOutpost

bool Barotrauma.LocationType.HasOutpost

get

IgnoreGenericEvents

bool Barotrauma.LocationType.IgnoreGenericEvents

get

If set to true, only event sets that explicitly define this location type in EventSet.LocationTypeIdentifiers can be selected at this location. Defaults to false.

IsEnterable

bool Barotrauma.LocationType.IsEnterable

get

NameFormats

IReadOnlyList<string> Barotrauma.LocationType.NameFormats

get

RadiationSprite

Sprite Barotrauma.LocationType.RadiationSprite

get

ReplaceInRadiation

Identifier Barotrauma.LocationType.ReplaceInRadiation

get

RequestedGoodsCount

int Barotrauma.LocationType.RequestedGoodsCount = 1

get

RequestGoodPriceModifier

float Barotrauma.LocationType.RequestGoodPriceModifier = 2f

get

SecondaryFaction

Identifier Barotrauma.LocationType.SecondaryFaction

get

If set, forces the location to be assigned to this secondary faction. Set to "None" if you don't want the location to be assigned to any secondary faction.

Sprite

Sprite Barotrauma.LocationType.Sprite

get

SpriteColor

Color Barotrauma.LocationType.SpriteColor

get

StoreInitialBalance

int Barotrauma.LocationType.StoreInitialBalance = 5000

get

StoreMaxReputationModifier

float Barotrauma.LocationType.StoreMaxReputationModifier = 0.1f

get

StorePriceModifierRange

int Barotrauma.LocationType.StorePriceModifierRange = 5

get

In percentages.

StoreSellPriceModifier

float Barotrauma.LocationType.StoreSellPriceModifier = 0.3f

get

UsePortraitInRandomLoadingScreens

bool Barotrauma.LocationType.UsePortraitInRandomLoadingScreens

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/Map/LocationType.cs