Barotrauma.AIObjectiveCleanupItems Class Reference

Inheritance diagram for Barotrauma.AIObjectiveCleanupItems:

Public Member Functions
	AIObjectiveCleanupItems (Character character, AIObjectiveManager objectiveManager, Item prioritizedItem=null, float priorityModifier=1)
	AIObjectiveCleanupItems (Character character, AIObjectiveManager objectiveManager, IEnumerable< Item > prioritizedItems, float priorityModifier=1)
override void	OnDeselected ()
Public Member Functions inherited from Barotrauma.AIObjectiveLoop< Item >
bool	AddTarget (T target)
	AIObjectiveLoop (Character character, AIObjectiveManager objectiveManager, float priorityModifier, Identifier option=default)
override void	Update (float deltaTime)
override void	Reset ()

Static Public Member Functions
static bool	IsItemInsideValidSubmarine (Item item, Character character)
static bool	IsValidContainer (Item container, Character character)
static bool	IsValidTarget (Item item, Character character, bool checkInventory, bool allowUnloading=true, bool requireValidContainer=true, bool ignoreItemsMarkedForDeconstruction=true)

Public Attributes
readonly List< Item >	prioritizedItems = new List<Item>()

Protected Member Functions
override float	GetTargetPriority ()
override bool	IsValidTarget (Item target)
override IEnumerable< Item >	GetList ()
override AIObjective	ObjectiveConstructor (Item item)
override void	OnObjectiveCompleted (AIObjective objective, Item target)
Protected Member Functions inherited from Barotrauma.AIObjectiveLoop< Item >
override void	Act (float deltaTime)
override bool	CheckObjectiveSpecific ()
override float	GetPriority ()
void	UpdateTargets ()
virtual void	FindTargets ()
virtual void	CreateObjectives ()
void	OnObjectiveCompleted (AIObjective objective, T target)
IEnumerable< T >	GetList ()
	List of all possible items of the specified type. Used for filtering the removed objectives.
float	GetTargetPriority ()
	Returns a priority value based on the current targets (e.g. high prio when there's lots of severe fires or leaks). The priority of this objective is based on the target priority.
AIObjective	ObjectiveConstructor (T target)
bool	IsValidTarget (T target)

Properties
override Identifier	Identifier = "cleanup items".ToIdentifier() [get, set]
override bool	KeepDivingGearOn [get]
override bool	AllowAutomaticItemUnequipping [get]
override bool	ForceOrderPriority [get]
override int	MaxTargets [get]
Properties inherited from Barotrauma.AIObjectiveLoop< Item >
HashSet< T >	Targets [get]
Dictionary< T, AIObjective >	Objectives [get]
virtual float	TargetUpdateTimeMultiplier [get]
virtual float	IgnoreListClearInterval [get]
	By default, doesn't clear the list automatically.
HashSet< T >	ReportedTargets [get]
	Contains targets that anyone in the same crew has reported about. Used for automatic the target has to be reported before it can be can be targeted, so characters don't magically know where e.g. enemies are. Ignored on orders: a bot explicitly ordered to repair leaks or fight intruders can find targets that haven't been reported.
override bool	CanBeCompleted [get]
override bool	AbandonWhenCannotCompleteSubObjectives [get]
override bool	AllowSubObjectiveSorting [get]
override bool	AllowWhileHandcuffed [get]
override bool	AbandonIfDisallowed [get]
virtual bool	InverseTargetPriority [get]
	Makes the priority inversely proportional to the value returned by GetTargetPriority. In other words, gives this objective a high priority when priority of the targets is low.
virtual bool	ResetWhenClearingIgnoreList [get]
virtual bool	ForceOrderPriority [get]
virtual int	MaxTargets [get]

Additional Inherited Members
Protected Attributes inherited from Barotrauma.AIObjectiveLoop< Item >
HashSet< T >	ignoreList
float	targetUpdateTimer

Constructor & Destructor Documentation

AIObjectiveCleanupItems() [1/2]

Barotrauma.AIObjectiveCleanupItems.AIObjectiveCleanupItems	(	Character	character,
		AIObjectiveManager	objectiveManager,
		Item	prioritizedItem = null,
		float	priorityModifier = 1 )

AIObjectiveCleanupItems() [2/2]

Barotrauma.AIObjectiveCleanupItems.AIObjectiveCleanupItems	(	Character	character,
		AIObjectiveManager	objectiveManager,
		IEnumerable< Item >	prioritizedItems,
		float	priorityModifier = 1 )

Member Function Documentation

GetList()

override IEnumerable< Item > Barotrauma.AIObjectiveCleanupItems.GetList ( )

protected

GetTargetPriority()

override float Barotrauma.AIObjectiveCleanupItems.GetTargetPriority ( )

protected

IsItemInsideValidSubmarine()

static bool Barotrauma.AIObjectiveCleanupItems.IsItemInsideValidSubmarine ( Item item, Character character )

static

IsValidContainer()

static bool Barotrauma.AIObjectiveCleanupItems.IsValidContainer ( Item container, Character character )

static

IsValidTarget() [1/2]

static bool Barotrauma.AIObjectiveCleanupItems.IsValidTarget ( Item item, Character character, bool checkInventory, bool allowUnloading = true, bool requireValidContainer = true, bool ignoreItemsMarkedForDeconstruction = true )

static

IsValidTarget() [2/2]

override bool Barotrauma.AIObjectiveCleanupItems.IsValidTarget ( Item target )

protected

ObjectiveConstructor()

override AIObjective Barotrauma.AIObjectiveCleanupItems.ObjectiveConstructor ( Item item )

protected

OnDeselected()

override void Barotrauma.AIObjectiveCleanupItems.OnDeselected

(

)

OnObjectiveCompleted()

override void Barotrauma.AIObjectiveCleanupItems.OnObjectiveCompleted ( AIObjective objective, Item target )

protected

Member Data Documentation

prioritizedItems

readonly List<Item> Barotrauma.AIObjectiveCleanupItems.prioritizedItems = new List<Item>()

Property Documentation

AllowAutomaticItemUnequipping

override bool Barotrauma.AIObjectiveCleanupItems.AllowAutomaticItemUnequipping

get

ForceOrderPriority

override bool Barotrauma.AIObjectiveCleanupItems.ForceOrderPriority

getprotected

Identifier

override Identifier Barotrauma.AIObjectiveCleanupItems.Identifier = "cleanup items".ToIdentifier()

getset

KeepDivingGearOn

override bool Barotrauma.AIObjectiveCleanupItems.KeepDivingGearOn

get

MaxTargets

override int Barotrauma.AIObjectiveCleanupItems.MaxTargets

getprotected

---

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

• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Characters/AI/Objectives/AIObjectiveCleanupItems.cs