GetNearestObjectToLocation(int, location, int)

与えられたロケーションに対して、指定されたタイプで最も近いオブジェクトを返します。

object GetNearestObjectToLocation(
    int nObjectType,
    location lLocation,
    int nNth = 1
);

Parameters

nObjectType

OBJECT_TYPE_*

lLocation

nNth

(デフォルト: 1)

Description

lLocationに対して、指定されたタイプでN番目に近いオブジェクトを返します。

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

この関数は、与えられたロケーションに対して、特定タイプのオブジェクトでN番目(デフォルトは1、最も近い)に近いオブジェクトを選択します。

デフォルトでは、タイプはOBJECT_TYPE_ALLに設定されています。従って、OBJECT_TYPE_*のタイプを指定すると、関数は与えられたロケーションに対してN番目に近い有効なオブジェクトを返すでしょう。(有効なオブジェクトタイプの全てのリストについては、descriptionの最後を見て下さい。)

利用可能なオブジェクトタイプ定数のリスト：
OBJECT_TYPE_ALL (デフォルト)
OBJECT_TYPE_AREA_OF_EFFECT
OBJECT_TYPE_CREATURE
OBJECT_TYPE_DOOR
OBJECT_TYPE_ITEM
OBJECT_TYPE_ITEM
OBJECT_TYPE_PLACEABLE
OBJECT_TYPE_STORE
OBJECT_TYPE_TRIGGER
OBJECT_TYPE_WAYPOINT

Version

1.22

See Also

functions:	GetNearestObject | GetObjectByTag
categories:	Get Data from Object Functions
constants:	OBJECT_TYPE_* Constants

---

author: Jason Simpson, JP team: katsu794
Send comments on this topic.