Inheritance diagram for Barotrauma.LevelObjectPrefab:

Classes
class	ChildObject

class	SoundConfig

Public Types
enum class	SpawnPosType { None = 0 , MainPathWall = 1 , SidePathWall = 2 , CaveWall = 4 , NestWall = 8 , RuinWall = 16 , SeaFloor = 32 , MainPath = 64 , LevelStart = 128 , LevelEnd = 256 , OutpostWall = 512 , Wall = MainPathWall \| SidePathWall \| CaveWall }

Public Member Functions
override string	ToString ()

	LevelObjectPrefab (ContentXElement element, LevelObjectPrefabsFile file, Identifier identifierOverride=default)

float	GetCommonness (CaveGenerationParams generationParams, bool requireCaveSpecificOverride=true)

float	GetCommonness (LevelData levelData)

override void	Dispose ()

void	Save (XElement element)

Public Member Functions inherited from Barotrauma.Prefab
	Prefab (ContentFile file, Identifier identifier)

	Prefab (ContentFile file, ContentXElement element)

Static Public Member Functions
static Identifier	ParseIdentifier (Identifier identifierOverride, XElement element)

Static Public Member Functions inherited from Barotrauma.Prefab
static void	DisallowCallFromConstructor ()

Public Attributes
readonly List< ContentXElement >	LevelTriggerElements

readonly Dictionary< Identifier, float >	OverrideCommonness
	Overrides the commonness of the object in a specific level type. Key = name of the level type, value = commonness in that level type. More...

Public Attributes inherited from Barotrauma.Prefab
readonly Identifier	Identifier

readonly ContentFile	ContentFile

Static Public Attributes
static readonly PrefabCollection< LevelObjectPrefab >	Prefabs = new PrefabCollection<LevelObjectPrefab>()

Static Public Attributes inherited from Barotrauma.Prefab
static readonly ImmutableHashSet< Type >	Types

Properties
List< Sprite >	Sprites = new List<Sprite>() `[get]`

DeformableSprite	DeformableSprite `[get]`

float	MinSize `[get]`

float	MaxSize `[get]`

Alignment	Alignment `[get]`
	Which sides of a wall the object can appear on. More...

SpawnPosType	SpawnPos `[get]`

XElement	Config `[get]`

XElement	PhysicsBodyElement `[get]`

int	PhysicsBodyTriggerIndex = -1 `[get]`

Dictionary< Sprite, XElement >	SpriteSpecificPhysicsBodyElements = new Dictionary<Sprite, XElement>() `[get]`

int	MaxCount `[get]`

Vector2	DepthRange `[get]`

float	ClusteringAmount `[get]`
	The tendency for the prefab to form clusters. Used as an exponent for perlin noise values that are used to determine the probability for an object to spawn at a specific position. More...

float	ClusteringGroup `[get]`
	A value between 0-1 that determines the z-coordinate to sample perlin noise from when determining the probability for an object to spawn at a specific position. Using the same (or close) value for different objects means the objects tend to form clusters in the same areas. More...

Vector2	RandomOffset `[get]`

bool	AlignWithSurface `[get]`

bool	AllowAtStart `[get]`

bool	AllowAtEnd `[get]`

float	MinSurfaceWidth `[get]`
	Minimum length of a graph edge the object can spawn on. More...

Vector2	RandomRotation `[get]`

Vector2	RandomRotationRad `[get]`

float	SwingAmount `[get]`

float	SwingAmountRad `[get]`

float	SwingFrequency `[get]`

Vector2	ScaleOscillation `[get]`

float	ScaleOscillationFrequency `[get]`

float	Commonness `[get]`

float	SonarDisruption `[get]`

bool	TakeLevelWallDamage `[get]`

bool	HideWhenBroken `[get]`

float	Health `[get]`

Color	SpriteColor `[get]`

string	Name `[get]`

List< ChildObject >	ChildObjects `[get]`

Dictionary< Identifier, SerializableProperty >	SerializableProperties `[get]`

List< LevelObjectPrefab >	OverrideProperties `[get]`
	A list of prefabs whose properties override this one's properties when a trigger is active. E.g. if a trigger in the index 1 of the trigger list is active, the properties in index 1 in this list are used (unless it's null) More...

List< int >	ParticleEmitterTriggerIndex `[get]`

List< ParticleEmitterPrefab >	ParticleEmitterPrefabs `[get]`

List< Vector2 >	EmitterPositions `[get]`

List< SoundConfig >	Sounds = new List<SoundConfig>() `[get]`

List< int >	LightSourceTriggerIndex = new List<int>() `[get]`

List< LightSourceParams >	LightSourceParams = new List<Lights.LightSourceParams>() `[get]`

