SetPosition

This page was generated by Sunjammer's Dragon Age Script Parser.

The parser was able to extract and/or match all the information required, however it has flagged this page as containing one or more joins. A join occurs when the parser encounters a single line entry (such as parameter descriptions or remarks) which has been split over multiple lines. The parser joins these lines together to prevent the information being omitted, however any original formatting will have been lost.

This page must be reviewed by a knowledgeable scripter as it will probably require updating. If the join occurred in a parameter description it will probably be necessary to move the additional information to the Description section below. Once identified, the issue in the source file should be reported to BioWare.

Please remove the {{Generated with joins}} tag once the page has been corrected.

Sets the position of an object.

void SetPosition(
object oObject,
vector vPosition,
int bSafePosition
);

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.

See also

GetPosition