Barotrauma.Mission Class Reference

Inheritance diagram for Barotrauma.Mission:

Public Member Functions
	Mission (MissionPrefab prefab, Location[] locations, Submarine sub)
virtual void	SetLevel (LevelData level)
virtual int	GetReward (Submarine sub)
void	Start (Level level)
void	Update (float deltaTime)
void	End ()
	End the mission and give a reward if it was completed successfully More...
int	GetFinalReward (Submarine sub)
	Get the final reward, taking talent bonuses into account if the mission has concluded and the talents modified the reward accordingly. More...
virtual void	AdjustLevelData (LevelData levelData)
Color	GetDifficultyColor ()
virtual RichString	GetMissionRewardText (Submarine sub)
	Returns the full reward text of the mission (e.g. "Reward: 2,000 mk" or "Reward: 500 mk x 2 (out of max 5) = 1,000 mk") More...
RichString	GetReputationRewardText ()
Identifier	GetOverrideMusicType ()
virtual void	ClientRead (IReadMessage msg)
virtual void	ClientReadInitial (IReadMessage msg)

Static Public Member Functions
static Mission	LoadRandom (Location[] locations, string seed, bool requireCorrectLocationType, MissionType missionType, bool isSinglePlayer=false)
static Mission	LoadRandom (Location[] locations, MTRandom rand, bool requireCorrectLocationType, MissionType missionType, bool isSinglePlayer=false)
static int	GetRewardDistibutionSum (IEnumerable< Character > crew, int rewardDistribution=0)
static Color	GetDifficultyColor (int difficulty)

Public Attributes
readonly MissionPrefab	Prefab
readonly ImmutableArray< LocalizedString >	Headers
readonly ImmutableArray< LocalizedString >	Messages
Location	OriginLocation
	Where was this mission received from? Affects which faction we give reputation for if the mission is configured to give reputation for the faction that gave the mission. Defaults to Locations[0] More...
readonly Location[]	Locations
Action< Mission >	OnMissionStateChanged

Static Public Attributes
static int	Amount

Protected Member Functions
virtual void	StartMissionSpecific (Level level)
virtual void	UpdateMissionSpecific (float deltaTime)
void	ShowMessage (int missionState)
virtual LocalizedString	ModifyMessage (LocalizedString message, bool color=true)
abstract bool	DetermineCompleted ()
virtual void	EndMissionSpecific (bool completed)
void	ChangeLocationType (LocationTypeChange change)
HumanPrefab	GetHumanPrefabFromElement (XElement element)
ItemPrefab	FindItemPrefab (XElement element)
Vector2?	GetCargoSpawnPosition (ItemPrefab itemPrefab, out Submarine cargoRoomSub)
LocalizedString	GetRewardAmountText (Submarine sub)
	Returns the amount of marks you get from the reward (e.g. "3,000 mk") More...
void	CreateMessageBox (LocalizedString header, LocalizedString message)

Static Protected Member Functions
static Character	CreateHuman (HumanPrefab humanPrefab, List< Character > characters, Dictionary< Character, List< Item >> characterItems, Submarine submarine, CharacterTeamType teamType, ISpatialEntity positionToStayIn=null, Rand.RandSync humanPrefabRandSync=Rand.RandSync.ServerAndClient)

Protected Attributes
bool	failed
Level	level
int	state
LocalizedString	description
LocalizedString	descriptionWithoutReward

Properties
virtual int?	State [get, set]
int	TimesAttempted [get, set]
static bool	IsClient [get]
virtual LocalizedString	Name [get]
virtual LocalizedString	SuccessMessage [get]
virtual LocalizedString	FailureMessage [get]
virtual LocalizedString	Description [get]
virtual bool	AllowUndocking [get]
virtual int	Reward [get]
ImmutableList< MissionPrefab.ReputationReward >	ReputationRewards [get]
bool	Completed [get, set]
bool	Failed [get]
virtual bool	AllowRespawn [get]
virtual int	TeamCount [get]
virtual SubmarineInfo	EnemySubmarineInfo [get]
virtual IEnumerable<(LocalizedString Label, Vector2 Position)>	SonarLabels [get]
Identifier	SonarIconIdentifier [get]
int?	Difficulty [get]
IEnumerable< LocalizedString >	ShownMessages [get]
bool	DisplayTargetHudIcons [get]
virtual IEnumerable< Entity >	HudIconTargets [get]
abstract bool	DisplayAsCompleted [get]
	Is the mission at a state at which the only thing left to do is to reach the end of the level? More...
