The description element can be used to define descriptions for the affliction which are shown under specific conditions; for example a description that only shows to other players or only at certain strength levels. More...

Public Types
enum class	TargetType { Any , Self , OtherCharacter }

Public Member Functions
	Description (ContentXElement element, AfflictionPrefab affliction)

Public Attributes
readonly LocalizedString	Text
	Raw text for the description. More...

readonly Identifier	TextTag
	Text tag used to set the text from the localization files. More...

readonly float	MinStrength
	Minimum strength required for the description to be shown. More...

readonly float	MaxStrength
	Maximum strength required for the description to be shown. More...

readonly TargetType	Target
	Who can see the description. More...

Detailed Description

The description element can be used to define descriptions for the affliction which are shown under specific conditions; for example a description that only shows to other players or only at certain strength levels.

<doc> <Field identifier="Text" type="string" defaultValue=""""> Raw text for the description. </Field> </doc>

Definition at line 490 of file AfflictionPrefab.cs.

Member Enumeration Documentation

◆ TargetType

enum Barotrauma.AfflictionPrefab.Description.TargetType

strong

Enumerator
Any	Everyone can see the description.
Self	Only the affected character can see the description.
OtherCharacter	The affected character cannot see the description but others can.

Definition at line 492 of file AfflictionPrefab.cs.

Constructor & Destructor Documentation

◆ Description()

Barotrauma.AfflictionPrefab.Description.Description	(	ContentXElement	element,
		AfflictionPrefab	affliction
	)

Definition at line 533 of file AfflictionPrefab.cs.

Member Data Documentation

◆ MaxStrength

readonly float Barotrauma.AfflictionPrefab.Description.MaxStrength

Maximum strength required for the description to be shown.

Definition at line 526 of file AfflictionPrefab.cs.

◆ MinStrength

readonly float Barotrauma.AfflictionPrefab.Description.MinStrength

Minimum strength required for the description to be shown.

Definition at line 521 of file AfflictionPrefab.cs.

◆ Target

readonly TargetType Barotrauma.AfflictionPrefab.Description.Target

Who can see the description.

Definition at line 531 of file AfflictionPrefab.cs.

◆ Text

readonly LocalizedString Barotrauma.AfflictionPrefab.Description.Text

Raw text for the description.

Definition at line 511 of file AfflictionPrefab.cs.

◆ TextTag

readonly Identifier Barotrauma.AfflictionPrefab.Description.TextTag

Text tag used to set the text from the localization files.

Definition at line 516 of file AfflictionPrefab.cs.

Public Types

Public Member Functions

Public Attributes