Add this component to a character and it'll be able to interact with button activated zones and objects Animator parameters : Activating (bool) More...

Inheritance diagram for MoreMountains.CorgiEngine.CharacterButtonActivation:

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	UpdateAnimator ()
	At the end of the ability's cycle, we send our current crouching and crawling states to the animator More...

virtual void	SetTriggerParameter ()

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	ProcessAbility ()
	The second of the 3 passes you can have in your ability. Think of it as Update() 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	ResetAbility ()
	Override this to reset this ability's parameters. It'll be automatically called when the character gets killed, in anticipation for its respawn. 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
bool	PreventJumpWhenInZone = true
	whether or not this character can jump when in a button activated zone More...

float	ActivationCooldownDuration = 0f
	the duration, in seconds, after an activation, during which no new activation can happen 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	Initialization ()
	Gets and stores components for further use More...

override void	HandleInput ()
	Every frame, we check the input to see if we need to pause/unpause the game More...

virtual void	ButtonActivation ()
	Tries to activate the button activated zone More...

override void	OnDeath ()
	On Death we lose any connection we may have had to a button activated zone 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	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	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	_activating = false

float	_lastActivatedAt = -10f

int	_activatingAnimationParameter

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	_activatingAnimationParameterName = "Activating"

Properties
bool	InButtonActivatedZone `[get, set]`
	true if the character is in a dialogue zone More...

bool	InButtonAutoActivatedZone `[get, set]`
	true if the zone is automated More...

bool	InJumpPreventingZone `[get, set]`
	true if the zone prevents jump More...

ButtonActivated	ButtonActivatedZone `[get, set]`
	the current button activated zone More...

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 interact with button activated zones and objects Animator parameters : Activating (bool)

Member Function Documentation

◆ ButtonActivation()

virtual void MoreMountains.CorgiEngine.CharacterButtonActivation.ButtonActivation ( )

protectedvirtual

Tries to activate the button activated zone

◆ HandleInput()

override void MoreMountains.CorgiEngine.CharacterButtonActivation.HandleInput ( )

protectedvirtual

Every frame, we check the input to see if we need to pause/unpause the game

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ HelpBoxText()

override string MoreMountains.CorgiEngine.CharacterButtonActivation.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.

◆ Initialization()

override void MoreMountains.CorgiEngine.CharacterButtonActivation.Initialization ( )

protectedvirtual

Gets and stores components for further use

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ InitializeAnimatorParameters()

override void MoreMountains.CorgiEngine.CharacterButtonActivation.InitializeAnimatorParameters ( )

protectedvirtual

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

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ OnDeath()

override void MoreMountains.CorgiEngine.CharacterButtonActivation.OnDeath ( )

protectedvirtual

On Death we lose any connection we may have had to a button activated zone

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

◆ SetTriggerParameter()

virtual void MoreMountains.CorgiEngine.CharacterButtonActivation.SetTriggerParameter ( )

virtual

◆ UpdateAnimator()

override void MoreMountains.CorgiEngine.CharacterButtonActivation.UpdateAnimator ( )

virtual

At the end of the ability's cycle, we send our current crouching and crawling states to the animator

Reimplemented from MoreMountains.CorgiEngine.CharacterAbility.

Member Data Documentation

◆ _activating

bool MoreMountains.CorgiEngine.CharacterButtonActivation._activating = false

protected

◆ _activatingAnimationParameter

int MoreMountains.CorgiEngine.CharacterButtonActivation._activatingAnimationParameter

protected

◆ _activatingAnimationParameterName

const string MoreMountains.CorgiEngine.CharacterButtonActivation._activatingAnimationParameterName = "Activating"

staticprotected

◆ _lastActivatedAt

float MoreMountains.CorgiEngine.CharacterButtonActivation._lastActivatedAt = -10f

protected

◆ ActivationCooldownDuration

float MoreMountains.CorgiEngine.CharacterButtonActivation.ActivationCooldownDuration = 0f

the duration, in seconds, after an activation, during which no new activation can happen

◆ PreventJumpWhenInZone

bool MoreMountains.CorgiEngine.CharacterButtonActivation.PreventJumpWhenInZone = true

whether or not this character can jump when in a button activated zone

Property Documentation

◆ ButtonActivatedZone

ButtonActivated MoreMountains.CorgiEngine.CharacterButtonActivation.ButtonActivatedZone

getset

the current button activated zone

◆ InButtonActivatedZone

bool MoreMountains.CorgiEngine.CharacterButtonActivation.InButtonActivatedZone

getset

true if the character is in a dialogue zone

◆ InButtonAutoActivatedZone

bool MoreMountains.CorgiEngine.CharacterButtonActivation.InButtonAutoActivatedZone

getset

true if the zone is automated

◆ InJumpPreventingZone

bool MoreMountains.CorgiEngine.CharacterButtonActivation.InJumpPreventingZone

getset

true if the zone prevents jump

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ ButtonActivation()

◆ HandleInput()

◆ HelpBoxText()

◆ Initialization()

◆ InitializeAnimatorParameters()

◆ OnDeath()

◆ SetTriggerParameter()

◆ UpdateAnimator()

Member Data Documentation

◆ _activating

◆ _activatingAnimationParameter

◆ _activatingAnimationParameterName

◆ _lastActivatedAt

◆ ActivationCooldownDuration

◆ PreventJumpWhenInZone

Property Documentation

◆ ButtonActivatedZone

◆ InButtonActivatedZone

◆ InButtonAutoActivatedZone

◆ InJumpPreventingZone