Trigger - Revision history

Sunjammer: /* Trigger Scripts */ applying syntax highlighting

2012-03-11T16:43:11Z

‎Trigger Scripts: applying syntax highlighting

Kelamor: Add language bar

2011-12-26T09:54:04Z

Add language bar

Sunjammer: Fixing image

2011-08-10T21:51:06Z

Fixing image

Proleric1: /* Trigger Scripts */

2010-09-05T06:36:49Z

‎Trigger Scripts

BryanDerksen: {{Infobox area}}

2010-02-03T18:08:47Z

BryanDerksen: {{Resource palette}}

2010-01-25T18:29:42Z

Challseus: Changed the TRIG_TALK_SPEAKER type from int to string.

2009-12-31T01:50:11Z

Changed the TRIG_TALK_SPEAKER type from int to string.

BryanDerksen: /* Variables */ more variable tables

2009-08-20T16:13:55Z

‎Variables: more variable tables

BryanDerksen: /* Talk triggers */ variable table formatting

2009-08-20T16:01:09Z

‎Talk triggers: variable table formatting

BryanDerksen at 15:58, 20 August 2009

2009-08-20T15:58:21Z

@@ Line 32: / Line 32: @@
 == Trigger Scripts ==
-Any other functionality for a trigger must be put in a script manually. The trigger_core.nss script (which may change) in the _Core Scripts directory is a good template for such a script.
+Any other functionality for a trigger must be put in a script manually. The trigger_core.nss script (which may change) in the '''_Core Scripts''' directory is a good template for such a script.
-Without any modifications this script performs the area transition. The code to do so is in a switch statement that looks for the event matching the predefined constant EVENT_TYPE_ENTER.
+Without any modifications this script performs the area transition. The code to do so is in a switch statement that looks for the event matching the predefined constant [[EVENT_TYPE_ENTER]].
 Note that there is an if statement in here that checks to see if it was the player who set off the trigger, (it also checks to see if there was an area transition tag set). If you want to have the trigger do something only when the player enters it you should do a similar check, otherwise it will activate whenever any creature enters.
@@ Line 40: / Line 40: @@
 Example: Have a cutscene play, but only the first time the player enters the trigger.
