GetNearestObjectByTag(string, object, int)

オブジェクトのタグ値を調べることによって、対象に対して最も近いオブジェクトを返します。

object GetNearestObjectByTag(
    string sTag,
    object oTarget = OBJECT_SELF,
    int nNth = 1
);

Parameters

sTag

oTarget

(デフォルト: OBJECT_SELF)

nNth

(デフォルト: 1)

Description

タグ値としてsTagを持っているoTargetに、N番目に近いオブジェクトを返します。

エラー時には、OBJECT_INVALIDを返します。

関数は、与えられたタグ文字列にマッチするオブジェクトに対して、N番目(デフォルトは1、いちばん近い)に近いオブジェクトを選択します。

oTARGETは、デフォルトではOBJECT_SELFになってますが、おそらく別のオブジェクトが設定されるかもしれません。

この関数に必要なパラメーターは、タグ値の文字列だけです。

例えば、GetNearestObjectByTag(sFoo)は、タグ文字列としてsFooを持っているこの関数を呼び出すオブジェクトに最も近いオブジェクトを返すでしょう。

GetNearestObjectByTag(sFoo, oStatue1, 3)とすることで、タグ文字列としてsFooを持っているオブジェクトoStatue1に３番目に近いオブジェクトを取り出すこともできます。

注意：
要求されるパラメーターsTagは、文字列値でなければなりません。

以下の２通りの方法から１つを使うことができます。1)関数呼び出しの外部で値を設定する。(例 string sFoo = “myObjectsTagName”)、または、2)関数のパラメーターに直接タグ名を入力するために、ダブルクォーテーションを使用する。 (例 GetNearestObjectByTag(“myObjectTagName”) )

Remarks

GetNearestObjectByTag()関数が取り出す最も近いオブジェクトは、oTargetが占めているエリア内におけるオブジェクトのみです。

Version

1.22

Example

// エリア内において、関数を呼び出すオブジェクトと同じタグを持っている最も近いオブジェクトを取り出します。

void main()
{
     string sTag=GetTag(OBJECT_SELF);
     object oNearestObject=GetNearestObjectByTag(sTag);
}