Pythonシミュレーションスクリプト

Pythonシミュレーションスクリプトとは

Pythonシミュレーションスクリプトアイテム(PythonSimScriptItem)は、シミュレーションと連動して実行されるPythonスクリプトに対応するアイテムです。シミュレーションの開始や終了といったタイミングに合わせてスクリプトを実行させることができます。例えば、シミュレーション開始時に環境の状態を設定したり、シミュレーション終了時に結果の処理を行ったりといった用途に利用できます。

この機能はPythonSimScriptプラグインによって提供されます。

利用方法

スクリプトファイルは、メインメニューの「ファイル」-「読み込み」-「シミュレーション用Pythonスクリプト」で読み込みます。

読み込んだアイテムは、対象とするシミュレーションのワールドアイテムの配下に配置し、チェックを入れておきます。するとそのワールドでシミュレーションを実行した際に、「タイミング」プロパティで指定したタイミングでスクリプトが実行されます。

スクリプトの実行タイミングは、シミュレーションの初期化・終了処理を基準として、以下から選択できます。

  • 初期化前 … シミュレーションの初期化前に実行されます。

  • 初期化中 … シミュレーションの初期化処理の中で実行されます。

  • 初期化後 … シミュレーションの初期化完了後(シミュレーション開始時)に実行されます。

  • 終了処理中 … シミュレーションの終了処理の中で実行されます。

  • 終了処理後 … シミュレーションの終了処理の完了後に実行されます。

さらに「遅延」プロパティを設定することで、上記タイミングから指定した時間だけ遅らせてスクリプトを実行させることもできます。

アイテムのプロパティ

Pythonシミュレーションスクリプトアイテムでは、Pythonスクリプトアイテムと同様のバックグラウンド実行・独立名前空間のプロパティに加えて、以下のプロパティが利用できます。

プロパティ

デフォルト値

意味

タイミング

初期化後

スクリプトを実行するタイミングを「初期化前」「初期化中」「初期化後」「終了処理中」「終了処理後」から選択します。

遅延

0.0

上記タイミングからの遅延時間です [s]。

シミュレーション用に限定

true

trueの場合、スクリプトはシミュレーションと連動したタイミングでのみ実行されます。falseにすると、コンテキストメニューの「実行」による手動実行も可能となります。