Extension Modules

These components extend OmniWalk beyond its locomotion core. Each is independently optional — add only what your game requires. All modules follow the same attach-and-configure pattern as UOmniWalkPro.

Trigger Zones

AOmniWalkTriggerZone overrides OmniWalk gravity for characters that enter a volume. Unlike AOmniWalkGravityVolume (which affects all OmniWalk characters in range), Trigger Zones support per-actor targeting, four gravity modes, and a priority system that resolves conflicts when multiple zones overlap.

Setup

Priority Resolution

When multiple zones overlap, UOmniWalkZonePrioritySubsystem selects the one with the highest Priority value. Tie-breaking is first-registered. A character exiting a high-priority zone automatically falls back to the next registered zone, then to the base AOmniWalkGravityVolume.

Properties

Delegates & API

// Respond to zone entry/exit
TriggerZone->OnActorEnterZone.AddDynamic(this, &AMyActor::HandleEnter);
TriggerZone->OnActorLeaveZone.AddDynamic(this, &AMyActor::HandleLeave);

// Toggle zone at runtime
TriggerZone->SetEnabled(false);

// Query gravity "up" for a world location (useful for preview/AI)
FVector GravUp = TriggerZone->ComputeGravityUpForLocation(MyPawn->GetActorLocation());

Spline Volume

AOmniWalkSplineVolume makes gravity follow the nearest point on a USplineComponent. Characters inside the influence box have gravity pulled toward (or away from) the spline axis, blending in at BlendRadius for smooth entry and exit.

Setup

Properties

// SplineLinked: a TriggerZone delegates to this volume
TriggerZone->GravityMode = EOmniWalkTriggerGravityMode::SplineLinked;
TriggerZone->LinkedSplineVolume = MySplineVolume;

// Query gravity direction at any world point (C++ / AI use)
FVector Up = MySplineVolume->GetGravityUpForLocation(WorldPos);

Zone Priority System

UOmniWalkZonePrioritySubsystem is an automatic game subsystem — no setup required. It maintains a runtime registry of all active AOmniWalkTriggerZone actors and resolves which zone applies to each character when overlaps conflict.

Physics Field

UOmniWalkPhysicsField makes nearby physics-simulating objects fall in the same direction as the character's current gravity. Add it alongside UOmniWalkPro on the character. Each tick, it finds objects within FieldRadius and applies AddForce in the character's "down" direction.

Setup

Add UOmniWalkPhysicsField to the same character Blueprint (or C++ class) that has UOmniWalkPro. No configuration beyond FieldRadius is required for basic use. The component self-caches UOmniWalkPro at BeginPlay.

Properties

API

UOmniWalkPhysicsField* Field = FindComponentByClass<UOmniWalkPhysicsField>();

// Disable field temporarily (e.g. during zero-g sequence)
Field->SetFieldEnabled(false);

// Resize at runtime (e.g. power-up expands field)
Field->SetFieldRadius(1200.0f);

// Enumerate currently affected actors
TArray<AActor*> Affected = Field->GetAffectedActors();

// Listen for objects entering/leaving the field
Field->OnObjectEnterField.AddDynamic(this, &AMyClass::OnObjectEntered);
Field->OnObjectLeaveField.AddDynamic(this, &AMyClass::OnObjectLeft);

Surface Response

The Surface Response system maps Unreal Physical Materials to OmniWalk behavior modifiers. It has two parts: a data asset (UOmniWalkSurfaceResponseTable) that defines presets, and a component (UOmniWalkSurfaceResponse) that samples the surface underfoot each tick and applies the matching preset.

Step 1 — Create the Data Asset

Built-in Presets (C++ only)

Five named presets are available as static factory methods to populate entries programmatically:

Step 2 — Add the Component

Add UOmniWalkSurfaceResponse alongside UOmniWalkPro on your character. Assign the data asset to ResponseTable. The component auto-binds to UOmniWalkPro's OnSurfaceAttached / OnSurfaceDetached events and resets multipliers automatically when off-surface.

// C++ constructor example
UOmniWalkSurfaceResponse* SR = CreateDefaultSubobject<UOmniWalkSurfaceResponse>(TEXT("SurfaceResponse"));
SR->ResponseTable = MyTableAsset;  // UOmniWalkSurfaceResponseTable*
SR->SampleInterval = 0.1f;        // Re-sample every 100 ms

FOmniWalkSurfaceEntry Fields

Footstep Routing

