ToggleBuildingPriority

ISettlers4Api::ToggleBuildingPriority method

Toggle priority mode for a building. This is the same event that players can issue by clicking the priority icon in the side panel of a selected building that has not yet been fully build.

Syntax

BOOL ISettlers4Api::ToggleBuildingPriority(
	DWORD building, 
	DWORD player
);

Parameters

building

The index of the building to toggle the priority mode for. The player should own this building.

player

The player who issues the command. Use 0 (zero) to issue this event as the local player.

Return value

If this method could append the event successfully it will return TRUE. If an error occurred it will return FALSE.

Remarks

The corresponding network event id of the command is ID 5004.

Requirements

Minimum API Level	1
Target Edition	Any
Header	S4ModApi.h
Library	S4ModApi.lib
DLL	S4ModApi.dll

See also

ISettlers4Api

ISettlers4Api::BuildBuilding

ISettlers4Api::ToggleBuildingHalt