You should extend this class for all your playable characters The asset includes a bunch of examples of how you can do that : Jumper, Flappy, Dragon, etc... More...

Inheritance diagram for MoreMountains.InfiniteRunnerEngine.PlayableCharacter:

Public Member Functions
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	MainActionStart ()
	What happens when the main action button button is pressed.
virtual void	MainActionEnd ()
	What happens when the main action button button is released.
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
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
virtual void	Awake ()
	Use this for initialization.
virtual void	Start ()
	On start - Override this if needed.
virtual void	Initialize ()
	This method initializes all essential elements.
virtual void	Update ()
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	UpdateAllMecanimAnimators ()
	Updates all mecanim animators.
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
Vector3	_initialPosition
bool	_grounded
MMRigidbodyInterface	_rigidbodyInterface
Animator	_animator
float	_distanceToTheGroundRaycastLength = 50f
GameObject	_ground
LayerMask	_collisionMaskSave
float	_awakeAt
Vector3	_raycastLeftOrigin
Vector3	_raycastRightOrigin

Properties
float	DistanceToTheGround `[get, protected set]`
	the distance between the character and the ground
bool	Invincible `[get]`

Detailed Description

You should extend this class for all your playable characters The asset includes a bunch of examples of how you can do that : Jumper, Flappy, Dragon, etc...

Member Function Documentation

◆ Awake()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.Awake ( )

protectedvirtual

Use this for initialization.

Reimplemented in MoreMountains.InfiniteRunnerEngine.Dragon, MoreMountains.InfiniteRunnerEngine.Flappy, and MoreMountains.InfiniteRunnerEngine.LaneRunner.

◆ CheckDeathConditions()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.CheckDeathConditions ( )

protectedvirtual

Checks the death conditions.

◆ CollisionEnter()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.CollisionEnter ( GameObject collidingObject )

protectedvirtual

Override this to define what happens when your playable character enters something.

Parameters

collidingObject Colliding object.

Reimplemented in MoreMountains.InfiniteRunnerEngine.VerticalCharacter.

◆ CollisionExit()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.CollisionExit ( GameObject collidingObject )

protectedvirtual

Override this to define what happens when your playable character exits something.

Parameters

collidingObject Colliding object.

◆ ComputeDistanceToTheGround()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.ComputeDistanceToTheGround ( )

protectedvirtual

Determines the distance between the Jumper and the ground.

◆ DetermineIfGroudedConditionsAreMet()

virtual bool MoreMountains.InfiniteRunnerEngine.PlayableCharacter.DetermineIfGroudedConditionsAreMet ( )

protectedvirtual

Determines if grouded conditions are met.

Returns: true, if if grouded conditions are met was determined, false otherwise.

◆ Die()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.Die ( )

virtual

What happens when the object gets killed.

Reimplemented in MoreMountains.InfiniteRunnerEngine.CaveRacer, MoreMountains.InfiniteRunnerEngine.HillRider, and MoreMountains.InfiniteRunnerEngine.LaneRunner.

◆ Disable()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.Disable ( )

virtual

Disables the playable character.

◆ DisableCollisions()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.DisableCollisions ( )

virtual

Disables the collisions.

◆ DownEnd()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.DownEnd ( )

virtual

What happens when the down button is released.

◆ DownOngoing()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.DownOngoing ( )

virtual

What happens when the down button is being pressed.

◆ DownStart()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.DownStart ( )

virtual

What happens when the down button is pressed.

◆ EnableCollisions()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.EnableCollisions ( )

virtual

Enables the collisions.

◆ GetPlayableCharacterBounds()

virtual Bounds MoreMountains.InfiniteRunnerEngine.PlayableCharacter.GetPlayableCharacterBounds ( )

protectedvirtual

Gets the playable character bounds.

Returns: The playable character bounds.

◆ Initialize()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.Initialize ( )

protectedvirtual

This method initializes all essential elements.

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

◆ LeftEnd()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.LeftEnd ( )

virtual

What happens when the left button is released.

Reimplemented in MoreMountains.InfiniteRunnerEngine.FreeLeftToRightMovement.

◆ LeftOngoing()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.LeftOngoing ( )

virtual

What happens when the left button is being pressed.

Reimplemented in MoreMountains.InfiniteRunnerEngine.LeftRightMove.

◆ LeftStart()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.LeftStart ( )

virtual

What happens when the left button is pressed.

Reimplemented in MoreMountains.InfiniteRunnerEngine.FreeLeftToRightMovement, MoreMountains.InfiniteRunnerEngine.LaneRunner, and MoreMountains.InfiniteRunnerEngine.VerticalCharacter.

◆ MainActionEnd()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.MainActionEnd ( )

virtual

What happens when the main action button button is released.

Reimplemented in MoreMountains.InfiniteRunnerEngine.Flappy, MoreMountains.InfiniteRunnerEngine.Jumper, and MoreMountains.InfiniteRunnerEngine.Rocket.

