Package net.runelite.api

Interface Projectile

  • All Superinterfaces:
    Node, Renderable
    public interface Projectile
extends Renderable
    Represents a projectile entity. (ie. cannonball, arrow)

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Animation getAnimation()
      The animation of the projectile
      int getAnimationFrame()
      The frame of the current animation
      int getEndCycle()
      Gets the game cycle that the projectile will reach its target at.
      int getEndHeight()
      Gets the ending height of the projectile.
      int getFloor()
      Gets the plane that the projectile is on.
      int getHeight()
      Gets the height of the projectile.
      int getId()
      Gets the ID of the projectile.
      Actor getInteracting()
      Gets the actor that is targeted by this projectile.
      int getRemainingCycles()
      Gets the remaining game cycles until the projectile reaches its target and despawns.
      double getScalar()
      Gets the scalar quantity (speed) at which the projectile is travelling.
      int getSlope()
      Gets the slope of the projectile.
      int getStartCycle()
      Gets the game cycle that the projectile begun movement at.
      int getStartHeight()
      Gets the starting height of the projectile.
      LocalPoint getTarget()
      Get the target point of the projectile.
      double getVelocityX()
      Gets the x-axis velocity of the projectile.
      double getVelocityY()
      Gets the y-axis velocity of the projectile.
      double getVelocityZ()
      Gets the z-axis velocity of the projectile.
      double getX()
      Gets the current x-axis coordinate of the projectile.
      int getX1()
      Gets the original x-axis coordinate that this projectile started from.
      double getY()
      Gets the current y-axis coordinate of the projectile.
      int getY1()
      Gets the original y-axis coordinate that this projectile started from.
      double getZ()
      Gets the current z-axis coordinate of the projectile.
      void setEndCycle​(int cycle)
      Sets the game cycle the projectile will reach its target at.

    • Method Detail

      • getId

        int getId()
        Gets the ID of the projectile.
        Returns:
        the projectile ID
        See Also:
        GraphicID

      • getInteracting

        Actor getInteracting()
        Gets the actor that is targeted by this projectile.
        Returns:
        the target actor, or null if this projectile is an AoE attack

      • getTarget

        LocalPoint getTarget()
        Get the target point of the projectile. For projectiles with an actor target, this is updated each frame to the actor position.
        Returns:

      • getX1

        int getX1()
        Gets the original x-axis coordinate that this projectile started from.
        Returns:
        the original coordinate

      • getY1

        int getY1()
        Gets the original y-axis coordinate that this projectile started from.
        Returns:
        the original coordinate

      • getFloor

        int getFloor()
        Gets the plane that the projectile is on.
        Returns:
        the plane

      • getHeight

        int getHeight()
        Gets the height of the projectile.
        Returns:
        the height

      • getEndHeight

        int getEndHeight()
        Gets the ending height of the projectile.
        Returns:
        the ending height

      • getStartCycle

        int getStartCycle()
        Gets the game cycle that the projectile begun movement at.
        Returns:
        the start game cycle

      • getEndCycle

        int getEndCycle()
        Gets the game cycle that the projectile will reach its target at.
        Returns:
        the end game cycle

      • setEndCycle

        void setEndCycle​(int cycle)
        Sets the game cycle the projectile will reach its target at. The projectile automatically despawns after this time, and setting the end cycle to a time in the past is an effective way of removing the projectile.
        Parameters:
        cycle -

      • getRemainingCycles

        int getRemainingCycles()
        Gets the remaining game cycles until the projectile reaches its target and despawns.
        Returns:
        the remaining game cycles

      • getSlope

        int getSlope()
        Gets the slope of the projectile.

        This value indicates how much arc the projectile can have. Projectiles with larger slopes have a more noticeable arc when thrown.

        Returns:
        the slope of the projectile

      • getStartHeight

        int getStartHeight()
        Gets the starting height of the projectile.
        Returns:
        the starting height

      • getX

        double getX()
        Gets the current x-axis coordinate of the projectile.
        Returns:
        the x-axis coordinate

      • getY

        double getY()
        Gets the current y-axis coordinate of the projectile.
        Returns:
        the y-axis coordinate

      • getZ

        double getZ()
        Gets the current z-axis coordinate of the projectile.
        Returns:
        the z-axis coordinate

      • getScalar

        double getScalar()
        Gets the scalar quantity (speed) at which the projectile is travelling.
        Returns:
        the scalar quantity

      • getVelocityX

        double getVelocityX()
        Gets the x-axis velocity of the projectile.
        Returns:
        the x-axis velocity

      • getVelocityY

        double getVelocityY()
        Gets the y-axis velocity of the projectile.
        Returns:
        the y-axis velocity

      • getVelocityZ

        double getVelocityZ()
        Gets the z-axis velocity of the projectile.
        Returns:
        the z-axis velocity

      • getAnimation

        @Nullable
Animation getAnimation()
        The animation of the projectile
        Returns:

      • getAnimationFrame

        int getAnimationFrame()
        The frame of the current animation
        Returns: