EventUserDefined(int)

nUserDefinedEventNumberのイベントタイプを返します。

event EventUserDefined(
    int nUserDefinedEventNumber
);

Parameters

nUserDefinedEventNumber

Description

EventUserDefined関数は、SignalEvent()関数と共にOnUserDefinedイベントを発動し、そこに割り当てられたスクリプトを実行するために使われます。OnUserDefinedイベントのスクリプトの中でGetUserDefinedEventNumber()関数を使うことによってnUserDefinedEventNumberを取り出すことができます。

nUserDefinedEventNumberは、標準的なイベント番号の１つ(オブジェクトのデフォルトのOnSpawnスクリプトを見て下さい)、あるいはカスタム番号です。

Remarks

EventUserDefined関数は、イベントのみを作成します。イベントを発動させるためには、SignalEvent()関数を使う必要があります。

ユーザ定義イベントの重要性は、NWNがイベントに割り当てたデフォルトのスクリプトを修正せずに、特有の状況を扱ったカスタムコードを実行できるところにあります。

Version

1.22

Example

// 例 1 - 以下のコードは、eSpecialEventとして1234のカスタムユーザイベントを
// 作成します。それから、oNPCのOnUserDefinedイベントを発動し、それにeSpecialEvent
// を渡しています。

  object oNPC;
  event eSpecialEvent;

  eSpecialEvent = EventUserDefined(1234);
  SignalEvent(oNPC,eSpecialEvent);