abstract bool	DisplayAsFailed [get]
	Is the mission at a state at which the mission cannot be completed anymore? More...

Detailed Description

Definition at line 13 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Constructor & Destructor Documentation

Mission()

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

Definition at line 165 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Member Function Documentation

AdjustLevelData()

virtual void Barotrauma.Mission.AdjustLevelData ( LevelData  levelData )

virtual

Reimplemented in Barotrauma.BeaconMission.

Definition at line 543 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

ChangeLocationType()

void Barotrauma.Mission.ChangeLocationType ( LocationTypeChange  change )

protected

Definition at line 512 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

ClientRead()

virtual void Barotrauma.Mission.ClientRead ( IReadMessage  msg )

virtual

Reimplemented in Barotrauma.ScanMission, and Barotrauma.SalvageMission.

Definition at line 181 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

ClientReadInitial()

virtual void Barotrauma.Mission.ClientReadInitial ( IReadMessage  msg )

virtual

Reimplemented in Barotrauma.ScanMission, Barotrauma.SalvageMission, Barotrauma.PirateMission, Barotrauma.NestMission, Barotrauma.MonsterMission, Barotrauma.MineralMission, Barotrauma.EscortMission, Barotrauma.EndMission, Barotrauma.CargoMission, Barotrauma.AlienRuinMission, and Barotrauma.AbandonedOutpostMission.

Definition at line 186 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

CreateHuman()

static Character Barotrauma.Mission.CreateHuman ( HumanPrefab  humanPrefab, List< Character >  characters, Dictionary< Character, List< Item >>  characterItems, Submarine  submarine, CharacterTeamType  teamType, ISpatialEntity  positionToStayIn = null, Rand.RandSync  humanPrefabRandSync = Rand.RandSync.ServerAndClient  )

staticprotected

Definition at line 568 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

CreateMessageBox()

void Barotrauma.Mission.CreateMessageBox ( LocalizedString  header, LocalizedString  message  )

protected

Definition at line 167 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

DetermineCompleted()

abstract bool Barotrauma.Mission.DetermineCompleted ( )

protectedpure virtual

Implemented in Barotrauma.ScanMission, Barotrauma.SalvageMission, Barotrauma.PirateMission, Barotrauma.NestMission, Barotrauma.MonsterMission, Barotrauma.MineralMission, Barotrauma.GoToMission, Barotrauma.EscortMission, Barotrauma.EndMission, Barotrauma.CombatMission, Barotrauma.CargoMission, Barotrauma.BeaconMission, Barotrauma.AlienRuinMission, and Barotrauma.AbandonedOutpostMission.

End()

void Barotrauma.Mission.End

(

)

End the mission and give a reward if it was completed successfully

Definition at line 364 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

EndMissionSpecific()

virtual void Barotrauma.Mission.EndMissionSpecific ( bool  completed )

protectedvirtual

Reimplemented in Barotrauma.ScanMission, Barotrauma.SalvageMission, Barotrauma.PirateMission, Barotrauma.NestMission, Barotrauma.MonsterMission, Barotrauma.MineralMission, Barotrauma.EscortMission, Barotrauma.CargoMission, Barotrauma.BeaconMission, Barotrauma.AlienRuinMission, and Barotrauma.AbandonedOutpostMission.

Definition at line 397 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

FindItemPrefab()

ItemPrefab Barotrauma.Mission.FindItemPrefab ( XElement  element )

protected

Definition at line 587 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

GetCargoSpawnPosition()

Vector2? Barotrauma.Mission.GetCargoSpawnPosition ( ItemPrefab  itemPrefab, out Submarine  cargoRoomSub  )

protected

Definition at line 615 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

GetDifficultyColor() [1/2]

Color Barotrauma.Mission.GetDifficultyColor

(

)

Definition at line 29 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

GetDifficultyColor() [2/2]

static Color Barotrauma.Mission.GetDifficultyColor ( int  difficulty )

