SetObjectStatus

Category: Objects / Status
Since engine version: 4.9.7.0 CR

Description

Changes the internal state of an object. Primarily needed for LoadScenarioSection.

Syntax

bool SetObjectStatus (int iNewStatus, object pObj, bool fClearPointers);

Parameters

iNewStatus:
New object status. The following values are possible:
Name Value Description
C4OS_DELETED 0 The object has been deleted. Can't be set via SetObjectStatus.
C4OS_NORMAL 1 Object is activated.
C4OS_INACTIVE 2 Object is deactivated.
pObj:
Object of which the status should be changed.
fClearPointers:
If true, all engine-internal connections to the object are deleted. The object is taken out of its container, its contents are ejected, effects assigned to the object are deleted, etc.
See also: GetObjectStatus, LoadScenarioSection
Fulgen, Clonk Wiki, Juli 2016