Video Demo

👟 UE5 Parkour System 👟

A parkour system where you can vault over and climb surfaces. Written in C++ and rendered in Unreal Engine 5.

Source Code · Report Bug

How to Play

WASD to move
Space to jump
F to vault over or climb surfaces

Thought Process

Check if surface is climbable

Use capsule trace
We may get multiple hit results

Check if we have reached a ledge after climbing

Use line trace from eye height

Manage climbing state

attemptClimbing (on key press)
canStartClimbing
isClimbing

Physics for climbing
1. Process climbable surfaces
  1. (Average) location
  2. (Average) normal (for making sure the character is always parallel to the surface when climbing a straight wall)
2. Handle climb movement
  1. Velocity
  2. Rotation
  3. Snapping character to the surface
```
 |     P
 |    /
 |   /  
 |  /  
 | /   ________Projected OP (onto ComponentForward)
 O←______Surface Normal
 →______SnapVector
 |______________ ComponentForward
```
  O: character's location
  
  P: climbable surface location (exaggerated for visualization, it's actually directly to the right of O)
  
  Projected OP: distance from the character to the climbable surface, but only in the direction the character is currently facing or moving towards
  
  SnapVector: length of the projection in the opposite direction of the surface normal
Handle up down left right movement when character is climbing and no longer on the ground
1. Get necessary vectors using cross product w LHR
Stop climbing at ledge
1. Get necessary vectors using dot product
```
 A     B
 |    / 
 |   /  
 |  /  
 | /
 O
```
OA: surface normal of flat ground

OB: surface normal of ledge

When angle between these two vectors is smaller than some angle, we need to stop climbing

a ⋅ b = ∣a∣ × ∣b∣ × cos(θ)

When a and b are unit vectors, a.b = cos(θ)

θ = cos−1 (a⋅b)
Check if floor reached (to exit climbing more naturally)
1. Check if line trace downwards from character hit anything, and
2. Character's speed must be in the downwards direction
Check if ledge reached (to begin climb up animation)
1. Check if line trace starting from above the character, into the wall, hit anything
2. If it didn't, it means there is open air so we have reached a ledge, and from that trace end, check if line trace directly downwards hit anything
Check can climb down from ledge
1. Check if line trace starting from slightly in front of character, to directly downwards hit anything
2. If it did, it means character is standing on a walkable surface, and from slightly forward of that trace end, check if line trace directly downwards hit anything
Check can vault
1. Draw 5 line traces in front of the character, each one longer than the previous one
2. Player | | | | | | | | | | | | | | | | |
3. We need 2 hits - first one for when the character places his hand on the surface and pushes off, and the second for when he lands
Hopping by pressing down directional key and jump key at the same time
1. We first need to swap out the current logic for handling climb and ground movement - right now when the directional input keys are pressed, we manually check isClimbing and then set the corresponding movement state
2. Let's use a delegate instead - when character is climbing, CustomMovementComponent should notify Character via the delegate and add the corresponding input mapping context
3. We will use this ClimbMappingContext when detecting when a directional key and jump key is pressed at the same time
4. Use dot product to figure out if player is trying to hop up/down/left/right - dot product of two parallel vectors is 1
5. Check if can hop up
  1. Line trace from character's chest forwards into the wall
  2. From that trace hit, check if line trace directly upwards hit anything
  3. If it did, there is still wall for us to hop up to

Social Media

🥂Rachel 🔗 LinkedIn 📧 Email

peilunnn/UE5ParkourSystem

Video Demo

👟 UE5 Parkour System 👟

How to Play

Thought Process

Social Media