Add this component to a character and it'll be able to look up Animator parameters : LookingUp More...

Inheritance diagram for MoreMountains.CorgiEngine.CharacterLookUp:

Public Member Functions
override string	HelpBoxText ()
	This method is only used to display a helpbox text at the beginning of the ability's inspector. More...

override void	ProcessAbility ()
	Every frame, we check to see if we should exit the lookup state More...

override void	UpdateAnimator ()
	At the end of each cycle, we send our current LookingUp status to the animator More...

override void	ResetAbility ()
	On reset ability, we cancel all the changes made More...

Public Member Functions inherited from MoreMountains.CorgiEngine.CharacterAbility
virtual void	SetInputManager (InputManager inputManager)
	Sets a new input manager for this ability to get input from More...

virtual void	BindAnimator ()
	Binds the animator from the character and initializes the animator parameters More...

virtual void	ResetInput ()
	Resets all input for this ability. Can be overridden for ability specific directives More...

virtual void	EarlyProcessAbility ()
	The first of the 3 passes you can have in your ability. Think of it as EarlyUpdate() if it existed More...

virtual void	LateProcessAbility ()
	The last of the 3 passes you can have in your ability. Think of it as LateUpdate() More...

virtual void	PermitAbility (bool abilityPermitted)
	Changes the status of the ability's permission More...

virtual void	Flip ()
	Override this to specify what should happen in this ability when the character flips More...

virtual void	PlayAbilityStartFeedbacks ()
	Plays the ability start sound effect More...

virtual void	StopStartFeedbacks ()
	Stops the ability used sound effect More...

virtual void	PlayAbilityStopFeedbacks ()
	Plays the ability stop sound effect More...

virtual void	RegisterAnimatorParameter (string parameterName, AnimatorControllerParameterType parameterType, out int parameter)
	Registers a new animator parameter to the list More...

Public Attributes
float	HorizontalInputThreshold = 0.5f
	the threshold of horizontal input above which the character should stop looking up More...

bool	MoveCameraTarget = true
	whether or not the camera should move when looking up More...

Vector3	CameraTargetOffset = new Vector3(0f, 6f, 0f)
	the offset by which to move the camera when looking up More...

Public Attributes inherited from MoreMountains.CorgiEngine.CharacterAbility
MMFeedbacks	AbilityStartFeedbacks
	the feedbacks to play when the ability starts More...

MMFeedbacks	AbilityStopFeedbacks
	the feedbacks to play when the ability stops More...

bool	AbilityPermitted = true
	if true, this ability can perform as usual, if not, it'll be ignored. You can use this to unlock abilities over time for example More...

CharacterStates.MovementStates[]	BlockingMovementStates
	an array containing all the blocking movement states. If the Character is in one of these states and tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while Idle or Swimming, for example. More...

CharacterStates.CharacterConditions[]	BlockingConditionStates
	an array containing all the blocking condition states. If the Character is in one of these states and tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while dead, for example. More...

Weapon.WeaponStates[]	BlockingWeaponStates
	an array containing all the blocking weapon states. If one of the character's weapons is in one of these states and yet the character tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while attacking, for example. More...

Protected Member Functions
override void	HandleInput ()
	Every frame, we check the input to More...

virtual void	LookUp ()
	Sets the character in looking up state and asks the camera to look up More...

virtual void	ExitLookUp ()
	Checks to see if we should exit the LookUp state More...

override void	InitializeAnimatorParameters ()
	Adds required animator parameters to the animator parameters list if they exist More...

Protected Member Functions inherited from MoreMountains.CorgiEngine.CharacterAbility
virtual void	Start ()
	On Start(), we call the ability's intialization More...

virtual void	Initialization ()
	Gets and stores components for further use More...

virtual void	InternalHandleInput ()
	Internal method to check if an input manager is present or not More...

virtual void	OnRespawn ()
	Override this to describe what should happen to this ability when the character respawns More...

virtual void	OnDeath ()
	Override this to describe what should happen to this ability when the character respawns More...

virtual void	OnHit ()
	Override this to describe what should happen to this ability when the character takes a hit More...

virtual void	OnEnable ()
	On enable, we bind our respawn delegate More...

virtual void	OnDisable ()
	On disable, we unbind our respawn delegate More...

Protected Attributes
bool	_lookingUp = false

int	_lookingUpAnimationParameter

