Barotrauma Client Doc
Barotrauma.CaveGenerationParams Class Reference
Inheritance diagram for Barotrauma.CaveGenerationParams:
Barotrauma.PrefabWithUintIdentifier Barotrauma.ISerializableEntity Barotrauma.Prefab

Public Member Functions

float GetCommonness (LevelData levelData, bool abyss)
 
 CaveGenerationParams (ContentXElement element, CaveGenerationParametersFile file)
 
void Save (XElement element)
 
override void Dispose ()
 
- Public Member Functions inherited from Barotrauma.Prefab
 Prefab (ContentFile file, Identifier identifier)
 
 Prefab (ContentFile file, ContentXElement element)
 

Static Public Member Functions

static CaveGenerationParams GetRandom (Level level, bool abyss, Rand.RandSync rand)
 
- Static Public Member Functions inherited from Barotrauma.Prefab
static void DisallowCallFromConstructor ()
 

Public Attributes

readonly Dictionary< Identifier, float > OverrideCommonness = new Dictionary<Identifier, float>()
 Overrides the commonness of the object in a specific level type. Key = name of the level type, value = commonness in that level type. More...
 
readonly Sprite WallSprite
 
readonly Sprite WallEdgeSprite
 
- Public Attributes inherited from Barotrauma.Prefab
readonly Identifier Identifier
 
readonly ContentFile ContentFile
 

Static Public Attributes

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

Properties

string Name [get]
 
Dictionary< Identifier, SerializablePropertySerializableProperties [get, set]
 
float Commonness [get]
 
int MinWidth [get, set]
 
int MaxWidth [get, set]
 
int MinHeight [get, set]
 
int MaxHeight [get, set]
 
int MinBranchCount [get, set]
 
int MaxBranchCount [get, set]
 
int LevelObjectAmount [get, set]
 
float DestructibleWallRatio [get, set]
 
- Properties inherited from Barotrauma.PrefabWithUintIdentifier
UInt32 UintIdentifier [get, set]
 
- Properties inherited from Barotrauma.Prefab
ContentPackageContentPackage [get]
 
ContentPath FilePath [get]
 
- Properties inherited from Barotrauma.ISerializableEntity
string Name [get]
 
Dictionary< Identifier, SerializablePropertySerializableProperties [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)
 

Detailed Description

Definition at line 10 of file CaveGenerationParams.cs.

Constructor & Destructor Documentation

◆ CaveGenerationParams()

Barotrauma.CaveGenerationParams.CaveGenerationParams ( ContentXElement  element,
CaveGenerationParametersFile  file 
)

Definition at line 127 of file CaveGenerationParams.cs.

Member Function Documentation

◆ Dispose()

override void Barotrauma.CaveGenerationParams.Dispose ( )
virtual

Implements Barotrauma.Prefab.

Definition at line 177 of file CaveGenerationParams.cs.

◆ GetCommonness()

float Barotrauma.CaveGenerationParams.GetCommonness ( LevelData  levelData,
bool  abyss 
)

Definition at line 109 of file CaveGenerationParams.cs.

◆ GetRandom()

static CaveGenerationParams Barotrauma.CaveGenerationParams.GetRandom ( Level  level,
bool  abyss,
Rand.RandSync  rand 
)
static

Definition at line 99 of file CaveGenerationParams.cs.

◆ Save()

void Barotrauma.CaveGenerationParams.Save ( XElement  element)

Definition at line 152 of file CaveGenerationParams.cs.

Member Data Documentation

◆ CaveParams

readonly PrefabCollection<CaveGenerationParams> Barotrauma.CaveGenerationParams.CaveParams = new PrefabCollection<CaveGenerationParams>()
static

Definition at line 12 of file CaveGenerationParams.cs.

◆ OverrideCommonness

readonly Dictionary<Identifier, float> Barotrauma.CaveGenerationParams.OverrideCommonness = new Dictionary<Identifier, float>()

Overrides the commonness of the object in a specific level type. Key = name of the level type, value = commonness in that level type.

Definition at line 31 of file CaveGenerationParams.cs.

◆ WallEdgeSprite

readonly Sprite Barotrauma.CaveGenerationParams.WallEdgeSprite

Definition at line 97 of file CaveGenerationParams.cs.

◆ WallSprite

readonly Sprite Barotrauma.CaveGenerationParams.WallSprite

Definition at line 96 of file CaveGenerationParams.cs.

Property Documentation

◆ Commonness

float Barotrauma.CaveGenerationParams.Commonness
get

Definition at line 34 of file CaveGenerationParams.cs.

◆ DestructibleWallRatio

float Barotrauma.CaveGenerationParams.DestructibleWallRatio
getset

Definition at line 90 of file CaveGenerationParams.cs.

◆ LevelObjectAmount

int Barotrauma.CaveGenerationParams.LevelObjectAmount
getset

Definition at line 83 of file CaveGenerationParams.cs.

◆ MaxBranchCount

int Barotrauma.CaveGenerationParams.MaxBranchCount
getset

Definition at line 76 of file CaveGenerationParams.cs.

◆ MaxHeight

int Barotrauma.CaveGenerationParams.MaxHeight
getset

Definition at line 62 of file CaveGenerationParams.cs.

◆ MaxWidth

int Barotrauma.CaveGenerationParams.MaxWidth
getset

Definition at line 48 of file CaveGenerationParams.cs.

◆ MinBranchCount

int Barotrauma.CaveGenerationParams.MinBranchCount
getset

Definition at line 69 of file CaveGenerationParams.cs.

◆ MinHeight

int Barotrauma.CaveGenerationParams.MinHeight
getset

Definition at line 55 of file CaveGenerationParams.cs.

◆ MinWidth

int Barotrauma.CaveGenerationParams.MinWidth
getset

Definition at line 41 of file CaveGenerationParams.cs.

◆ Name

string Barotrauma.CaveGenerationParams.Name
get

Definition at line 14 of file CaveGenerationParams.cs.

◆ SerializableProperties

Dictionary<Identifier, SerializableProperty> Barotrauma.CaveGenerationParams.SerializableProperties
getset

Definition at line 21 of file CaveGenerationParams.cs.