Inheritance diagram for Barotrauma.MissionPrefab:

Classes
class	ReputationReward

class	TriggerEvent

Public Member Functions
	MissionPrefab (ContentXElement element, MissionsFile file)

bool	IsAllowed (Location from, Location to)

bool	IsAllowedDifficulty (float difficulty)
	Inclusive (matching the min an max values is accepted).

Mission	Instantiate (Location[] locations, Submarine sub)

override void	Dispose ()

Public Member Functions inherited from Barotrauma.Prefab
	Prefab (ContentFile file, Identifier identifier)

	Prefab (ContentFile file, ContentXElement element)

void	Dispose ()

Public Attributes
readonly MissionType	Type

readonly bool	MultiplayerOnly

readonly bool	SingleplayerOnly

readonly Identifier	TextIdentifier

readonly ImmutableHashSet< Identifier >	Tags

readonly LocalizedString	Name

readonly LocalizedString	Description

readonly LocalizedString	SuccessMessage

readonly LocalizedString	FailureMessage

readonly LocalizedString	SonarLabel

readonly Identifier	SonarIconIdentifier

readonly Identifier	AchievementIdentifier

readonly ImmutableList< ReputationReward >	ReputationRewards

readonly List<(Identifier Identifier, object Value, SetDataAction.OperationType OperationType)>	DataRewards = new List<(Identifier Identifier, object Value, SetDataAction.OperationType OperationType)>()

readonly int	Commonness

readonly? int	Difficulty
	Displayed difficulty (indicator)

readonly int	MinLevelDifficulty = 0
	The actual minimum difficulty of the level allowed for this mission to trigger.

readonly int	MaxLevelDifficulty = 100
	The actual maximum difficulty of the level allowed for this mission to trigger.

readonly int	Reward

readonly ImmutableArray< LocalizedString >	Headers

readonly ImmutableArray< LocalizedString >	Messages

readonly bool	AllowRetry

readonly bool	ShowInMenus

readonly bool	ShowStartMessage

readonly bool	IsSideObjective

readonly bool	AllowOtherMissionsInLevel

readonly bool	RequireWreck

readonly bool	RequireRuin

readonly bool	RequireThalamusWreck

readonly bool	BlockLocationTypeChanges
	If enabled, locations this mission takes place in cannot change their type.

readonly bool	ShowProgressBar

readonly bool	ShowProgressInNumbers

readonly int	MaxProgressState

readonly LocalizedString	ProgressBarLabel

readonly List<(Identifier from, Identifier to)>	AllowedConnectionTypes
	The mission can only be received when travelling from a location of the first type to a location of the second type.

readonly List< Identifier >	AllowedLocationTypes = new List<Identifier>()
	The mission can only be received in these location types.

readonly Identifier	RequiredLocationFaction
	The mission can only happen in locations owned by this faction. In the mission mode, the location is forced to be owned by this faction.

readonly List< string >	UnhideEntitySubCategories = new List<string>()
	Show entities belonging to these sub categories when the mission starts.

readonly List< TriggerEvent >	TriggerEvents = new List<TriggerEvent>()

LocationTypeChange	LocationTypeChangeOnCompleted

readonly ContentXElement	ConfigElement

Public Attributes inherited from Barotrauma.Prefab
readonly Identifier	Identifier

readonly ContentFile	ContentFile

Static Public Attributes
static readonly PrefabCollection< MissionPrefab >	Prefabs = new PrefabCollection<MissionPrefab>()

static readonly Dictionary< MissionType, Type >	CoOpMissionClasses

static readonly Dictionary< MissionType, Type >	PvPMissionClasses

static readonly HashSet< MissionType >	HiddenMissionClasses = new HashSet<MissionType>() { MissionType.GoTo, MissionType.End }

const int	MinDifficulty = 1

const int	MaxDifficulty = 4

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.PrefabWithUintIdentifier
	PrefabWithUintIdentifier (ContentFile file, Identifier identifier)

	PrefabWithUintIdentifier (ContentFile file, ContentXElement element)

Protected Member Functions inherited from Barotrauma.Prefab
virtual Identifier	DetermineIdentifier (XElement element)

Properties inherited from Barotrauma.PrefabWithUintIdentifier
UInt32	UintIdentifier `[get, set]`

Properties inherited from Barotrauma.Prefab
ContentPackage?	ContentPackage `[get]`

ContentPath	FilePath `[get]`

Constructor & Destructor Documentation

◆ MissionPrefab()

Barotrauma.MissionPrefab.MissionPrefab	(	ContentXElement	element,
		MissionsFile	file )

Member Function Documentation

◆ Dispose()

