The "debug" module is a module that manages the functions for outputting logs.

Module name

cri.atomcraft.debug

The following functions are defined as:

Function	Description	Operation object
clear_log	Clear the log views	-
get_script_argument	Gets the arguments from the command lines	-
get_tool_version	Gets the version of Atom Craft	-
log	Outputs logs	-
ping	Remains unchanged	-
warning	Outputs a warning message	-

clear_log

Log Clear all the views.

This function was added in Ver.3.46.04.

Format

result = clear_log()

Input parameter

None

Return value

Name	Value
result [ "succeed" ]	True if succeeded, False if failed

get_script_argument

Gets the arguments passed using -scriptargument from the command lines.
This function is used from the command lines.
If no argument is given, an empty string is returned.

This function was added in Ver.3.45.00.

Format

result = get_script_argument()

Input parameter

None

Return value

Name	Value
result [ "succeed" ]	True if succeeded, False if failed
result [ "data" ]	Use the argument string provided by `-scriptargument`

get_tool_version

Gets the version of Atom Craft in use.
The value will be returned in this format: "Ver.(Major).(Minor).(Patch)", e.g., "Ver.3.46.04".

This function was added in Ver.3.46.04.

Format

result = get_tool_version()

Input parameter

None

Return value

Name	Value
result [ "succeed" ]	True if succeeded, False if failed
result [ "data" ]	Version string

log

Outputs the log.
For warning logs, use warning function instead.

Format

result = log(message)

Input parameter

Name	Value
message	Message text

Return value

Name	Value
result [ "succeed" ]	True if succeeded, False if failed

ping

Remains unchanged.
It does not make any changes to the project.
Usually, the execution result will be True regardless of the contents of the current project file.
It will be False if there is a problem in the API execution itself due to connection error.

Format

result = ping()

Input parameter

None

Return value

Name	Value
result [ "succeed" ]	True if succeeded, False if failed

warning

Outputs warning.
Use the log function instead if warning is not needed.

Format

result = warning(message)

Input parameter

Name	Value
message	Message text

Return value

Name	Value
result [ "succeed" ]	True if succeeded, False if failed