コンテンツにスキップ

GetSignal()#

GetSignal(id)#

指定IDの信号機オブジェクトを取得します。

パラメータ#

int id

オブジェクトID

Note

オブジェクトIDの代わりに部品に設定した名前でも検索できます。

戻り値#

VRMSignal

信号機オブジェクトのインスタンスを返します。

オブジェクトが取得できない場合は、例外が発生します。スクリプトの実行は停止します。

コメント#

固有のオブジェクトIDで指定したオブジェクトのインスタンスを取得します。

名前で指定した場合は、最初に名前が一致したオブジェクトのインスタンスを取得します。 複数のオブジェクトを取得する場合は、List系関数でリストを取得、任意の条件でリストから抽出します。

部品数が多い場合、オブジェクトの検索に時間がかかります。 ビュワー起動後、IDとインスタンスの関係は維持されます。 編成オブジェクト以外は、ビュワー起動時にGet系またはList系関数で取得すると速度が向上します。

サンプル#

signal = vrmapi.LAYOUT().GetSignal(1)