Polarith AI
1.7
AIMBehaviour Class Reference

Description

AIMBehaviour is the abstract base class for all the behaviours in the Move module of Polarith AI (front-end component).

Every AIMBehaviour component have got a certain Type specifying the processing order of the back-end MoveBehaviour within Context.Evaluate.

If the underlying MoveBehaviour is thread-safe, this should be indicated through returning true for the ThreadSafe property in derived AIMBehaviour components. An associated AIMContext is thread-safe if all of its behaviours are thread-safe, too.

Abstract base front-end component of every derived MoveBehaviour.

Inheritance diagram for AIMBehaviour:
IEvaluationPreparer AIMPerceptBehaviour< T > AIMPlanarConvolution AIMPlanarInterpolation AIMRetention AIMStabilization

Public Fields

int Order
 Specifies the execution order of this behaviour. More...
 
string Label
 Name to identify this component, e.g. More...
 

Protected Fields

AIMContext aimContext
 Quick access reference for derived classes to the component of the associated movement AI context. More...
 
Context context
 Quick access reference for derived classes to the associated movement AI context. More...
 

Properties

abstract MoveBehaviour Behaviour [get]
 Polymorphic reference to the underlying back-end class (read only). More...
 
virtual bool ThreadSafe [get]
 Determines whether the underlying back-end MoveBehaviour is thread-safe (read only). More...
 
bool Enabled [get, set]
 Determines whether this component is enabled. More...
 

Public Methods

virtual void PrepareEvaluation ()
 If necessary, re-registers this behaviour to its associated AIMContext according to the currently set Order. More...
 

Protected Methods

virtual void Reset ()
 Reset to default values. More...
 
virtual void Awake ()
 Awake is called when the script instance is being loaded. More...
 
virtual void OnEnable ()
 This method is called when the object becomes enabled and active. More...
 
virtual void OnDisable ()
 This method is called when the behaviour becomes disabled or inactive. More...
 
virtual void OnDestroy ()
 This method is called when the MonoBehaviour will be destroyed. More...
 
virtual void OnValidate ()
 This function is called when the script is loaded or a value is changed in the inspector (editor only). More...
 
List< int > GetDefaultTargetObjectives ()
 Generates a list containing all objectives currently available within the associated Context. More...
 
void CheckFirstAndCentralOrder (Type type)
 Should be used in OnValidate for derived classes to ensure that they are executed at first. More...
 
void CheckLastOrder (Type type)
 Should be used in OnValidate for derived classes to ensure that they are executed at last. More...
 
Imprint