MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D Class Reference

This AI Action will let an agent with a CharacterOrientation2D ability face its target. More...

Inheritance diagram for MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D:

Public Types
enum	Modes { LeftRight , FacingDirections }
	the possible modes you can ask the AI to face (should - usually - match your CharacterOrientation2D settings) More...
Public Types inherited from MoreMountains.Tools.AIAction
enum	InitializationModes { EveryTime , OnlyOnce }

Public Member Functions
override void	Initialization ()
	On init we grab our CharacterOrientation2D ability.
override void	OnEnterState ()
	Describes what happens when the brain enters the state this action is in. Meant to be overridden.
override void	OnExitState ()
	Describes what happens when the brain exits the state this action is in. Meant to be overridden.
override void	PerformAction ()
	On PerformAction we face our target.
Public Member Functions inherited from MoreMountains.Tools.AIAction
void	PerformAction ()

Public Attributes
Modes	Mode = Modes.LeftRight
	the selected facing mode
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	FaceTarget ()
	Makes the orientation 2D ability face towards the brain target.
Protected Member Functions inherited from MoreMountains.Tools.AIAction
virtual void	Awake ()
	On Awake we grab our AIBrain.

Protected Attributes
CharacterOrientation2D	_characterOrientation2D
Vector3	_targetPosition
Vector2	_distance
bool	_chacterOrientation2DNotNull
Character.FacingDirections	_newFacingDirection
CharacterOrientation2D.FacingModes	_initialFacingMode
Protected Attributes inherited from MoreMountains.Tools.AIAction
bool	_initialized
AIBrain	_brain

Additional Inherited Members
Properties inherited from MoreMountains.Tools.AIAction
virtual bool	ActionInProgress [get, set]
virtual bool	ShouldInitialize [get]

Detailed Description

This AI Action will let an agent with a CharacterOrientation2D ability face its target.

Member Enumeration Documentation

Modes

enum MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D.Modes

the possible modes you can ask the AI to face (should - usually - match your CharacterOrientation2D settings)

Enumerator
LeftRight
FacingDirections

Member Function Documentation

FaceTarget()

virtual void MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D.FaceTarget ( )

protectedvirtual

Makes the orientation 2D ability face towards the brain target.

Initialization()

override void MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D.Initialization ( )

virtual

On init we grab our CharacterOrientation2D ability.

Reimplemented from MoreMountains.Tools.AIAction.

OnEnterState()

override void MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D.OnEnterState ( )

virtual

Describes what happens when the brain enters the state this action is in. Meant to be overridden.

Reimplemented from MoreMountains.Tools.AIAction.

OnExitState()

override void MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D.OnExitState ( )

virtual

Describes what happens when the brain exits the state this action is in. Meant to be overridden.

Reimplemented from MoreMountains.Tools.AIAction.

PerformAction()

override void MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D.PerformAction

(

)

On PerformAction we face our target.

Member Data Documentation

_chacterOrientation2DNotNull

bool MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D._chacterOrientation2DNotNull

protected

_characterOrientation2D

CharacterOrientation2D MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D._characterOrientation2D

protected

_distance

Vector2 MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D._distance

protected

_initialFacingMode

CharacterOrientation2D.FacingModes MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D._initialFacingMode

protected

_newFacingDirection

Character.FacingDirections MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D._newFacingDirection

protected

_targetPosition

Vector3 MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D._targetPosition

protected

Mode

Modes MoreMountains.TopDownEngine.AIActionFaceTowardsTarget2D.Mode = Modes.LeftRight

the selected facing mode

---

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

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