MoreMountains.TopDownEngine.AIActionUnityEvents Class Reference

This action is used to trigger a UnityEvent. More...

Inheritance diagram for MoreMountains.TopDownEngine.AIActionUnityEvents:

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

Public Attributes
UnityEvent	TargetEvent
	The UnityEvent to trigger when this action gets performed by the AIBrain.
bool	OnlyPlayWhenEnteringState = true
	If this is false, the Unity Event will be triggered every PerformAction (by default every frame while in this state), otherwise it'll only play once, when entering the state.
Public Attributes inherited from MoreMountains.Tools.AIAction
InitializationModes	InitializationMode
	whether initialization should happen only once, or every time the brain is reset
string	Label
	a label you can set to organize your AI Actions, not used by anything else

Protected Member Functions
virtual void	TriggerEvent ()
	Triggers the target event.
Protected Member Functions inherited from MoreMountains.Tools.AIAction
virtual void	Awake ()
	On Awake we grab our AIBrain.

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 { EveryTime , OnlyOnce }
Properties inherited from MoreMountains.Tools.AIAction
virtual bool	ActionInProgress [get, set]
virtual bool	ShouldInitialize [get]

Detailed Description

This action is used to trigger a UnityEvent.

Member Function Documentation

OnEnterState()

override void MoreMountains.TopDownEngine.AIActionUnityEvents.OnEnterState ( )

virtual

On enter state we initialize our _played bool.

Reimplemented from MoreMountains.Tools.AIAction.

PerformAction()

override void MoreMountains.TopDownEngine.AIActionUnityEvents.PerformAction

(

)

On PerformAction we trigger our event.

TriggerEvent()

virtual void MoreMountains.TopDownEngine.AIActionUnityEvents.TriggerEvent ( )

protectedvirtual

Triggers the target event.

Member Data Documentation

_played

bool MoreMountains.TopDownEngine.AIActionUnityEvents._played = false

protected

OnlyPlayWhenEnteringState

bool MoreMountains.TopDownEngine.AIActionUnityEvents.OnlyPlayWhenEnteringState = true

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

TargetEvent

UnityEvent MoreMountains.TopDownEngine.AIActionUnityEvents.TargetEvent

The UnityEvent to trigger when this action gets performed by the AIBrain.

---

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

• H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/Common/Scripts/Characters/AI/Advanced/AIActionUnityEvents.cs