Objectives Editor - Revision history

Geep: // Add: Determining an Objective's Current State from a Script

2023-12-15T17:22:56Z

// Add: Determining an Objective's Current State from a Script

← Older revision		Revision as of 17:22, 15 December 2023
Line 355:		Line 355:

	'''NOTE''': You must make the brush for the info_tdm_objective_location '''large'''! I have had this objective completely fail when using a vaguely player-sized brush. Expanding the brush to fill the entire room made the objective work.		'''NOTE''': You must make the brush for the info_tdm_objective_location '''large'''! I have had this objective completely fail when using a vaguely player-sized brush. Expanding the brush to fill the entire room made the objective work.

			=== Determining an Objective's Current State from a Script ===
			''Adapted by Geep from discussion [https://forums.thedarkmod.com/index.php?/topic/9082-newbie-darkradiant-questions/&do=findComment&comment=490299 here].''

			This is easy. Suppose you have already created an objective "Have at least 1000 in loot", which happens to be item #3 in your objectives list. You want to know, when a particular script function is called, if the objective was satisfied. Begin your script with, e.g.:

			#define OBJECTIVE_TOTAL_LOOT 3
			// WARNING: IF OBJECTIVE NUMBER OF "Have at least 1000 in loot " CHANGES, IT MUST BE CHANGED HERE TOO!

			You could also #define the possible states: OBJ_INCOMPLETE = 0, OBJ_COMPLETE = 1, OBJ_INVALID = 2, OBJ_FAILED = 3

			Using #defines is optional. You can just directly hardcode the numbers. But assuming the #defines, then add:

			float objstate = $player1.getObjectiveState(OBJECTIVE_TOTAL_LOOT);

			if(objstate == OBJ_COMPLETE) {
			...
			}

	== Troubleshooting ==		== Troubleshooting ==

Datiswous: /* An Objective to place an object in a Certain Location */

2023-01-02T23:34:35Z

An Objective to place an object in a Certain Location

← Older revision		Revision as of 23:34, 2 January 2023
Line 300:		Line 300:
	* This creates a default Kill objective. Select it. Click the Edit button.		* This creates a default Kill objective. Select it. Click the Edit button.
	* Just below it click the Type bar and from the list that show select 'Item is in location' ('''NOT''' Item is in '''info'''_location!!)		* Just below it click the Type bar and from the list that show select 'Item is in location' ('''NOT''' Item is in '''info'''_location!!)
	* Further down click the bar below 'Entity' and select 'Name of single entity' ('''NOTE:''' If the entity is the player, use the entity setup described in [[Objectives_Editor#The_standard_~~%22exit_here_when_you~~'re_done_objective~~%22~~\|standard exit objective]] instead of the below steps)		* Further down click the bar below 'Entity' and select 'Name of single entity' ('''NOTE:''' If the entity is the player, use the entity setup described in [[Objectives_Editor#The_standard_"exit_here_when_you're_done_objective"\|standard exit objective]] instead of the below steps)
	* On the right of that type or paste in the name of the object (eg ragdoll) entity eg, JakesCorpse		* On the right of that type or paste in the name of the object (eg ragdoll) entity eg, JakesCorpse
	* Below, click the bar below Location and select 'Name of single entity'		* Below, click the bar below Location and select 'Name of single entity'

Frost Salamander: Add reference to player entity setup in object placement section

2022-12-28T00:39:43Z

Add reference to player entity setup in object placement section

← Older revision		Revision as of 00:39, 28 December 2022
Line 300:		Line 300:
	* This creates a default Kill objective. Select it. Click the Edit button.		* This creates a default Kill objective. Select it. Click the Edit button.
	* Just below it click the Type bar and from the list that show select 'Item is in location' ('''NOT''' Item is in '''info'''_location!!)		* Just below it click the Type bar and from the list that show select 'Item is in location' ('''NOT''' Item is in '''info'''_location!!)
	* Further down click the bar below 'Entity' and select 'Name of single entity'		* Further down click the bar below 'Entity' and select 'Name of single entity' ('''NOTE:''' If the entity is the player, use the entity setup described in [[Objectives_Editor#The_standard_%22exit_here_when_you're_done_objective%22\|standard exit objective]] instead of the below steps)
	* On the right of that type or paste in the name of the object (eg ragdoll) entity eg, JakesCorpse		* On the right of that type or paste in the name of the object (eg ragdoll) entity eg, JakesCorpse
	* Below, click the bar below Location and select 'Name of single entity'		* Below, click the bar below Location and select 'Name of single entity'

Frost Salamander: add missing comma

2022-07-23T12:55:12Z

add missing comma

← Older revision		Revision as of 12:55, 23 July 2022
Line 331:		Line 331:
	* AI from opposing teams getting into a fight and one of them dies		* AI from opposing teams getting into a fight and one of them dies

	To prevent this, set up the objective to specify AI teams, don't use the boolean NOT, tick 'Player responsible' and use the failure logic. The following example will fail a mission if the player kills guards, commoners neutrals:		To prevent this, set up the objective to specify AI teams, don't use the boolean NOT, tick 'Player responsible' and use the failure logic. The following example will fail a mission if the player kills guards, commoners or neutrals:
	[[File:ObjectiveNoKillExample.png\|thumb\|left\|screenshot of an example no kill objective]]		[[File:ObjectiveNoKillExample.png\|thumb\|left\|screenshot of an example no kill objective]]
	{{clear}}		{{clear}}

Frost Salamander: add section for example no-kill objective that avoids accidental deaths

2022-07-23T12:51:35Z

add section for example no-kill objective that avoids accidental deaths

← Older revision		Revision as of 12:51, 23 July 2022
Line 325:		Line 325:

	'''Important''': No kill objectives need be set as "Satisfied at Game Start" and "ongoing" or they will not work!		'''Important''': No kill objectives need be set as "Satisfied at Game Start" and "ongoing" or they will not work!

			=== Avoiding Unintentional or Accidental Deaths Failing 'No-Kill' Objectives ===
			A common requirement is the player shouldn't intentionally kill any human AI (guards, commoners, etc). If that is your intention, the method described above will fail under other circumstances, such as:
			* the player killing a rat, or a rat falling out of a window and dying
			* AI from opposing teams getting into a fight and one of them dies

			To prevent this, set up the objective to specify AI teams, don't use the boolean NOT, tick 'Player responsible' and use the failure logic. The following example will fail a mission if the player kills guards, commoners neutrals:
			[[File:ObjectiveNoKillExample.png\|thumb\|left\|screenshot of an example no kill objective]]
			{{clear}}

	=== Using Objectives to trigger things ===		=== Using Objectives to trigger things ===

Frost Salamander: update how to count loot

2022-07-07T20:35:47Z

update how to count loot

← Older revision		Revision as of 20:35, 7 July 2022
Line 316:		Line 316:
	Use the "overall (component specific)" option of "Player possesses item" for loot.		Use the "overall (component specific)" option of "Player possesses item" for loot.

	How do you find out how much loot is in your map? ~~The easiest way is to set up an easy objective to lead to mission success. On~~ the ~~Mission Statistics screen, it will list your loot total~~.		How do you find out how much loot is in your map? With your map open in DarkRadiant, select Scripts -> Count Loot from the menu.

	=== Optional 'No alerts', KO's, and Kills ===		=== Optional 'No alerts', KO's, and Kills ===

Thebigh: /* Leak caused by Objectives Entity */ -grammar

2022-01-07T06:09:08Z

Leak caused by Objectives Entity: -grammar

← Older revision		Revision as of 06:09, 7 January 2022
Line 206:		Line 206:

	;*Help! My objectives entity is outside the map and I have a leak! I can't find it! I even used the pointfile!! help!!!!		;*Help! My objectives entity is outside the map and I have a leak! I can't find it! I even used the pointfile!! help!!!!
	: Answer: The objectives entity is a very small, yellow cube that is spawned around the origin. ~~Its~~ about the size of a light entity.		: Answer: The objectives entity is a very small, yellow cube that is spawned around the origin. It's about the size of a light entity.


	===How to directly trigger an objective or component to complete===		===How to directly trigger an objective or component to complete===

Geep: /* An Objective to place an object in a Certain Location */

2020-11-13T19:53:15Z

An Objective to place an object in a Certain Location

← Older revision		Revision as of 19:53, 13 November 2020
Line 307:		Line 307:
	* Click the OK button and OK again and save your map.		* Click the OK button and OK again and save your map.

	TEMPORARY CAUTION: This "item is in location" objective doesn't always function properly; [https://bugs.thedarkmod.com/view.php?id=5404 a 2020 bug report has been filed]. You can try:		'''TEMPORARY CAUTION:''' This "item is in location" objective doesn't always function properly; [https://bugs.thedarkmod.com/view.php?id=5404 a 2020 bug report has been filed]. You can try:
	* also adding the "objective_ent 1" spawnarg to the info_tdm_objective_location.		* also adding the "objective_ent 1" spawnarg to the info_tdm_objective_location.
	* alternative techniques, using the objective components:		* alternative techniques, using the objective components:

Geep: /* An Objective to place an object in a Certain Location */ added TEMPORARY CAUTION

2020-11-13T19:52:39Z

An Objective to place an object in a Certain Location: added TEMPORARY CAUTION

← Older revision		Revision as of 19:52, 13 November 2020
Line 306:		Line 306:
	* On the right of that type or paste in the location entity name you gave above, eg, BodyDrop		* On the right of that type or paste in the location entity name you gave above, eg, BodyDrop
	* Click the OK button and OK again and save your map.		* Click the OK button and OK again and save your map.

			TEMPORARY CAUTION: This "item is in location" objective doesn't always function properly; [https://bugs.thedarkmod.com/view.php?id=5404 a 2020 bug report has been filed]. You can try:
			* also adding the "objective_ent 1" spawnarg to the info_tdm_objective_location.
			* alternative techniques, using the objective components:
			** "Two entities are within a radius of each other"
			** "Item is in info_location"

	=== Classic "Get X Loot" Objectives ===		=== Classic "Get X Loot" Objectives ===

VanishedOne: /* Classic "Get X Loot" Objectives */

2016-03-27T01:26:05Z

Classic "Get X Loot" Objectives

← Older revision		Revision as of 01:26, 27 March 2016
Line 309:		Line 309:
	=== Classic "Get X Loot" Objectives ===		=== Classic "Get X Loot" Objectives ===

	Use the "overall (component specific)" option of "Player ~~posess~~ item" for loot.		Use the "overall (component specific)" option of "Player possesses item" for loot.

	How do you find out how much loot is in your map? The easiest way is to set up an easy objective to lead to mission success. On the Mission Statistics screen, it will list your loot total.		How do you find out how much loot is in your map? The easiest way is to set up an easy objective to lead to mission success. On the Mission Statistics screen, it will list your loot total.