Difference between revisions of "GetLocation"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
Line 20: Line 20:
 
<!-- This section contains additional comments, observations and known issues. -->
 
<!-- This section contains additional comments, observations and known issues. -->
  
<!-- == Examples == -->
+
== Examples ==
 
<!-- This section contains examples transcluded from the snippet library. -->
 
<!-- This section contains examples transcluded from the snippet library. -->
 +
To get the location of the current PC/Hero:<br />
 +
location currentLocation = GetLocation(GetHero());
 +
  
 
== See also ==
 
== See also ==

Revision as of 08:01, 13 November 2009

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

The parser extracted and matched all the information required to the best of its ability however the parser relies on the source file, and especially a function's comments, to be correctly formatted. If the source file was not correctly formatted the information presented may be incomplete.

This page should be reviewed by a knowledgeable scripter as it may require updating. If an issue with the source file is identified it should be reported to BioWare.

Please remove the {{Generated}} tag once the page has been confirmed or corrected.

Returns the location of the specified object.

location GetLocation(
object oObject
);
Parameters:
oObject
the object to get the location of
Returns:

a valid location on success or invalid location on error

Source:

script.ldf

Description

This function returns the location of the specified object. If an invalid object is specified, then an invalid location will be returned.


Examples

To get the location of the current PC/Hero:
location currentLocation = GetLocation(GetHero());


See also

IsLocationValid