An enemy movement that patrols back and forth. More...

Inheritance diagram for PlatformerPro.EnemyMovement_Patrol:

Public Member Functions
override EnemyMovement	Init (Enemy enemy)
	Initialise this movement and return a reference to the ready to use movement. More...

override bool	DoMove ()
	Moves the character. More...

override void	HitCharacter (Character character, DamageInfo info)
	Called when the enemy hits the character. More...

override void	SwitchDirection ()
	Called by the enemy to switch (x) direction of the movement. Note that not all movements need to support this, they may do nothing. More...

override void	SetDirection (Vector2 direction)
	Often a movement will need some kind of direction information such as where the cahracter is in relation to the enemy. Use this to set that information. Note there is no specific rule for what that information is, it could be anything. More...

Public Member Functions inherited from PlatformerPro.EnemyMovement
virtual void	DoDamage (DamageInfo info)
	Do the damage movement More...

virtual void	DoDeath (DamageInfo info)
	Do the death movement More...

virtual void	GainingControl ()
	Called when this movement is gaining control. More...

virtual bool	LosingControl ()
	Called when this movement is losing control. More...

virtual bool	CheckForEdge (int movementDirection)
	Uses the Enemies feet colliders to see if there is nothing below the enemy, and if so returns true. More...

Public Member Functions inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual void	Validate (PlatformerProMonoBehaviour myTarget)
	Override this method if you want to provide custom validation. The actual code should be surrounded by the if UNITY_EDITOR / endif directive. More...

Public Attributes
float	rightOffset
	The distance from starting position to the right extent. More...

float	leftOffset
	The distance from starting position to the left extent. More...

float	speed
	The speed the platform moves at. More...

bool	bounceOnHit
	Will the enemy change direction when it hits the character? More...

bool	walkOffEdges = true
	Will the enemy change direction when it finds an edge? More...

AnimationState	animationState = AnimationState.WALK

Protected Attributes
float	rightExtent
	The right extent. More...

float	leftExtent
	The left extent. More...

Protected Attributes inherited from PlatformerPro.EnemyMovement
Enemy	enemy
	Cached reference to the character. More...

Properties
new static MovementInfo	Info `[get]`
	Static movement info used by the editor. More...

override AnimationState	AnimationState `[get]`
	Gets the animation state that this movement wants to set. More...

override int	FacingDirection `[get]`
	Returns the direction the character is facing. 0 for none, 1 for right, -1 for left. More...

Properties inherited from PlatformerPro.EnemyMovement
virtual AnimationState	AnimationState `[get]`
	Gets the animation state that this movement wants to set. More...

virtual string	OverrideState `[get]`
	Gets the animation override state that this movement wants to set. More...

virtual int	FacingDirection `[get]`
	Returns the direction the character is facing. 0 for none, 1 for right, -1 for left. More...

virtual bool	ShouldSnapToGround `[get]`
	If we are grounded shoudl we snap to the ground. Helps us handle slopes. More...

static MovementInfo	Info `[get]`
	Static movement info used by the editor. More...

Properties inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual string	Header `[get]`
	Gets the header string used to describe the component. More...

virtual string	DocLink `[get]`
	Gets a link to documentation site. More...

virtual string	VideoLink `[get]`
	Gets a link to a youtube video. More...

virtual string	Deprecated `[get]`
	If non-null this component is deprecated. The string shows a message indicating how it should be replaced. More...

Detailed Description

An enemy movement that patrols back and forth.

Member Function Documentation

◆ DoMove()

override bool PlatformerPro.EnemyMovement_Patrol.DoMove ( )

virtual

Moves the character.

Reimplemented from PlatformerPro.EnemyMovement.

◆ HitCharacter()

override void PlatformerPro.EnemyMovement_Patrol.HitCharacter	(	Character	character,
		DamageInfo	info
	)

virtual

Called when the enemy hits the character.

Parameters

character	Character.
info	Damage info.

Reimplemented from PlatformerPro.EnemyMovement.

◆ Init()

override EnemyMovement PlatformerPro.EnemyMovement_Patrol.Init ( Enemy enemy )

virtual

Initialise this movement and return a reference to the ready to use movement.

Reimplemented from PlatformerPro.EnemyMovement.

◆ SetDirection()

override void PlatformerPro.EnemyMovement_Patrol.SetDirection ( Vector2 direction )

virtual

Often a movement will need some kind of direction information such as where the cahracter is in relation to the enemy. Use this to set that information. Note there is no specific rule for what that information is, it could be anything.

Parameters

direction Direction.

Reimplemented from PlatformerPro.EnemyMovement.

◆ SwitchDirection()

override void PlatformerPro.EnemyMovement_Patrol.SwitchDirection ( )

virtual

Called by the enemy to switch (x) direction of the movement. Note that not all movements need to support this, they may do nothing.

Reimplemented from PlatformerPro.EnemyMovement.

Member Data Documentation

◆ animationState

AnimationState PlatformerPro.EnemyMovement_Patrol.animationState = AnimationState.WALK

◆ bounceOnHit

bool PlatformerPro.EnemyMovement_Patrol.bounceOnHit

Will the enemy change direction when it hits the character?

◆ leftExtent

float PlatformerPro.EnemyMovement_Patrol.leftExtent

protected

The left extent.

◆ leftOffset

float PlatformerPro.EnemyMovement_Patrol.leftOffset

The distance from starting position to the left extent.

◆ rightExtent

float PlatformerPro.EnemyMovement_Patrol.rightExtent

protected

The right extent.

◆ rightOffset

float PlatformerPro.EnemyMovement_Patrol.rightOffset

The distance from starting position to the right extent.

◆ speed

float PlatformerPro.EnemyMovement_Patrol.speed

The speed the platform moves at.

◆ walkOffEdges

bool PlatformerPro.EnemyMovement_Patrol.walkOffEdges = true

Will the enemy change direction when it finds an edge?

Property Documentation

◆ AnimationState

override AnimationState PlatformerPro.EnemyMovement_Patrol.AnimationState

get

Gets the animation state that this movement wants to set.

◆ FacingDirection

override int PlatformerPro.EnemyMovement_Patrol.FacingDirection

get

Returns the direction the character is facing. 0 for none, 1 for right, -1 for left.

◆ Info

new static MovementInfo PlatformerPro.EnemyMovement_Patrol.Info

staticget

Static movement info used by the editor.

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

D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Enemies/Movement/EnemyMovement_Patrol.cs

Public Member Functions

Public Attributes

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ DoMove()

◆ HitCharacter()

◆ Init()

◆ SetDirection()

◆ SwitchDirection()

Member Data Documentation

◆ animationState

◆ bounceOnHit

◆ leftExtent

◆ leftOffset

◆ rightExtent

◆ rightOffset

◆ speed

◆ walkOffEdges

Property Documentation

◆ AnimationState

◆ FacingDirection

◆ Info