debug モジュール

debug モジュールは、ログ出力を行う関数を管理するモジュールです。

モジュール名

cri.atomcraft.debug

次の関数が定義されています。

関数	説明	操作オブジェクト
clear_log	ログビューをクリアします	-
get_script_argument	コンソール実行時に引数を取得します	-
get_tool_version	CRI 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

使用しているAtomCraftのバージョンを取得します。
値は "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