Bind OnSurfaceTypeChanged in Blueprint or C++ to drive footstep audio, VFX, or any per-surface logic:

// C++ bind
SurfaceResponse->OnSurfaceTypeChanged.AddDynamic(this, &AMyChar::OnSurfaceChanged);

void AMyChar::OnSurfaceChanged(FName SurfaceTag)
{
    if (SurfaceTag == "Ice")
    {
        // play ice footstep, spawn frost VFX
    }
    else if (SurfaceTag == NAME_None)
    {
        // off surface or unmatched material — reset to default
    }
}

UOmniWalkSurfaceResponse Properties

Cinematic Control

UOmniWalkCinematic is designed for cutscenes and scripted sequences. It can freeze UOmniWalkPro's surface detection — preventing unexpected gravity changes during a camera animation — and smoothly interpolate gravity to any target direction over a configurable duration.

Typical Usage

UOmniWalkCinematic* Cin = FindComponentByClass<UOmniWalkCinematic>();

// --- Cutscene begins ---
Cin->SetCinematicMode(true);

// Smoothly flip gravity over 2 seconds (ease-in-out)
Cin->SetCinematicGravityDirection(FVector(0, 0, -1), 2.0f);

// Listen for completion
Cin->OnGravityTransitionComplete.AddDynamic(this, &AMyClass::OnFlipDone);

// --- Cutscene ends (call when sequence finishes) ---
Cin->SetCinematicMode(false);

One-Shot Helper

Set bAutoExitCinematicOnTransitionEnd = true to have the component automatically call SetCinematicMode(false) once the gravity transition completes. Useful for a simple "flip and resume" pattern without manually tracking the cutscene state.

// Auto-exit after flip completes — no manual SetCinematicMode(false) needed
Cin->bAutoExitCinematicOnTransitionEnd = true;
Cin->SetCinematicGravityDirection(FVector(0, 1, 0), 1.5f);

Properties & API Reference

Patrol Path

AOmniWalkPatrolPath defines an ordered sequence of world-space waypoints using a USplineComponent. Each spline control point is a waypoint. Place this actor in the level, edit the spline, and assign it to UOmniWalkAIPatrol on your AI pawn.

Properties

Query API

// Number of control points / waypoints
int32 N = PatrolPath->GetPatrolPointCount();

// World location of waypoint i (applies WaypointHeightOffset)
FVector Loc = PatrolPath->GetPatrolPointLocation(i);

// World transform (includes spline orientation at that point)
FTransform T = PatrolPath->GetPatrolPointTransform(i);

// Next index given current index and direction (+1 / -1)
// bReversed is set true when PingPong mode flips the direction
bool bReversed;
int32 Next = PatrolPath->GetNextPointIndex(Current, 1, bReversed);
// Returns -1 in Once mode when the end is reached

// Find the waypoint closest to an actor's position
int32 Nearest = PatrolPath->GetNearestPointIndex(MyPawn->GetActorLocation());

AI Patrol

UOmniWalkAIPatrol drives an AI pawn along an AOmniWalkPatrolPath using the pawn's AAIController. It issues MoveToLocation requests for each waypoint in sequence, waits for the controller's path-following result, optionally idles at each stop via WaypointWaitTime, then advances to the next point.

Setup

Properties

Control API

UOmniWalkAIPatrol* Patrol = FindComponentByClass<UOmniWalkAIPatrol>();

// Start / resume patrol
Patrol->StartPatrol();

// Pause at current position (in-flight move finishes naturally)
Patrol->PausePatrol();
Patrol->ResumePatrol();

// Full stop (aborts in-flight move)
Patrol->StopPatrol();

// Hot-swap path at runtime
Patrol->SetPatrolPath(NewPathActor);

// Teleport logic: jump to a specific waypoint index
Patrol->JumpToWaypoint(3);

// State queries
bool bActive  = Patrol->IsPatrolling();
int32 Current = Patrol->GetCurrentWaypointIndex();

Events

// Fires each time a waypoint is reached
Patrol->OnReachedPatrolPoint.AddDynamic(this, &AMyClass::OnWaypointReached);

// Fires when a Once-mode path ends at the last point
Patrol->OnPatrolPathComplete.AddDynamic(this, &AMyClass::OnPatrolDone);

void AMyClass::OnWaypointReached(int32 PointIndex)
{
    // e.g. play an animation, trigger dialogue, update AI state
    UE_LOG(LogTemp, Log, TEXT("AI reached waypoint %d"), PointIndex);
}

Support & Legal

Troubleshooting Modules

About