Difference between revisions of "SetPosition"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
BryanDerksen (Talk | contribs) m (looks fine to me, removing tag) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=SetPosition | |name=SetPosition | ||
| Line 6: | Line 5: | ||
|param1name=oObject | |param1name=oObject | ||
|param1desc=The Object to set the position of | |param1desc=The Object to set the position of | ||
| + | |param1default= | ||
|param2type=vector | |param2type=vector | ||
|param2name=vPosition | |param2name=vPosition | ||
|param2desc=The position vector containing the new coordinates | |param2desc=The position vector containing the new coordinates | ||
| + | |param2default= | ||
|param3type=int | |param3type=int | ||
|param3name=bSafePosition | |param3name=bSafePosition | ||
|param3desc=Specifies whether a safe position should be calculated and used | |param3desc=Specifies whether a safe position should be calculated and used | ||
| + | |param3default=TRUE | ||
|returntype=void | |returntype=void | ||
|returndesc= | |returndesc= | ||
Latest revision as of 22:17, 9 February 2010
Sets the position of an object.
- Parameters:
- oObject
- The Object to set the position of
- vPosition
- The position vector containing the new coordinates
- bSafePosition
- Specifies whether a safe position should be calculated and used
- Returns:
- Nothing.
- Source:
- script.ldf
Description
Sets the position of the object oObject to the xyz coordinates contained in the vector vPosition. If bSafePosition is set to TRUE, then a safe position will be computed based off of the vector vPosition and this position will be used. A safe position is a valid position on the nearest walkable mesh.
Remarks
If an invalid object is specified then the function will fail. If a non-creature object is specified, a safe position can not be computed for the object so vPosition will be used, regardless of whether or not it is safe. If a safe position cannot be found and the bSafePosition flag is set to TRUE, the function will fail.
