Skip to content

SetTempToolHelpStr.md

Latest commit

 

History

History
73 lines (61 loc) · 1.54 KB

SetTempToolHelpStr.md

File metadata and controls

73 lines (61 loc) · 1.54 KB
Raw

SetTempToolHelpStr

Description

Sets a text to be used as help string for temp tool calls: RunTempTool, TrackObject, GetPt, GetPtL, GetPt3D, and GetPtL3D.

This function should be called prior to calling the tool.

The help string will be used for subsequent temp tool runs until changed.

PROCEDURE SetTempToolHelpStr(helpString : STRING);
def vs.SetTempToolHelpStr(helpString):
    return None

Parameters

Name Type Description
helpString STRING The help string for the next temp tool.

Examples

VectorScript

PROCEDURE Test;
VAR h : HANDLE;
  
  FUNCTION CheckObjCallback(h : HANDLE) : BOOLEAN;
  BEGIN
     {any object is ok}
     CheckObjCallback := true;
  END;

BEGIN
SetTempToolHelpStr( 'Select any object' );
TrackObject( CheckObjCallback, h );
SetSelect( h );
END;
RUN( Test );

Python



NumNFerInstruments := 0;
TempHandle1 := NIL;
TempHandle2 := NIL;
ALLOCATE InstHands [1..5];
SetTempToolHelpStr(GetPlugInString(3007));
STRING3005 := GetPlugInString(3005);
STRING3006 := GetPlugInString(3006);
REPEAT
TrackObject( CheckObjCallback, TempHandle1,TempXLoc, TempYLoc, TempZLoc );

SetTempToolHelpStr( GetPlugInString(5008) );
TrackLightingDevice( TmpPickObjHan, shiftKeyPressed );
WHILE ( TmpPickObjHan <> NIL ) & ( NOT IsCanceled ) DO
BEGIN
	NumInsts := NumInsts + 1;


vs.SetTempToolHelpStr('Example')


Version


Availability: from Vectorworks 2010


Category