/ HALion Developer Resource / HALion Script / Reference /
getQCAssignmentScope
getQCAssignmentScope(qc, assignment)
Description
Function to retrieve the Element object that is set as scope for the specified quick control assignment. The quick control assignment is determined by the Layer object of the layer, the index of the quick control and the index of the assignment itself. For example, this.parent defines the parent layer of the script module as the layer that contains the quick control. The qc argument is the index of the quick control and the assignment argument is the index of the assignment with the requested scope. The indices of the quick controls and the assignments both start counting from 1.
Available in: Controller.
Arguments
| Argument | Description | Value Type |
|---|---|---|
| qc | The index of the quick control. | number |
| assignment | The index of the quick control assignment. | number |
Return Values
Returns the element object that is set as scope for the specified quick control assignment.
Example
-- Print the scope for the qc assignment.
layer = this.parent
qc = 1
assignment = 1
scope = layer:getQCAssignmentScope(qc, assignment).name -- use only the name of the returned element
print("Scope of '"..layer.name.."', QC "..qc..", assignment "..assignment..": "..scope..".")
See also: addQCAssignment, removeQCAssignment, getNumQCAssignments, getQCAssignmentParamId, getQCAssignmentMin, getQCAssignmentMax, getQCAssignmentCurve, getQCAssignmentMode, getQCAssignmentBypass, setQCAssignmentParamId, setQCAssignmentScope, setQCAssignmentMin, setQCAssignmentMax, setQCAssignmentCurve, setQCAssignmentMode, setQCAssignmentBypass, Quick Control Assignment Modes