Summary

A PlatformerGameKit.Characters.States.JumpState which allows you to hold the button down to jump higher.

Assembly

PlatformerGameKit.dll

Namespace

PlatformerGameKit.Characters.States

Interfaces

IOwnedState<CharacterState>

Base Types

StateBehaviour
CharacterState
JumpState

Derived Types

graph BT Type-->Base0["JumpState"] click Base0 "/platformer/api/PlatformerGameKit.Characters.States/JumpState" Base0-->Base1["CharacterState"] click Base1 "/platformer/api/PlatformerGameKit.Characters.States/CharacterState" Base1-->Base2["StateBehaviour"] Type-.->Interface0["IOwnedState<CharacterState>"] Type["HoldJumpState"] class Type type-node Derived0["AirJumpState"]-->Type click Derived0 "/platformer/api/PlatformerGameKit.Characters.States/AirJumpState" Derived1["WallJumpState"]-->Type click Derived1 "/platformer/api/PlatformerGameKit.Characters.States/WallJumpState"

Syntax

[AddComponentMenu(MenuPrefix + "Hold Jump State")]
[PlatformerHelpUrl(typeof(HoldJumpState))]
public class HoldJumpState : JumpState, IOwnedState<CharacterState>

Remarks

Documentation: Hold Jump

Attributes

Type	Description
AddComponentMenu
PlatformerHelpUrlAttribute	[Assert-Conditional] A `UnityEngine.HelpURLAttribute` which points to Platformer Game Kit's documentation.

Fields

Name	Constant Value	Summary
MenuPrefix	Platformer Game Kit/Characters/States/	The menu prefix for `UnityEngine.AddComponentMenu`. Inherited from CharacterState static

Properties

Name	Value	Summary
Animation	ClipTransition	Inherited from JumpState
CanEnterState	bool	Inherited from JumpState
CanTurn	bool	Inherited from CharacterState
Character	Character	The `Samples.PlatformerCharacter` that owns this state. Inherited from CharacterState
Height	float	Inherited from JumpState
HoldAcceleration	float
Inertia	float	Inherited from JumpState
MovementSpeedMultiplier	float	Inherited from JumpState
OwnerStateMachine	StateMachine<CharacterState>	Inherited from CharacterState

Methods

Name	Value	Summary
Awake()	void	Inherited from JumpState
CalculateJumpSpeed(float)	float	Inherited from JumpState
CalculateJumpVelocity()	Vector2	Inherited from JumpState
CalculateJumpVelocity(float, float)	Vector2	Inherited from JumpState
FixedUpdate()	void
OnEnterState()	void	Inherited from JumpState
OnExitState()	void	Inherited from JumpState
OnValidate()	void
SetCharacter(Character)	void	Sets the `PlatformerGameKit.Characters.States.CharacterState.Character`. Inherited from CharacterState