Barotrauma.ConversationAction Class Reference

Triggers a "conversation popup" with text and support for different branching options. More...

Inheritance diagram for Barotrauma.ConversationAction:

Public Types
enum	DialogTypes { Regular , Small , Mission }

Public Member Functions
	ConversationAction (ScriptedEvent parentEvent, ContentXElement element)
LocalizedString	GetDisplayText ()
override IEnumerable< EventAction >	GetSubActions ()
override bool	IsFinished (ref string goTo)
override void	Reset ()
override bool	SetGoToTarget (string goTo)
int[]	GetEndingOptions ()
override void	Update (float deltaTime)
override string	ToDebugString ()
	Rich test to display in debugdraw.
void	IgnoreClient (Client c, float seconds)
void	ServerWrite (Character speaker, Client client, bool interrupt)
void	ServerWriteSelectedOption (Client client)
Public Member Functions inherited from Barotrauma.EventAction
	EventAction (ScriptedEvent parentEvent, ContentXElement element)
bool	IsFinished (ref string goToLabel)
	Has the action finished.
void	Reset ()
virtual bool	CanBeFinished ()

Public Attributes
readonly UInt16	Identifier
Public Attributes inherited from Barotrauma.EventAction
readonly ScriptedEvent	ParentEvent

Properties
string	Text [get, set]
Identifier	SpeakerTag [get, set]
Identifier	TargetTag [get, set]
bool	WaitForInteraction [get, set]
Identifier	InvokerTag [get, set]
bool	FadeToBlack [get, set]
bool	EndEventIfInterrupted [get, set]
string	EventSprite [get, set]
DialogTypes	DialogType [get, set]
bool	ContinueConversation [get, set]
bool	ContinueAutomatically [get, set]
bool	IgnoreInterruptDistance [get, set]
Character	Speaker [get]
List< SubactionGroup >	Options [get]
SubactionGroup	Interrupted [get]
int	SelectedOption [get, set]
IEnumerable< Client >	TargetClients [get]

Additional Inherited Members
Static Public Member Functions inherited from Barotrauma.EventAction
static EventAction	Instantiate (ScriptedEvent scriptedEvent, ContentXElement element)
Protected Member Functions inherited from Barotrauma.EventAction
void	ApplyTagsToHulls (Entity entity, Identifier hullTag, Identifier linkedHullTag)
string	GetEventDebugName ()

Detailed Description

Triggers a "conversation popup" with text and support for different branching options.

Member Enumeration Documentation

DialogTypes

enum Barotrauma.ConversationAction.DialogTypes

Enumerator
Regular
Small
Mission

Constructor & Destructor Documentation

ConversationAction()

Barotrauma.ConversationAction.ConversationAction	(	ScriptedEvent	parentEvent,
		ContentXElement	element )

Member Function Documentation

GetDisplayText()

LocalizedString Barotrauma.ConversationAction.GetDisplayText

(

)

GetEndingOptions()

int[] Barotrauma.ConversationAction.GetEndingOptions

(

)

GetSubActions()

override IEnumerable< EventAction > Barotrauma.ConversationAction.GetSubActions ( )

virtual

Reimplemented from Barotrauma.EventAction.

IgnoreClient()

void Barotrauma.ConversationAction.IgnoreClient	(	Client	c,
		float	seconds )

IsFinished()

override bool Barotrauma.ConversationAction.IsFinished

(

ref string

goTo

)

Reset()

override void Barotrauma.ConversationAction.Reset

(

)

ServerWrite()

void Barotrauma.ConversationAction.ServerWrite	(	Character	speaker,
		Client	client,
		bool	interrupt )

ServerWriteSelectedOption()

void Barotrauma.ConversationAction.ServerWriteSelectedOption

(

Client

client

)

SetGoToTarget()

override bool Barotrauma.ConversationAction.SetGoToTarget ( string goTo )

virtual

Reimplemented from Barotrauma.EventAction.

ToDebugString()

override string Barotrauma.ConversationAction.ToDebugString ( )

virtual

Rich test to display in debugdraw.

public override string ToDebugString()
{
    return $"{ToolBox.GetDebugSymbol(isFinished)} SomeAction -> "(someInfo: {info.ColorizeObject()})";
}

Returns

Reimplemented from Barotrauma.EventAction.

Update()

override void Barotrauma.ConversationAction.Update ( float deltaTime )

virtual

Reimplemented from Barotrauma.EventAction.

Member Data Documentation

Identifier

readonly UInt16 Barotrauma.ConversationAction.Identifier

Property Documentation

ContinueAutomatically

bool Barotrauma.ConversationAction.ContinueAutomatically

getset

ContinueConversation

bool Barotrauma.ConversationAction.ContinueConversation

getset

DialogType

DialogTypes Barotrauma.ConversationAction.DialogType

getset

EndEventIfInterrupted

bool Barotrauma.ConversationAction.EndEventIfInterrupted

getset

EventSprite

string Barotrauma.ConversationAction.EventSprite

getset

FadeToBlack

bool Barotrauma.ConversationAction.FadeToBlack

getset

IgnoreInterruptDistance

bool Barotrauma.ConversationAction.IgnoreInterruptDistance

getset

Interrupted

SubactionGroup Barotrauma.ConversationAction.Interrupted

get

InvokerTag

Identifier Barotrauma.ConversationAction.InvokerTag

getset

Options

List<SubactionGroup> Barotrauma.ConversationAction.Options

get

SelectedOption

int Barotrauma.ConversationAction.SelectedOption

getset

Speaker

Character Barotrauma.ConversationAction.Speaker

get

SpeakerTag

Identifier Barotrauma.ConversationAction.SpeakerTag

getset

TargetClients

IEnumerable<Client> Barotrauma.ConversationAction.TargetClients

get

TargetTag

Identifier Barotrauma.ConversationAction.TargetTag

getset

Text

string Barotrauma.ConversationAction.Text

getset

WaitForInteraction

bool Barotrauma.ConversationAction.WaitForInteraction

getset

---

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

• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs
• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaServer/ServerSource/Events/EventActions/ConversationAction.cs