PokéRogue
    Preparing search index...

    Provides methods for enabling, disabling, and refreshing the Arcade Physics Body belonging to a Game Object. This component is mixed into Game Objects that use Arcade Physics, giving them the ability to control whether their physics body is active in the simulation and participates in collision and overlap detection.

    interface Enable {
        disableBody(disableGameObject?: boolean, hideGameObject?: boolean): this;
        enableBody(
            reset?: boolean,
            x?: number,
            y?: number,
            enableGameObject?: boolean,
            showGameObject?: boolean,
        ): this;
        refreshBody(): this;
        setDirectControl(value?: boolean): this;
    }

    Implemented by

    Index
    • Stops and disables this Game Object's Arcade Physics Body. The body's velocity is set to zero and it is removed from collision and overlap detection within the physics simulation. Optionally sets the Game Object's active and visible properties to false at the same time, which is useful when deactivating pooled Game Objects.

      Parameters

      • OptionaldisableGameObject: boolean

        Also set this Game Object's active to false. Default false.

      • OptionalhideGameObject: boolean

        Also set this Game Object's visible to false. Default false.

      Returns this

      This Game Object.

    • Enables this Game Object's Arcade Physics Body, allowing it to participate in collision and overlap detection within the physics simulation. Optionally resets the Body and repositions the Game Object at the given coordinates. If you reset the Body you must also pass x and y. You can also optionally set the Game Object's active and visible properties at the same time.

      Parameters

      • Optionalreset: boolean

        Also reset the Body and place the Game Object at (x, y).

      • Optionalx: number

        The horizontal position to place the Game Object, if reset is true.

      • Optionaly: number

        The vertical position to place the Game Object, if reset is true.

      • OptionalenableGameObject: boolean

        Also set this Game Object's active to true.

      • OptionalshowGameObject: boolean

        Also set this Game Object's visible to true.

      Returns this

      This Game Object.

    • Syncs the Body's position and size with its parent Game Object. You don't need to call this for Dynamic Bodies, as it happens automatically. But for Static bodies it's a useful way of modifying the position of a Static Body in the Physics World, based on its Game Object.undefined

      Returns this

      This Game Object.

    • Sets whether this Body should calculate its velocity based on its change in position every frame. The default, which is to not do this, means that you make this Body move by setting the velocity directly. However, if you are trying to move this Body via a Tween, or have it follow a Path, then you should enable this instead. This will allow it to still collide with other bodies, something that isn't possible if you're just changing its position directly.

      Parameters

      • Optionalvalue: boolean

        true if the Body calculates velocity based on changes in position, otherwise false. Default true.

      Returns this

      This Game Object.