Introduced in

Version:3.9.1

Description

Description:Enables or disables the motion device on the given IGs.

Syntax

Syntax:[isEnabled, ctlViews, isViewGrp, deviceID] call Gateway_EnableMotionTracking
Parameters:
  • isEnabled: Boolean - Set to true if motion tracking should be enabled for the list of IGs, set to false if it should be disabled.
  • ctlViews: Array - List of IG view or group IDs that are controlled by the motion device.
  • isViewGrp: Boolean - Set to true if the controlled view list is groups, false if individual views (optional, default: false).
  • 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, [1]] call Gateway_EnableMotionTracking; // returns true
[true, [1], true, 5] call Gateway_EnableMotionTracking; // 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