Protected Attributes inherited from MoreMountains.CorgiEngine.CharacterAbility
Character	_character

Transform	_characterTransform

Health	_health

CharacterHorizontalMovement	_characterHorizontalMovement

CorgiController	_controller

InputManager	_inputManager

CameraController	_sceneCamera

Animator	_animator

CharacterStates	_state

SpriteRenderer	_spriteRenderer

MMStateMachine< CharacterStates.MovementStates >	_movement

MMStateMachine< CharacterStates.CharacterConditions >	_condition

bool	_abilityInitialized = false

CharacterGravity	_characterGravity

float	_verticalInput

float	_horizontalInput

bool	_startFeedbackIsPlaying = false

List< CharacterHandleWeapon >	_handleWeaponList

Static Protected Attributes
const string	_lookingUpAnimationParameterName = "LookingUp"

Additional Inherited Members
Properties inherited from MoreMountains.CorgiEngine.CharacterAbility
virtual bool	AbilityAuthorized `[get]`

virtual bool	AbilityInitialized `[get]`
	true if the ability has already been initialized More...

Detailed Description

Add this component to a character and it'll be able to look up Animator parameters : LookingUp

Member Function Documentation

◆ ExitLookUp()

virtual void MoreMountains.CorgiEngine.CharacterLookUp.ExitLookUp ( )

protectedvirtual

Checks to see if we should exit the LookUp state

◆ HandleInput()

override void MoreMountains.CorgiEngine.CharacterLookUp.HandleInput ( )

protectedvirtual

Every frame, we check the input to

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ HelpBoxText()

override string MoreMountains.CorgiEngine.CharacterLookUp.HelpBoxText ( )

virtual

This method is only used to display a helpbox text at the beginning of the ability's inspector.

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ InitializeAnimatorParameters()

override void MoreMountains.CorgiEngine.CharacterLookUp.InitializeAnimatorParameters ( )

protectedvirtual

Adds required animator parameters to the animator parameters list if they exist

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ LookUp()

virtual void MoreMountains.CorgiEngine.CharacterLookUp.LookUp ( )

protectedvirtual

Sets the character in looking up state and asks the camera to look up

◆ ProcessAbility()

override void MoreMountains.CorgiEngine.CharacterLookUp.ProcessAbility ( )

virtual

Every frame, we check to see if we should exit the lookup state

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ ResetAbility()

override void MoreMountains.CorgiEngine.CharacterLookUp.ResetAbility ( )

virtual

On reset ability, we cancel all the changes made

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ UpdateAnimator()

override void MoreMountains.CorgiEngine.CharacterLookUp.UpdateAnimator ( )

virtual

At the end of each cycle, we send our current LookingUp status to the animator

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

Member Data Documentation

◆ _lookingUp

bool MoreMountains.CorgiEngine.CharacterLookUp._lookingUp = false

protected

◆ _lookingUpAnimationParameter

int MoreMountains.CorgiEngine.CharacterLookUp._lookingUpAnimationParameter

protected

◆ _lookingUpAnimationParameterName

const string MoreMountains.CorgiEngine.CharacterLookUp._lookingUpAnimationParameterName = "LookingUp"

staticprotected

◆ CameraTargetOffset

Vector3 MoreMountains.CorgiEngine.CharacterLookUp.CameraTargetOffset = new Vector3(0f, 6f, 0f)

the offset by which to move the camera when looking up

◆ HorizontalInputThreshold

float MoreMountains.CorgiEngine.CharacterLookUp.HorizontalInputThreshold = 0.5f

the threshold of horizontal input above which the character should stop looking up

◆ MoveCameraTarget

bool MoreMountains.CorgiEngine.CharacterLookUp.MoveCameraTarget = true

whether or not the camera should move when looking up

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

Assets/CorgiEngine/Common/Scripts/Agents/CharacterAbilities/CharacterLookUp.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ExitLookUp()

◆ HandleInput()

◆ HelpBoxText()

◆ InitializeAnimatorParameters()

◆ LookUp()

◆ ProcessAbility()

◆ ResetAbility()

◆ UpdateAnimator()

Member Data Documentation

◆ _lookingUp

◆ _lookingUpAnimationParameter

◆ _lookingUpAnimationParameterName

◆ CameraTargetOffset

◆ HorizontalInputThreshold

◆ MoveCameraTarget