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




Introduced in

Version:3.8.1

Description

Description:IMPORTANT: This function only works when VBS is started with the -gateway switch.
Queues a setting change for the given FOM setting.
Note: Queued changes are applied with Gateway ApplySettings.

Syntax

Syntax:[fom_name, setting_name, setting_value] call Gateway_ChangeSetting
Parameters:
  • fom_name: String - The FOM name.
  • setting_name: String - The setting name.
  • setting_value: String - The setting value.
Return Value:String or Array - The given value is returned if the FOM and setting exist, otherwise returns an empty array.

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:
app_id = [ "DIS", "AppId", "auto" ] call Gateway_ChangeSetting;

Additional Information

See also: Gateway GetSetting, Gateway ApplySettings
Multiplayer: The function returns nil, if not used in multiplayer or when Gateway is not active (the -gateway start-up parameter is not used).
Problems: 

Notes