-<pre>
+<dascript>
- if(IsPartyMember(oCreature)) {
+    if(IsPartyMember(oCreature))
-  resource rCutscene = R"mycutscene.cut";
-  LoadCutscene(rCutscene);
+      resource rCutscene = R"mycutscene.cut";
-  PlayCutscene(oCreature);
+      LoadCutscene(rCutscene);
-  DestroyObject(OBJECT_SELF, 0);
+      PlayCutscene(oCreature);
+      DestroyObject(OBJECT_SELF, 0);
-</pre>
+</dascript>
-Comment : originally, the above example used a function called IsPlayer, which doesn't seem to exist.
 If you do create a custom trigger script you should call the following after the switch statement:
-<pre>
+<dascript>
- HandleEvent(ev, RESOURCE_SCRIPT_TRIGGER_CORE);
+    HandleEvent(ev, RESOURCE_SCRIPT_TRIGGER_CORE);
-</pre>
+</dascript>
 This ensures that anything your custom script doesn't process still gets processed correctly by the default script.
-Once you have created your script, click on the "script" field of the attributes of the trigger, and then choose your script from the ellipsis ([[Image:ellipsis.png]]) browser.
+Once you have created your script, click on the "script" field of the attributes of the trigger, and then choose your script from the ellipsis ([[Image:ellipsis.png|link=]]) browser.
-Note that triggers don’t behave as expected when you use "SetObjectActive(OBJECT_SELF, FALSE)" on them.  This function sets the trigger to inactive, but the trigger will still fire when inactive.  So any trigger script that needs to account for whether the trigger is active should be surrounded by an "if(GetObjectActive(OBJECT_SELF))" statement to explicitly test whether it should fire. Alternately, if the trigger is never intended to fire again, use DestroyObject(OBJECT_SELF, 0); instead of setting it inactive.
+Note that triggers do not behave as expected when you use <code>SetObjectActive(OBJECT_SELF, FALSE);</code>.  This function sets the trigger to inactive, but the trigger will still fire when inactive.  Therefore any trigger script that needs to account for whether the trigger is active should be surrounded by an <code>if(GetObjectActive(OBJECT_SELF))</code> statement to explicitly test whether it should fire. Alternately, if the trigger is never intended to fire again, use <code>DestroyObject(OBJECT_SELF, 0);</code> instead of setting it inactive.
 == Traps ==

← Older revision		Revision as of 09:54, 26 December 2011
Line 131:		Line 131:
	{{inspector end}}		{{inspector end}}

		+	{{languages}}
	[[Category:Triggers]]		[[Category:Triggers]]

@@ Line 22: / Line 22: @@
 == Area Transitions ==
-To make a trigger into an area transition, right click on trigger in the module tree view and choose Open Resource. You will need to check it out to modify it, if you haven't already. Select the Variable field in the Attributes section and click on the elipses ([[Image:ellipsis.png]]) icon on the right side.
+To make a trigger into an area transition, right click on trigger in the module tree view and choose Open Resource. You will need to check it out to modify it, if you haven't already. Select the Variable field in the Attributes section and click on the elipses ([[Image:ellipsis.png|link=]]) icon on the right side.
 The variables we need are:

@@ Line 41: / Line 41: @@
 <pre>
-  if(IsPlayer(oCreature)) {
+  if(IsPartyMember(oCreature)) {
    resource rCutscene = R"mycutscene.cut";
    LoadCutscene(rCutscene);
@@ Line 48: / Line 48: @@
+  }
 </pre>
 If you do create a custom trigger script you should call the following after the switch statement:

← Older revision		Revision as of 18:08, 3 February 2010
Line 1:		Line 1:
−	{{Resource palette}}	+	{\| style="float:right;"
		+	\|-
		+	\| {{Resource palette}}
		+	\|-
		+	\| {{Infobox area}}
		+	\|}

	Triggers are polygonal shapes painted onto areas that receive an event when a creature enters or exits it, which generally is then processed by a script to perform some action.		Triggers are polygonal shapes painted onto areas that receive an event when a creature enters or exits it, which generally is then processed by a script to perform some action.

← Older revision		Revision as of 18:29, 25 January 2010
Line 1:		Line 1:
		+	{{Resource palette}}
		+
	Triggers are polygonal shapes painted onto areas that receive an event when a creature enters or exits it, which generally is then processed by a script to perform some action.		Triggers are polygonal shapes painted onto areas that receive an event when a creature enters or exits it, which generally is then processed by a script to perform some action.

@@ Line 76: / Line 76: @@
 {{Variable table row|TRIG_TALK_SET_FLAG and FLAG2 | int || sets the plot and flag when triggered, works with TRIG_TALK_SET_PLOT }}
 {{Variable table row|TRIG_TALK_SET_PLOT and PLOT2 | string || sets the plot and flag when triggered, works with TRIG_TALK_SET_FLAG }}
-{{Variable table row|TRIG_TALK_SPEAKER | int || NPC initiating the dialog - this is the only mandatory field }}
+{{Variable table row|TRIG_TALK_SPEAKER | string || NPC initiating the dialog - this is the only mandatory field }}
 {{Variable table end}}

@@ Line 83: / Line 83: @@
 The following set of variables are available if you're using the basic var_trigger 2da:
-{| border="1"
+{{variable table start}}
-|-
+{{Variable table row|TRIGGER_ACTIVATE_TEAM_HELP | int || Activates team-help system on a team of creatures using            SetLocalVarOnTeam(oCreature, TRIGGER_ACTIVATE_TEAM_HELP, AI_HELP_TEAM_STATUS, 1); }}
-|TRIGGER_ACTIVATE_TEAM_HELP || int || Activates team-help system on a team of creatures using            SetLocalVarOnTeam(oCreature, TRIGGER_ACTIVATE_TEAM_HELP, AI_HELP_TEAM_STATUS, 1);
+{{Variable table row|TRIGGER_ACTIVATE_TEAM_STATIONARY_HARD | int || Activates a team to be stationary (AI system) using SetLocalVarOnTeam(oCreature, TRIGGER_ACTIVATE_TEAM_STATIONARY_HARD, AI_FLAG_STATIONARY, 2); }}
-|-
+{{Variable table row|TRIGGER_ACTIVATE_TEAM_STATIONARY_SOFT | int || Activates a team to be stationary (AI system) using SetLocalVarOnTeam(oCreature, TRIGGER_ACTIVATE_TEAM_STATIONARY_SOFT, AI_FLAG_STATIONARY, 1); }}
-|TRIGGER_ACTIVATE_TEAM_STATIONARY_HARD || int || Activates a team to be stationary (AI system) using SetLocalVarOnTeam(oCreature, TRIGGER_ACTIVATE_TEAM_STATIONARY_HARD, AI_FLAG_STATIONARY, 2);
+{{Variable table row|TRIGGER_AT_DEST_AREA_TAG | string || The tag of the area that this trigger sends the player to (area transition) }}
-|-
+{{Variable table row|TRIGGER_AT_DEST_TAG | string || The tag of the waypoint within the destination area this trigger sends the player to (area transition) }}
-|TRIGGER_ACTIVATE_TEAM_STATIONARY_SOFT || int || Activates a team to be stationary (AI system) using SetLocalVarOnTeam(oCreature, TRIGGER_ACTIVATE_TEAM_STATIONARY_SOFT, AI_FLAG_STATIONARY, 1);
+{{Variable table row|TRIGGER_COUNTER_1 to 3 | int || }}
-|-
+{{Variable table row|TRIGGER_DO_ONCE_A and B | int || }}
-|TRIGGER_AT_DEST_AREA_TAG || string || The tag of the area that this trigger sends the player to (area transition)
+{{Variable table row|TRIGGER_ENCOUNTER_TEAM | int | | }}
-|-
+{{Variable table row|TRIGGER_PARTY_TRIGGER_LOCATION | int || }}
-|TRIGGER_AT_DEST_TAG || string || The tag of the waypoint within the destination area this trigger sends the player to (area transition)
+{{Variable table row|TRIGGER_ROOM_TEXT | int || }}
-|-
+{{Variable table end}}
-|TRIGGER_COUNTER_1 to 3 || int ||
-|-
-|TRIGGER_DO_ONCE_A and B || int ||
-|-
-|TRIGGER_ENCOUNTER_TEAM || int ||
-|-
-|TRIGGER_PARTY_TRIGGER_LOCATION || int ||
-|-
-|TRIGGER_ROOM_TEXT || int ||
-|}
 These are in the var_trigger_ambient 2da, for use with the gentr_ambient.nss script:
-{| border="1"
+{{Variable table start}}
-|-
+{{Variable table row|AMBIENT_ANIM_FREQ_OVERRIDE | float || If non-zero, takes precedence over AMBIENT_ANIM_FREQ value set on the creature's template. Format is a float (x.y) to play a random number of animations between x and y. Specify -1.0 to play all animations (in order) listed in [[ambient_ai.xls]]. }}
-|AMBIENT_ANIM_FREQ_OVERRIDE || float || If non-zero, takes precedence over AMBIENT_ANIM_FREQ value set on the creature's template. Format is a float (x.y) to play a random number of animations between x and y. Specify -1.0 to play all animations (in order) listed in ambient_ai.xls.
+{{Variable table row|AMBIENT_ANIM_OVERRIDE_COUNT | int || Number of times the overridden animation pattern is used before the original is restored. Default = -1 (i.e. no countdown) }}
-|-
+{{Variable table row|AMBIENT_ANIM_PATTERN_OVERRIDE | int || Index into ambient_ai.xls. If non-zero, this value takes precedence over the AMBIENT_ANIM_PATTERN value set on the creature's template. }}
-|AMBIENT_ANIM_OVERRIDE_COUNT || int || Number of times the overridden animation pattern is used before the original is restored. Default = -1 (i.e. no countdown)
+{{Variable table row|AMBIENT_TARGET_FILTER | string || The creature entering or in the trigger will have its ambient behaviour overridden if its tag appears somewhere in this comma-separated list. }}
-|-
+{{Variable table row|AMBIENT_TRIGGER_FILTER | string || The ambient behaviour of the target creature will be overridden when a creature with a tag somewhere in this coma-separated list enters the trigger. Use <hero> to specify the player. Will default to AMBIENT_TARGET_FILTER if blank. }}
-|AMBIENT_ANIM_PATTERN_OVERRIDE || int || Index into ambient_ai.xls. If non-zero, this value takes precedence over the AMBIENT_ANIM_PATTERN value set on the creature's template.
+{{Variable table end}}
-|-
-|AMBIENT_TARGET_FILTER || string || The creature entering or in the trigger will have its ambient behaviour overridden if its tag appears somewhere in this comma-separated list.
-|-
-|AMBIENT_TRIGGER_FILTER ||string || The ambient behaviour of the target creature will be overridden when a creature with a tag somewhere in this coma-separated list enters the trigger. Use <hero> to specify the player. Will default to AMBIENT_TARGET_FILTER if blank.
-|}
 == Properties ==

@@ Line 66: / Line 66: @@
 The following set of variables are available in the var_trigger_talk variable 2da:
-{| border="1"
+{{Variable table start}}
-|-
+{{Variable table row|TRIG_TALK_ACTIVE_FOR_FLAG | int || triggers only if a specific plot/flag is active - works with TRIG_TALK_ACTIVE_FOR_PLOT }}
-|TRIG_TALK_ACTIVE_FOR_FLAG || int || triggers only if a specific plot/flag is active - works with TRIG_TALK_ACTIVE_FOR_PLOT
+{{Variable table row|TRIG_TALK_ACTIVE_FOR_PLOT | string || triggers only if a specific plot/flag is active - works with TRIG_TALK_ACTIVE_FOR_FLAG }}
-|-
+{{Variable table row|TRIG_TALK_DIALOG_OVERRIDE | resource || a dialog file to override the default one for the NPC. Type it in the format of "gen000_example.dlg" (without the quotes) }}
-|TRIG_TALK_ACTIVE_FOR_PLOT || string || triggers only if a specific plot/flag is active - works with TRIG_TALK_ACTIVE_FOR_FLAG
+{{Variable table row|TRIG_TALK_INACTIVE_FOR_FLAG and FLAG2 | int || triggers only if a specific plot/flag is inactive - works with TRIG_TALK_ACTIVE_FOR_PLOT }}
-|-
+{{Variable table row|TRIG_TALK_INACTIVE_FOR_PLOT and PLOT2 | string || triggers only if a specific plot/flag is inactive - works with TRIG_TALK_ACTIVE_FOR_FLAG }}
-|TRIG_TALK_DIALOG_OVERRIDE || resource || a dialog file to override the default one for the NPC. Type it in the format of "gen000_example.dlg" (without the quotes)
+{{Variable table row|TRIG_TALK_LISTENER | string || a string for an NPC listener. Should be used for ambient conversations }}
-|-
+{{Variable table row|TRIG_TALK_REPEAT | int || 1 so the trigger can re-fire, 0 - the trigger fires only once }}
-|TRIG_TALK_INACTIVE_FOR_FLAG and FLAG2 || int || triggers only if a specific plot/flag is inactive - works with TRIG_TALK_ACTIVE_FOR_PLOT
+{{Variable table row|TRIG_TALK_SET_FLAG and FLAG2 | int || sets the plot and flag when triggered, works with TRIG_TALK_SET_PLOT }}
-|-
+{{Variable table row|TRIG_TALK_SET_PLOT and PLOT2 | string || sets the plot and flag when triggered, works with TRIG_TALK_SET_FLAG }}
-|TRIG_TALK_INACTIVE_FOR_PLOT and PLOT2 || string || triggers only if a specific plot/flag is inactive - works with TRIG_TALK_ACTIVE_FOR_FLAG
+{{Variable table row|TRIG_TALK_SPEAKER | int || NPC initiating the dialog - this is the only mandatory field }}
-|-
+{{Variable table end}}
-|TRIG_TALK_LISTENER || string || a string for an NPC listener. Should be used for ambient conversations
-|-
-|TRIG_TALK_REPEAT || int || 1 so the trigger can re-fire, 0 - the trigger fires only once
-|-
-|TRIG_TALK_SET_FLAG and FLAG2 || int || sets the plot and flag when triggered, works with TRIG_TALK_SET_PLOT
-|-
-|TRIG_TALK_SET_PLOT and PLOT2 || string || sets the plot and flag when triggered, works with TRIG_TALK_SET_FLAG
-|-
-|TRIG_TALK_SPEAKER || int || NPC initiating the dialog - this is the only mandatory field
-|}
 == Variables ==

← Older revision		Revision as of 15:58, 20 August 2009
Line 146:		Line 146:
	{{inspector row\|Variables\| Displays the table selected in the variable 2da field. Allows initial values to be defined. }}		{{inspector row\|Variables\| Displays the table selected in the variable 2da field. Allows initial values to be defined. }}
	{{inspector end}}		{{inspector end}}
		+
		+	[[Category:Triggers]]