Skip to content

CallToolByIndex.md

Latest commit

 

History

History
55 lines (44 loc) · 1.09 KB

CallToolByIndex.md

File metadata and controls

55 lines (44 loc) · 1.09 KB
Raw

CallToolByIndex

Description

Similar to CallTool. Takes the internal ID of a tool (Script Appendix)

FUNCTION CallToolByIndex(toolIndex : INTEGER): BOOLEAN;
def vs.CallToolByIndex(toolIndex):
    return BOOLEAN

Parameters

Name Type Description
toolIndex INTEGER

Examples

VectorScript

Message( CallToolByIndex( -221 ) ) { activate locus tool, returns true if successful }

Python

vs.Message( vs.CallToolByIndex( -221 ) ) # activate locus tool, returns true if successful
resultOK := CallToolByIndex(1);
import vs

# Similar to CallTool.
toolIndex = 1

ok = vs.CallToolByIndex(toolIndex)
if ok:
    vs.Message('CallToolByIndex succeeded')
else:
    vs.Message('CallToolByIndex failed')

See Also

VS Functions:

Version

Availability: from Vectorworks 2014

Category