MoreMountains.InfiniteRunnerEngine.Jumper Class Reference

Inheritance diagram for MoreMountains.InfiniteRunnerEngine.Jumper:

Public Member Functions
override void	MainActionStart ()
	What happens when the main action button button is pressed.
virtual void	Jump ()
override void	MainActionEnd ()
	What happens when the main action button button is released.
virtual IEnumerator	JumpSlow ()
	Slows the player's jump.
Public Member Functions inherited from MoreMountains.InfiniteRunnerEngine.PlayableCharacter
virtual void	SetInitialPosition (Vector3 initialPosition)
	Use this to define the initial position of the agent. Used mainly for reset position purposes.
virtual void	Disable ()
	Disables the playable character.
virtual void	Die ()
	What happens when the object gets killed.
virtual void	DisableCollisions ()
	Disables the collisions.
virtual void	EnableCollisions ()
	Enables the collisions.
virtual void	MainActionOngoing ()
	What happens when the main action button button is being pressed.
virtual void	DownStart ()
	What happens when the down button is pressed.
virtual void	DownEnd ()
	What happens when the down button is released.
virtual void	DownOngoing ()
	What happens when the down button is being pressed.
virtual void	UpStart ()
	What happens when the up button is pressed.
virtual void	UpEnd ()
	What happens when the up button is released.
virtual void	UpOngoing ()
	What happens when the up button is being pressed.
virtual void	LeftStart ()
	What happens when the left button is pressed.
virtual void	LeftEnd ()
	What happens when the left button is released.
virtual void	LeftOngoing ()
	What happens when the left button is being pressed.
virtual void	RightStart ()
	What happens when the right button is pressed.
virtual void	RightEnd ()
	What happens when the right button is released.
virtual void	RightOngoing ()
	What happens when the right button is being pressed.

Public Attributes
float	JumpForce = 20f
	the vertical force applied to the character when jumping
int	NumberOfJumpsAllowed = 2
	the number of jumps allowed
float	CooldownBetweenJumps = 0f
	the minimum time (in seconds) allowed between two consecutive jumps
bool	JumpsAllowedWhenGroundedOnly
	can the character jump only when grounded ?
float	JumpReleaseSpeed = 50f
	the speed at which the character falls back down again when the jump button is released
bool	JumpProportionalToPress = true
	if this is set to false, the jump height won't depend on the jump button release speed
float	MinimalDelayBetweenJumps = 0.02f
	the minimal time, in seconds, that needs to have passed for a new jump to be authorized
float	UngroundedDurationAfterJump = 0.2f
	a duration, after a jump, during which the character can't be considered grounded (to avoid jumps left to be reset too soon depending on context)
int	_numberOfJumpsLeft
Public Attributes inherited from MoreMountains.InfiniteRunnerEngine.PlayableCharacter
bool	UseDefaultMecanim = true
	should we use the default mecanim ?
bool	ShouldResetPosition = true
	returns true if the character is currently grounded
float	ResetPositionSpeed = 0.5f
float	GroundDistanceTolerance = 0.05f
	the distance tolerance at which a character is considered grounded
float	InitialInvincibilityDuration = 3f
	the duration (in seconds) of invincibility on spawn

Protected Member Functions
override void	Start ()
	On Start() we initialize the last jump time.
override void	Update ()
	On update, we update the animator and try to reset the jumper's position.
override void	UpdateAllMecanimAnimators ()
	Updates all mecanim animators.
virtual void	PerformJump ()
virtual void	ApplyJumpForce ()
virtual bool	EvaluateJumpConditions ()
Protected Member Functions inherited from MoreMountains.InfiniteRunnerEngine.PlayableCharacter
virtual void	Awake ()
	Use this for initialization.
virtual void	Initialize ()
	This method initializes all essential elements.
virtual void	ComputeDistanceToTheGround ()
	Determines the distance between the Jumper and the ground.
virtual bool	DetermineIfGroudedConditionsAreMet ()
	Determines if grouded conditions are met.
virtual void	CheckDeathConditions ()
	Checks the death conditions.
virtual Bounds	GetPlayableCharacterBounds ()
	Gets the playable character bounds.
virtual void	UpdateAnimator ()
	This is called at Update() and sets each of the animators parameters to their corresponding State values.
virtual void	ResetPosition ()
	Called on update, tries to return the object to its initial position.
virtual void	OnCollisionEnter2D (Collision2D collidingObject)
	Handles enter collision with 2D colliders.
virtual void	OnCollisionExit2D (Collision2D collidingObject)
	Handles exit collision with 2D colliders.
virtual void	OnCollisionEnter (Collision collidingObject)
	Handles enter collision with 3D colliders.
virtual void	OnCollisionExit (Collision collidingObject)
	Handles exit collision with 3D colliders.
virtual void	OnTriggerEnter2D (Collider2D collidingObject)
	Handles enter collision with 2D triggers.
virtual void	OnTriggerExit2D (Collider2D collidingObject)
	Handles enter collision with 2D triggers.
virtual void	OnTriggerEnter (Collider collidingObject)
	Handles enter collision with 2D triggers.
virtual void	OnTriggerExit (Collider collidingObject)
	Handles enter collision with 2D triggers.
virtual void	CollisionEnter (GameObject collidingObject)
	Override this to define what happens when your playable character enters something.
virtual void	CollisionExit (GameObject collidingObject)
	Override this to define what happens when your playable character exits something.
virtual void	TriggerEnter (GameObject collidingObject)
	Override this to define what happens when your playable character enters a trigger.
