GetObjectByTag(string, int)

与えられたタグに基づきオブジェクトを取り出します。

object GetObjectByTag(
    string sTag,
    int nNth = 0
);

Parameters

sTag

捜すオブジェクトのタグ。

nNth

要求されタグを持っているN番目のオブジェクト。(デフォルト: 0)

Description

指定されたタグを持っているnN番目のオブジェクトを返します。また、オブジェクトが発見できなかった場合は、OBJECT_INVALIDを返します。

Remarks

nNthパラメーターは、現在のエリア内において、スクリプトを実行しているオブジェクトに対してnNth番目に近いオブジェクトを返すために決定されます。

現在のエリア外では、最後（最も新しく）にモジュールに追加されたエリアに対し、以下の階層構造に従ってスキャンが開始されるでしょう。

OBJECT_TYPE_STORE (128)
OBJECT_TYPE_PLACEABLE (64)
OBJECT_TYPE_WAYPOINT (32)
OBJECT_TYPE_AREA_OF_EFFECT (16) (sounds)
OBJECT_TYPE_DOOR (8)
OBJECT_TYPE_TRIGGER (4)
OBJECT_TYPE_ITEM (2)
OBJECT_TYPE_CREATURE (1)

Known Bugs

以前に記述したバグは、いくつか前のパッチでフィックスされました。

Version

1.29

Example

// GetObjectByTag()関数でオブジェクトを取り出す方法とそれに呪文エフェクトを適用する方法を説明します。

void main()
{
     // NPCのBobに対して、周りが暗闇に見えるようにします。
     ApplyEffectToObject(DURATION_TYPE_PERMANENT, EffectDarkness(), GetObjectByTag("NPC_BOB"));
}

functions:	ActionJumpToObject \| GetNearestObjectByTag \| GetNearestObjectToLocation \| GetTag
categories:	Get Data from Object Functions