static

Definition at line 33 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

GetFinalReward()

int Barotrauma.Mission.GetFinalReward

(

Submarine

sub

)

Get the final reward, taking talent bonuses into account if the mission has concluded and the talents modified the reward accordingly.

Definition at line 402 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

GetHumanPrefabFromElement()

HumanPrefab Barotrauma.Mission.GetHumanPrefabFromElement ( XElement  element )

protected

Definition at line 546 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

GetMissionRewardText()

virtual RichString Barotrauma.Mission.GetMissionRewardText ( Submarine  sub )

virtual

Returns the full reward text of the mission (e.g. "Reward: 2,000 mk" or "Reward: 500 mk x 2 (out of max 5) = 1,000 mk")

Reimplemented in Barotrauma.CargoMission.

Definition at line 58 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

GetOverrideMusicType()

Identifier Barotrauma.Mission.GetOverrideMusicType

(

)

Definition at line 176 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

GetReputationRewardText()

RichString Barotrauma.Mission.GetReputationRewardText

(

)

Definition at line 64 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

GetReward()

virtual int Barotrauma.Mission.GetReward ( Submarine  sub )

virtual

Reimplemented in Barotrauma.PirateMission, Barotrauma.EscortMission, and Barotrauma.CargoMission.

Definition at line 257 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

GetRewardAmountText()

LocalizedString Barotrauma.Mission.GetRewardAmountText ( Submarine  sub )

protected

Returns the amount of marks you get from the reward (e.g. "3,000 mk")

Definition at line 43 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

GetRewardDistibutionSum()

static int Barotrauma.Mission.GetRewardDistibutionSum ( IEnumerable< Character >  crew, int  rewardDistribution = 0  )

static

LoadRandom() [1/2]

static Mission Barotrauma.Mission.LoadRandom ( Location[]  locations, MTRandom  rand, bool  requireCorrectLocationType, MissionType  missionType, bool  isSinglePlayer = false  )

static

Definition at line 220 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

LoadRandom() [2/2]

static Mission Barotrauma.Mission.LoadRandom ( Location[]  locations, string  seed, bool  requireCorrectLocationType, MissionType  missionType, bool  isSinglePlayer = false  )

static

Definition at line 215 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

ModifyMessage()

virtual LocalizedString Barotrauma.Mission.ModifyMessage ( LocalizedString  message, bool  color = true  )

protectedvirtual

Reimplemented in Barotrauma.MineralMission.

Definition at line 306 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

SetLevel()

virtual void Barotrauma.Mission.SetLevel ( LevelData  level )

virtual

Reimplemented in Barotrauma.PirateMission.

Definition at line 213 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

ShowMessage()

void Barotrauma.Mission.ShowMessage ( int  missionState )

protected

Definition at line 299 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Start()

void Barotrauma.Mission.Start

(

Level

level

)

Definition at line 262 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

StartMissionSpecific()

virtual void Barotrauma.Mission.StartMissionSpecific ( Level  level )

protectedvirtual

Reimplemented in Barotrauma.ScanMission, Barotrauma.SalvageMission, Barotrauma.PirateMission, Barotrauma.NestMission, Barotrauma.MonsterMission, Barotrauma.MineralMission, Barotrauma.EscortMission, Barotrauma.EndMission, Barotrauma.CombatMission, Barotrauma.CargoMission, Barotrauma.AlienRuinMission, and Barotrauma.AbandonedOutpostMission.

Definition at line 281 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Update()

void Barotrauma.Mission.Update

(

float

deltaTime

)

Definition at line 283 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

UpdateMissionSpecific()

virtual void Barotrauma.Mission.UpdateMissionSpecific ( float  deltaTime )

protectedvirtual

Reimplemented in Barotrauma.ScanMission, Barotrauma.SalvageMission, Barotrauma.PirateMission, Barotrauma.NestMission, Barotrauma.MonsterMission, Barotrauma.MineralMission, Barotrauma.GoToMission, Barotrauma.EscortMission, Barotrauma.EndMission, Barotrauma.BeaconMission, Barotrauma.AlienRuinMission, and Barotrauma.AbandonedOutpostMission.

Definition at line 297 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Member Data Documentation

