Inheritance diagram for Barotrauma.AIObjectiveFindSafety:

Public Types
enum class	HullSearchStatus { Running , Finished }

Public Member Functions
	AIObjectiveFindSafety (Character character, AIObjectiveManager objectiveManager, float priorityModifier=1)

override void	Update (float deltaTime)

void	UpdateSimpleEscape (float deltaTime)

HullSearchStatus	FindBestHull (out Hull bestHull, IEnumerable< Hull > ignoredHulls=null, bool allowChangingSubmarine=true)
	Tries to find the best (safe, nearby) hull the character can find a path to. Checks one hull at a time, and returns HullSearchStatus.Finished when all potential hulls have been checked. More...

override void	Reset ()

Public Member Functions inherited from Barotrauma.AIObjective
IEnumerable< AIObjective >	GetSubObjectivesRecursive (bool includingSelf=false)

AIObjective	GetActiveObjective ()

	AIObjective (Character character, AIObjectiveManager objectiveManager, float priorityModifier, Identifier option=default)

void	TryComplete (float deltaTime)
	Makes the character act according to the objective, or according to any subobjectives that need to be completed before this one More...

void	AddSubObjective (AIObjective objective, bool addFirst=false)

void	RemoveSubObjective< T > (ref T objective)

void	SortSubObjectives ()

bool	IsIgnoredAtOutpost ()
	Returns true only when at a friendly outpost and when the order is set to be ignored there. Note that even if this returns false, the objective can be disallowed, because AllowInFriendlySubs is false. More...

float	CalculatePriority ()
	Call this only when the priority needs to be recalculated. Use the cached Priority property when you don't need to recalculate. More...

virtual bool	IsDuplicate< T > (T otherObjective)

virtual void	OnSelected ()

virtual void	OnDeselected ()

virtual void	SpeakAfterOrderReceived ()

Sprite	GetSprite ()

Protected Member Functions
override bool	CheckObjectiveSpecific ()

override float	GetPriority ()

override void	Act (float deltaTime)

Protected Member Functions inherited from Barotrauma.AIObjective
void	HandleNonAllowed ()

void	SyncRemovedObjectives< T1, T2 > (Dictionary< T1, T2 > dictionary, IEnumerable< T1 > collection)
	Checks if the subobjectives in the given collection are removed from the subobjectives. And if so, removes it also from the dictionary. More...

bool	TryAddSubObjective< T > (ref T objective, Func< T > constructor, Action onCompleted=null, Action onAbandon=null)
	Checks if the objective already is created and added in subobjectives. If not, creates it. Handles objectives that cannot be completed. If the objective has been removed form the subobjectives, a null value is assigned to the reference. Returns true if the objective was created and successfully added. More...

virtual void	OnCompleted ()

virtual void	OnAbandon ()

bool	CanEquip (Item item, bool allowWearing)

Properties
override Identifier	Identifier = "find safety".ToIdentifier() `[get, set]`

override bool	ForceRun `[get]`

override bool	KeepDivingGearOn `[get]`

override bool	IgnoreUnsafeHulls `[get]`

override bool	ConcurrentObjectives `[get]`

override bool	AllowOutsideSubmarine `[get]`

override bool	AllowInAnySub `[get]`

override bool	AbandonWhenCannotCompleteSubjectives `[get]`

override bool	IsLoop `[get, set]`

override bool	CanBeCompleted `[get]`

Properties inherited from Barotrauma.AIObjective
virtual float	Devotion `[get]`

abstract Identifier	Identifier `[get, set]`

virtual string	DebugTag `[get]`

virtual bool	ForceRun `[get]`

virtual bool	IgnoreUnsafeHulls `[get]`

virtual bool	AbandonWhenCannotCompleteSubjectives `[get]`

virtual bool	AllowSubObjectiveSorting `[get]`

virtual bool	PrioritizeIfSubObjectivesActive `[get]`

virtual bool	AllowMultipleInstances `[get]`
	Can there be multiple objective instaces of the same type? More...

