Difference between revisions of "WR GetPlotFlag"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(Created page with '{{dafunction |name = WR_GetPlotFlag |brief = Returns the value of a plot flag, optionally running the plot event script |param1type = string |param1name = strPlot |param1desc =...')
 
m (Fixing source)
 
Line 1: Line 1:
 
{{dafunction
 
{{dafunction
|name = WR_GetPlotFlag
+
|name         = WR_GetPlotFlag
|brief = Returns the value of a plot flag, optionally running the plot event script
+
|brief         = Returns the value of a plot flag, optionally running the plot event script
|param1type = string  
+
|param1type   = string  
|param1name = strPlot  
+
|param1name   = strPlot  
|param1desc = name of the plot
+
|param1desc   = name of the plot
 
|param1default =
 
|param1default =
|param2type = int  
+
|param2type   = int  
|param2name = nFlag  
+
|param2name   = nFlag  
|param2desc = which flag in the plot to get the value of
+
|param2desc   = which flag in the plot to get the value of
 
|param2default =
 
|param2default =
|param3type = int
+
|param3type   = int
|param3name = nCallScript
+
|param3name   = nCallScript
|param3desc = whether to call the event script associated with this plot
+
|param3desc   = whether to call the event script associated with this plot
|param3default =FALSE
+
|param3default = FALSE
 
+
|returntype   = int
|returntype = int
+
|returndesc   = the value of the plot flag
|returndesc = the value of the plot flag
+
|sourcefile   = wrappers_h
|sourcefile = wrappers_h
+
|sourcemodule = Core Game Resources
|sourcemodule = Core Resources
+
 
}}
 
}}
 
 
<!-- == 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. -->
 
 
<!-- == Remarks == -->
 
<!-- == Remarks == -->
 
<!-- This section contains additional comments, observations and known issues. -->
 
<!-- This section contains additional comments, observations and known issues. -->
 
 
<!-- == 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. -->
  
 
[[Category:Plot manager functions]]
 
[[Category:Plot manager functions]]

Latest revision as of 14:06, 27 March 2012

Returns the value of a plot flag, optionally running the plot event script

int WR_GetPlotFlag(
string strPlot,
int nFlag,
int nCallScript = FALSE
);
Parameters:
strPlot
name of the plot
nFlag
which flag in the plot to get the value of
nCallScript
whether to call the event script associated with this plot
Returns:

the value of the plot flag

Source:

Core Game Resources.wrappers_h