Page tree
Skip to end of metadata
Go to start of metadata




Introduced in

Version:3.2

Description

Description:

Returns the building status of a construction object. Construction objects are special objects that can be modified by compatible engineering equipment.

The returned value is the ratio between the work time that has been applied to the object (stored in the Construction Objects object variable) and the value defined in the object "Engineering" >> "buildTime" property.

Note: The only implemented construction objects are berms, which can be modified by bulldozers.

Syntax

Syntax:object call fn_vbs_engineering_getBuildState
Parameters:
  • object: Object - Construction object.
Return Value:

Number - State of completion;

  • 0 - Deconstructed.
  • 1 - Fully built.
  • -1 - Object does not support engineering.

Warning

When using functions in VBS versions older than 3.4, certain limitations and requirements should be kept in mind - the main ones being that capitalization of the function name is crucial, and that #include "\vbs2\headers\function_library.hpp" has to be included in every script that utilizes it. More Category VBS Scripting Functions.

Examples

Examples:
_state = berm1 call fn_vbs_engineering_getBuildState

Additional Information

See also: fn vbs engineering logWork
Multiplayer: 
Problems: 

Notes