virtual bool	ConcurrentObjectives `[get]`
	Run the main objective with all subobjectives concurrently? If false, the main objective will continue only when all the subobjectives have been removed (done). More...

virtual bool	KeepDivingGearOn `[get]`

virtual bool	KeepDivingGearOnAlsoWhenInactive `[get]`

virtual bool	AllowAutomaticItemUnequipping `[get]`
	There's a separate property for diving suit and mask: KeepDivingGearOn. More...

virtual bool	AllowOutsideSubmarine `[get]`

virtual bool	AllowInFriendlySubs `[get]`

virtual bool	AllowInAnySub `[get]`

virtual bool	AllowWhileHandcuffed `[get]`

float	CumulatedDevotion `[get, set]`

virtual float	MaxDevotion `[get]`

float	Priority `[get, set]`
	Final priority value after all calculations. More...

float	BasePriority `[get, set]`

float	PriorityModifier = 1 `[get]`

bool	ForceHighestPriority `[get, set]`

bool	ForceWalk `[get, set]`

bool	IgnoreAtOutpost `[get, set]`

bool	Abandon `[get, set]`

virtual bool	CanBeCompleted `[get]`

virtual bool	IsLoop `[get, set]`
	When true, the objective is never completed, unless CanBeCompleted returns false. More...

IEnumerable< AIObjective >	SubObjectives `[get]`

AIObjective	CurrentSubObjective `[get]`

HumanAIController	HumanAIController `[get]`

IndoorsSteeringManager	PathSteering `[get]`

SteeringManager	SteeringManager `[get]`

bool	IsAllowed `[get]`

bool	IsCompleted `[get, protected set]`

static Color	ObjectiveIconColor `[get]`

Additional Inherited Members
Static Public Member Functions inherited from Barotrauma.AIObjective
static Sprite	GetSprite (Identifier identifier, Identifier option, Entity targetEntity)

Public Attributes inherited from Barotrauma.AIObjective
readonly Character	character

readonly AIObjectiveManager	objectiveManager

readonly Identifier	Option

Func< AIObjective, bool >	AbortCondition
	Aborts the objective when this condition is true. More...

Static Protected Member Functions inherited from Barotrauma.AIObjective
static bool	CanEquip (Character character, Item item, bool allowWearing)

Protected Attributes inherited from Barotrauma.AIObjective
readonly List< AIObjective >	subObjectives = new List<AIObjective>()

Events inherited from Barotrauma.AIObjective
Action	Completed
	A single shot event. Automatically cleared after launching. Use OnCompleted method for implementing (internal) persistent behavior. More...

Action	Abandoned
	A single shot event. Automatically cleared after launching. Use OnAbandoned method for implementing (internal) persistent behavior. More...

Action	Selected
	A single shot event. Automatically cleared after launching. Use OnSelected method for implementing (internal) persistent behavior. More...

Action	Deselected
	A single shot event. Automatically cleared after launching. Use OnDeselected method for implementing (internal) persistent behavior. More...

Detailed Description

Definition at line 10 of file AIObjectiveFindSafety.cs.

Member Enumeration Documentation

◆ HullSearchStatus

enum Barotrauma.AIObjectiveFindSafety.HullSearchStatus

strong

Enumerator
Running
Finished

Definition at line 319 of file AIObjectiveFindSafety.cs.

Constructor & Destructor Documentation

◆ AIObjectiveFindSafety()

Barotrauma.AIObjectiveFindSafety.AIObjectiveFindSafety	(	Character	character,
		AIObjectiveManager	objectiveManager,
		float	priorityModifier = `1`
	)

Definition at line 34 of file AIObjectiveFindSafety.cs.

Member Function Documentation

◆ Act()

override void Barotrauma.AIObjectiveFindSafety.Act ( float deltaTime )

protectedvirtual

Implements Barotrauma.AIObjective.

Definition at line 131 of file AIObjectiveFindSafety.cs.

◆ CheckObjectiveSpecific()

override bool Barotrauma.AIObjectiveFindSafety.CheckObjectiveSpecific ( )

protectedvirtual

Implements Barotrauma.AIObjective.

