Plot - Revision history

Proleric1 at 19:11, 19 November 2010

2010-11-19T19:11:21Z

Sunjammer: Applied Languages template

2010-10-26T12:28:59Z

Applied Languages template

Kelamor: Add links for other language

2010-10-24T23:45:52Z

Add links for other language

Proleric1: /* Plot event scripts */

2010-10-22T10:39:27Z

‎Plot event scripts

Proleric1: /* Codex */

2010-07-04T18:02:28Z

‎Codex

Proleric1: /* Parent-Child Plots */

2010-04-21T12:31:12Z

‎Parent-Child Plots

Proleric1: /* Parent-Child Plots */

2010-04-21T12:27:59Z

‎Parent-Child Plots

Proleric1: /* Granting rewards via plots */

2010-04-21T12:18:39Z

‎Granting rewards via plots

Proleric1: /* Granting rewards via plots */

2010-03-21T10:10:07Z

‎Granting rewards via plots

Proleric1: /* Granting rewards via plots */

2010-03-21T10:03:30Z

‎Granting rewards via plots

@@ Line 182: / Line 182: @@
 However, if you need to update the parent journal as soon as all child plots are complete (so that it reads "I found a lemon and a duck, now go to the kitchen and make soup"), there is an important nuance - when a plot flag is set, its script is called BEFORE the flag receives its new value.
 So, in the plot script for "lemon", you need something like
@@ Line 196: / Line 198: @@
                if (nValue)
+                 {
-                    if (WR_GetPlotFlag(PLT_DUCK, DUCK_FOUND))
+                   // Force the plot flag to be set first
                       WR_SetPlotFlag(PLT_SOUP, SOUP_INGREDIENTS_FOUND, 1, TRUE);
+                 }
                break;