List< SpriteDeformation >	SpriteDeformations = new List<SpriteDeformation>() `[get]`
	Only used for editing sprite deformation parameters. The actual LevelObjects use separate SpriteDeformation instances. More...

Properties inherited from Barotrauma.PrefabWithUintIdentifier
UInt32	UintIdentifier `[get, set]`

Properties inherited from Barotrauma.Prefab
ContentPackage?	ContentPackage `[get]`

ContentPath	FilePath `[get]`

Properties inherited from Barotrauma.ISerializableEntity
string	Name `[get]`

Dictionary< Identifier, SerializableProperty >	SerializableProperties `[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 BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

Member Enumeration Documentation

◆ SpawnPosType

enum Barotrauma.LevelObjectPrefab.SpawnPosType

strong

Enumerator
None
MainPathWall
SidePathWall
CaveWall
NestWall
RuinWall
SeaFloor
MainPath
LevelStart
LevelEnd
OutpostWall
Wall

Definition at line 35 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

Constructor & Destructor Documentation

◆ LevelObjectPrefab()

Barotrauma.LevelObjectPrefab.LevelObjectPrefab	(	ContentXElement	element,
		LevelObjectPrefabsFile	file,
		Identifier	identifierOverride = `default`
	)

Definition at line 326 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

Member Function Documentation

◆ Dispose()

override void Barotrauma.LevelObjectPrefab.Dispose ( )

virtual

Implements Barotrauma.Prefab.

Definition at line 461 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ GetCommonness() [1/2]

float Barotrauma.LevelObjectPrefab.GetCommonness	(	CaveGenerationParams	generationParams,
		bool	requireCaveSpecificOverride = `true`
	)

Definition at line 432 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ GetCommonness() [2/2]

float Barotrauma.LevelObjectPrefab.GetCommonness ( LevelData levelData )

Definition at line 443 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ ParseIdentifier()

static Identifier Barotrauma.LevelObjectPrefab.ParseIdentifier	(	Identifier	identifierOverride,
		XElement	element
	)

static

Definition at line 350 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ Save()

void Barotrauma.LevelObjectPrefab.Save ( XElement element )

Definition at line 118 of file BarotraumaClient/ClientSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ ToString()

override string Barotrauma.LevelObjectPrefab.ToString ( )

Definition at line 320 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

Member Data Documentation

◆ LevelTriggerElements

readonly List<ContentXElement> Barotrauma.LevelObjectPrefab.LevelTriggerElements

Definition at line 99 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ OverrideCommonness

readonly Dictionary<Identifier, float> Barotrauma.LevelObjectPrefab.OverrideCommonness

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 105 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ Prefabs

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

static

Definition at line 12 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

Property Documentation

◆ Alignment

Alignment Barotrauma.LevelObjectPrefab.Alignment

get

Which sides of a wall the object can appear on.

Definition at line 80 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ AlignWithSurface

bool Barotrauma.LevelObjectPrefab.AlignWithSurface

get

Definition at line 175 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ AllowAtEnd

bool Barotrauma.LevelObjectPrefab.AllowAtEnd

get

Definition at line 189 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ AllowAtStart

bool Barotrauma.LevelObjectPrefab.AllowAtStart

get

Definition at line 182 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ ChildObjects

List<ChildObject> Barotrauma.LevelObjectPrefab.ChildObjects

get

Definition at line 299 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ ClusteringAmount

float Barotrauma.LevelObjectPrefab.ClusteringAmount

get

The tendency for the prefab to form clusters. Used as an exponent for perlin noise values that are used to determine the probability for an object to spawn at a specific position.

Definition at line 145 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ ClusteringGroup

float Barotrauma.LevelObjectPrefab.ClusteringGroup

get

A value between 0-1 that determines the z-coordinate to sample perlin noise from when determining the probability for an object to spawn at a specific position. Using the same (or close) value for different objects means the objects tend to form clusters in the same areas.

Definition at line 161 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ Commonness

float Barotrauma.LevelObjectPrefab.Commonness

get

Definition at line 256 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ Config

XElement Barotrauma.LevelObjectPrefab.Config

get

Definition at line 93 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ DeformableSprite

DeformableSprite Barotrauma.LevelObjectPrefab.DeformableSprite

get

Definition at line 57 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ DepthRange

Vector2 Barotrauma.LevelObjectPrefab.DepthRange

get

Definition at line 133 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ EmitterPositions

List<Vector2> Barotrauma.LevelObjectPrefab.EmitterPositions

get

Definition at line 38 of file BarotraumaClient/ClientSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ Health

float Barotrauma.LevelObjectPrefab.Health

get

Definition at line 284 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ HideWhenBroken

bool Barotrauma.LevelObjectPrefab.HideWhenBroken

get

Definition at line 277 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ LightSourceParams

List<LightSourceParams> Barotrauma.LevelObjectPrefab.LightSourceParams = new List<Lights.LightSourceParams>()

get

Definition at line 55 of file BarotraumaClient/ClientSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ LightSourceTriggerIndex

List<int> Barotrauma.LevelObjectPrefab.LightSourceTriggerIndex = new List<int>()

get

Definition at line 50 of file BarotraumaClient/ClientSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ MaxCount

int Barotrauma.LevelObjectPrefab.MaxCount

get

Definition at line 126 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ MaxSize

float Barotrauma.LevelObjectPrefab.MaxSize

get

Definition at line 70 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ MinSize

float Barotrauma.LevelObjectPrefab.MinSize

get

Definition at line 64 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ MinSurfaceWidth

float Barotrauma.LevelObjectPrefab.MinSurfaceWidth

get

Minimum length of a graph edge the object can spawn on.

Definition at line 199 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ Name

string Barotrauma.LevelObjectPrefab.Name

get

Definition at line 297 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ OverrideProperties

List<LevelObjectPrefab> Barotrauma.LevelObjectPrefab.OverrideProperties

get

A list of prefabs whose properties override this one's properties when a trigger is active. E.g. if a trigger in the index 1 of the trigger list is active, the properties in index 1 in this list are used (unless it's null)

Definition at line 314 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ ParticleEmitterPrefabs

List<ParticleEmitterPrefab> Barotrauma.LevelObjectPrefab.ParticleEmitterPrefabs

get

Definition at line 33 of file BarotraumaClient/ClientSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ ParticleEmitterTriggerIndex

List<int> Barotrauma.LevelObjectPrefab.ParticleEmitterTriggerIndex

get

Definition at line 28 of file BarotraumaClient/ClientSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ PhysicsBodyElement

XElement Barotrauma.LevelObjectPrefab.PhysicsBodyElement

get

Definition at line 107 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ PhysicsBodyTriggerIndex

int Barotrauma.LevelObjectPrefab.PhysicsBodyTriggerIndex = -1

get

Definition at line 112 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ RandomOffset

Vector2 Barotrauma.LevelObjectPrefab.RandomOffset

get

Definition at line 168 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ RandomRotation

Vector2 Barotrauma.LevelObjectPrefab.RandomRotation

get

Definition at line 207 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ RandomRotationRad

Vector2 Barotrauma.LevelObjectPrefab.RandomRotationRad

get

Definition at line 216 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ ScaleOscillation

Vector2 Barotrauma.LevelObjectPrefab.ScaleOscillation

get

Definition at line 239 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ ScaleOscillationFrequency

float Barotrauma.LevelObjectPrefab.ScaleOscillationFrequency

get

Definition at line 246 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ SerializableProperties

Dictionary<Identifier, SerializableProperty> Barotrauma.LevelObjectPrefab.SerializableProperties

get

Definition at line 305 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ SonarDisruption

float Barotrauma.LevelObjectPrefab.SonarDisruption

get

Definition at line 263 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ Sounds

List<SoundConfig> Barotrauma.LevelObjectPrefab.Sounds = new List<SoundConfig>()

get

Definition at line 44 of file BarotraumaClient/ClientSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ SpawnPos

SpawnPosType Barotrauma.LevelObjectPrefab.SpawnPos

get

Definition at line 87 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ SpriteColor

Color Barotrauma.LevelObjectPrefab.SpriteColor

get

Definition at line 291 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ SpriteDeformations

List<SpriteDeformation> Barotrauma.LevelObjectPrefab.SpriteDeformations = new List<SpriteDeformation>()

get

Only used for editing sprite deformation parameters. The actual LevelObjects use separate SpriteDeformation instances.

Definition at line 64 of file BarotraumaClient/ClientSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ Sprites

List<Sprite> Barotrauma.LevelObjectPrefab.Sprites = new List<Sprite>()

get

Definition at line 51 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ SpriteSpecificPhysicsBodyElements

Dictionary<Sprite, XElement> Barotrauma.LevelObjectPrefab.SpriteSpecificPhysicsBodyElements = new Dictionary<Sprite, XElement>()

get

Definition at line 118 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ SwingAmount

float Barotrauma.LevelObjectPrefab.SwingAmount

get

Definition at line 220 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ SwingAmountRad

float Barotrauma.LevelObjectPrefab.SwingAmountRad

get

Definition at line 229 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ SwingFrequency

float Barotrauma.LevelObjectPrefab.SwingFrequency

get

Definition at line 232 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

◆ TakeLevelWallDamage

bool Barotrauma.LevelObjectPrefab.TakeLevelWallDamage

get

Definition at line 270 of file BarotraumaShared/SharedSource/Map/Levels/LevelObjects/LevelObjectPrefab.cs.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Additional Inherited Members