Script Function Reference

Function Reference >Script Function Reference >Varaible Manipulation>getComplexNumber

getComplexNumber

getComplexNumber will retrieve a number variable.

getComplexNumber(varName, ...)

Parameters

getComplexNumber will accept any number of string values. Each string needs to be the name of a varaible defined in the calculator.

Return Value

For each parameter passed getComplexNumber will return a number in the number table format. If the variable is not defined in the calculator or is a list or matrix a nil is returned.

Example

function example()
	x = getComplexNumber("x")
	outputString("abs(x)="..(math.sqrt(x.r*x.r+x.i*x.i)).."\n")
end