Barotrauma Server Doc
Barotrauma.MineralMission Class Reference
Inheritance diagram for Barotrauma.MineralMission:
Barotrauma.Mission Barotrauma.Mission

Public Member Functions

 MineralMission (MissionPrefab prefab, Location[] locations, Submarine sub)
 
override void ServerWriteInitial (IWriteMessage msg, Client c)
 
- Public Member Functions inherited from Barotrauma.Mission
 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)
 
virtual void ServerWrite (IWriteMessage msg)
 

Static Public Attributes

static readonly ImmutableArray< PositionType > ValidPositionTypes
 
- Static Public Attributes inherited from Barotrauma.Mission
static int Amount
 

Protected Member Functions

override void StartMissionSpecific (Level level)
 
override void UpdateMissionSpecific (float deltaTime)
 
override bool DetermineCompleted ()
 
override void EndMissionSpecific (bool completed)
 
override LocalizedString ModifyMessage (LocalizedString message, bool color=true)
 
- Protected Member Functions inherited from Barotrauma.Mission
void ShowMessage (int missionState)
 
void ChangeLocationType (LocationTypeChange change)
 
HumanPrefab GetHumanPrefabFromElement (XElement element)
 
ItemPrefab FindItemPrefab (XElement element)
 
Vector2? GetCargoSpawnPosition (ItemPrefab itemPrefab, out Submarine cargoRoomSub)
 

Properties

override IEnumerable<(LocalizedString Label, Vector2 Position)> SonarLabels [get]
 
override LocalizedString SuccessMessage [get]
 
override LocalizedString FailureMessage [get]
 
override LocalizedString Description [get]
 
override LocalizedString Name [get]
 
- Properties inherited from Barotrauma.Mission
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.ReputationRewardReputationRewards [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]
 

Additional Inherited Members

- Static Public Member Functions inherited from Barotrauma.Mission
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 int DistributeRewardsToCrew (IEnumerable< Character > crew, int totalReward)
 
- Public Attributes inherited from Barotrauma.Mission
readonly MissionPrefab Prefab
 
readonly ImmutableArray< LocalizedStringHeaders
 
readonly ImmutableArray< LocalizedStringMessages
 
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< MissionOnMissionStateChanged
 
- Static Protected Member Functions inherited from Barotrauma.Mission
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 inherited from Barotrauma.Mission
bool failed
 
Level level
 
int state
 
LocalizedString description
 
LocalizedString descriptionWithoutReward
 

Detailed Description

Constructor & Destructor Documentation

◆ MineralMission()

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

Member Function Documentation

◆ DetermineCompleted()

override bool Barotrauma.MineralMission.DetermineCompleted ( )
protectedvirtual

◆ EndMissionSpecific()

override void Barotrauma.MineralMission.EndMissionSpecific ( bool  completed)
protectedvirtual

◆ ModifyMessage()

override LocalizedString Barotrauma.MineralMission.ModifyMessage ( LocalizedString  message,
bool  color = true 
)
protectedvirtual

◆ ServerWriteInitial()

override void Barotrauma.MineralMission.ServerWriteInitial ( IWriteMessage  msg,
Client  c 
)
virtual

◆ StartMissionSpecific()

override void Barotrauma.MineralMission.StartMissionSpecific ( Level  level)
protectedvirtual

◆ UpdateMissionSpecific()

override void Barotrauma.MineralMission.UpdateMissionSpecific ( float  deltaTime)
protectedvirtual

Member Data Documentation

◆ ValidPositionTypes

readonly ImmutableArray<PositionType> Barotrauma.MineralMission.ValidPositionTypes
static
Initial value:
= new PositionType[]
{
PositionType.Cave,
PositionType.SidePath,
PositionType.MainPath,
PositionType.AbyssCave,
}.ToImmutableArray()

The list order is important. It defines the order in which we "override" positionType in case no valid position types are found in the level when generating them in Level.GenerateMissionResources(ItemPrefab, int, PositionType, out float).

Definition at line 27 of file BarotraumaShared/SharedSource/Events/Missions/MineralMission.cs.

Property Documentation

◆ Description

override LocalizedString Barotrauma.MineralMission.Description
get

◆ FailureMessage

override LocalizedString Barotrauma.MineralMission.FailureMessage
get

◆ Name

override LocalizedString Barotrauma.MineralMission.Name
get

◆ SonarLabels

override IEnumerable<(LocalizedString Label, Vector2 Position)> Barotrauma.MineralMission.SonarLabels
get

◆ SuccessMessage

override LocalizedString Barotrauma.MineralMission.SuccessMessage
get