override void Barotrauma.MissionPrefab.Dispose ( )

◆ Instantiate()

Mission Barotrauma.MissionPrefab.Instantiate	(	Location[]	locations,
		Submarine	sub )

◆ IsAllowed()

bool Barotrauma.MissionPrefab.IsAllowed	(	Location	from,
		Location	to )

◆ IsAllowedDifficulty()

bool Barotrauma.MissionPrefab.IsAllowedDifficulty ( float difficulty )

Inclusive (matching the min an max values is accepted).

Member Data Documentation

◆ AchievementIdentifier

readonly Identifier Barotrauma.MissionPrefab.AchievementIdentifier

◆ AllowedConnectionTypes

readonly List<(Identifier from, Identifier to)> Barotrauma.MissionPrefab.AllowedConnectionTypes

The mission can only be received when travelling from a location of the first type to a location of the second type.

◆ AllowedLocationTypes

readonly List<Identifier> Barotrauma.MissionPrefab.AllowedLocationTypes = new List<Identifier>()

The mission can only be received in these location types.

◆ AllowOtherMissionsInLevel

readonly bool Barotrauma.MissionPrefab.AllowOtherMissionsInLevel

◆ AllowRetry

readonly bool Barotrauma.MissionPrefab.AllowRetry

◆ BlockLocationTypeChanges

readonly bool Barotrauma.MissionPrefab.BlockLocationTypeChanges

If enabled, locations this mission takes place in cannot change their type.

◆ Commonness

readonly int Barotrauma.MissionPrefab.Commonness

◆ ConfigElement

readonly ContentXElement Barotrauma.MissionPrefab.ConfigElement

◆ CoOpMissionClasses

readonly Dictionary<MissionType, Type> Barotrauma.MissionPrefab.CoOpMissionClasses

static

Initial value:

= new Dictionary<MissionType, Type>()
        {
            { MissionType.Salvage, typeof(SalvageMission) },
            { MissionType.Monster, typeof(MonsterMission) },
            { MissionType.Cargo, typeof(CargoMission) },
            { MissionType.Beacon, typeof(BeaconMission) },
            { MissionType.Nest, typeof(NestMission) },
            { MissionType.Mineral, typeof(MineralMission) },
            { MissionType.AbandonedOutpost, typeof(AbandonedOutpostMission) },
            { MissionType.Escort, typeof(EscortMission) },
            { MissionType.Pirate, typeof(PirateMission) },
            { MissionType.GoTo, typeof(GoToMission) },
            { MissionType.ScanAlienRuins, typeof(ScanMission) },
            { MissionType.EliminateTargets, typeof(EliminateTargetsMission) },
            { MissionType.End, typeof(EndMission) }
        }

◆ DataRewards

readonly List<(Identifier Identifier, object Value, SetDataAction.OperationType OperationType)> Barotrauma.MissionPrefab.DataRewards = new List<(Identifier Identifier, object Value, SetDataAction.OperationType OperationType)>()

◆ Description

readonly LocalizedString Barotrauma.MissionPrefab.Description

◆ Difficulty

readonly? int Barotrauma.MissionPrefab.Difficulty

Displayed difficulty (indicator)

◆ FailureMessage

readonly LocalizedString Barotrauma.MissionPrefab.FailureMessage

◆ Headers

readonly ImmutableArray<LocalizedString> Barotrauma.MissionPrefab.Headers

◆ HiddenMissionClasses

readonly HashSet<MissionType> Barotrauma.MissionPrefab.HiddenMissionClasses = new HashSet<MissionType>() { MissionType.GoTo, MissionType.End }

static

◆ IsSideObjective

readonly bool Barotrauma.MissionPrefab.IsSideObjective

◆ LocationTypeChangeOnCompleted

LocationTypeChange Barotrauma.MissionPrefab.LocationTypeChangeOnCompleted

◆ MaxDifficulty

const int Barotrauma.MissionPrefab.MaxDifficulty = 4

static

◆ MaxLevelDifficulty

readonly int Barotrauma.MissionPrefab.MaxLevelDifficulty = 100

The actual maximum difficulty of the level allowed for this mission to trigger.

◆ MaxProgressState

readonly int Barotrauma.MissionPrefab.MaxProgressState

◆ Messages

readonly ImmutableArray<LocalizedString> Barotrauma.MissionPrefab.Messages

◆ MinDifficulty

const int Barotrauma.MissionPrefab.MinDifficulty = 1

static

◆ MinLevelDifficulty

readonly int Barotrauma.MissionPrefab.MinLevelDifficulty = 0

The actual minimum difficulty of the level allowed for this mission to trigger.

