Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.EnemyMovement_FlyUpAndDown Class Reference

An enemy movement that flies up and down. More...

Inheritance diagram for PlatformerPro.EnemyMovement_FlyUpAndDown:
PlatformerPro.EnemyMovement PlatformerPro.PlatformerProMonoBehaviour

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...
 
- 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 void HitCharacter (Character character, DamageInfo info)
 Called when the enemy hits the character. More...
 
virtual 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...
 
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 topOffset
 The distance from starting position to the top extent. More...
 
float bottomOffset
 The distance from starting position to the bottom extent. More...
 
float speed
 The speed the enemy moves at. More...
 

Protected Attributes

float topExtent
 The top extent. More...
 
float bottomExtent
 The bottom 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 flies up and down.

Member Function Documentation

◆ DoMove()

override bool PlatformerPro.EnemyMovement_FlyUpAndDown.DoMove ( )
virtual

Moves the character.

Reimplemented from PlatformerPro.EnemyMovement.

◆ Init()

override EnemyMovement PlatformerPro.EnemyMovement_FlyUpAndDown.Init ( Enemy  enemy)
virtual

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

Reimplemented from PlatformerPro.EnemyMovement.

Member Data Documentation

◆ bottomExtent

float PlatformerPro.EnemyMovement_FlyUpAndDown.bottomExtent
protected

The bottom extent.

◆ bottomOffset

float PlatformerPro.EnemyMovement_FlyUpAndDown.bottomOffset

The distance from starting position to the bottom extent.

◆ speed

float PlatformerPro.EnemyMovement_FlyUpAndDown.speed

The speed the enemy moves at.

◆ topExtent

float PlatformerPro.EnemyMovement_FlyUpAndDown.topExtent
protected

The top extent.

◆ topOffset

float PlatformerPro.EnemyMovement_FlyUpAndDown.topOffset

The distance from starting position to the top extent.

Property Documentation

◆ AnimationState

override AnimationState PlatformerPro.EnemyMovement_FlyUpAndDown.AnimationState
get

Gets the animation state that this movement wants to set.

◆ FacingDirection

override int PlatformerPro.EnemyMovement_FlyUpAndDown.FacingDirection
get

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

◆ Info

new static MovementInfo PlatformerPro.EnemyMovement_FlyUpAndDown.Info
staticget

Static movement info used by the editor.


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