preview モジュール

preview モジュールは、プレビュー操作を行う関数を管理するモジュールです。

モジュール名

cri.atomcraft.preview

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

関数	説明	操作オブジェクト
start_playback_cue	指定したキューを再生します	キュー
stop_all	再生中のキューを全て停止します	-
start_ingame_preview	インゲーム接続を開始します	-
stop_ingame_preview	インゲーム接続を停止します	-

start_playback_cue

指定したキューを再生します。

書式

result = start_playback_cue(cue)

入力パラメーター

名前	値
cue	キューオブジェクト

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False

stop_all

再生中のキューを全て停止します。

書式

result = stop_all()

入力パラメーター

なし

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False

start_ingame_preview

インゲーム接続を開始します。
target には以下の文字列が指定可能です。大文字小文字は区別しません。

"pc", "public", "android", "iphone", "xboxone", "xbox360", "ps4", "ps5", "switch"

ip_addressには文字列を指定してください。

覚え書き

start_profiler_logging を使用する場合、start_ingame_previewから復帰した後も暫く処理がブロックされる場合があります。
time.sleep() 関数を使用してスリープを挟んでから start_profiler_logging を呼び出してください。

書式

result = start_ingame_preview(target, ip_address)

入力パラメーター

名前	値
target	接続先のターゲット
ip_address	接続先のIPアドレス

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False

stop_ingame_preview

インゲーム接続を停止します。

書式

result = stop_ingame_preview()

入力パラメーター

なし

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False