Player Location Tracker

BeginnerDisplay

Displays your current world coordinates and region. Shows how to access and display location data.

8 min read

What It Does

Displays your current world coordinates and region. Shows how to access and display location data.

Source Code

java
1package com.example;
2
3import net.runelite.api.Client;
4import net.runelite.api.Player;
5import net.runelite.api.coords.WorldPoint;
6import net.runelite.client.ui.overlay.Overlay;
7import net.runelite.client.ui.overlay.OverlayManager;
8import net.runelite.client.ui.overlay.OverlayLayer;
9import net.runelite.client.ui.overlay.OverlayPosition;
10import net.runelite.client.plugins.Plugin;
11import net.runelite.client.plugins.PluginDescriptor;
12import javax.inject.Inject;
13import java.awt.*;
14
15@PluginDescriptor(
16    name = "Location Tracker",
17    description = "Shows your current location"
18)
19public class LocationTrackerPlugin extends Plugin {
20    @Inject
21    private Client client;
22
23    @Inject
24    private OverlayManager overlayManager;
25
26    private final Overlay overlay = new Overlay() {
27        @Override
28        public Dimension render(Graphics2D graphics) {
29            Player player = client.getLocalPlayer();
30            if (player == null) {
31                return null;
32            }
33
34            WorldPoint location = player.getWorldLocation();
35            graphics.setColor(Color.WHITE);
36            graphics.drawString("X: " + location.getX(), 10, 20);
37            graphics.drawString("Y: " + location.getY(), 10, 35);
38            graphics.drawString("Plane: " + location.getPlane(), 10, 50);
39
40            return new Dimension(150, 70);
41        }
42    };
43
44    {
45        overlay.setLayer(OverlayLayer.ABOVE_SCENE);
46        overlay.setPosition(OverlayPosition.TOP_LEFT);
47    }
48
49    @Override
50    protected void startUp() {
51        overlayManager.add(overlay);
52    }
53
54    @Override
55    protected void shutDown() {
56        overlayManager.remove(overlay);
57    }
58}

Code Annotations

Line 28

Get player's world location coordinates

Line 31

Display X coordinate

Line 32

Display Y coordinate

Line 33

Display plane (floor level)

API Classes Used

Key Concepts

  • Get player's world location coordinates
  • Display X coordinate
  • Display Y coordinate
  • Display plane (floor level)

Next Steps

  • Learn about WorldPoint API
  • Add region calculation
  • Add distance calculations