AirJumpState Class

Summary

A PlatformerGameKit.Characters.States.HoldJumpState which allows the character to jump a limited number of times in the air.
Assembly
PlatformerGameKit.dll
Namespace
PlatformerGameKit.Characters.States
Interfaces
Base Types
graph BT Type-->Base0["HoldJumpState"] click Base0 "/platformer/api/PlatformerGameKit.Characters.States/HoldJumpState" Base0-->Base1["JumpState"] click Base1 "/platformer/api/PlatformerGameKit.Characters.States/JumpState" Base1-->Base2["CharacterState"] click Base2 "/platformer/api/PlatformerGameKit.Characters.States/CharacterState" Base2-->Base3["StateBehaviour"] Type-.->Interface0["IOwnedState<CharacterState>"] Type["AirJumpState"] class Type type-node

Syntax

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

Remarks

Documentation: Air 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
AirJumps int
Animation ClipTransition
Inherited from JumpState
CanEnterState bool
CanTurn bool
Inherited from CharacterState
Character Character
The Samples.PlatformerCharacter that owns this state.
Inherited from CharacterState
Height float
Inherited from JumpState
HoldAcceleration float
Inherited from HoldJumpState
Inertia float
Inherited from JumpState
MovementSpeedMultiplier float
Inherited from JumpState
OwnerStateMachine StateMachine<CharacterState>
Inherited from CharacterState

Methods

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