system.vision.isOverlaysEnabled

Backwards Compatibility

This function replaces system.tag.isOverlaysEnabled. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.

This function is used in Python Scripting.

Description

Returns whether or not the current client's quality overlay system is currently enabled.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.isOverlaysEnabled()

Parameters

Nothing

Returns

Boolean - True if overlays are currently enabled.

Scope

Vision Client

Code Examples

Example #1

# This code will return whether or not overlays are currently enabled.
print system.vision.isOverlaysEnabled()