NiceTouch v2.1
MoreMountains.NiceTouch.CharacterMovement Class Reference

CharacterMovement is a very basic character class, used only to demonstrate how to bind the various controls to a character. More...

Inherits MonoBehaviour.

Public Member Functions

virtual void Move (Vector2 newMovement)
 Sets the character's horizontal and vertical movement based on what's passed as a parameter More...
 
virtual void SetHorizontalAxis (float value)
 Sets the character's horizontal movement More...
 
virtual void SetVerticalAxis (float value)
 Sets the character's vertical movement More...
 
virtual void Jump ()
 Makes the character jump More...
 

Public Attributes

float Speed = 50f
 The Speed of the character. More...
 
float MaximumSpeed = 20f
 the character's maximum speed More...
 
float JumpForce = 100f
 the force applied when jumping More...
 

Protected Member Functions

virtual void Start ()
 On Start, we get the character's rigidbody More...
 
virtual void Update ()
 On Update, we move the character based on what's been input More...
 

Protected Attributes

Rigidbody _rigidbody
 
float _horizontalMovement
 
float _verticalMovement
 
bool _axisBased =false
 

Detailed Description

CharacterMovement is a very basic character class, used only to demonstrate how to bind the various controls to a character.

Member Function Documentation

◆ Jump()

virtual void MoreMountains.NiceTouch.CharacterMovement.Jump ( )
virtual

Makes the character jump

◆ Move()

virtual void MoreMountains.NiceTouch.CharacterMovement.Move ( Vector2  newMovement)
virtual

Sets the character's horizontal and vertical movement based on what's passed as a parameter

Parameters
newMovementNew movement.

◆ SetHorizontalAxis()

virtual void MoreMountains.NiceTouch.CharacterMovement.SetHorizontalAxis ( float  value)
virtual

Sets the character's horizontal movement

Parameters
valueValue.

◆ SetVerticalAxis()

virtual void MoreMountains.NiceTouch.CharacterMovement.SetVerticalAxis ( float  value)
virtual

Sets the character's vertical movement

Parameters
valueValue.

◆ Start()

virtual void MoreMountains.NiceTouch.CharacterMovement.Start ( )
protectedvirtual

On Start, we get the character's rigidbody

◆ Update()

virtual void MoreMountains.NiceTouch.CharacterMovement.Update ( )
protectedvirtual

On Update, we move the character based on what's been input

Member Data Documentation

◆ _axisBased

bool MoreMountains.NiceTouch.CharacterMovement._axisBased =false
protected

◆ _horizontalMovement

float MoreMountains.NiceTouch.CharacterMovement._horizontalMovement
protected

◆ _rigidbody

Rigidbody MoreMountains.NiceTouch.CharacterMovement._rigidbody
protected

◆ _verticalMovement

float MoreMountains.NiceTouch.CharacterMovement._verticalMovement
protected

◆ JumpForce

float MoreMountains.NiceTouch.CharacterMovement.JumpForce = 100f

the force applied when jumping

◆ MaximumSpeed

float MoreMountains.NiceTouch.CharacterMovement.MaximumSpeed = 20f

the character's maximum speed

◆ Speed

float MoreMountains.NiceTouch.CharacterMovement.Speed = 50f

The Speed of the character.


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