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.
Retrieves the current value for the given setting in the given FOM.

Note: FOM name and setting name are case-sensitive.

Syntax

Syntax:[fom_name, setting_name] call Gateway_GetSetting
Parameters:
  • fom_name: String - The FOM name.
  • setting_name: String - The setting name.
Return Value:String - The setting value.

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" ] call Gateway_GetSetting;

Additional Information

See also: Gateway ChangeSetting, 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