• Reference
  • LUA API
  • Global
  • Math

Math

Functions

get_random_angle

Get a random angle.

cli.get_random_angle()

get_points_angle

Get the angle between vector (O, point_1) and vector (O, point_2).

Parameters

VariableTypeDescription
point_1pointPoint 1.
point_2pointPoint 2.

Return

TypeDescription
numberAngle.
cli.get_points_angle(point_1, point_2)

create_annular_shape

Annular area.

Parameters

VariableTypeDescription
in_radiusnumberInner radius.
out_radiusnumberOuter radius.

Return

TypeDescription
regionRegion.
cli.create_annular_shape(in_radius, out_radius)

create_circular_shape

Circular region.

Parameter

VariableTypeDescription
radiusnumberRadius.

Return

TypeDescription
regionRegion.
cli.create_circular_shape(radius)

create_rectangle_shape

Rectangle region.

Parameters

VariableTypeDescription
widthnumberWidth.
lengthnumberLength.
anglenumberAngle.

Return

TypeDescription
regionRegion.
cli.create_rectangle_shape(width, length, angle)

create_sector_shape

Sector.

Parameters

VariableTypeDescription
radiusnumberRadius.
anglenumberAngle.
directionnumberDirection.

Return

TypeDescription
regionRegion.
cli.create_sector_shape(radius, angle, direction)

int_to_float

Convert an integer to a real number.

Parameter

VariableTypeDescription
valueintegerInteger.

Return

TypeDescription
floatReal number.
cli.int_to_float(value)

string_to_float

Convert a string to a real number.

Parameter

VariableTypeDescription
valuestringString.

Return

TypeDescription
floatReal number.
cli.string_to_float(value)

random_float_with_min_and_max

Random real number in range.

Parameters

VariableTypeDescription
minnumberSmallest real number in the range.
maxnumberLargest real number in the range.

Return

TypeDescription
floatReal number.
cli.random_float_with_min_and_max(min, max)

get_two_points_distance

Compute the distance between two points.

Parameters

VariableTypeDescription
point_1pointPoint 1.
point_2pointPoint 2.

Return

TypeDescription
numberDistance.
cli.get_two_points_distance(point_1, point_2)

float_plus_one

Real number plus 1.

Parameter

VariableTypeDescription
valuenumberReal number.

Return

TypeDescription
floatReal number.
cli.float_plus_one(value)

sin

Sine.

Parameter

VariableTypeDescription
valuenumberReal number.

Return

TypeDescription
floatReal number.
cli.sin(value)

cos

Cosine.

Parameter

VariableTypeDescription
valuenumberReal number.

Return

TypeDescription
floatReal number.
cli.cos(value)

tan

Tangent.

Parameter

VariableTypeDescription
valuenumberReal number.

Return

TypeDescription
floatReal number.
cli.tan(value)

asin

Arcsine.

Parameter

VariableTypeDescription
valuenumberReal number.

Return

TypeDescription
floatReal number.
cli.asin(value)

acos

Arccosine.

Parameter

VariableTypeDescription
valuenumberReal number.

Return

TypeDescription
floatReal number.
cli.acos(value)

atan

Arctangent.

Parameter

VariableTypeDescription
valuenumberReal number.

Return

TypeDescription
floatReal number.
cli.atan(value)

sqrt

Square root.

Parameter

VariableTypeDescription
valuenumberReal number.

Return

TypeDescription
floatReal number.
cli.sqrt(value)

pow

Find the power.

Parameters

VariableTypeDescription
valuenumberReal number.
countintegerNumber of times.

Return

TypeDescription
floatReal number.
cli.pow(value, count)

abs

Find the absolute value.

Parameter

VariableTypeDescription
valuenumberReal number.

Return

TypeDescription
floatReal number.
cli.abs(value)

log10

Logarithm based on 10.

Parameter

VariableTypeDescription
valuenumberReal number.

Return

TypeDescription
floatReal number.
cli.log10(value)

log

Value is based on the logarithm of base.

Parameters

VariableTypeDescription
valuenumberReal number.
basenumberReal number.

Return

TypeDescription
floatReal number.
cli.log(value, base)

round_dec

Result after keeping X decimal places.

Parameters

VariableTypeDescription
valuenumberReal number.
positionintegerPosition.
is_roundbooleanWhether to round up or down.

Return

TypeDescription
floatReal number.
cli.round_dec(value, position, is_round)

get_minor_between_two_float

Get the smaller value between a real number and another real number.

Parameters

VariableTypeDescription
onenumberReal number.
twonumberReal number.

Return

TypeDescription
floatReal number.
cli.get_minor_between_two_float(one, two)

get_bigger_between_two_float

Get the larger value between a real number and another real number.

Parameters

VariableTypeDescription
onenumberReal number.
twonumberReal number.

Return

TypeDescription
floatLarger of the real numbers.
cli.get_bigger_between_two_float(one, two)

float_to_int

Convert a float to an integer.

Parameter

VariableTypeDescription
valuenumberReal number.

Return

TypeDescription
integerInteger.
cli.float_to_int(value)

string_to_int

String to integer.

Parameter

VariableTypeDescription
valuestringString.

Return

TypeDescription
integerInteger.
cli.string_to_int(value)

get_random_int

Random integer in range.

Parameters

VariableTypeDescription
minintegerInteger.
maxintegerInteger.

Return

TypeDescription
integerInteger.
cli.get_random_int(min, max)

get_minor_between_two_int

Get the smaller value between two integers.

Parameters

VariableTypeDescription
oneintegerInteger.
twointegerInteger.

Return

TypeDescription
integerInteger.
cli.get_minor_between_two_int(one, two)

get_bigger_between_two_int

Get the larger value between two integers.

Parameters

VariableTypeDescription
oneintegerInteger.
twointegerInteger.

Return

TypeDescription
integerInteger.
cli.get_bigger_between_two_int(one, two)

int_plus_one

Integer plus 1.

Parameter

VariableTypeDescription
valueintegerInteger.

Return

TypeDescription
integerInteger.
cli.int_plus_one(value)