Barotrauma Client Doc
Barotrauma.TutorialPrefab Class Reference
Inheritance diagram for Barotrauma.TutorialPrefab:
Barotrauma.Prefab

Public Types

enum class  EndType { None , Continue , Restart }
 

Public Member Functions

readonly record struct EndMessageInfo (EndType EndType, Identifier NextTutorialIdentifier)
 
 TutorialPrefab (ContentFile file, ContentXElement element)
 
CharacterInfo GetTutorialCharacterInfo ()
 
override void Dispose ()
 
- Public Member Functions inherited from Barotrauma.Prefab
 Prefab (ContentFile file, Identifier identifier)
 
 Prefab (ContentFile file, ContentXElement element)
 

Public Attributes

readonly int Order
 
readonly bool DisableBotConversations
 
readonly bool AllowCharacterSwitch
 
readonly ContentPath SubmarinePath = ContentPath.FromRaw("Content/Tutorials/Dugong_Tutorial.sub")
 
readonly ContentPath OutpostPath = ContentPath.FromRaw("Content/Tutorials/TutorialOutpost.sub")
 
readonly string LevelSeed
 
readonly string LevelParams
 
readonly ImmutableArray< IdentifierStartingItemTags
 
readonly Identifier EventIdentifier
 
readonly Sprite Banner
 
readonly EndMessageInfo EndMessage
 
- Public Attributes inherited from Barotrauma.Prefab
readonly Identifier Identifier
 
readonly ContentFile ContentFile
 

Static Public Attributes

static readonly PrefabCollection< TutorialPrefabPrefabs
 
- Static Public Attributes inherited from Barotrauma.Prefab
static readonly ImmutableHashSet< Type > Types
 

Additional Inherited Members

- Static Public Member Functions inherited from Barotrauma.Prefab
static void DisallowCallFromConstructor ()
 
- Protected Member Functions inherited from Barotrauma.Prefab
virtual Identifier DetermineIdentifier (XElement element)
 
- Properties inherited from Barotrauma.Prefab
ContentPackageContentPackage [get]
 
ContentPath FilePath [get]
 

Detailed Description

Definition at line 6 of file TutorialPrefab.cs.

Member Enumeration Documentation

◆ EndType

Enumerator
None 
Continue 
Restart 

Definition at line 34 of file TutorialPrefab.cs.

Constructor & Destructor Documentation

◆ TutorialPrefab()

Barotrauma.TutorialPrefab.TutorialPrefab ( ContentFile  file,
ContentXElement  element 
)

Definition at line 40 of file TutorialPrefab.cs.

Member Function Documentation

◆ Dispose()

override void Barotrauma.TutorialPrefab.Dispose ( )
virtual

Implements Barotrauma.Prefab.

Definition at line 103 of file TutorialPrefab.cs.

◆ EndMessageInfo()

readonly record struct Barotrauma.TutorialPrefab.EndMessageInfo ( EndType  EndType,
Identifier  NextTutorialIdentifier 
)

◆ GetTutorialCharacterInfo()

CharacterInfo Barotrauma.TutorialPrefab.GetTutorialCharacterInfo ( )

Definition at line 79 of file TutorialPrefab.cs.

Member Data Documentation

◆ AllowCharacterSwitch

readonly bool Barotrauma.TutorialPrefab.AllowCharacterSwitch

Definition at line 18 of file TutorialPrefab.cs.

◆ Banner

readonly Sprite Barotrauma.TutorialPrefab.Banner

Definition at line 30 of file TutorialPrefab.cs.

◆ DisableBotConversations

readonly bool Barotrauma.TutorialPrefab.DisableBotConversations

Definition at line 17 of file TutorialPrefab.cs.

◆ EndMessage

readonly EndMessageInfo Barotrauma.TutorialPrefab.EndMessage

Definition at line 32 of file TutorialPrefab.cs.

◆ EventIdentifier

readonly Identifier Barotrauma.TutorialPrefab.EventIdentifier

Definition at line 28 of file TutorialPrefab.cs.

◆ LevelParams

readonly string Barotrauma.TutorialPrefab.LevelParams

Definition at line 23 of file TutorialPrefab.cs.

◆ LevelSeed

readonly string Barotrauma.TutorialPrefab.LevelSeed

Definition at line 22 of file TutorialPrefab.cs.

◆ Order

readonly int Barotrauma.TutorialPrefab.Order

Definition at line 16 of file TutorialPrefab.cs.

◆ OutpostPath

readonly ContentPath Barotrauma.TutorialPrefab.OutpostPath = ContentPath.FromRaw("Content/Tutorials/TutorialOutpost.sub")

Definition at line 21 of file TutorialPrefab.cs.

◆ Prefabs

readonly PrefabCollection<TutorialPrefab> Barotrauma.TutorialPrefab.Prefabs
static
Initial value:
=
new PrefabCollection<TutorialPrefab>(onSort: MainMenuScreen.UpdateInstanceTutorialButtons)

Definition at line 9 of file TutorialPrefab.cs.

◆ StartingItemTags

readonly ImmutableArray<Identifier> Barotrauma.TutorialPrefab.StartingItemTags

Definition at line 26 of file TutorialPrefab.cs.

◆ SubmarinePath

readonly ContentPath Barotrauma.TutorialPrefab.SubmarinePath = ContentPath.FromRaw("Content/Tutorials/Dugong_Tutorial.sub")

Definition at line 20 of file TutorialPrefab.cs.