debug模块

debug模块是用于管理执行日志输出的函数。

模块名

cri.atomcraft.debug

定义了以下函数。

函数	说明	操作对象
clear_log	清除日志视图	-
get_script_argument	在控制台执行时获取参数	-
get_tool_version	获取Atom Craft的版本	-
log	输出日志	-
ping	不执行任何操作	-
warning	输出警告	-

clear_log

日志 清除所有视图。

从 Ver.3.46.04 开始，添加了本函数。

格式

result = clear_log()

输入的参数

无

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

get_script_argument

在控制台执行时获取通过 -scriptargument 传递的参数。
在控制台执行时可以使用此功能。
未传递任何参数时，则返回空字符串。

从 Ver.3.45.00 开始，添加了本函数。

格式

result = get_script_argument()

输入的参数

无

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	通过 -scriptargument 传递的参数字符串

get_tool_version

获取正在使用的Atom Craft版本。
此值以 "Ver.(Major).(Minor).(Patch)" 的形式返回。（例："Ver.3.46.04"）

从 Ver.3.46.04 开始，添加了本函数。

格式

result = get_tool_version()

输入的参数

无

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	版本的字符串

log

输出日志。
想要作为警告日志进行强调时，请使用 warning 函数。

格式

result = log(message)

输入的参数

名称	值
message	讯息文字

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

ping

不执行任何操作。
不会对项目进行任何任何更改。
通常情况下，不论打开的项目文件的内容如何，执行结果均是 True。
因通信失败等理由，导致API执行发生问题时，执行结果则是 False。

格式

result = ping()

输入的参数

无

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

warning

输出警告。
不强调日志时，请使用 log 函数。

格式

result = warning(message)

输入的参数

名称	值
message	讯息文字

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False