◆ MainActionOngoing()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.MainActionOngoing ( )

virtual

What happens when the main action button button is being pressed.

◆ MainActionStart()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.MainActionStart ( )

virtual

What happens when the main action button button is pressed.

Reimplemented in MoreMountains.InfiniteRunnerEngine.CaveRacer, MoreMountains.InfiniteRunnerEngine.Flappy, MoreMountains.InfiniteRunnerEngine.Jumper, and MoreMountains.InfiniteRunnerEngine.Rocket.

◆ OnCollisionEnter()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.OnCollisionEnter ( Collision collidingObject )

protectedvirtual

Handles enter collision with 3D colliders.

Parameters

collidingObject Colliding object.

◆ OnCollisionEnter2D()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.OnCollisionEnter2D ( Collision2D collidingObject )

protectedvirtual

Handles enter collision with 2D colliders.

Parameters

collidingObject Colliding object.

◆ OnCollisionExit()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.OnCollisionExit ( Collision collidingObject )

protectedvirtual

Handles exit collision with 3D colliders.

Parameters

collidingObject Other.

◆ OnCollisionExit2D()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.OnCollisionExit2D ( Collision2D collidingObject )

protectedvirtual

Handles exit collision with 2D colliders.

Parameters

collidingObject Colliding object.

◆ OnTriggerEnter()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.OnTriggerEnter ( Collider collidingObject )

protectedvirtual

Handles enter collision with 2D triggers.

Parameters

collidingObject Colliding object.

◆ OnTriggerEnter2D()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.OnTriggerEnter2D ( Collider2D collidingObject )

protectedvirtual

Handles enter collision with 2D triggers.

Parameters

collidingObject Colliding object.

◆ OnTriggerExit()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.OnTriggerExit ( Collider collidingObject )

protectedvirtual

Handles enter collision with 2D triggers.

Parameters

collidingObject Colliding object.

◆ OnTriggerExit2D()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.OnTriggerExit2D ( Collider2D collidingObject )

protectedvirtual

Handles enter collision with 2D triggers.

Parameters

collidingObject Colliding object.

◆ ResetPosition()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.ResetPosition ( )

protectedvirtual

Called on update, tries to return the object to its initial position.

◆ RightEnd()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.RightEnd ( )

virtual

What happens when the right button is released.

Reimplemented in MoreMountains.InfiniteRunnerEngine.FreeLeftToRightMovement.

◆ RightOngoing()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.RightOngoing ( )

virtual

What happens when the right button is being pressed.

Reimplemented in MoreMountains.InfiniteRunnerEngine.LeftRightMove.

◆ RightStart()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.RightStart ( )

virtual

What happens when the right button is pressed.

Reimplemented in MoreMountains.InfiniteRunnerEngine.FreeLeftToRightMovement, MoreMountains.InfiniteRunnerEngine.LaneRunner, and MoreMountains.InfiniteRunnerEngine.VerticalCharacter.

◆ SetInitialPosition()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.SetInitialPosition ( Vector3 initialPosition )

virtual

Use this to define the initial position of the agent. Used mainly for reset position purposes.

Parameters

initialPosition Initial position.

◆ Start()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.Start ( )

protectedvirtual

On start - Override this if needed.

Reimplemented in MoreMountains.InfiniteRunnerEngine.AlbatrossController, MoreMountains.InfiniteRunnerEngine.CaveRacer, MoreMountains.InfiniteRunnerEngine.Dragon, MoreMountains.InfiniteRunnerEngine.FreeLeftToRightMovement, and MoreMountains.InfiniteRunnerEngine.Jumper.

◆ TriggerEnter()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.TriggerEnter ( GameObject collidingObject )

protectedvirtual

Override this to define what happens when your playable character enters a trigger.

Parameters

collidingObject Colliding object.

Reimplemented in MoreMountains.InfiniteRunnerEngine.CaveRacer.

◆ TriggerExit()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.TriggerExit ( GameObject collidingObject )

protectedvirtual

Override this to define what happens when your playable character exits a trigger.

Parameters

collidingObject Colliding object.

◆ Update()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.Update ( )

protectedvirtual

◆ UpdateAllMecanimAnimators()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.UpdateAllMecanimAnimators ( )

protectedvirtual

Updates all mecanim animators.

Reimplemented in MoreMountains.InfiniteRunnerEngine.Dragon, MoreMountains.InfiniteRunnerEngine.Flappy, MoreMountains.InfiniteRunnerEngine.HillRider, MoreMountains.InfiniteRunnerEngine.Jumper, and MoreMountains.InfiniteRunnerEngine.VerticalCharacter.

◆ UpdateAnimator()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.UpdateAnimator ( )

protectedvirtual

This is called at Update() and sets each of the animators parameters to their corresponding State values.

◆ UpEnd()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.UpEnd ( )

virtual

What happens when the up button is released.

