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



Introduced in

Version:1.00

Description

Description:

Sets the status of an objective that was defined in the Mission Briefing (see Edit the Mission Briefing in the VBS3 Editor Manual).

For example, to refer to an objective that is named "OBJ_1", use only the part after OBJ_ in this command (for example, "1" objStatus "HIDDEN").

This name part does not have to be just a number - it can be any string (for example, if the objective is defined as "OBJ_EliminateTank", then the respective command would be "EliminateTank" objStatus "DONE").

The current objective status cannot be read in any way, and the caption cannot be changed.

If the simulation option Cadet Mode and Training Hints is enabled, then a hint message is shown when an objective status changes. The message is "Mission plan updated", if it changes to "ACTIVE" or "FAILED", or "Objective completed" if it changes to "DONE".

Syntax

Syntax:name objStatus status
Parameters:
  • name: String - Objective name, as used in a briefing (see Edit the Mission Briefing in the VBS3 Editor Manual).
  • status: String - Status to set objective indicator to. Can be:
    • "ACTIVE" (black circle)
    • "FAILED" (red cross)
    • "DONE" (green checkmark)
    • "HIDDEN" (invisible)

Example:

Return Value:Nothing

Examples

Examples:
Mark the objective named "OBJ_1" as completed:
"1" objStatus "DONE"
Hide the objective named "OBJ_DoThis":
"DoThis" objStatus "HIDDEN"

Additional Information

See also:

Multiplayer:
Problems:

Notes