AiMalgam Core 1.1.0
API documentation for the generic Unity3D AI System
Public Member Functions | Properties | List of all members
NikosAssets.AiMalgam.Systems.Engines.AiMalgamBaseEngineWrapper Class Referenceabstract

A wrapper class for custom Engines to host, maintain and execute IAiMalgamBaseActionWrappers the same way a Scheduler would. Is visible and assignable in the Unity inspector More...

Public Member Functions

abstract AiMalgamApplyActionSettingResult ApplySettings (AiMalgamBaseSettings settings)
 Apply the AiMalgamBaseSettings to this Engine and convert it to its respective IAiMalgamBaseActionWrapper More...
 
abstract AiMalgamApplyActionSettingResult ValidateSettings (AiMalgamBaseSettings settings)
 Validate the given AiMalgamBaseSettings by checking its AiMalgamBaseSettings.conditionToEnter and if the current AiMalgamEntity.currentStates allow it. More...
 
abstract void RemoveAllActiveActionsAndStatesQueue ()
 Clear all AiMalgamStates attached on this AiMalgamEntity and their represented IAiMalgamBaseActionWrappers on this Engine More...
 
abstract List< IAiMalgamBaseActionWrapperGetStableActiveActions ()
 Get IAiMalgamBaseActionWrappers that are actively running and not in the remove queue More...
 

Properties

abstract string ActionTypeSupported [get, protected set]
 Which custom IAiMalgamBaseActionWrapper can this Engine be mapped to? Setting this property generates the ActionTypeSupportedHash for the mapping mechanic
 
abstract int ActionTypeSupportedHash [get]
 Used to map the compatible custom IAiMalgamBaseActionWrapper to this Engine
 
abstract AiMalgamEntity AiMalgamEntity [get, set]
 The hosting AiMalgamEntity
 

Detailed Description

A wrapper class for custom Engines to host, maintain and execute IAiMalgamBaseActionWrappers the same way a Scheduler would. Is visible and assignable in the Unity inspector

Member Function Documentation

◆ ApplySettings()

abstract AiMalgamApplyActionSettingResult NikosAssets.AiMalgam.Systems.Engines.AiMalgamBaseEngineWrapper.ApplySettings ( AiMalgamBaseSettings  settings)
pure virtual

Apply the AiMalgamBaseSettings to this Engine and convert it to its respective IAiMalgamBaseActionWrapper

Parameters
settingsTurn this into the respective IAiMalgamBaseActionWrapper
Returns
AiMalgamApplyActionSettingResult

◆ GetStableActiveActions()

abstract List< IAiMalgamBaseActionWrapper > NikosAssets.AiMalgam.Systems.Engines.AiMalgamBaseEngineWrapper.GetStableActiveActions ( )
pure virtual

Get IAiMalgamBaseActionWrappers that are actively running and not in the remove queue

Returns
A list of IAiMalgamBaseActionWrappers

Implemented in NikosAssets.AiMalgam.Systems.Engines.AiMalgamEntityBaseEngine< ActionType, BlackboardType >.

◆ RemoveAllActiveActionsAndStatesQueue()

abstract void NikosAssets.AiMalgam.Systems.Engines.AiMalgamBaseEngineWrapper.RemoveAllActiveActionsAndStatesQueue ( )
pure virtual

Clear all AiMalgamStates attached on this AiMalgamEntity and their represented IAiMalgamBaseActionWrappers on this Engine

Implemented in NikosAssets.AiMalgam.Systems.Engines.AiMalgamEntityBaseEngine< ActionType, BlackboardType >.

◆ ValidateSettings()

abstract AiMalgamApplyActionSettingResult NikosAssets.AiMalgam.Systems.Engines.AiMalgamBaseEngineWrapper.ValidateSettings ( AiMalgamBaseSettings  settings)
pure virtual

Validate the given AiMalgamBaseSettings by checking its AiMalgamBaseSettings.conditionToEnter and if the current AiMalgamEntity.currentStates allow it.

Parameters
settingsValidate those
Returns
AiMalgamApplyActionSettingResult

Implemented in NikosAssets.AiMalgam.Systems.Engines.AiMalgamEntityBaseEngine< ActionType, BlackboardType >.