Class HintArrow

This section is for hintArrows, arrows that are on the minimap and in the world that help draw attention to specific characters and areas. Everyone has played a game where there is a huge “?” above a character's head.
That question mark is really a hintArrow letting you know to talk to that specific character. Let's go over how you can create your own hint arrows for your plugin.

There are two different types of hintArrows you can make: a character hintArrow or a location hintArrow. A character hint arrow will appear on top of a player’s or npc’s head and follow them around, whereas a location hint arrow will appear at a specific location or coordinates in the game world. When you create a hintArrow, you can choose which type it will be with the hintArrow properties.

You also have the ability to customize what you want your hintArrows to look like. A hintArrow is able to look like any sprite (image) that is currently in the game, and it can also be customized using its function properties.

Once a hintArrow is created and drawn into the world there are a multitude of methods you can use on it. You can make the hintArrow blink on and off screen at different rates (setFlashRate), change its position (setTargetCoord), change the character it is following (setTargetNpc), change how it looks (setNewSprite), and much more. Have fun playing around with hintArrows, and have your plugin lead players to all kinds of fun locations or funny NPC’s.

Hint Arrows can be used for placing directional arrows on the minimap and in the world to draw attention to certain areas. Eventually placing them on the world map will be supported.

-- This example will add a Hint Arrow to every goblin around you using the inventory bag sprite.
local goblins = osrs.ClientOp.getNpcIdByNameAll("Goblin")
local hintArrows = {}

for i = 1, #goblins do
	hintArrows[i] = osrs.HintArrow.new({ 
	npc = goblins[i],
	drawOnMinimap = false,
	sprite = 123
	})
end

-- When you wanted to clear all the arrows from both the client and Lua state you can do this.
for i = 1, #hintArrows do
  --Removes the reference to the arrow from the client.
	hintArrows[i]:clear()
	--Removes the reference to the arrow from the Lua state.
	hintArrows[i] = nil
end
Copy

Passing an empty table will result in an inactive arrow object which can still be manipulated later. Arrows are intended to point at a single target so only pass a table with either coord, player, or npc, not all of them.

However if you do pass a table with more than one the order the "Arrow Mode" is set is coord -> player -> npc, so top priority is always NPC. Below is the full table you could pass into the .new function.

fullTable = 
{
 coord = osrs.MapCoord.new(0, 0, 0),
 player = 0,
 npc = 0,
 sprite = 0,
 fineCoords = { x = 64, z = 64},
 drawOnMininmap = true,
 drawOnWorldMap = true,
 drawInWorld = true,
}

local hintArrow = osrs.HintArrow.new(fullTable)
Copy