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	TargetType { Any , Self , OtherCharacter }

Public Member Functions
	Description (ContentXElement element, AfflictionPrefab affliction)

Public Attributes
readonly LocalizedString	Text
	Raw text for the description.

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

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

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

readonly TargetType	Target
	Who can see the description.

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>

Member Enumeration Documentation

◆ TargetType

enum Barotrauma.AfflictionPrefab.Description.TargetType

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.

Constructor & Destructor Documentation

◆ Description()

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

Member Data Documentation

◆ MaxStrength

readonly float Barotrauma.AfflictionPrefab.Description.MaxStrength

Maximum strength required for the description to be shown.

◆ MinStrength

readonly float Barotrauma.AfflictionPrefab.Description.MinStrength

Minimum strength required for the description to be shown.

◆ Target

readonly TargetType Barotrauma.AfflictionPrefab.Description.Target

Who can see the description.

◆ Text

readonly LocalizedString Barotrauma.AfflictionPrefab.Description.Text

Raw text for the description.

◆ TextTag

readonly Identifier Barotrauma.AfflictionPrefab.Description.TextTag

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

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

/home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Characters/Health/Afflictions/AfflictionPrefab.cs

Public Types

Public Member Functions

Public Attributes