ToggleBuildingHalt

ISettlers4Api::ToggleBuildingHalt method

Toggle halt mode for a building. This is the same event that players can issue by clicking the halt icon in the side panel of a selected building.

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

building

The index of the building to toggle the halt 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.

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

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