Barotrauma Client Doc
Barotrauma.LocationTypeChange.Requirement Class Reference

Public Types

enum class  FunctionType { Add , Multiply }
 

Public Member Functions

 Requirement (ContentXElement element, LocationTypeChange change)
 
bool AnyWithinDistance (Location startLocation, int distance)
 
bool MatchesLocation (Location location)
 
bool MatchesConnection (LocationConnection connection)
 

Public Attributes

readonly FunctionType Function
 
readonly ImmutableArray< IdentifierRequiredLocations
 The change can only happen if there's at least one of the given types of locations near this one More...
 
readonly int RequiredProximity
 How close the location needs to be to one of the RequiredLocations for the change to occur More...
 
readonly float Probability
 Base probability per turn for the location to change if near one of the RequiredLocations More...
 
readonly int RequiredProximityForProbabilityIncrease
 How close the location needs to be to one of the RequiredLocations for the probability to increase More...
 
readonly float ProximityProbabilityIncrease
 How much the probability increases per turn if within RequiredProximityForProbabilityIncrease steps of RequiredLocations More...
 
readonly bool RequireBeaconStation
 Does there need to be a beacon station within RequiredProximity More...
 
readonly bool RequireHuntingGrounds
 Does there need to be hunting grounds within RequiredProximity More...
 

Detailed Description

Definition at line 13 of file LocationTypeChange.cs.

Member Enumeration Documentation

◆ FunctionType

Enumerator
Add 
Multiply 

Definition at line 15 of file LocationTypeChange.cs.

Constructor & Destructor Documentation

◆ Requirement()

Barotrauma.LocationTypeChange.Requirement.Requirement ( ContentXElement  element,
LocationTypeChange  change 
)

Definition at line 58 of file LocationTypeChange.cs.

Member Function Documentation

◆ AnyWithinDistance()

bool Barotrauma.LocationTypeChange.Requirement.AnyWithinDistance ( Location  startLocation,
int  distance 
)

Definition at line 96 of file LocationTypeChange.cs.

◆ MatchesConnection()

bool Barotrauma.LocationTypeChange.Requirement.MatchesConnection ( LocationConnection  connection)

Definition at line 110 of file LocationTypeChange.cs.

◆ MatchesLocation()

bool Barotrauma.LocationTypeChange.Requirement.MatchesLocation ( Location  location)

Definition at line 105 of file LocationTypeChange.cs.

Member Data Documentation

◆ Function

readonly FunctionType Barotrauma.LocationTypeChange.Requirement.Function

Definition at line 21 of file LocationTypeChange.cs.

◆ Probability

readonly float Barotrauma.LocationTypeChange.Requirement.Probability

Base probability per turn for the location to change if near one of the RequiredLocations

Definition at line 36 of file LocationTypeChange.cs.

◆ ProximityProbabilityIncrease

readonly float Barotrauma.LocationTypeChange.Requirement.ProximityProbabilityIncrease

How much the probability increases per turn if within RequiredProximityForProbabilityIncrease steps of RequiredLocations

Definition at line 46 of file LocationTypeChange.cs.

◆ RequireBeaconStation

readonly bool Barotrauma.LocationTypeChange.Requirement.RequireBeaconStation

Does there need to be a beacon station within RequiredProximity

Definition at line 51 of file LocationTypeChange.cs.

◆ RequiredLocations

readonly ImmutableArray<Identifier> Barotrauma.LocationTypeChange.Requirement.RequiredLocations

The change can only happen if there's at least one of the given types of locations near this one

Definition at line 26 of file LocationTypeChange.cs.

◆ RequiredProximity

readonly int Barotrauma.LocationTypeChange.Requirement.RequiredProximity

How close the location needs to be to one of the RequiredLocations for the change to occur

Definition at line 31 of file LocationTypeChange.cs.

◆ RequiredProximityForProbabilityIncrease

readonly int Barotrauma.LocationTypeChange.Requirement.RequiredProximityForProbabilityIncrease

How close the location needs to be to one of the RequiredLocations for the probability to increase

Definition at line 41 of file LocationTypeChange.cs.

◆ RequireHuntingGrounds

readonly bool Barotrauma.LocationTypeChange.Requirement.RequireHuntingGrounds

Does there need to be hunting grounds within RequiredProximity

Definition at line 56 of file LocationTypeChange.cs.