Traversal
0 - Introduction
Traversal defines the means through which the player explores the game world, and includes the mechanics and tools that allow the player to move from one point to another.
0.1 - Disclaimer
The terminology used in this document (e.g. "Rock Climbing") functions as a conceptual descriptor of how the player's movement is affected by specific mechanics rather than literal items or objects.
0.2 - Design Philosophy
Due to the high verticality of the game's level design, multiple vertical traversal mechanics are required to ensure fluid and engaging player movement. The goal is to combine these systems seamlessly, allowing the player to chain various traversal actions dynamically without breaking gameplay flow.
0.3 - Terminology
| Term | Meaning |
|---|---|
| PC | Player Character |
1 - Traversal Mechanics
1.1 - Basic Traversal
| Mechanic | Overview |
|---|---|
| Walking | Standard for 3D games. Does not consume Stamina |
| Sprinting | Standard for 3D games Features editable delays for acceleration/deceleration Consumes Stamina over time |
| Jumping | True directional jumping Consumes Stamina PC remains steerable while airborne |
| Crouching | Standard crouch movement Reduces visibility and hitbox size Consumes stamina |
1.2 Vertical Traversal
| Mechanic | Overview |
|---|---|
| Grappling Hook | Allows the player to attach to specific objects and climb up or down The player can also swing to reach new surfaces Consumes Stamina while the interaction is active |
| Rock Climbing | Enabled when interacting with designated surfaces Upon activation the camera moves to 3rd person The player can move along the vertical plane defined by the surface's orientation If the player is touching the ground, no stamina is consumed While not touching the ground, stamina is continuously consumed If the player is actively moving, stamina is consumed faster If stamina reaches 0, player enters a Freefall state |
| Rope | Restricts the PC's movement to the vertical axis Stamina is consumed while the player is suspended or moving (LINK HERE!!!!!!!!!!!!!!!!!!) If stamina reaches 0, player enters a Freefall state |
| Water | Mitigates fall damage completely upon entry |
| Geyser | Launches the PC towards a vector defined per actor instance Alternatively, it can add a launch vector to the PC's existing momentum Both launching and landing consume stamina If the PC is launched without the needed stamina, they enter the Freefall state If the PC lands without the needed stamina, they get the Crippled status |
| Trampoline | Converts downwards momentum into upwards momentum Allows the player to build and maintain speed Each bounce consumes stamina |
Every mechanic that launches the PC by default puts them in the Controlled Fall state. For more info read the Player State Machine document
1.3 - Horizontal Traversal
| Mechanic | Overview |
|---|---|
| Rail Skating | The PC automatically snaps onto a predefined spline and follows it The player can jump off at any moment at the cost of stamina Splines can branch into multiple paths from which the player can choose using their standard movement input While skating, stamina neither regenerates nor depletes |
| Grappling Hook | Can be used to propel the player in a horizontal direction Allows traversal over gaps and hazards |
2 - Technical Documentation
2.1 - Walking Data
| Parameter | Type | Description |
|---|---|---|
| Walk Speed | The PC's base walking speed | |
| Acceleration | Time required to reach max walking speed | |
| Deceleration | Time required to come to a full stop | |
| Footstep Sound Cue | Defines the sound asset played when walking on a surface type | |
| Stamina Cost per Second | Defines the stamina loss in special situation |
2.2 - Sprinting Data
| Parameter | Type | Description |
|---|---|---|
| Sprint Speed Multiplier | Walk Speed multiplier applied while Sprinting | |
| Acceleration Delay | Time before reaching max sprint speed | |
| Deceleration Delay | Time before returning to normal speed when sprinting stops | |
| Stamina Cost per Second | Stamina drain while sprinting | |
| Minimum Stamina to Start Sprint | Minimum stamina amount required to initiate a sprint | |
| Camera FOV Change | Defines the FOV change while sprinting (visual feedback) |
2.3 Jumping Data
| Parameter | Type | Description |
|---|---|---|
| Jump Height | Determines the height of the PC's jump | |
| Air Control Multiplies | Defines how much directional control the player has mid-air | |
| Stamina Cost | Determines the stamina cost to perform a jump | |
| Coyote Time | Time window after walking off a ledge that the player can still jump | |
| Landing Recovery Time | Recovery time after landing before movement fully resumes |
2.4 Crouching Data
| Parameter | Type | Description |
|---|---|---|
| Crouch Speed | Movement speed while crouched | |
| Transition Speed | Time to transition between standing and crouching | |
| Collider Height | Capsule height while crouched | |
| Stamina Cost per Second | Stamina drain while crouched | |
| Visibility Modifier | Reduction to the detectibility of the player by enemy AI | |
| Noise Reduction Multiplies | Scalar applied to the sound produced while moving |
2.5 Grappling Hook
| Parameter | Type | Description |
|---|---|---|
| Hook Target | Defines the object that the grapple line is attached to | |
| Hook Range | Maximum distance the Grappling Hook can attach to | |
| Climb Speed | Speed at which the player ascends or descends along the rope | |
| Swing Speed Multiplier | Controls how much forward momentum the player gains while swinging | |
| Stamina Cost per Second | Defines how fast stamina drains |
2.6 Rock Climbing
| Parameter | Type | Description |
|---|---|---|
| Surface Bounds | Defines the climbable area's bounds | |
| Climb Speed | Defines the movement speed of the player along the surface | |
| Camera Offset | Camera offset relative to the player while climbing | |
| Stamina Cost | Stamina drain while attached to the surface | |
| Stamina Cost per Movement | Stamina drain while moving along the surface | |
| Fall Threshold Stamina | Minimum stamina required to prevent entering the Freefall state |
2.7 Rope
| Parameter | Type | Description |
|---|---|---|
| Rope Length | Defines the length of the climbable segment of rope | |
| Attach Point | World-space location of the rope anchor point | |
| Swing Speed | Optional parameter for when the rope allows for limited swinging | |
| Stamina Cost per Second | Stamina drain while handing or moving along the rope |
2.8 Geyser
| Parameter | Type | Description |
|---|---|---|
| Launch Vector | Defines the launch direction | |
| Launch Force | The magnitude of the launch vector | |
| AddToMomentum? | If true, adds to the player's existing velocity instead of setting it | |
| Min Stamina Required | Minimum stamina required to enter Controlled Fall instead of Freefall on launch | |
| Cooldown Time | Time before the Geyser can be activated again |
2.9 Trampoline
| Parameter | Type | Description |
|---|---|---|
| Bounce Multiplier | Controls how much vertical velocity is retained or increased after impact | |
| Max Chain Bounces | Defines how many consecutive bounces can be performed before losing momentum | |
| Stamina Cost per Bounce | Stamina drained on each bounce | |
| Min Stamina Required | Minimim stamina required to enter Controlled Fall instead of Freefall |
2.10 Rail Spline
| Parameter | Type | Description |
|---|---|---|
| Spline Path | Defines the spline asset used | |
| Base Speed | Default speed along spline | |
| Branch Nodes | [ Array ] | The array of branch paths the player can switch to |
| Allow Mid-Air Attach? | Defines if the PC can attach mid-jump |