SetWorldCursor

ISettlers4Api::SetWorldCursor method

Set or move the world cursor to a specified position on the map.

Use ISettlers4Api::DeleteWorldCursor to remove the cursor.

Syntax

BOOL ISettlers4Api::SetWorldCursor(
	INT x,
    INT y
);

Parameters

x

The new x coordinate on the map for the world cursor.

y

The new y coordinate on the map for the world cursor.

Return value

If this method could execute successfully it will return TRUE. If an error occurred it will return FALSE.

Remarks

Only one world cursor can be visible at a time. Use ISettlers4Api::AddEffect with S4_EFFECT_TUTORIAL_ARROW to spawn more.

It is not yet known whether the world cursor can desync multiplayer games.

Requirements

Minimum API Level	1
Target Edition	HistoryEdition MD5: C13883CBD796C614365AB2D670EAD561
Header	S4ModApi.h
Library	S4ModApi.lib
DLL	S4ModApi.dll

See also

ISettlers4Api

ISettlers4Api::DeleteWorldCursor

ISettlers4Api::AddEffect

Tutorial.SetWorldCursor (s4.muffinmar.io)