MoreMountains.InfiniteRunnerEngine.Rocket Class Reference

A rocket controller (the longer you press, the higher you go). More...

Inheritance diagram for MoreMountains.InfiniteRunnerEngine.Rocket:

Public Member Functions
override void	MainActionStart ()
	When pressing the main action button for the first time we start boosting.
override void	MainActionEnd ()
	When we stop pressing the main action button, we stop boosting.
virtual void	Fly ()
	When the rocket is boosting we add a vertical force to make it climb. Gravity will handle the rest.
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	FlyForce = 20f
	The force applied when pressing the main button.
float	MaximumVelocity = 5f
	The maximum velocity.
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	Update ()
	On Update.
virtual void	FixedUpdate ()
	On fixed update.
Protected Member Functions inherited from MoreMountains.InfiniteRunnerEngine.PlayableCharacter
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	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
bool	_boosting = false
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]

Detailed Description

A rocket controller (the longer you press, the higher you go).

Member Function Documentation

FixedUpdate()

virtual void MoreMountains.InfiniteRunnerEngine.Rocket.FixedUpdate ( )

protectedvirtual

On fixed update.

Fly()

virtual void MoreMountains.InfiniteRunnerEngine.Rocket.Fly ( )

virtual

When the rocket is boosting we add a vertical force to make it climb. Gravity will handle the rest.

MainActionEnd()

override void MoreMountains.InfiniteRunnerEngine.Rocket.MainActionEnd ( )

virtual

When we stop pressing the main action button, we stop boosting.

Reimplemented from MoreMountains.InfiniteRunnerEngine.PlayableCharacter.

MainActionStart()

override void MoreMountains.InfiniteRunnerEngine.Rocket.MainActionStart ( )

virtual

When pressing the main action button for the first time we start boosting.

Reimplemented from MoreMountains.InfiniteRunnerEngine.PlayableCharacter.

Update()

override void MoreMountains.InfiniteRunnerEngine.Rocket.Update ( )

protectedvirtual

On Update.

Reimplemented from MoreMountains.InfiniteRunnerEngine.PlayableCharacter.

Member Data Documentation

_boosting

bool MoreMountains.InfiniteRunnerEngine.Rocket._boosting = false

protected

FlyForce

float MoreMountains.InfiniteRunnerEngine.Rocket.FlyForce = 20f

The force applied when pressing the main button.

MaximumVelocity

float MoreMountains.InfiniteRunnerEngine.Rocket.MaximumVelocity = 5f

The maximum velocity.

---

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

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