Barotrauma.CharacterParams Class Reference

Contains character data that should be editable in the character editor. More...

Inheritance diagram for Barotrauma.CharacterParams:

Classes
class	AIParams
class	HealthParams
class	InventoryParams
class	ParticleParams
class	SoundParams
class	SubParam
class	TargetParams

Public Member Functions
	CharacterParams (CharacterFile file)
bool	Load ()
bool	Save (string fileNameWithoutExtension=null)
override bool	Reset (bool forceReload=false)
bool	Deserialize (XElement element=null, bool alsoChildren=true, bool recursive=true, bool loadDefaultValues=true)
bool	Serialize (XElement element=null, bool alsoChildren=true, bool recursive=true)
bool	AddSound ()
void	AddInventory ()
void	AddBloodEmitter ()
void	AddGibEmitter ()
void	AddDamageEmitter ()
bool	RemoveSound (SoundParams soundParams)
bool	RemoveBloodEmitter (ParticleParams emitter)
bool	RemoveGibEmitter (ParticleParams emitter)
bool	RemoveDamageEmitter (ParticleParams emitter)
bool	RemoveInventory (InventoryParams inventory)
Public Member Functions inherited from Barotrauma.EditableParams
virtual bool	Save (string fileNameWithoutExtension=null, System.Xml.XmlWriterSettings settings=null)

Static Public Member Functions
static XElement	CreateVariantXml (XElement variantXML, XElement baseXML)
static bool	CompareGroup (Identifier group1, Identifier group2)

Public Attributes
readonly CharacterFile	File
readonly List< SubParam >	SubParams = new List<SubParam>()
readonly List< SoundParams >	Sounds = new List<SoundParams>()
readonly List< ParticleParams >	BloodEmitters = new List<ParticleParams>()
readonly List< ParticleParams >	GibEmitters = new List<ParticleParams>()
readonly List< ParticleParams >	DamageEmitters = new List<ParticleParams>()
readonly List< InventoryParams >	Inventories = new List<InventoryParams>()

Protected Member Functions
override string	GetName ()
void	CreateSubParams ()
bool	RemoveSubParam< T > (T subParam, IList< T > collection=null)
bool	TryAddSubParam< T > (ContentXElement element, Func< ContentXElement, CharacterParams, T > constructor, out T subParam, IList< T > collection=null, Func< IList< T >, bool > filter=null)
Protected Member Functions inherited from Barotrauma.EditableParams
ContentXElement	CreateElement (string name, params object[] attrs)
virtual bool	Deserialize (XElement element=null)
virtual bool	Serialize (XElement element=null)
virtual bool	Load (ContentPath file)
virtual void	UpdatePath (ContentPath fullPath)

Properties
Identifier	SpeciesName [get]
Identifier	SpeciesTranslationOverride [get]
string	DisplayName [get]
Identifier	Group [get]
bool	Humanoid [get]
bool	HasInfo [get]
bool	CanInteract [get]
bool	Husk [get]
bool	UseHuskAppendage [get]
bool	NeedsAir [get, set]
bool	NeedsWater [get, set]
bool	UseHumanAI [get, set]
bool	IsMachine [get, set]
bool	CanSpeak [get, set]
bool	ShowHealthBar [get]
bool	UseBossHealthBar [get]
float	Noise [get, set]
float	Visibility [get, set]
string	BloodDecal [get]
string	BleedParticleAir [get]
string	BleedParticleWater [get]
float	BleedParticleMultiplier [get]
bool	CanEat [get, set]
float	EatingSpeed [get, set]
bool	UsePathFinding [get, set]
float	PathFinderPriority [get, set]
bool	HideInSonar [get, set]
bool	HideInThermalGoggles [get, set]
float	SonarDisruption [get, set]
float	DistantSonarRange [get, set]
float	DisableDistance [get, set]
float	SoundInterval [get, set]
bool	DrawLast [get, set]
float	AITurretPriority [get, set]
float	AISlowTurretPriority [get, set]
Identifier	DespawnContainer [get]
XDocument	VariantFile [get]
HealthParams	Health [get]
AIParams	AI [get]
	Parameters for EnemyAIController. Not used by HumanAIController.
