Package net.runelite.api

Interface World

  • public interface World
    Holds data of a RuneScape world.

    • Method Detail

      • getTypes

        EnumSet<WorldType> getTypes()
        Gets all applicable world types for this world.
        Returns:
        the world types

      • setTypes

        void setTypes​(EnumSet<WorldType> types)
        Sets world types.
        Parameters:
        types - the types

      • getPlayerCount

        int getPlayerCount()
        Gets the current number of players logged in the world.
        Returns:
        the player count

      • setPlayerCount

        void setPlayerCount​(int playerCount)
        Sets the player count of the world.
        Parameters:
        playerCount - the new player count

      • getLocation

        int getLocation()
        Gets the world location value.
        Returns:
        the world location

      • setLocation

        void setLocation​(int location)
        Sets the world location value.
        Parameters:
        location - the location

      • getIndex

        int getIndex()
        Gets the worlds index.
        Returns:
        the index

      • setIndex

        void setIndex​(int index)
        Sets the worlds index.
        Parameters:
        index - the index

      • getId

        int getId()
        Gets the world number.
        Returns:
        the world number

      • setId

        void setId​(int id)
        Sets the world number.
        Parameters:
        id - the world number

      • getActivity

        String getActivity()
        Gets the world activity description.

        For example, world 2 would return "Trade - Members".

        Returns:
        the world activity

      • setActivity

        void setActivity​(String activity)
        Sets the world activity description.
        Parameters:
        activity - the activity

      • getAddress

        String getAddress()
        Gets the address of the world.
        Returns:
        the world address

      • setAddress

        void setAddress​(String address)
        Sets the address of the world.
        Parameters:
        address - the address