Movement Modes

Core, and modules

PartyCharacter is the motor. Walking, running, jumping, falling, gravity, facing and the ground sensors live in it, always run, and are not a module.

Most other ways of moving are components implementing IMovementModule (crouch is the one exception — see below). The character finds them with a plain GetComponents call, so the set of movement your game has is the set of components on the prefab — no registration, no priority table in the motor, no list to keep in sync.

// Enable swimming for a game:
player.AddComponent<SwimMode>();

// Disable it:
Destroy(player.GetComponent<SwimMode>());

// Neither of those touches PartyCharacter.

Each frame the motor hands control to the highest-priority module whose WantsControl is true. Core walk runs when none of them wants it. Crucially, a module owns its own detection: swim looks for water, slide looks at the slope. The motor does not centralise any of that, which is why adding a module cannot require editing it.

What a mode is

IMovementMode is the acting half — enter, tick, exit, and a say in what it will hand over to. It also declares two things about itself once, at its own definition, which is the pattern worth copying:

public interface IMovementMode
{
    LocomotionCategory Category { get; }
    int AnimatorModeId { get; }

    void Enter(PartyCharacter motor);
    void Tick(PartyCharacter motor, float fixedDeltaTime);
    void Exit(PartyCharacter motor);
    bool CanTransitionTo(IMovementMode next);
}

Animator ids

The motor writes each mode's AnimatorModeId to an integer animator parameter every frame, and the controller gives each locomotion state a transition conditioned on it. The bundled values:

Tuning: MovementConfig

One asset holds the numbers — Create → Party Core Kit → Movement Config— shared by the motor and every module, so a character's feel is one file you can duplicate per character type.

The shipped modules

Swim has a few settings of its own, since water needs describing:

Writing your own mode

1. Implement both halves on one component

   IMovementModule for selection — Priority, WantsControl, Mode — and IMovementMode for acting. Returning this from Mode is the shipped pattern.

2. Own your detection

   Put the "should I be running?" test inside WantsControl. Nothing else needs to know your mode exists.

3. Declare your category and animator id

   Pick the LocomotionCategory that describes your physics, and an unused AnimatorModeId. Add a matching state to your controller.

4. Add the component

   That is the installation step. There is no registration call.

Multiplayer