VS:CallToolByIndex: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
m (1 revision)
m (add see also)
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<desc>
<desc>
Similar to CallTool. Takes the internal ID of a tool.</desc>
Similar to CallTool. Takes the internal ID of a tool ([[VS:Function_Reference_Appendix#settool| Appendix]] )
 
</desc>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
Line 33: Line 35:


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<sample></sample>
<sample>
 
==== Vectorscript ====
<code lang="pas">
Message( CallToolByIndex( -221 ) ) { activate locus tool, returns true if successful }
</code>
 
==== Python ====
<code lang="py">
vs.Message( vs.CallToolByIndex( -221 ) ) # activate locus tool, returns true if successful
</code>
 
</sample>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<seeAlso></seeAlso>
<seeAlso>
VS Functions:
* [[VS:CallTool]]
* [[VS:CallToolByName]]
</seeAlso>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------

Latest revision as of 05:19, 19 January 2022

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

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

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

Parameters

toolIndex INTEGER

Example

Vectorscript

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

Python

vs.Message( vs.CallToolByIndex( -221 ) ) # activate locus tool, returns true if successful

Version

Availability: from Vectorworks 2014

See Also

VS Functions:

VS Functions:
  • [[VS:CallTool]]
  • [[VS:CallToolByName]]