WallJumpState Class

Summary

A PlatformerGameKit.Characters.States.HoldJumpState which allows the character to jump off walls.
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["WallJumpState"] class Type type-node

Syntax

[AddComponentMenu(MenuPrefix + "Wall Jump State")]
[HelpURL(APIDocumentation + nameof(WallJumpState))]
public class WallJumpState : HoldJumpState, IOwnedState<CharacterState>

Remarks

Documentation: Wall Jump

Attributes

Type Description
AddComponentMenu
HelpURLAttribute

Fields

Name Constant Value Summary
APIDocumentation https://kybernetik.com.au/platformer/api/PlatformerGameKit.Characters.States/
The URL of the website where the PlatformerGameKit.Characters.States API documentation is hosted.
Inherited from CharacterState
static
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
CanExitState bool
Prevents PlatformerGameKit.Characters.States.LandState from being triggered by setting the PlatformerGameKit.Characters.CharacterBody2D.IsGrounded because at that point the PlatformerGameKit.Characters.States.JumpState.Animation hasn't started playing yet.
CanTurn bool
Inherited from CharacterState
Character Character
The Examples.PlatformerCharacter that owns this state.
Inherited from CharacterState
DetectionDistance float
Height float
Inherited from JumpState
HoldAcceleration float
Inherited from HoldJumpState
HorizontalMultiplier 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
CalculateJumpVelocity(float, float) Vector2
Inherited from JumpState
FixedUpdate() void
Inherited from HoldJumpState
OnEnterState() void
Sets the PlatformerGameKit.Characters.CharacterBody2D.IsGrounded to be true momentarily so that PlatformerGameKit.Characters.States.AirJumpState resets its jump counter.
OnExitState() void
Inherited from JumpState
OnValidate() void
SetCharacter(Character) void
Sets the PlatformerGameKit.Characters.States.CharacterState.Character.
Inherited from CharacterState