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




Introduced in

Version:3.9.1

Description

Description:Centers the motion device by sending IG_CenterMotionDevice to the IGs.

Syntax

Syntax:[enabled, deviceID] call Gateway_CenterMotionDevice
Parameters:
  • enabled: Boolean - Set to true to enable boresight centering of the motion device, set to false to disable it.
  • deviceID: Number - ID of the device this command applies to (optional, default: 1).
Return Value:Boolean - Returns true if the command is successful, false otherwise.

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:
[true] call Gateway_CenterMotionDevice; // returns true
[false, 5] call Gateway_CenterMotionDevice; // returns false

Additional Information

See also: IG EnableMotionTracking, IG CenterMotionDevice
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