FormatLocationToString


Converts a location to a string of format "(X, Y)".

Syntax

C++
Python
 
def FormatLocationToString(
	inLocation: Location,
	/,
	*,
	inDigitCount: int = 0,
	inTrailingCharacter: str = "\"0\"",
	inForceSignPrinting: bool = False,
	inSuffix: str = "\"\"",
	inSystemBase: int = 10,
	inPrintBrackets: bool = True
)
-> outString: str

Parameters

Name Type Range Default Description
Input value inLocation Location
Input value inDigitCount int 0 - 0 How many characters the output coordinate should have at least
Input value inTrailingCharacter str "\"0\"" Defines the trailing character
Input value inForceSignPrinting bool False Forces printing the signs of the coordinates even if the number is positive
Input value inSuffix str "\"\"" Defines a suffix. Generally it is an unit of value (e.g. mm)
Input value inSystemBase int 2 - 16 10 The base of the numeral system
Input value inPrintBrackets bool True Determines whether the brackets should be printed or not
Output value outString str