@@ Line 1: / Line 1: @@
 {| style="float:right;"
 |-
@@ Line 228: / Line 223: @@
 {{inspector row|Script| Event script assigned to the resource. }}
 {{inspector end}}
 [[Category:Plots]]

← Older revision		Revision as of 23:45, 24 October 2010
Line 1:		Line 1:
		+	<includeonly>{{K-langs:{{{enname\|}}}}}</includeonly><noinclude>{{K-langs:H:f Plot}}
		+	*Перевод: Kelamor / [mailto:kelamor@inbox.ru Почта] / [[User:Kelamor\|Переводы]]
		+	----------------
		+
		+
	{\| style="float:right;"		{\| style="float:right;"
	\|-		\|-

@@ Line 88: / Line 88: @@
 To use a plot event script:
-* create a script e.g. "kill_all_wolves.ncs"
+* create a script e.g. "kill_all_wolves.ncs" by editing a copy of the default script (plot_core).
 * On your plot in the property inspector (bottom right of toolset) make sure to assign your script to your plot (instead of the default ''plot_core'')
 * Set or get a plot flag, making sure to set the last parameter (nCallScript) to TRUE (see [[WR_GetPlotFlag]] and [[WR_SetPlotFlag]]
@@ Line 99: / Line 99: @@
 '''Important:''' Notice the last parameter '''TRUE'''. This parameter '''must''' be set to TRUE to have the function also call the plot script!
 == Plot assist markers ==

← Older revision		Revision as of 18:02, 4 July 2010
Line 50:		Line 50:

	An easy way to make other codex entries appear in game is to use a placeable which has an Examinable appearance. Set the PLC_CODEX_PLOT and PLC_CODEX_FLAG variables to the text you want to appear in the codex when the player examines the placeable.		An easy way to make other codex entries appear in game is to use a placeable which has an Examinable appearance. Set the PLC_CODEX_PLOT and PLC_CODEX_FLAG variables to the text you want to appear in the codex when the player examines the placeable.
		+
		+	Items can generate a codex entry on acquisition. The item's ITEM_SEND_ACQUIRED_EVENT variable must be set to 1. The item tag is set to the codex plot name (e.g. cod_bks_dalish_history). The ITEM_CODEX_FLAG variable identifies the main flag within that plot which corresponds to the codex text to be displayed. The default module_core script destroys the item after the codex entry is generated.

	== Story Plot ==		== Story Plot ==

@@ Line 200: / Line 200: @@
 </dascript>
-whereas in the plot script for "duck" you need the converse.
+whereas in the plot script for "duck" you need the converse. In this instance, checking that both flags are set will fail, because one of them is not yet set at the time the script executes.
 Of course, unless you make the items "plot" or "indestructable", you might need additional checks to confirm that the player still has the items when the time comes to use them. That's yet another alternative to synchronising the journals.

@@ Line 150: / Line 150: @@
 It's only a matter of presentation in the journal - you set the parent and child plot flags independently.
-You may not need to synchronise them, either - in our example, it may be acceptable that the parent journal still says "I need to find a lemon and a duck, then make soup" after the child journals both say "I found x", until the soup is actually made.
+You might not need to synchronise them, either - in our example, it may be acceptable that the parent journal still says "I need to find a lemon and a duck, then make soup" after the child journals both say "I found x", until the soup is actually made.
 However, if you need to update the parent journal as soon as all child plots are complete (so that it reads "I found a lemon and a duck, now go to the kitchen and make soup"), there is an important nuance - when a plot flag is set, its script is called BEFORE the flag receives its new value.
@@ Line 159: / Line 182: @@
 <dascript>
-     int nFlag  = GetEventInteger(eParms, 1); // Plot flag
+    event eParms = GetCurrentEvent();
-     int nValue = GetEventInteger(eParms, 2); // 0=Clear 1=Set
+     int   nFlag  = GetEventInteger(eParms, 1); // Plot flag
        switch(nFlag)
@@ Line 171: / Line 195: @@
                       WR_SetPlotFlag(PLT_SOUP, SOUP_INGREDIENTS_FOUND, 1, TRUE);
+                 }
+             }
+         }

← Older revision		Revision as of 12:18, 21 April 2010
Line 135:		Line 135:

	If you are making a new campaign, you may prefer to override rewards.xls entirely, since the default contents refer to the official campaign plots. Alternatively, you can make an M2DA if you just want to add to the official rewards.		If you are making a new campaign, you may prefer to override rewards.xls entirely, since the default contents refer to the official campaign plots. Alternatively, you can make an M2DA if you just want to add to the official rewards.
		+
		+	== Parent-Child Plots ==
		+
		+	Sometimes, plots have independent sub-plots which can happen in any order.
		+
		+	For example, "find a lemon and a duck, then make soup in the kitchen".
		+
		+	We might want to update the journal when the lemon or the duck is found.
		+
		+	This is simply achieved by defining three plots: the parent plot ("soup") and two child plots ("lemon" and "duck").
		+
		+	The relationship is established simply by setting the Parent Plot property of the child plot.
		+
		+	It's only a matter of presentation in the journal - you set the parent and child plot flags independently.
		+
		+	You may not need to synchronise them, either - in our example, it may be acceptable that the parent journal still says "I need to find a lemon and a duck, then make soup" after the child journals both say "I found x", until the soup is actually made.
		+
		+	In that case, it's sufficient to have a Defined Flag on the parent which checks whether both child plots are complete when we try to make soup in the kitchen.
		+
		+	However, if you need to update the parent journal as soon as all child plots are complete (so that it reads "I found a lemon and a duck, now go to the kitchen and make soup"), there is an important nuance - when a plot flag is set, its script is called BEFORE the flag receives its new value.
		+
		+	So, in the plot script for "lemon", you need something like
		+
		+	<dascript>
		+	int nFlag = GetEventInteger(eParms, 1); // Plot flag
		+	int nValue = GetEventInteger(eParms, 2); // 0=Clear 1=Set
		+
		+	switch(nFlag)
		+	{
		+	case LEMON_FOUND:
		+	{
		+	if (nValue)
		+	{
		+	if (WR_GetPlotFlag(PLT_DUCK, DUCK_FOUND))
		+	WR_SetPlotFlag(PLT_SOUP, SOUP_INGREDIENTS_FOUND, 1, TRUE);
		+	}
		+	}
		+	}
		+	</dascript>
		+
		+	whereas in the plot script for "duck" you need the converse.
		+
		+	Of course, unless you make the items "plot" or "indestructable", you might need additional checks to confirm that the player still has the items when the time comes to use them. That's yet another alternative to synchronising the journals.

	== Properties ==		== Properties ==

← Older revision		Revision as of 10:10, 21 March 2010
Line 133:		Line 133:

	This is a simple and powerful mechanism for giving the player XP, money, items or a combination thereof.		This is a simple and powerful mechanism for giving the player XP, money, items or a combination thereof.
		+
		+	If you are making a new campaign, you may prefer to override rewards.xls entirely, since the default contents refer to the official campaign plots. Alternatively, you can make an M2DA if you just want to add to the official rewards.

	== Properties ==		== Properties ==

← Older revision		Revision as of 10:03, 21 March 2010
Line 129:		Line 129:

	Each plot flag can have a reward associated with it, picked from a list defined by the [[rewards.xls]] [[2DA]]. This reward is given to the player when the plot flag is set.		Each plot flag can have a reward associated with it, picked from a list defined by the [[rewards.xls]] [[2DA]]. This reward is given to the player when the plot flag is set.
		+
		+	Once your rewards.GDA is in your export folder, it becomes available to plots when you next start the toolset.
		+
		+	This is a simple and powerful mechanism for giving the player XP, money, items or a combination thereof.

	== Properties ==		== Properties ==