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




Introduced in

Version:17.1.0

Description

Description:Returns the value of an internal property from an external simulation.
Note: The command only works if the External Controller adapter is enabled in VBS Gateway.

Syntax

Syntax:[extSim, id, property] call Gateway_GetExternalProperty
Parameters:
  • extSim: String - Name of the external simulation type.
  • id: Array of Number - Object ID of the entity that is registered as an external simulation.
  • property: String - Property name to get.
Return Value:Number - Value of the property.

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:
 ["JSBSim", [4,13,333], "fcs/pitch-trim-cmd-norm"] call Gateway_GetExternalProperty; 
 ["JSBSim", [4,13,333], "fcs/roll-trim-cmd-norm"] call Gateway_GetExternalProperty;
 ["JSBSim", [4,13,333], "fcs/yaw-trim-cmd-norm"] call Gateway_GetExternalProperty; 

Additional Information

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