Difference between revisions of "UT GetNearestObjectByTag"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
BryanDerksen (Talk | contribs) |
||
(8 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | |||
{{dafunction | {{dafunction | ||
|name=UT_GetNearestObjectByTag | |name=UT_GetNearestObjectByTag | ||
Line 6: | Line 5: | ||
|param1name=oObject | |param1name=oObject | ||
|param1desc=target Object | |param1desc=target Object | ||
+ | |param1default= | ||
|param2type=string | |param2type=string | ||
|param2name=sTag | |param2name=sTag | ||
|param2desc=Tag for the objects to query | |param2desc=Tag for the objects to query | ||
+ | |param2default= | ||
|param3type=int | |param3type=int | ||
|param3name=nIncludeSelf | |param3name=nIncludeSelf | ||
|param3desc=TRUE if the query should check the target object | |param3desc=TRUE if the query should check the target object | ||
+ | |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.