Difference between revisions of "GetPartyPlotFlag"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
m (Adding remarks, cleaning up template, removing bad link) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
| − | |name=GetPartyPlotFlag | + | |name = GetPartyPlotFlag |
| − | |brief=Returns the value of a plot flag | + | |brief = Returns the value of a plot flag |
| − | |param1type=object | + | |param1type = object |
| − | |param1name=oParty | + | |param1arra = |
| − | |param1desc= | + | |param1name = oParty |
| − | |param2type=string | + | |param1default= |
| − | |param2name=strPlot | + | |param1desc = party object |
| − | |param2desc= | + | |param2type = string |
| − | |param3type=int | + | |param2arra = |
| − | |param3name=nFlag | + | |param2name = strPlot |
| − | |param3desc= | + | |param2default= |
| − | |param4type=int | + | |param2desc = plot name to query |
| − | |param4name=nCallScript | + | |param3type = int |
| − | |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 | + | |param3arra = |
| − | |returntype=int | + | |param3name = nFlag |
| − | |returndesc= | + | |param3default= |
| − | |sourcefile=script.ldf | + | |param3desc = plot flag number to query |
| − | + | |param4type = int | |
| + | |param4arra = | ||
| + | |param4name = nCallScript | ||
| + | |param4default = FALSE | ||
| + | |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 nFlag is a defined flag then the script will start calling itself recursively | ||
| + | |returntype = int | ||
| + | |returnarra = | ||
| + | |returndesc = TRUE, if the flag is set, or FALSE | ||
| + | |sourcemodule = | ||
| + | |sourcefile = script.ldf | ||
}} | }} | ||
| Line 24: | Line 32: | ||
<!-- 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. --> | ||
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. | 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 == | |
| − | + | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| + | [[OBJECT_INVALID keyword|OBJECT_INVALID]] is valid for the '''oParty''' parameter (see [[GetParty]]). | ||
| + | The plot's GUID and ResRef are both valid for the '''strPlot''' parameter. | ||
<!-- == Examples == --> | <!-- == Examples == --> | ||
<!-- This section contains examples transcluded from the snippet library. --> | <!-- This section contains examples transcluded from the snippet library. --> | ||
| − | |||
== See also == | == See also == | ||
<!-- This section contains links to articles, functions or constant groups. --> | <!-- This section contains links to articles, functions or constant groups. --> | ||
| − | [[SetPartyPlotFlag | + | [[SetPartyPlotFlag]] |
[[Category: Plot manager functions]] | [[Category: Plot manager functions]] | ||
Latest revision as of 22:26, 6 August 2011
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.
