arrow

Shows or clears the quest arrow at the edge of a player's screen, which points to a spot of the map.

Source: src/Moongate.Server.Ultima/Modules/ArrowModule.cs

Functions

clear

arrow.clear(player) -> boolean

Takes the quest arrow away from the player's screen. True when the client was told, also when it showed no arrow; the client is given the target the arrow was shown with. False for an NPC or a player that is not in the world.

Takes the arrow away, as the Tracking skill does every time it is used:

function tracking.on_use(user)
    arrow.clear(user)
end

Parameter	Type	Default
player	integer

Returns boolean.

show

arrow.show(player, x, y, target?) -> boolean

Shows the quest arrow at the edge of the player's screen, pointing to x, y of the map it is on, in place of the one it had (the old one is taken away first when the target differs). The optional target is the serial of the mobile the arrow points to, which a client from 7.0.9.0 is told. The client moves the arrow as the player walks; it stays until arrow.clear or another arrow.show, and the server does not follow the target. True when the client was told; false for an NPC, a player that is not in the world, or x or y that is not a whole number from 0 to 65535.

A guide that points the quest arrow to the bank of Britain when asked; the arrow stays until arrow.clear or another arrow.show, and a client from 7.0.9.0 is told which mobile it points to when the optional serial is given:

function guide.on_speech(serial, speaker, text)
    if text:lower():find("bank", 1, true) then
        npc.say(serial, "Follow the arrow.")
        arrow.show(speaker, 1434, 1699)
    end
end

Parameter	Type	Default
player	integer
x	number
y	number
target (optional)	integer	0

Returns boolean.