Summary

A PlatformerGameKit.Characters.States.CharacterState that plays a jump animation and applies some upwards force.

Assembly

PlatformerGameKit.dll

Namespace

PlatformerGameKit.Characters.States

Interfaces

IOwnedState<CharacterState>

Base Types

StateBehaviour
CharacterState

Derived Types

HoldJumpState

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

Syntax

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

Remarks

Documentation: 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
CanEnterState	bool
CanTurn	bool	Inherited from CharacterState
Character	Character	The `Samples.PlatformerCharacter` that owns this state. Inherited from CharacterState
Height	float
Inertia	float
MovementSpeedMultiplier	float
OwnerStateMachine	StateMachine<CharacterState>	Inherited from CharacterState

Methods

Name	Value	Summary
Awake()	void
CalculateJumpSpeed(float)	float
CalculateJumpVelocity()	Vector2
CalculateJumpVelocity(float, float)	Vector2
OnEnterState()	void
OnExitState()	void
OnValidate()	void	[Editor-Only] Ensures that all fields have valid values and finds missing components nearby.
SetCharacter(Character)	void	Sets the `PlatformerGameKit.Characters.States.CharacterState.Character`. Inherited from CharacterState