@rbxts/falldown - v1.0.0
    Preparing search index...

    Interface IActiveRagdoll

    Interface representing an active ragdoll instance. Users receive pre-constructed instances from Falldown.RagdollCharacter.

    interface IActiveRagdoll {
        Character: Model;
        Destroyed: Signal<void>;
        Ended: Signal<void>;
        Humanoid: Humanoid;
        AddRandomVelocity(maxVelocity: number): void;
        AddVelocity(velocity: Vector3, mode: 0 | 1 | 2 | 3): void;
        Destroy(): void;
    }
    Index

    Properties

    Character Destroyed Ended Humanoid

    Methods

    AddRandomVelocity AddVelocity Destroy

    Properties

    Character: Model

    The character Model that is currently ragdolled.

    Destroyed: Signal<void>

    Signal that fires when the ragdoll is destroyed. Fires after character removal, manual Destroy call, or automatic duration expiry.

    IActiveRagdoll.Destroy

    Ended: Signal<void>

    Signal that fires when the ragdoll's getup animation completes and the character is restored to normal control. Fires before Destroyed.

    IActiveRagdoll.Destroyed

    Humanoid: Humanoid

    The Humanoid instance of the ragdolled character.

    Methods

    • Applies random velocity to each body part independently in all directions. Each part receives random velocity with components in range [-maxVelocity, maxVelocity].

      Parameters

      • maxVelocity: number

        Maximum velocity magnitude for each axis (in studs/second)

      Returns void

      IActiveRagdoll.AddVelocity

    Settings

    Member Visibility

    On This Page

    Properties
    Methods