GetPartyPlotFlag
From Dragon Age Toolset Wiki
Revision as of 22:26, 6 August 2011 by Sunjammer (Talk | contribs) (Adding remarks, cleaning up template, removing bad link)
Returns the value of a plot flag
- Parameters:
- oParty
- party object
- strPlot
- plot name to query
- nFlag
- plot flag number to query
- nCallScript
- Whether or not to call the plot script. Note: this should not be set to TRUE when this function is used inside a plot script. If nFlag is a defined flag then the script will start calling itself recursively
- Returns:
- TRUE, if the flag is set, or FALSE
- Source:
- script.ldf
Description
Queries the state of a plot flag from a party's plot table. In order to query DEFINED flags, this function needs to query the plot script associated with that flag.
Remarks
OBJECT_INVALID is valid for the oParty parameter (see GetParty).
The plot's GUID and ResRef are both valid for the strPlot parameter.