An enemy movement that quickly snaps upwards at player if they come within range. More...

Inheritance diagram for PlatformerPro.EnemyMovement_VerticalSnapper:

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...

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 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...

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	speed = 5.0f
	The speed the enemy snaps upwards at. More...

float	retractSpeed = 2.0f
	The speed the enemy retracts back at. More...

float	moveRange = 2.0f
	How far the enemy can charge upwards. More...

bool	autoRetractAtTop = false
	If true automatically retract after reaching the top position. If false stay in top position. More...

bool	mustFullyRetract = true
	If true automatically retract after reaching the top position. If false stay in top position. More...

float	sightRange = 2.0f
	How far the enemy can 'see'. More...

LayerMask	sightLayers
	The layers that trigger the snapping charge. More...

int	damageAmount = 1
	The damage amount. More...

DamageType	damageType = DamageType.PHYSICAL
	The type of the damage. More...

AnimationState	animationState = AnimationState.ATTACK
	The animation state to set while charging. More...

AnimationState	animationStateRetract = AnimationState.WALK
	The animation state to set while retracting. More...

Protected Member Functions
virtual void	CheckForPlayer ()
	Checks for the player and updates state. More...

Protected Attributes
SnapperState	state = SnapperState.IDLE
	The current state. More...

Vector2	startingPos
	The position we start at. More...

Vector2	endingPos
	The position we end at. 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 quickly snaps upwards at player if they come within range.

Member Function Documentation

◆ CheckForPlayer()

virtual void PlatformerPro.EnemyMovement_VerticalSnapper.CheckForPlayer ( )

protectedvirtual

Checks for the player and updates state.

◆ DoMove()

override bool PlatformerPro.EnemyMovement_VerticalSnapper.DoMove ( )

virtual

Moves the character.

Reimplemented from PlatformerPro.EnemyMovement.

◆ HitCharacter()

override void PlatformerPro.EnemyMovement_VerticalSnapper.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_VerticalSnapper.Init ( Enemy enemy )

virtual

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

Reimplemented from PlatformerPro.EnemyMovement.

◆ SwitchDirection()

override void PlatformerPro.EnemyMovement_VerticalSnapper.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_VerticalSnapper.animationState = AnimationState.ATTACK

The animation state to set while charging.

◆ animationStateRetract

AnimationState PlatformerPro.EnemyMovement_VerticalSnapper.animationStateRetract = AnimationState.WALK

The animation state to set while retracting.

◆ autoRetractAtTop

bool PlatformerPro.EnemyMovement_VerticalSnapper.autoRetractAtTop = false

If true automatically retract after reaching the top position. If false stay in top position.

◆ damageAmount

int PlatformerPro.EnemyMovement_VerticalSnapper.damageAmount = 1

The damage amount.

◆ damageType

DamageType PlatformerPro.EnemyMovement_VerticalSnapper.damageType = DamageType.PHYSICAL

The type of the damage.

◆ endingPos

Vector2 PlatformerPro.EnemyMovement_VerticalSnapper.endingPos

protected

The position we end at.

◆ moveRange

float PlatformerPro.EnemyMovement_VerticalSnapper.moveRange = 2.0f

How far the enemy can charge upwards.

◆ mustFullyRetract

bool PlatformerPro.EnemyMovement_VerticalSnapper.mustFullyRetract = true

If true automatically retract after reaching the top position. If false stay in top position.

◆ retractSpeed

float PlatformerPro.EnemyMovement_VerticalSnapper.retractSpeed = 2.0f

The speed the enemy retracts back at.

◆ sightLayers

LayerMask PlatformerPro.EnemyMovement_VerticalSnapper.sightLayers

The layers that trigger the snapping charge.

◆ sightRange

float PlatformerPro.EnemyMovement_VerticalSnapper.sightRange = 2.0f

How far the enemy can 'see'.

◆ speed

float PlatformerPro.EnemyMovement_VerticalSnapper.speed = 5.0f

The speed the enemy snaps upwards at.

◆ startingPos

Vector2 PlatformerPro.EnemyMovement_VerticalSnapper.startingPos

protected

The position we start at.

◆ state

SnapperState PlatformerPro.EnemyMovement_VerticalSnapper.state = SnapperState.IDLE

protected

The current state.

Property Documentation

◆ AnimationState

override AnimationState PlatformerPro.EnemyMovement_VerticalSnapper.AnimationState

get

Gets the animation state that this movement wants to set.

◆ FacingDirection

override int PlatformerPro.EnemyMovement_VerticalSnapper.FacingDirection

get

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

◆ Info

new static MovementInfo PlatformerPro.EnemyMovement_VerticalSnapper.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_VerticalSnapper.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ CheckForPlayer()

◆ DoMove()

◆ HitCharacter()

◆ Init()

◆ SwitchDirection()

Member Data Documentation

◆ animationState

◆ animationStateRetract

◆ autoRetractAtTop

◆ damageAmount

◆ damageType

◆ endingPos

◆ moveRange

◆ mustFullyRetract

◆ retractSpeed

◆ sightLayers

◆ sightRange

◆ speed

◆ startingPos

◆ state

Property Documentation

◆ AnimationState

◆ FacingDirection

◆ Info