From Vectorworks Developer
Revision as of 03:27, 6 July 2018 by MaKro
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
DescriptionReturns the point clicked by the user. inPtIndex is 0-based. If you pass in an index that is greater than the number of points clicked by the user, result will be false.
VAR outX :REAL;
VAR outY :REAL;
def vs.vstGetPt2D(inPtIndex, result): return (outX, outY)
inPtIndex LONGINT outX REAL Output parameter. outY REAL Output parameter. result BOOLEAN
RemarksNote that VS:vstNumPts will return the number of clicked points (a 1-based index). vstGetPt2D is zero-based. So if you're collecting points in the kToolEventPointAdded event you'll likely have to do something like
vstNumPoints(pointNum); vstGetPt2D(pointNum-1, ...);
[MaKro 6/2018]: ... consider using VS:vstGetCurrPt2D ...
VersionAvailability: from All Versions
This is drop-in function.