Difference between revisions of "GetGroupHostility"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
BryanDerksen (Talk | contribs) (looks okay, removing tag) |
||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=GetGroupHostility | |name=GetGroupHostility | ||
| Line 17: | Line 16: | ||
== Description == | == Description == | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
| − | This function accesses the hostility tables for the two specified groups and returns whether they are hostile | + | 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. |
| − | 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 == | == Remarks == | ||
Latest revision as of 19:38, 1 March 2010
Returns whether two groups are hostile to each other.
- 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
