Difference between revisions of "GetPartyPlotFlag"
BryanDerksen (Talk | contribs) m (typo on my part there...) |
BryanDerksen (Talk | contribs) m (1 revision: re-import with default parameter value parameters set) |
||
Line 1: | Line 1: | ||
+ | {{Generated}} | ||
{{dafunction | {{dafunction | ||
|name=GetPartyPlotFlag | |name=GetPartyPlotFlag | ||
Line 5: | Line 6: | ||
|param1name=oParty | |param1name=oParty | ||
|param1desc=Party Object ID | |param1desc=Party Object ID | ||
+ | |param1default= | ||
|param2type=string | |param2type=string | ||
|param2name=strPlot | |param2name=strPlot | ||
|param2desc=Plot name to query | |param2desc=Plot name to query | ||
+ | |param2default= | ||
|param3type=int | |param3type=int | ||
|param3name=nFlag | |param3name=nFlag | ||
|param3desc=Plot flag # to query (32-127) | |param3desc=Plot flag # to query (32-127) | ||
+ | |param3default= | ||
|param4type=int | |param4type=int | ||
|param4name=nCallScript | |param4name=nCallScript | ||
− | |param4desc=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 nBit is a defined flag then the script will start calling itself | + | |param4desc=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 nBit is a defined flag then the script will start calling itself recursivly |
|param4default=FALSE | |param4default=FALSE | ||
|returntype=int | |returntype=int |
Revision as of 23:28, 31 July 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 value of a plot flag
- Parameters:
- oParty
- Party Object ID
- strPlot
- Plot name to query
- nFlag
- Plot flag # to query (32-127)
- 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 nBit is a defined flag then the script will start calling itself recursivly
- Returns:
- value of the flag - TRUE 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.