GetGroupHostility

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.

Returns whether two groups are hostile to each other.

int GetGroupHostility(
int nGroupA,
int nGroupB
);
Parameters:
nGroupA
The source group to use to check the hostility tables
nGroupB
The target group to use to check the hostility tables
Returns:

Returns TRUE if the two groups are hostile. FALSE otherwise. Returns FALSE on error.

Source:

script.ldf

Description

This function accesses the hostility tables for the two specified groups and returns whether they are hostile to each other or not. If either of the two group ID's are not valid, the function will return FALSE. Changing group hostility will result in a perception event being refired to all creatures that can perceive a member of the group.

Remarks

If invalid group ID's are specified, the function will return FALSE


See also

SetGroupHostility, GetGroupId, SetGroupId