AiMalgam Core 1.1.0
API documentation for the generic Unity3D AI System
Public Member Functions | Protected Member Functions | Properties | Events | List of all members
NikosAssets.AiMalgam.Systems.Actions.AiMalgamBaseAction< BlackboardType > Class Template Referenceabstract

The base action you want to inherit from to create your own AI logic More...

Public Member Functions

abstract void Initialize (BlackboardType blackboard)
 
abstract bool Validate (BlackboardType blackboard)
 Must return true in order for this action to Run() More...
 
abstract void Run (BlackboardType blackboard)
 The (custom) action's main feature!
 
abstract void Restore (BlackboardType blackboard)
 Restores the previous state if implemented that is
 
virtual void Dispose ()
 Clear up any resources of this action
 

Protected Member Functions

 AiMalgamBaseAction (AiMalgamBaseSettings settings, AiMalgamBaseEngineWrapper baseEngineWrapper)
 
virtual void OnNodeChanged (AiMalgamNode settings)
 

Properties

virtual bool IsDone [get, set]
 Is the action done yet? More...
 
virtual bool Success [get, protected set]
 
virtual int RunCount [get, set]
 How often did this action Run() successfully? More...
 
virtual int InvalidRunsAmount [get, set]
 The current failed (invalidated) run attempts of this action More...
 
virtual AiMalgamBaseEngineWrapper Engine [get, protected set]
 The hosting AiMalgamBaseEngineWrapper of this action More...
 
abstract AiMalgamBaseSettings Settings [get, set]
 The AiMalgamBaseSettings this action represents More...
 
TimingHelper RunDelayTiming [get, protected set]
 The delay for this action to run next time More...
 
TimingHelper DisposeActionTiming [get, protected set]
 The time until this action should dispose More...
 
- Properties inherited from NikosAssets.AiMalgam.Systems.Actions.IAiMalgamBaseActionWrapper
bool IsDone [get, set]
 Is the action done yet? More...
 
bool Success [get]
 
int RunCount [get, set]
 How often did this action Run() successfully? More...
 
int InvalidRunsAmount [get, set]
 The current failed (invalidated) run attempts of this action More...
 
AiMalgamBaseEngineWrapper Engine [get]
 The hosting AiMalgamBaseEngineWrapper of this action More...
 
AiMalgamBaseSettings Settings [get]
 The AiMalgamBaseSettings this action represents More...
 
TimingHelper RunDelayTiming [get]
 The delay for this action to run next time More...
 
TimingHelper DisposeActionTiming [get]
 The time until this action should dispose More...
 

Events

virtual Action< IAiMalgamBaseActionWrapperOnActionDisposed
 
virtual Action< IAiMalgamBaseActionWrapperOnActionInitialized
 
- Events inherited from NikosAssets.AiMalgam.Systems.Actions.IAiMalgamBaseActionWrapper
Action< IAiMalgamBaseActionWrapperOnActionDisposed
 

Additional Inherited Members

- Public Attributes inherited from NikosAssets.AiMalgam.Systems.Actions.IAiMalgamBaseActionWrapper
Action< IAiMalgamBaseActionWrapperOnActionInitialized
 

Detailed Description

The base action you want to inherit from to create your own AI logic

Template Parameters
BlackboardType
Type Constraints
BlackboardType :IAiMalgamBlackboard 

Member Function Documentation

◆ Validate()

abstract bool NikosAssets.AiMalgam.Systems.Actions.AiMalgamBaseAction< BlackboardType >.Validate ( BlackboardType  blackboard)
pure virtual

Must return true in order for this action to Run()

Parameters
blackboardThe custom IAiMalgamBlackboard that may or may not be mandatory for validation
Returns

Property Documentation

◆ DisposeActionTiming

TimingHelper NikosAssets.AiMalgam.Systems.Actions.AiMalgamBaseAction< BlackboardType >.DisposeActionTiming
getprotected set

The time until this action should dispose

Implements NikosAssets.AiMalgam.Systems.Actions.IAiMalgamBaseActionWrapper.

◆ Engine

The hosting AiMalgamBaseEngineWrapper of this action

Implements NikosAssets.AiMalgam.Systems.Actions.IAiMalgamBaseActionWrapper.

◆ InvalidRunsAmount

virtual int NikosAssets.AiMalgam.Systems.Actions.AiMalgamBaseAction< BlackboardType >.InvalidRunsAmount
getset

The current failed (invalidated) run attempts of this action

Implements NikosAssets.AiMalgam.Systems.Actions.IAiMalgamBaseActionWrapper.

◆ IsDone

virtual bool NikosAssets.AiMalgam.Systems.Actions.AiMalgamBaseAction< BlackboardType >.IsDone
getset

◆ RunCount

virtual int NikosAssets.AiMalgam.Systems.Actions.AiMalgamBaseAction< BlackboardType >.RunCount
getset

How often did this action Run() successfully?

Implements NikosAssets.AiMalgam.Systems.Actions.IAiMalgamBaseActionWrapper.

◆ RunDelayTiming

TimingHelper NikosAssets.AiMalgam.Systems.Actions.AiMalgamBaseAction< BlackboardType >.RunDelayTiming
getprotected set

The delay for this action to run next time

Implements NikosAssets.AiMalgam.Systems.Actions.IAiMalgamBaseActionWrapper.

◆ Settings

The AiMalgamBaseSettings this action represents

Implements NikosAssets.AiMalgam.Systems.Actions.IAiMalgamBaseActionWrapper.

◆ Success

virtual bool NikosAssets.AiMalgam.Systems.Actions.AiMalgamBaseAction< BlackboardType >.Success
getprotected set