IsLocationSafe

From Dragon Age Toolset Wiki
Revision as of 02:40, 29 July 2009 by Sunjammer (Talk | contribs) (Generated by Sunjammer's Dragon Age Script Paser)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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.

Used to test if a specific location is safe.

int IsLocationSafe(
location lLocation
);
Parameters:
lLocation
The location tested to see if it's safe
Returns:

TRUE on success, FALSE on error

Source:

script.ldf

Description

This function is used to test if a specific location is safe. A safe location is a walkable section of terrain that is not occupied by a creature. It should be noted that walkable also means that the specified location would not be occupied by a placeable object, unless the placeable object had no walkmesh.

Remarks

This function is expensive, and as such should not be called frequently if it can be helped.


See also

IsLocationValid