Skip to content

LDevice_SetParamBool.md

Latest commit

 

History

History
52 lines (43 loc) · 1.43 KB

LDevice_SetParamBool.md

File metadata and controls

52 lines (43 loc) · 1.43 KB
Raw

LDevice_SetParamBool

Description

Set boolean parameter of a Lighting Device or attached Accessory by Worksheet Name. Use cell index 0 to operate on the first cell. Use cell index -1 to set value for all the cells. Use accessory index -2 to ignore accessory values. Use accessory index 0 to operate on the first accessory of the specified cell. Use accessory index -1 to set value for all the accessories on the specified cell.

PROCEDURE LDevice_SetParamBool(
				handle         : HANDLE;
				cellIndex      : LONGINT;
				accessoryIndex : LONGINT;
				universalName  : STRING;
				newValue       : BOOLEAN);
def vs.LDevice_SetParamBool(handle, cellIndex, accessoryIndex, universalName, newValue):
    return None

Parameters

Name Type Description
handle HANDLE
cellIndex LONGINT
accessoryIndex LONGINT
universalName STRING
newValue BOOLEAN

Examples

LDevice_SetParamBool(handle, 1, 2, 'Example', TRUE);
import vs

# Set boolean parameter of a Lighting Device or attached Accessory by
# Worksheet Name.
handle = vs.FSActLayer()  # handle to the first selected object on the active layer
cellIndex = 1
accessoryIndex = 1
universalName = 'Example'
newValue = True

vs.LDevice_SetParamBool(handle, cellIndex, accessoryIndex, universalName, newValue)

Version

Availability: from Vectorworks 2021

Category