Barotrauma Client Doc
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
Barotrauma.ConversationAction Class Reference
Inheritance diagram for Barotrauma.ConversationAction:
Barotrauma.EventAction Barotrauma.EventAction

Public Types

enum class  DialogTypes { Regular , Small , Mission }
 

Public Member Functions

 ConversationAction (ScriptedEvent parentEvent, ContentXElement element)
 
LocalizedString GetDisplayText ()
 
override IEnumerable< EventAction > GetSubActions ()
 
override bool IsFinished (ref string goTo)
 Has the action finished. More...
 
override void Reset ()
 
override bool SetGoToTarget (string goTo)
 
int[] GetEndingOptions ()
 
override void Update (float deltaTime)
 
override string ToDebugString ()
 Rich test to display in debugdraw More...
 
- Public Member Functions inherited from Barotrauma.EventAction
 EventAction (ScriptedEvent parentEvent, ContentXElement element)
 
virtual bool CanBeFinished ()
 

Static Public Member Functions

static void CreateDialog (LocalizedString text, Character speaker, IEnumerable< string > options, int[] closingOptions, string eventSprite, UInt16 actionId, bool fadeToBlack, DialogTypes dialogType, bool continueConversation=false)
 
static void SelectOption (ushort actionId, int option)
 
- Static Public Member Functions inherited from Barotrauma.EventAction
static EventAction Instantiate (ScriptedEvent scriptedEvent, ContentXElement element)
 

Public Attributes

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

Properties

string Text [get, set]
 
int DefaultOption [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]
 
static bool IsDialogOpen [get]
 
static bool FadeScreenToBlack [get]
 

Additional Inherited Members

- Protected Member Functions inherited from Barotrauma.EventAction
void ApplyTagsToHulls (Entity entity, Identifier hullTag, Identifier linkedHullTag)
 

Detailed Description

Definition at line 11 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

Member Enumeration Documentation

◆ DialogTypes

enum Barotrauma.ConversationAction.DialogTypes
strong
Enumerator
Regular 
Small 
Mission 

Definition at line 14 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

Constructor & Destructor Documentation

◆ ConversationAction()

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

Definition at line 94 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

Member Function Documentation

◆ CreateDialog()

static void Barotrauma.ConversationAction.CreateDialog ( LocalizedString  text,
Character  speaker,
IEnumerable< string >  options,
int[]  closingOptions,
string  eventSprite,
UInt16  actionId,
bool  fadeToBlack,
DialogTypes  dialogType,
bool  continueConversation = false 
)
static

Definition at line 48 of file BarotraumaClient/ClientSource/Events/EventActions/ConversationAction.cs.

◆ GetDisplayText()

LocalizedString Barotrauma.ConversationAction.GetDisplayText ( )

Definition at line 124 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ GetEndingOptions()

int [] Barotrauma.ConversationAction.GetEndingOptions ( )

Definition at line 240 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ GetSubActions()

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

Reimplemented from Barotrauma.EventAction.

Definition at line 139 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ IsFinished()

override bool Barotrauma.ConversationAction.IsFinished ( ref string  goToLabel)
virtual

Has the action finished.

Parameters
goToLabelIf null or empty, the event moves to the next action. Otherwise it moves to the specified label.
Returns

Implements Barotrauma.EventAction.

Definition at line 144 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ Reset()

override void Barotrauma.ConversationAction.Reset ( )
virtual

Implements Barotrauma.EventAction.

Definition at line 196 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ SelectOption()

static void Barotrauma.ConversationAction.SelectOption ( ushort  actionId,
int  option 
)
static

Definition at line 296 of file BarotraumaClient/ClientSource/Events/EventActions/ConversationAction.cs.

◆ SetGoToTarget()

override bool Barotrauma.ConversationAction.SetGoToTarget ( string  goTo)
virtual

Reimplemented from Barotrauma.EventAction.

Definition at line 206 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ 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.

Definition at line 431 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ Update()

override void Barotrauma.ConversationAction.Update ( float  deltaTime)
virtual

Reimplemented from Barotrauma.EventAction.

Definition at line 247 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

Member Data Documentation

◆ Identifier

readonly UInt16 Barotrauma.ConversationAction.Identifier

Definition at line 83 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

Property Documentation

◆ ContinueAutomatically

bool Barotrauma.ConversationAction.ContinueAutomatically
getset

Definition at line 63 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ ContinueConversation

bool Barotrauma.ConversationAction.ContinueConversation
getset

Definition at line 60 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ DefaultOption

int Barotrauma.ConversationAction.DefaultOption
getset

Definition at line 33 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ DialogType

DialogTypes Barotrauma.ConversationAction.DialogType
getset

Definition at line 57 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ EndEventIfInterrupted

bool Barotrauma.ConversationAction.EndEventIfInterrupted
getset

Definition at line 51 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ EventSprite

string Barotrauma.ConversationAction.EventSprite
getset

Definition at line 54 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ FadeScreenToBlack

bool Barotrauma.ConversationAction.FadeScreenToBlack
staticget

Definition at line 28 of file BarotraumaClient/ClientSource/Events/EventActions/ConversationAction.cs.

◆ FadeToBlack

bool Barotrauma.ConversationAction.FadeToBlack
getset

Definition at line 48 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ IgnoreInterruptDistance

bool Barotrauma.ConversationAction.IgnoreInterruptDistance
getset

Definition at line 66 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ Interrupted

SubactionGroup Barotrauma.ConversationAction.Interrupted
get

Definition at line 78 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ InvokerTag

Identifier Barotrauma.ConversationAction.InvokerTag
getset

Definition at line 45 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ IsDialogOpen

bool Barotrauma.ConversationAction.IsDialogOpen
staticget

Definition at line 19 of file BarotraumaClient/ClientSource/Events/EventActions/ConversationAction.cs.

◆ Options

List<SubactionGroup> Barotrauma.ConversationAction.Options
get

Definition at line 76 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ Speaker

Character Barotrauma.ConversationAction.Speaker
get

Definition at line 68 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ SpeakerTag

Identifier Barotrauma.ConversationAction.SpeakerTag
getset

Definition at line 36 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ TargetTag

Identifier Barotrauma.ConversationAction.TargetTag
getset

Definition at line 39 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ Text

string Barotrauma.ConversationAction.Text
getset

Definition at line 30 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.

◆ WaitForInteraction

bool Barotrauma.ConversationAction.WaitForInteraction
getset

Definition at line 42 of file BarotraumaShared/SharedSource/Events/EventActions/ConversationAction.cs.