◆ MultiplayerOnly

readonly bool Barotrauma.MissionPrefab.MultiplayerOnly

◆ Name

readonly LocalizedString Barotrauma.MissionPrefab.Name

◆ Prefabs

readonly PrefabCollection<MissionPrefab> Barotrauma.MissionPrefab.Prefabs = new PrefabCollection<MissionPrefab>()

static

◆ ProgressBarLabel

readonly LocalizedString Barotrauma.MissionPrefab.ProgressBarLabel

◆ PvPMissionClasses

readonly Dictionary<MissionType, Type> Barotrauma.MissionPrefab.PvPMissionClasses

static

Initial value:

= new Dictionary<MissionType, Type>()
        {
            { MissionType.Combat, typeof(CombatMission) }
        }

◆ ReputationRewards

readonly ImmutableList<ReputationReward> Barotrauma.MissionPrefab.ReputationRewards

◆ RequiredLocationFaction

readonly Identifier Barotrauma.MissionPrefab.RequiredLocationFaction

The mission can only happen in locations owned by this faction. In the mission mode, the location is forced to be owned by this faction.

◆ RequireRuin

readonly bool Barotrauma.MissionPrefab.RequireRuin

◆ RequireThalamusWreck

readonly bool Barotrauma.MissionPrefab.RequireThalamusWreck

◆ RequireWreck

readonly bool Barotrauma.MissionPrefab.RequireWreck

◆ Reward

readonly int Barotrauma.MissionPrefab.Reward

◆ ShowInMenus

readonly bool Barotrauma.MissionPrefab.ShowInMenus

◆ ShowProgressBar

readonly bool Barotrauma.MissionPrefab.ShowProgressBar

◆ ShowProgressInNumbers

readonly bool Barotrauma.MissionPrefab.ShowProgressInNumbers

◆ ShowStartMessage

readonly bool Barotrauma.MissionPrefab.ShowStartMessage

◆ SingleplayerOnly

readonly bool Barotrauma.MissionPrefab.SingleplayerOnly

◆ SonarIconIdentifier

readonly Identifier Barotrauma.MissionPrefab.SonarIconIdentifier

◆ SonarLabel

readonly LocalizedString Barotrauma.MissionPrefab.SonarLabel

◆ SuccessMessage

readonly LocalizedString Barotrauma.MissionPrefab.SuccessMessage

◆ Tags

readonly ImmutableHashSet<Identifier> Barotrauma.MissionPrefab.Tags

◆ TextIdentifier

readonly Identifier Barotrauma.MissionPrefab.TextIdentifier

◆ TriggerEvents

readonly List<TriggerEvent> Barotrauma.MissionPrefab.TriggerEvents = new List<TriggerEvent>()

◆ Type

readonly MissionType Barotrauma.MissionPrefab.Type

◆ UnhideEntitySubCategories

readonly List<string> Barotrauma.MissionPrefab.UnhideEntitySubCategories = new List<string>()

Show entities belonging to these sub categories when the mission starts.

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

/home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Events/Missions/MissionPrefab.cs

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ MissionPrefab()

Member Function Documentation

◆ Dispose()

◆ Instantiate()

◆ IsAllowed()

◆ IsAllowedDifficulty()

Member Data Documentation

◆ AchievementIdentifier

◆ AllowedConnectionTypes

◆ AllowedLocationTypes

◆ AllowOtherMissionsInLevel

◆ AllowRetry

◆ BlockLocationTypeChanges

◆ Commonness

◆ ConfigElement

◆ CoOpMissionClasses

◆ DataRewards

◆ Description

◆ Difficulty

◆ FailureMessage

◆ Headers

◆ HiddenMissionClasses

◆ IsSideObjective

◆ LocationTypeChangeOnCompleted

◆ MaxDifficulty

◆ MaxLevelDifficulty

◆ MaxProgressState

◆ Messages

◆ MinDifficulty

◆ MinLevelDifficulty

◆ MultiplayerOnly

◆ Name

◆ Prefabs

◆ ProgressBarLabel

◆ PvPMissionClasses

◆ ReputationRewards

◆ RequiredLocationFaction

◆ RequireRuin

◆ RequireThalamusWreck

◆ RequireWreck

◆ Reward

◆ ShowInMenus

◆ ShowProgressBar

◆ ShowProgressInNumbers

◆ ShowStartMessage

◆ SingleplayerOnly

◆ SonarIconIdentifier

◆ SonarLabel

◆ SuccessMessage

◆ Tags

◆ TextIdentifier

◆ TriggerEvents

◆ Type

◆ UnhideEntitySubCategories