Barotrauma Client Doc
Barotrauma.AIObjectiveOperateItem Class Reference
Inheritance diagram for Barotrauma.AIObjectiveOperateItem:
Barotrauma.AIObjective

Public Member Functions

override bool IsDuplicate< T > (T otherObjective)
 
ItemComponent GetTarget ()
 
 AIObjectiveOperateItem (ItemComponent item, Character character, AIObjectiveManager objectiveManager, Identifier option, bool requireEquip, Entity operateTarget=null, bool useController=false, ItemComponent controller=null, float priorityModifier=1)
 
override void Reset ()
 
- Public Member Functions inherited from Barotrauma.AIObjective
IEnumerable< AIObjectiveGetSubObjectivesRecursive (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 void Update (float deltaTime)
 
virtual void OnSelected ()
 
virtual void OnDeselected ()
 
virtual void SpeakAfterOrderReceived ()
 
Sprite GetSprite ()
 

Public Attributes

Func< PathNode, bool > EndNodeFilter
 If undefined, a default filter will be used. More...
 
Func< bool > completionCondition
 
float? OverridePriority = null
 
- 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...
 

Protected Member Functions

override float GetPriority ()
 
override void Act (float deltaTime)
 
override bool CheckObjectiveSpecific ()
 
- 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 = "operate item".ToIdentifier() [get, set]
 
override string DebugTag [get]
 
override bool AllowAutomaticItemUnequipping [get]
 
override bool AllowMultipleInstances [get]
 
override bool AllowInAnySub [get]
 
override bool AllowWhileHandcuffed [get]
 
override bool PrioritizeIfSubObjectivesActive [get]
 
bool Override = true [get, set]
 
override bool CanBeCompleted [get]
 
Entity OperateTarget [get]
 
ItemComponent Component [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< AIObjectiveSubObjectives [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)
 
- 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< AIObjectivesubObjectives = 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 9 of file AIObjectiveOperateItem.cs.

Constructor & Destructor Documentation

◆ AIObjectiveOperateItem()

Barotrauma.AIObjectiveOperateItem.AIObjectiveOperateItem ( ItemComponent  item,
Character  character,
AIObjectiveManager  objectiveManager,
Identifier  option,
bool  requireEquip,
Entity  operateTarget = null,
bool  useController = false,
ItemComponent  controller = null,
float  priorityModifier = 1 
)

Definition at line 165 of file AIObjectiveOperateItem.cs.

Member Function Documentation

◆ Act()

override void Barotrauma.AIObjectiveOperateItem.Act ( float  deltaTime)
protectedvirtual

Implements Barotrauma.AIObjective.

Definition at line 188 of file AIObjectiveOperateItem.cs.

◆ CheckObjectiveSpecific()

override bool Barotrauma.AIObjectiveOperateItem.CheckObjectiveSpecific ( )
protectedvirtual

◆ GetPriority()

override float Barotrauma.AIObjectiveOperateItem.GetPriority ( )
protectedvirtual

Reimplemented from Barotrauma.AIObjective.

Definition at line 48 of file AIObjectiveOperateItem.cs.

◆ GetTarget()

ItemComponent Barotrauma.AIObjectiveOperateItem.GetTarget ( )

◆ IsDuplicate< T >()

override bool Barotrauma.AIObjectiveOperateItem.IsDuplicate< T > ( otherObjective)
virtual

Reimplemented from Barotrauma.AIObjective.

◆ Reset()

override void Barotrauma.AIObjectiveOperateItem.Reset ( )
virtual

Reimplemented from Barotrauma.AIObjective.

Definition at line 308 of file AIObjectiveOperateItem.cs.

Member Data Documentation

◆ completionCondition

Func<bool> Barotrauma.AIObjectiveOperateItem.completionCondition

Definition at line 43 of file AIObjectiveOperateItem.cs.

◆ EndNodeFilter

Func<PathNode, bool> Barotrauma.AIObjectiveOperateItem.EndNodeFilter

If undefined, a default filter will be used.

Definition at line 30 of file AIObjectiveOperateItem.cs.

◆ OverridePriority

float? Barotrauma.AIObjectiveOperateItem.OverridePriority = null

Definition at line 46 of file AIObjectiveOperateItem.cs.

Property Documentation

◆ AllowAutomaticItemUnequipping

override bool Barotrauma.AIObjectiveOperateItem.AllowAutomaticItemUnequipping
get

Definition at line 14 of file AIObjectiveOperateItem.cs.

◆ AllowInAnySub

override bool Barotrauma.AIObjectiveOperateItem.AllowInAnySub
get

Definition at line 16 of file AIObjectiveOperateItem.cs.

◆ AllowMultipleInstances

override bool Barotrauma.AIObjectiveOperateItem.AllowMultipleInstances
get

Definition at line 15 of file AIObjectiveOperateItem.cs.

◆ AllowWhileHandcuffed

override bool Barotrauma.AIObjectiveOperateItem.AllowWhileHandcuffed
get

Definition at line 17 of file AIObjectiveOperateItem.cs.

◆ CanBeCompleted

override bool Barotrauma.AIObjectiveOperateItem.CanBeCompleted
get

Definition at line 34 of file AIObjectiveOperateItem.cs.

◆ Component

ItemComponent Barotrauma.AIObjectiveOperateItem.Component
get

Definition at line 39 of file AIObjectiveOperateItem.cs.

◆ DebugTag

override string Barotrauma.AIObjectiveOperateItem.DebugTag
get

Definition at line 12 of file AIObjectiveOperateItem.cs.

◆ Identifier

override Identifier Barotrauma.AIObjectiveOperateItem.Identifier = "operate item".ToIdentifier()
getset

Definition at line 11 of file AIObjectiveOperateItem.cs.

◆ OperateTarget

Entity Barotrauma.AIObjectiveOperateItem.OperateTarget
get

Definition at line 38 of file AIObjectiveOperateItem.cs.

◆ Override

bool Barotrauma.AIObjectiveOperateItem.Override = true
getset

Definition at line 32 of file AIObjectiveOperateItem.cs.

◆ PrioritizeIfSubObjectivesActive

override bool Barotrauma.AIObjectiveOperateItem.PrioritizeIfSubObjectivesActive
get

Definition at line 18 of file AIObjectiveOperateItem.cs.