Skip to content

StartBuildingPlacement

nyfrk edited this page Feb 3, 2022 · 2 revisions

ISettlers4Api::StartBuildingPlacement method

This puts the game into the building placement mode.

Syntax

BOOL ISettlers4Api::StartBuildingPlacement(
	S4_BUILDING_ENUM building
);

Parameters

building

The building type you want to start the placement mode for. See S4_BUILDING_ENUM for a list of possible building types.

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 event id of the command is ID 437.

This method does not cause a network event and is thus multiplayer compatible.

Currently this method is not supported by the Gold Edition. This is considered a bug and will be fixed in future releases.

Requirements

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

See also

ISettlers4Api

ISettlers4Api::BuildBuilding

Clone this wiki locally