override ContentXElement	MainElement [get]
Properties inherited from Barotrauma.EditableParams
bool	IsLoaded [get, protected set]
string	Name [get]
string	FileName [get]
string	FileNameWithoutExtension [get]
string	Folder [get]
ContentPath	Path = ContentPath.Empty [get, protected set]
Dictionary< Identifier, SerializableProperty >	SerializableProperties [get, protected set]
virtual ContentXElement	MainElement [get]
ContentXElement	OriginalElement [get, protected set]
Properties inherited from Barotrauma.ISerializableEntity

Additional Inherited Members
Protected Attributes inherited from Barotrauma.EditableParams
ContentXElement	rootElement
XDocument	doc

Detailed Description

Contains character data that should be editable in the character editor.

Constructor & Destructor Documentation

CharacterParams()

Barotrauma.CharacterParams.CharacterParams

(

CharacterFile

file

)

Member Function Documentation

AddBloodEmitter()

void Barotrauma.CharacterParams.AddBloodEmitter

(

)

AddDamageEmitter()

void Barotrauma.CharacterParams.AddDamageEmitter

(

)

AddGibEmitter()

void Barotrauma.CharacterParams.AddGibEmitter

(

)

AddInventory()

void Barotrauma.CharacterParams.AddInventory

(

)

AddSound()

bool Barotrauma.CharacterParams.AddSound

(

)

CompareGroup()

static bool Barotrauma.CharacterParams.CompareGroup ( Identifier group1, Identifier group2 )

static

CreateSubParams()

void Barotrauma.CharacterParams.CreateSubParams ( )

protected

CreateVariantXml()

static XElement Barotrauma.CharacterParams.CreateVariantXml ( XElement variantXML, XElement baseXML )

static

Deserialize()

bool Barotrauma.CharacterParams.Deserialize	(	XElement	element = null,
		bool	alsoChildren = true,
		bool	recursive = true,
		bool	loadDefaultValues = true )

GetName()

override string Barotrauma.CharacterParams.GetName ( )

protectedvirtual

Reimplemented from Barotrauma.EditableParams.

Load()

bool Barotrauma.CharacterParams.Load

(

)

RemoveBloodEmitter()

bool Barotrauma.CharacterParams.RemoveBloodEmitter

(

ParticleParams

emitter

)

RemoveDamageEmitter()

bool Barotrauma.CharacterParams.RemoveDamageEmitter

(

ParticleParams

emitter

)

RemoveGibEmitter()

bool Barotrauma.CharacterParams.RemoveGibEmitter

(

ParticleParams

emitter

)

RemoveInventory()

bool Barotrauma.CharacterParams.RemoveInventory

(

InventoryParams

inventory

)

RemoveSound()

bool Barotrauma.CharacterParams.RemoveSound

(

SoundParams

soundParams

)

RemoveSubParam< T >()

bool Barotrauma.CharacterParams.RemoveSubParam< T > ( T subParam, IList< T > collection = null )

protected

Type Constraints

T

:

SubParam

Reset()

override bool Barotrauma.CharacterParams.Reset ( bool forceReload = false )

virtual

Reimplemented from Barotrauma.EditableParams.

Save()

bool Barotrauma.CharacterParams.Save

(

string

fileNameWithoutExtension = null

)

Serialize()

bool Barotrauma.CharacterParams.Serialize	(	XElement	element = null,
		bool	alsoChildren = true,
		bool	recursive = true )

TryAddSubParam< T >()

bool Barotrauma.CharacterParams.TryAddSubParam< T > ( ContentXElement element, Func< ContentXElement, CharacterParams, T > constructor, out T subParam, IList< T > collection = null, Func< IList< T >, bool > filter = null )

protected

Type Constraints

T

:

SubParam

Member Data Documentation

BloodEmitters

readonly List<ParticleParams> Barotrauma.CharacterParams.BloodEmitters = new List<ParticleParams>()

DamageEmitters

readonly List<ParticleParams> Barotrauma.CharacterParams.DamageEmitters = new List<ParticleParams>()

File