Amount

int Barotrauma.Mission.Amount

static

Definition at line 499 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

description

LocalizedString Barotrauma.Mission.description

protected

Definition at line 76 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

descriptionWithoutReward

LocalizedString Barotrauma.Mission.descriptionWithoutReward

protected

Definition at line 83 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

failed

bool Barotrauma.Mission.failed

protected

Definition at line 17 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Headers

readonly ImmutableArray<LocalizedString> Barotrauma.Mission.Headers

Definition at line 51 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

level

Level Barotrauma.Mission.level

protected

Definition at line 19 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Locations

readonly Location [] Barotrauma.Mission.Locations

Definition at line 142 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Messages

readonly ImmutableArray<LocalizedString> Barotrauma.Mission.Messages

Definition at line 52 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

OnMissionStateChanged

Action<Mission> Barotrauma.Mission.OnMissionStateChanged

Definition at line 163 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

OriginLocation

Location Barotrauma.Mission.OriginLocation

Where was this mission received from? Affects which faction we give reputation for if the mission is configured to give reputation for the faction that gave the mission. Defaults to Locations[0]

Definition at line 140 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Prefab

readonly MissionPrefab Barotrauma.Mission.Prefab

Definition at line 15 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

state

int Barotrauma.Mission.state

protected

Definition at line 21 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Property Documentation

AllowRespawn

virtual bool Barotrauma.Mission.AllowRespawn

get

Definition at line 114 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

AllowUndocking

virtual bool Barotrauma.Mission.AllowUndocking

get

Definition at line 85 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Completed

bool Barotrauma.Mission.Completed

getset

Definition at line 103 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Description

virtual LocalizedString Barotrauma.Mission.Description

get

Definition at line 77 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Difficulty

int? Barotrauma.Mission.Difficulty

get

Definition at line 144 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

DisplayAsCompleted

abstract bool Barotrauma.Mission.DisplayAsCompleted

get

Is the mission at a state at which the only thing left to do is to reach the end of the level?

Definition at line 23 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

DisplayAsFailed

abstract bool Barotrauma.Mission.DisplayAsFailed

get

Is the mission at a state at which the mission cannot be completed anymore?

Definition at line 27 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

DisplayTargetHudIcons

bool Barotrauma.Mission.DisplayTargetHudIcons

get

Definition at line 16 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

EnemySubmarineInfo

virtual SubmarineInfo Barotrauma.Mission.EnemySubmarineInfo

get

Definition at line 124 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Failed

bool Barotrauma.Mission.Failed

get

Definition at line 109 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

FailureMessage

virtual LocalizedString Barotrauma.Mission.FailureMessage

get

Definition at line 70 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

HudIconTargets

virtual IEnumerable<Entity> Barotrauma.Mission.HudIconTargets

get

Definition at line 18 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

IsClient

bool Barotrauma.Mission.IsClient

staticgetprotected

Definition at line 47 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Name

virtual LocalizedString Barotrauma.Mission.Name

get

Definition at line 60 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

ReputationRewards

ImmutableList<MissionPrefab.ReputationReward> Barotrauma.Mission.ReputationRewards

get

Definition at line 98 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

Reward

virtual int Barotrauma.Mission.Reward

get

Definition at line 90 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

ShownMessages

IEnumerable<LocalizedString> Barotrauma.Mission.ShownMessages

get

Definition at line 14 of file BarotraumaClient/ClientSource/Events/Missions/Mission.cs.

SonarIconIdentifier

Identifier Barotrauma.Mission.SonarIconIdentifier

get

Definition at line 134 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

SonarLabels

virtual IEnumerable<(LocalizedString Label, Vector2 Position)> Barotrauma.Mission.SonarLabels

get

Definition at line 129 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

State

virtual int? Barotrauma.Mission.State

getset

Definition at line 22 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

SuccessMessage

virtual LocalizedString Barotrauma.Mission.SuccessMessage

get

Definition at line 63 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

TeamCount

virtual int Barotrauma.Mission.TeamCount

get

Definition at line 119 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.

TimesAttempted

int Barotrauma.Mission.TimesAttempted

getset

Definition at line 45 of file BarotraumaShared/SharedSource/Events/Missions/Mission.cs.