Difference between revisions of "EVENT TYPE GET PLOT"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(split out of event)
 
(formatting)
Line 1: Line 1:
*<b>Sent When:</b> A plot is setting a plot flag
+
{{event
*<b>Sent From:</b> engine
+
|when= A plot is setting a plot flag
*<b>Sent To:</b> plot script
+
|from= [[engine]]
 
+
|to= plot script
Parameters:
+
|creatorname = oPlayer
*<b>Creator:</b> owner of the plot table, should be a player
+
|creatordesc = owner of the plot table, should be a player
*<b>String 0:</b> plot GUID, defined as string constants
+
|string0name = sPlotGUID
*<b>Int 1:</b> bit flag number being affected
+
|string0desc= plot GUID, defined as string constants
*<b>Int 4:</b> 1 if the current flag (Int 1) is defined, 0 for normal flag.
+
|int1name= nFlagAffected
 +
|int1desc= bit flag number being affected
 +
|int4name= nDefined
 +
|int4desc= 1 if the current flag (Int 1) is defined, 0 for normal flag.
 +
}}
  
 
[[Category:Event types|GET_PLOT]]
 
[[Category:Event types|GET_PLOT]]
 
[[Category:Plots]]
 
[[Category:Plots]]

Revision as of 18:02, 24 July 2009

Source:
[Undocumented]
Sent when:
A plot is setting a plot flag
Sent from:
engine
Sent to:
plot script
Parameters:
  • Creator: owner of the plot table, should be a player
  • Integer 1: bit flag number being affected
  • Integer 4: 1 if the current flag (Int 1) is defined, 0 for normal flag.
  • String 0: plot GUID, defined as string constants

Usage

case EVENT_TYPE_GET_PLOT:
{
object oPlayer = GetEventCreator(ev); // owner of the plot table, should be a player
int nFlagAffected = GetEventInteger(ev, 1); // bit flag number being affected
int nDefined = GetEventInteger(ev, 4); // 1 if the current flag (Int 1) is defined, 0 for normal flag.
string sPlotGUID = GetEventString(ev, 0); // plot GUID, defined as string constants

// insert event-handling code here

break;
}