readonly CharacterFile Barotrauma.CharacterParams.File

GibEmitters

readonly List<ParticleParams> Barotrauma.CharacterParams.GibEmitters = new List<ParticleParams>()

Inventories

readonly List<InventoryParams> Barotrauma.CharacterParams.Inventories = new List<InventoryParams>()

Sounds

readonly List<SoundParams> Barotrauma.CharacterParams.Sounds = new List<SoundParams>()

SubParams

readonly List<SubParam> Barotrauma.CharacterParams.SubParams = new List<SubParam>()

Property Documentation

AI

AIParams Barotrauma.CharacterParams.AI

get

Parameters for EnemyAIController. Not used by HumanAIController.

Returns

AIParams or null. Use EnemyAIController.AIParams, if you don't expect nulls.

AISlowTurretPriority

float Barotrauma.CharacterParams.AISlowTurretPriority

getset

AITurretPriority

float Barotrauma.CharacterParams.AITurretPriority

getset

BleedParticleAir

string Barotrauma.CharacterParams.BleedParticleAir

get

BleedParticleMultiplier

float Barotrauma.CharacterParams.BleedParticleMultiplier

get

BleedParticleWater

string Barotrauma.CharacterParams.BleedParticleWater

get

BloodDecal

string Barotrauma.CharacterParams.BloodDecal

get

CanEat

bool Barotrauma.CharacterParams.CanEat

getset

CanInteract

bool Barotrauma.CharacterParams.CanInteract

get

CanSpeak

bool Barotrauma.CharacterParams.CanSpeak

getset

DespawnContainer

Identifier Barotrauma.CharacterParams.DespawnContainer

get

DisableDistance

float Barotrauma.CharacterParams.DisableDistance

getset

DisplayName

string Barotrauma.CharacterParams.DisplayName

get

DistantSonarRange

float Barotrauma.CharacterParams.DistantSonarRange

getset

DrawLast

bool Barotrauma.CharacterParams.DrawLast

getset

EatingSpeed

float Barotrauma.CharacterParams.EatingSpeed

getset

Group

Identifier Barotrauma.CharacterParams.Group

get

HasInfo

bool Barotrauma.CharacterParams.HasInfo

get

Health

HealthParams Barotrauma.CharacterParams.Health

get

HideInSonar

bool Barotrauma.CharacterParams.HideInSonar

getset

HideInThermalGoggles

bool Barotrauma.CharacterParams.HideInThermalGoggles

getset

Humanoid

bool Barotrauma.CharacterParams.Humanoid

get

Husk

bool Barotrauma.CharacterParams.Husk

get

IsMachine

bool Barotrauma.CharacterParams.IsMachine

getset

MainElement

override ContentXElement Barotrauma.CharacterParams.MainElement

get

NeedsAir

bool Barotrauma.CharacterParams.NeedsAir

getset

NeedsWater

bool Barotrauma.CharacterParams.NeedsWater

getset

Noise

float Barotrauma.CharacterParams.Noise

getset

PathFinderPriority

float Barotrauma.CharacterParams.PathFinderPriority

getset

ShowHealthBar

bool Barotrauma.CharacterParams.ShowHealthBar

get

SonarDisruption

float Barotrauma.CharacterParams.SonarDisruption

getset

SoundInterval

float Barotrauma.CharacterParams.SoundInterval

getset

SpeciesName

Identifier Barotrauma.CharacterParams.SpeciesName

get

SpeciesTranslationOverride

Identifier Barotrauma.CharacterParams.SpeciesTranslationOverride

get

UseBossHealthBar

bool Barotrauma.CharacterParams.UseBossHealthBar

get

UseHumanAI

bool Barotrauma.CharacterParams.UseHumanAI

getset

UseHuskAppendage

bool Barotrauma.CharacterParams.UseHuskAppendage

get

UsePathFinding

bool Barotrauma.CharacterParams.UsePathFinding

getset

VariantFile

XDocument Barotrauma.CharacterParams.VariantFile

get

Visibility

float Barotrauma.CharacterParams.Visibility

getset

---

The documentation for this class was generated from the following file:

• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Characters/Params/CharacterParams.cs