PluginRegistrar.RegisterTimerEvent

導入

v5.1

詳細

TimerEvent を登録します。特定の時間間隔でイベントコールバックを起動するタイマ。最初にイベントコールバックが呼び出されるときの遅延時間を指定することもできます。

C#構文

PluginItem PluginRegistrar.RegisterTimerEvent( String in_eventName, Int32 in_interval, Int32 in_delay );

スクリプト構文

oReturn = PluginRegistrar.RegisterTimerEvent( Name, Interval, [Delay] );

戻り値

PluginItem

パラメータ

パラメータ タイプ 説明
Name String 登録するカスタムタイマイベントの名前。文字から開始し、英数字とアンダースコア(_)記号のみを使用する必要があります。

タイマイベント名にスペースが含まれている場合("My Timer"など)は、コールバック関数名ではスペースを削除する必要があります("MyTimer_Init"など)。

Softimage では、登録イベントに関連付けるハンドラ関数を{event name}_OnEvent の書式で表します。
Interval Long リ秒単位の時間間隔の値。この値には、各コールバックの呼び出しの間に待機する時間の長さを指定します。値が0 の場合、イベントタイマは最初の呼び出し後に停止(ミュート)されます。タイマは、イベントのミュートを解除することで再開できます。値が 0 より大きい場合、タイマはそのまま無限に経過します。
Delay Long 遅延の値(ミリ秒単位)は、最初にコールバックが起動するまで待機する時間の長さです。デフォルトの遅延時間は 0 で、すぐにタイマが起動します。

デフォルト値: 0

関連項目

Plugin.Items Definition Callbacks for Events