virtual void	TriggerExit (GameObject collidingObject)
	Override this to define what happens when your playable character exits a trigger.

Protected Attributes
bool	_jumping = false
float	_lastJumpTime
Protected Attributes inherited from MoreMountains.InfiniteRunnerEngine.PlayableCharacter
Vector3	_initialPosition
bool	_grounded
MMRigidbodyInterface	_rigidbodyInterface
Animator	_animator
float	_distanceToTheGroundRaycastLength = 50f
GameObject	_ground
LayerMask	_collisionMaskSave
float	_awakeAt
Vector3	_raycastLeftOrigin
Vector3	_raycastRightOrigin

Additional Inherited Members
Properties inherited from MoreMountains.InfiniteRunnerEngine.PlayableCharacter
float	DistanceToTheGround [get, protected set]
	the distance between the character and the ground
bool	Invincible [get]

Member Function Documentation

ApplyJumpForce()

virtual void MoreMountains.InfiniteRunnerEngine.Jumper.ApplyJumpForce ( )

protectedvirtual

Reimplemented in MoreMountains.InfiniteRunnerEngine.HillRider, and MoreMountains.InfiniteRunnerEngine.VerticalCharacter.

EvaluateJumpConditions()

virtual bool MoreMountains.InfiniteRunnerEngine.Jumper.EvaluateJumpConditions ( )

protectedvirtual

Jump()

virtual void MoreMountains.InfiniteRunnerEngine.Jumper.Jump ( )

virtual

Reimplemented in MoreMountains.InfiniteRunnerEngine.HillRider, and MoreMountains.InfiniteRunnerEngine.VerticalCharacter.

JumpSlow()

virtual IEnumerator MoreMountains.InfiniteRunnerEngine.Jumper.JumpSlow ( )

virtual

Slows the player's jump.

Returns

The slow.

MainActionEnd()

override void MoreMountains.InfiniteRunnerEngine.Jumper.MainActionEnd ( )

virtual

What happens when the main action button button is released.

Reimplemented from MoreMountains.InfiniteRunnerEngine.PlayableCharacter.

MainActionStart()

override void MoreMountains.InfiniteRunnerEngine.Jumper.MainActionStart ( )

virtual

What happens when the main action button button is pressed.

Reimplemented from MoreMountains.InfiniteRunnerEngine.PlayableCharacter.

PerformJump()

virtual void MoreMountains.InfiniteRunnerEngine.Jumper.PerformJump ( )

protectedvirtual

Start()

override void MoreMountains.InfiniteRunnerEngine.Jumper.Start ( )

protectedvirtual

On Start() we initialize the last jump time.

Reimplemented from MoreMountains.InfiniteRunnerEngine.PlayableCharacter.

Update()

override void MoreMountains.InfiniteRunnerEngine.Jumper.Update ( )

protectedvirtual

On update, we update the animator and try to reset the jumper's position.

Reimplemented from MoreMountains.InfiniteRunnerEngine.PlayableCharacter.

Reimplemented in MoreMountains.InfiniteRunnerEngine.VerticalCharacter.

UpdateAllMecanimAnimators()

override void MoreMountains.InfiniteRunnerEngine.Jumper.UpdateAllMecanimAnimators ( )

protectedvirtual

Updates all mecanim animators.

Reimplemented from MoreMountains.InfiniteRunnerEngine.PlayableCharacter.

Reimplemented in MoreMountains.InfiniteRunnerEngine.VerticalCharacter.

Member Data Documentation

_jumping

bool MoreMountains.InfiniteRunnerEngine.Jumper._jumping = false

protected

_lastJumpTime

float MoreMountains.InfiniteRunnerEngine.Jumper._lastJumpTime

protected

_numberOfJumpsLeft

int MoreMountains.InfiniteRunnerEngine.Jumper._numberOfJumpsLeft

CooldownBetweenJumps

float MoreMountains.InfiniteRunnerEngine.Jumper.CooldownBetweenJumps = 0f

the minimum time (in seconds) allowed between two consecutive jumps

JumpForce

float MoreMountains.InfiniteRunnerEngine.Jumper.JumpForce = 20f

the vertical force applied to the character when jumping

JumpProportionalToPress

bool MoreMountains.InfiniteRunnerEngine.Jumper.JumpProportionalToPress = true

if this is set to false, the jump height won't depend on the jump button release speed

JumpReleaseSpeed

float MoreMountains.InfiniteRunnerEngine.Jumper.JumpReleaseSpeed = 50f

the speed at which the character falls back down again when the jump button is released

JumpsAllowedWhenGroundedOnly

bool MoreMountains.InfiniteRunnerEngine.Jumper.JumpsAllowedWhenGroundedOnly

can the character jump only when grounded ?

MinimalDelayBetweenJumps

float MoreMountains.InfiniteRunnerEngine.Jumper.MinimalDelayBetweenJumps = 0.02f

the minimal time, in seconds, that needs to have passed for a new jump to be authorized

NumberOfJumpsAllowed

int MoreMountains.InfiniteRunnerEngine.Jumper.NumberOfJumpsAllowed = 2

the number of jumps allowed

UngroundedDurationAfterJump

float MoreMountains.InfiniteRunnerEngine.Jumper.UngroundedDurationAfterJump = 0.2f

a duration, after a jump, during which the character can't be considered grounded (to avoid jumps left to be reset too soon depending on context)

---

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

• Assets/InfiniteRunnerEngine/Common/Scripts/PlayableCharacters/Jumper.cs