TopDown Engine  v3.6
MoreMountains.TopDownEngine.AIActionMMFeedbacks Class Reference

This action is used to play a MMFeedbacks More...

Inheritance diagram for MoreMountains.TopDownEngine.AIActionMMFeedbacks:
MoreMountains.Tools.AIAction

Public Member Functions

override void PerformAction ()
 On PerformAction we play our MMFeedbacks More...
 
override void OnEnterState ()
 On enter state we initialize our _played bool More...
 
- Public Member Functions inherited from MoreMountains.Tools.AIAction
virtual void Initialization ()
 Initializes the action. Meant to be overridden More...
 
virtual void OnExitState ()
 Describes what happens when the brain exits the state this action is in. Meant to be overridden. More...
 

Public Attributes

MMFeedbacks TargetFeedbacks
 The MMFeedbacks to play when this action gets performed by the AIBrain. More...
 
bool OnlyPlayWhenEnteringState = true
 If this is false, the feedback will be played every PerformAction (by default every frame while in this state), otherwise it'll only play once, when entering the state. More...
 
bool SetTargetGameObjectActive = false
 If this is true, the target game object the TargetFeedbacks is on will be set active when performing this action. More...
 
- Public Attributes inherited from MoreMountains.Tools.AIAction
InitializationModes InitializationMode
 
string Label
 a label you can set to organize your AI Actions, not used by anything else More...
 

Protected Member Functions

virtual void PlayFeedbacks ()
 Plays the target MMFeedbacks More...
 
- Protected Member Functions inherited from MoreMountains.Tools.AIAction
virtual void Awake ()
 On Awake we grab our AIBrain More...
 

Protected Attributes

bool _played = false
 
- Protected Attributes inherited from MoreMountains.Tools.AIAction
bool _initialized
 
AIBrain _brain
 

Additional Inherited Members

- Public Types inherited from MoreMountains.Tools.AIAction
enum  InitializationModes { InitializationModes.EveryTime, InitializationModes.OnlyOnce }
 
- Properties inherited from MoreMountains.Tools.AIAction
virtual bool ActionInProgress [get, set]
 
virtual bool ShouldInitialize [get]
 

Detailed Description

This action is used to play a MMFeedbacks

Member Function Documentation

◆ OnEnterState()

override void MoreMountains.TopDownEngine.AIActionMMFeedbacks.OnEnterState ( )
virtual

On enter state we initialize our _played bool

Reimplemented from MoreMountains.Tools.AIAction.

◆ PerformAction()

override void MoreMountains.TopDownEngine.AIActionMMFeedbacks.PerformAction ( )
virtual

On PerformAction we play our MMFeedbacks

Implements MoreMountains.Tools.AIAction.

◆ PlayFeedbacks()

virtual void MoreMountains.TopDownEngine.AIActionMMFeedbacks.PlayFeedbacks ( )
protectedvirtual

Plays the target MMFeedbacks

Member Data Documentation

◆ _played

bool MoreMountains.TopDownEngine.AIActionMMFeedbacks._played = false
protected

◆ OnlyPlayWhenEnteringState

bool MoreMountains.TopDownEngine.AIActionMMFeedbacks.OnlyPlayWhenEnteringState = true

If this is false, the feedback will be played every PerformAction (by default every frame while in this state), otherwise it'll only play once, when entering the state.

◆ SetTargetGameObjectActive

bool MoreMountains.TopDownEngine.AIActionMMFeedbacks.SetTargetGameObjectActive = false

If this is true, the target game object the TargetFeedbacks is on will be set active when performing this action.

◆ TargetFeedbacks

MMFeedbacks MoreMountains.TopDownEngine.AIActionMMFeedbacks.TargetFeedbacks

The MMFeedbacks to play when this action gets performed by the AIBrain.


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