Difference between revisions of "UT GetNearestObjectByTag"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(Been a week since I asked about this in Talk:GetNearestObjectByTag, restoring the comment until further developments.)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Generated with errors}}
 
 
{{dafunction
 
{{dafunction
 
|name=UT_GetNearestObjectByTag
 
|name=UT_GetNearestObjectByTag
Line 16: Line 15:
 
|param3default=0
 
|param3default=0
 
|returntype=object
 
|returntype=object
|returndesc=
+
|returndesc=the object nearest to oObject that meets the criteria
 
|sourcefile=script.ldf
 
|sourcefile=script.ldf
 
|sourcemodule=
 
|sourcemodule=
Line 24: Line 23:
  
 
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
 
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
Cite DavidSims: "UT_GetNearestObjectByTag returns the object in the current area which both has the given tag and is closest to the speicified object."
+
 
 +
UT_GetNearestObjectByTag returns the object in the current area which both has the given tag and is closest to the specified object.<!-- Cite DavidSims -->
  
 
<!-- == Remarks == -->
 
<!-- == Remarks == -->

Latest revision as of 19:08, 10 February 2010

Returns the one nearest object to the specified object

object UT_GetNearestObjectByTag(
object oObject,
string sTag,
int nIncludeSelf = 0
);
Parameters:
oObject
target Object
sTag
Tag for the objects to query
nIncludeSelf
TRUE if the query should check the target object
Returns:

the object nearest to oObject that meets the criteria

Source:

script.ldf

Description

UT_GetNearestObjectByTag returns the object in the current area which both has the given tag and is closest to the specified object.