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




Introduced in

Version:3.4

Description

Description:

Removes a Systems-Menu item from its parent item. If the item is the Systems-Menu root, the whole system is removed.

For more information, see Systems Menu in the VBS3 User Manual.

Syntax

Syntax:[vehicle, systemID, systemItemID, remRef] call fn_vbs_removeSystemItem
Parameters:
  • vehicle: Object - The vehicle.
  • systemID: String - The system ID.
  • systemItemID: String - The Systems-Menu item ID.
  • remRef: Boolean - Remove reference to itself from the parent item (optional, default: true).
Return Value:Boolean - Returns false, if the system or the item do not exist.

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:
 [tank1, 1, 2, false] call fn_vbs_removeSystemItem

Additional Information

See also: fn vbs createSystem, fn vbs getDefaultSystem, fn vbs setDefaultSystem, fn vbs getSystemItemShortcut, fn vbs setSystemItemShortcut
Multiplayer:
Problems:

Notes