◆ FindBestHull()

HullSearchStatus Barotrauma.AIObjectiveFindSafety.FindBestHull	(	out Hull	bestHull,
		IEnumerable< Hull >	ignoredHulls = `null`,
		bool	allowChangingSubmarine = `true`
	)

Tries to find the best (safe, nearby) hull the character can find a path to. Checks one hull at a time, and returns HullSearchStatus.Finished when all potential hulls have been checked.

Definition at line 335 of file AIObjectiveFindSafety.cs.

◆ GetPriority()

override float Barotrauma.AIObjectiveFindSafety.GetPriority ( )

protectedvirtual

Reimplemented from Barotrauma.AIObjective.

Definition at line 41 of file AIObjectiveFindSafety.cs.

◆ Reset()

override void Barotrauma.AIObjectiveFindSafety.Reset ( )

virtual

Reimplemented from Barotrauma.AIObjective.

Definition at line 485 of file AIObjectiveFindSafety.cs.

◆ Update()

override void Barotrauma.AIObjectiveFindSafety.Update ( float deltaTime )

virtual

Reimplemented from Barotrauma.AIObjective.

Definition at line 82 of file AIObjectiveFindSafety.cs.

◆ UpdateSimpleEscape()

void Barotrauma.AIObjectiveFindSafety.UpdateSimpleEscape ( float deltaTime )

Definition at line 272 of file AIObjectiveFindSafety.cs.

Property Documentation

◆ AbandonWhenCannotCompleteSubjectives

override bool Barotrauma.AIObjectiveFindSafety.AbandonWhenCannotCompleteSubjectives

get

Definition at line 19 of file AIObjectiveFindSafety.cs.

◆ AllowInAnySub

override bool Barotrauma.AIObjectiveFindSafety.AllowInAnySub

get

Definition at line 18 of file AIObjectiveFindSafety.cs.

◆ AllowOutsideSubmarine

override bool Barotrauma.AIObjectiveFindSafety.AllowOutsideSubmarine

get

Definition at line 17 of file AIObjectiveFindSafety.cs.

◆ CanBeCompleted

override bool Barotrauma.AIObjectiveFindSafety.CanBeCompleted

get

Definition at line 37 of file AIObjectiveFindSafety.cs.

◆ ConcurrentObjectives

override bool Barotrauma.AIObjectiveFindSafety.ConcurrentObjectives

get

Definition at line 16 of file AIObjectiveFindSafety.cs.

◆ ForceRun

override bool Barotrauma.AIObjectiveFindSafety.ForceRun

get

Definition at line 13 of file AIObjectiveFindSafety.cs.

◆ Identifier

override Identifier Barotrauma.AIObjectiveFindSafety.Identifier = "find safety".ToIdentifier()

getset

Definition at line 12 of file AIObjectiveFindSafety.cs.

◆ IgnoreUnsafeHulls

override bool Barotrauma.AIObjectiveFindSafety.IgnoreUnsafeHulls

get

Definition at line 15 of file AIObjectiveFindSafety.cs.

◆ IsLoop

override bool Barotrauma.AIObjectiveFindSafety.IsLoop

getset

Definition at line 20 of file AIObjectiveFindSafety.cs.

◆ KeepDivingGearOn

override bool Barotrauma.AIObjectiveFindSafety.KeepDivingGearOn

get

Definition at line 14 of file AIObjectiveFindSafety.cs.

Public Types

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ HullSearchStatus

Constructor & Destructor Documentation

◆ AIObjectiveFindSafety()

Member Function Documentation

◆ Act()

◆ CheckObjectiveSpecific()

◆ FindBestHull()

◆ GetPriority()

◆ Reset()

◆ Update()

◆ UpdateSimpleEscape()

Property Documentation

◆ AbandonWhenCannotCompleteSubjectives

◆ AllowInAnySub

◆ AllowOutsideSubmarine

◆ CanBeCompleted

◆ ConcurrentObjectives

◆ ForceRun

◆ Identifier

◆ IgnoreUnsafeHulls

◆ IsLoop

◆ KeepDivingGearOn