Difference between revisions of "UT GetNearestObjectByTag"
From Dragon Age Toolset Wiki
(David's comments are superfluous and have been removed) |
BryanDerksen (Talk | contribs) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{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= | ||
}} | }} | ||
| − | + | == Description == | |
| + | |||
<!-- 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. --> | ||
| + | |||
| + | 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
- 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.
