> For the complete documentation index, see [llms.txt](https://malbersanimations.gitbook.io/animal-controller/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://malbersanimations.gitbook.io/animal-controller/main-components/path-constraint/mpath.md).
# MPath
## Overview
The `MPath` component is the bridge between any Path/Spline solution and the Path Constraint. It reads the values it needs from the spline and exposes them so a character wearing a Path Constraint can be aligned to and moved along it.
## How it Works
Every `Path Constraint` in the scene polls all active `MPath` components on its own **Search Interval** and runs a two-phase proximity check: a cheap bounding-box rejection first, then an exact nearest-point-on-spline test. When both the character's `Radius` and this path's `Search Radius` search spheres intersect — and `Automatic` is enabled — the character is constrained to the path.
{% hint style="info" %}
**No Collider required.** Path detection used to rely on a trigger Collider on the path (Box Collider recommended) with a Layer filter. It is now fully code-driven and polled from the character side — if you're migrating an older project you can safely remove the Box Collider, Path Bounds and Layer setup, they no longer do anything.
{% endhint %}
{% embed url="" %}
## Requirements
* Any type of `IPath` component — [Path Link (Unity Spline)](/animal-controller/main-components/path-constraint/path-link-unity-spline.md) (default) or [Path Link (Straight)](/animal-controller/main-components/path-constraint/path-link-straight.md) for a simple two-point line
{% hint style="info" %}
The Cinemachine Path and Path Creator (Sebastian Lague) integrations have been removed. **Path Link (Unity Spline)**, built on Unity's native Splines package, is now the default. If an older project used either of the removed integrations, switch it to Path Link (Unity Spline).
{% endhint %}
## Parameters
### Path
#### IPath
Type of path solution to use — [Path Link (Unity Spline)](/animal-controller/main-components/path-constraint/path-link-unity-spline.md) (default, uses Unity's built-in Spline system) or [Path Link (Straight)](/animal-controller/main-components/path-constraint/path-link-straight.md) for a simple two-point line. Add your solution component to the same GameObject, then hit the refresh button.
#### Automatic
The character is constrained to the path automatically as soon as both search spheres intersect.
Some paths are set to not be Automatic. To activate those, go to the character's Path Constraint component, add an Input connection, and use the method **`TryEnterExitPath()`**. This also works for exiting a path in the middle of it.
#### Auto Change Path
Lets the character switch directly from one path onto this one automatically while already constrained to another path. This path also needs `Automatic` enabled.
#### Lock Rotation
The character cannot rotate or change direction while on the path (it can still walk backward).
#### Follow Direction (Lock Rotation = True)
When Lock Rotation is true you can set the Follow Direction, which automatically rotates the character to match the correct orientation while on the path.
* **None**: the character keeps the starting orientation it had when entering, whether it entered from the start or the end of the spline.
| Entering from End | Entering from Start |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|  |  |
* **Forward**: the character is oriented to the forward path direction (start to end), regardless of which end it entered from.
| Entering from End | Entering from Start |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|  |  |
* **Backward**: the character is oriented to the backward path direction (end to start), regardless of which end it entered from.
| Entering from End | Entering from Start |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|  |  |
#### Use Path Rotation
The character also follows the path's own rotation values (banking, pitch, and similar orientation baked into the spline), not just its position.
#### Orient Smoothness
Per-path multiplier for how fast the character orients to this specific path (multiplies the Path Constraint's own **Orient Smoothness**). Use it to make some paths (e.g. tight rails) snap the character into orientation faster than others.
#### Alignment Offset
Local offset applied to the character's position while it's constrained to this path.
#### Path Position
Optional Transform that is kept updated to the character's current position and rotation on the path — use it to have another GameObject follow along the ride.
#### Can Exit on Start
The character can exit automatically when it reaches the start of the spline.
#### Can Exit on End
The character can exit automatically when it reaches the end of the spline.
#### Can Exit on Middle
The character can exit if something interrupts the path mid-way (e.g. jumping off in the middle of the spline).
#### No Exit Path Reactions
If this path is entered while the character is already on another path, skip that old path's Exit reactions (**Exit Reaction**, **Exit From Start/End/Middle**). Useful for seamless path-to-path transitions where you don't want the "leaving" reaction to play.
#### Path Cooldown
Once the character enters this path, this much time must elapse before it can exit and re-enter it again. Prevents flicker from entering and exiting on the same frame.
#### Search Radius
Radius of this path's own search sphere. When it intersects the character's `Radius`, the character can enter.
#### Search Offset
Offset of the search sphere relative to the path's position.
{% hint style="info" %}
Looking for the search **interval**? It now lives on the character's Path Constraint component, since the search is polled by the character, not the path.
{% endhint %}
### Animal
#### Activate State
State to activate when the character enters this path.
#### Ignore Vertical
While active, the animal cannot move on the Y-axis while on the path. Disable this if you want the character to be able to jump while on the path.
\[Insert Image - Ignore Vertical enabled vs disabled]
#### Ignore Grounded
Use when there's no terrain/ground beneath the path (e.g. a rope bridge or zip line over a chasm) so the animal doesn't fight grounding checks.
\[Insert Image - Ignore Grounded on an elevated path]
#### Disable States
States disabled on the character while it's on the path. E.g. disable the Jump State while riding a rail.
\[Insert Image - Disable States list on a path]
#### Ignore States
States that force an early exit from the path. E.g. Jump can force exiting the path if the Jump State is on this list.
\[Insert Image - Ignore States list on a path]
#### Exit Any Mode
If enabled, playing any Mode exits the path.
#### Ignore Modes
Modes that force an early exit from the path. E.g. Damage can force exiting the path if the Damage Mode is on this list.
\[Insert Image - Ignore Modes list on a path]
### Reactions
Reactions are played on the character (`Reaction2`, through the `MAnimal`) as it enters and exits the path.
#### Enter Reaction
Always plays when the character enters the path, in addition to the matching Enter From Start/End/Middle reaction below.
#### Exit Reaction
Always plays when the character exits the path, in addition to the matching Exit From Start/End/Middle reaction below — unless the path being entered next has `No Exit Path Reactions` enabled.
#### Enter From Start / Enter From End / Enter From Middle
Plays depending on where along the spline the character entered from.
#### Exit From Start / Exit From End / Exit From Middle
Plays depending on where along the spline the character was when it exited.
### Events
#### Can Enter Path
Raised per-character when `Automatic` is disabled and that character is close enough to enter manually — call `TryEnterExitPath()` on its Path Constraint while this is `true` to enter. Lowers back to `false` once the character enters or walks away.
#### On Enter Path / On Exit Path
Invoked when a character enters/exits this path. Passes the character's `Path Constraint` component.
#### Is On Start Of Path / Is On End Of Path
Raised `true` once the character gets within tolerance of the path's start/end (before it actually exits), and back to `false` once it moves away from that end again. Useful to trigger slow-down or warning behavior near the ends of a path.