◆ UpOngoing()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.UpOngoing ( )

virtual

What happens when the up button is being pressed.

◆ UpStart()

virtual void MoreMountains.InfiniteRunnerEngine.PlayableCharacter.UpStart ( )

virtual

What happens when the up button is pressed.

Member Data Documentation

◆ _animator

Animator MoreMountains.InfiniteRunnerEngine.PlayableCharacter._animator

protected

◆ _awakeAt

float MoreMountains.InfiniteRunnerEngine.PlayableCharacter._awakeAt

protected

◆ _collisionMaskSave

LayerMask MoreMountains.InfiniteRunnerEngine.PlayableCharacter._collisionMaskSave

protected

◆ _distanceToTheGroundRaycastLength

float MoreMountains.InfiniteRunnerEngine.PlayableCharacter._distanceToTheGroundRaycastLength = 50f

protected

◆ _ground

GameObject MoreMountains.InfiniteRunnerEngine.PlayableCharacter._ground

protected

◆ _grounded

bool MoreMountains.InfiniteRunnerEngine.PlayableCharacter._grounded

protected

◆ _initialPosition

Vector3 MoreMountains.InfiniteRunnerEngine.PlayableCharacter._initialPosition

protected

◆ _raycastLeftOrigin

Vector3 MoreMountains.InfiniteRunnerEngine.PlayableCharacter._raycastLeftOrigin

protected

◆ _raycastRightOrigin

Vector3 MoreMountains.InfiniteRunnerEngine.PlayableCharacter._raycastRightOrigin

protected

◆ _rigidbodyInterface

MMRigidbodyInterface MoreMountains.InfiniteRunnerEngine.PlayableCharacter._rigidbodyInterface

protected

◆ GroundDistanceTolerance

float MoreMountains.InfiniteRunnerEngine.PlayableCharacter.GroundDistanceTolerance = 0.05f

the distance tolerance at which a character is considered grounded

◆ InitialInvincibilityDuration

float MoreMountains.InfiniteRunnerEngine.PlayableCharacter.InitialInvincibilityDuration = 3f

the duration (in seconds) of invincibility on spawn

◆ ResetPositionSpeed

float MoreMountains.InfiniteRunnerEngine.PlayableCharacter.ResetPositionSpeed = 0.5f

◆ ShouldResetPosition

bool MoreMountains.InfiniteRunnerEngine.PlayableCharacter.ShouldResetPosition = true

returns true if the character is currently grounded

◆ UseDefaultMecanim

bool MoreMountains.InfiniteRunnerEngine.PlayableCharacter.UseDefaultMecanim = true

should we use the default mecanim ?

Property Documentation

◆ DistanceToTheGround

float MoreMountains.InfiniteRunnerEngine.PlayableCharacter.DistanceToTheGround

getprotected set

the distance between the character and the ground

◆ Invincible

bool MoreMountains.InfiniteRunnerEngine.PlayableCharacter.Invincible

get

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

Assets/InfiniteRunnerEngine/Common/Scripts/PlayableCharacters/PlayableCharacter.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ Awake()

◆ CheckDeathConditions()

◆ CollisionEnter()

◆ CollisionExit()

◆ ComputeDistanceToTheGround()

◆ DetermineIfGroudedConditionsAreMet()

◆ Die()

◆ Disable()

◆ DisableCollisions()

◆ DownEnd()

◆ DownOngoing()

◆ DownStart()

◆ EnableCollisions()

◆ GetPlayableCharacterBounds()

◆ Initialize()

◆ LeftEnd()

◆ LeftOngoing()

◆ LeftStart()

◆ MainActionEnd()

◆ MainActionOngoing()

◆ MainActionStart()

◆ OnCollisionEnter()

◆ OnCollisionEnter2D()

◆ OnCollisionExit()

◆ OnCollisionExit2D()

◆ OnTriggerEnter()

◆ OnTriggerEnter2D()

◆ OnTriggerExit()

◆ OnTriggerExit2D()

◆ ResetPosition()

◆ RightEnd()

◆ RightOngoing()

◆ RightStart()

◆ SetInitialPosition()

◆ Start()

◆ TriggerEnter()

◆ TriggerExit()

◆ Update()

◆ UpdateAllMecanimAnimators()

◆ UpdateAnimator()

◆ UpEnd()

◆ UpOngoing()

◆ UpStart()

Member Data Documentation

◆ _animator

◆ _awakeAt

◆ _collisionMaskSave

◆ _distanceToTheGroundRaycastLength

◆ _ground

◆ _grounded

◆ _initialPosition

◆ _raycastLeftOrigin

◆ _raycastRightOrigin

◆ _rigidbodyInterface

◆ GroundDistanceTolerance

◆ InitialInvincibilityDuration

◆ ResetPositionSpeed

◆ ShouldResetPosition

◆ UseDefaultMecanim

Property Documentation

◆ DistanceToTheGround

◆ Invincible