Popup messages - Revision history

Frost Salamander: fix incorrect entity name

2023-03-11T13:18:15Z

fix incorrect entity name

← Older revision		Revision as of 13:18, 11 March 2023
Line 7:		Line 7:
	For each message you want to show, insert one '''atdm:gui_message''' entity in your map. The place does not matter, but putting it near the location where the message appears makes sense. Set the proper spawnargs, then simply target that entity from any trigger.		For each message you want to show, insert one '''atdm:gui_message''' entity in your map. The place does not matter, but putting it near the location where the message appears makes sense. Set the proper spawnargs, then simply target that entity from any trigger.

	You can also use '''atdm:~~target_message_enable~~''' and '''atdm:target_message_enable''' entities to disable/enable a certain message.		You can also use '''atdm:target_message_disable''' and '''atdm:target_message_enable''' entities to disable/enable a certain message.

	If you want your message to appear only once, no matter what, use '''trigger_once'''. If it should appear multiple times until a certain condition is fulfilled, use a '''trigger_multiple''' and then a '''atdm:target_message_disable''' entity to disable the message entity.		If you want your message to appear only once, no matter what, use '''trigger_once'''. If it should appear multiple times until a certain condition is fulfilled, use a '''trigger_multiple''' and then a '''atdm:target_message_disable''' entity to disable the message entity.

Geep: Change category tag to {{GUI}}, that includes Editing

2022-11-04T18:10:15Z

Change category tag to {{GUI}}, that includes Editing

← Older revision		Revision as of 18:10, 4 November 2022
Line 65:		Line 65:
	If true, the messages are shown, if false, suppressed unless they have "force" on them.		If true, the messages are shown, if false, suppressed unless they have "force" on them.

	{{~~editing~~}}		{{GUI}}

Geep: Mention "guis/tdm_message_no_art.gui"

2020-11-05T05:13:16Z

Mention "guis/tdm_message_no_art.gui"

← Older revision		Revision as of 05:13, 5 November 2020
Line 55:		Line 55:
	If true, the message is always shown, regardless of the CVAR. It is wise to set force to 1 for messages that are not pop-up messages, but instead overlay titles. Think of the "movie titles" '''Brideport, late night" that appear transparent over the entire screen. You don't want these to disappear just because the user has the CVAR (see below) set to off.		If true, the message is always shown, regardless of the CVAR. It is wise to set force to 1 for messages that are not pop-up messages, but instead overlay titles. Think of the "movie titles" '''Brideport, late night" that appear transparent over the entire screen. You don't want these to disappear just because the user has the CVAR (see below) set to off.

	=== gui (string~~, filename~~, default "guis/tdm_message.gui") ===		=== gui (string, default "guis/tdm_message.gui") ===

	Name of the GUI file~~, which is~~ used to display the message.		Name of the GUI file used to display the message. The default provides an opaque "aged paper" rectangular background in the upper left corner. For a transparent centered overlay with white text, try "guis/tdm_message_no_art.gui" .

	== CVAR ==		== CVAR ==

Petike: update of link

2019-03-26T12:40:45Z

update of link

← Older revision		Revision as of 12:40, 26 March 2019
Line 1:		Line 1:
	== Introduction ==		== Introduction ==

	Often it can be useful to show the player messages on the screen, this is used for instance for instructions in the training mission. This article describes how to make this work.		Often it can be useful to show the player messages on the screen, this is used for instance for instructions in the [[Training Mission (OM)\|training mission]]. This article describes how to make this work.

	== Usage ==		== Usage ==

Destined: /* text (string) */

2019-01-09T06:41:33Z

text (string)

← Older revision		Revision as of 06:41, 9 January 2019
Line 45:		Line 45:
	The text to display.		The text to display.

	~~If you want to change the~~ displayed text during gameplay (e.g. to use variables like "X of 3 objects found"), ~~you can use~~ the "setKey" script command before activating the message entity.		The displayed text can be changed during gameplay (e.g. to use variables like "X of 3 objects found"), by using a script with the "setKey" script command before activating the message entity.

	=== lines (int, default: 1) ===		=== lines (int, default: 1) ===

Destined: /* text (string) */

2019-01-09T06:40:28Z

text (string)

← Older revision		Revision as of 06:40, 9 January 2019
Line 45:		Line 45:
	The text to display.		The text to display.

	If you want to change the displayed text during gameplay, you can use the "setKey" script command before activating the message entity.		If you want to change the displayed text during gameplay (e.g. to use variables like "X of 3 objects found"), you can use the "setKey" script command before activating the message entity.

	=== lines (int, default: 1) ===		=== lines (int, default: 1) ===

Destined: /* text (string) */

2019-01-09T06:39:19Z

text (string)

← Older revision		Revision as of 06:39, 9 January 2019
Line 44:		Line 44:

	The text to display.		The text to display.

			If you want to change the displayed text during gameplay, you can use the "setKey" script command before activating the message entity.

	=== lines (int, default: 1) ===		=== lines (int, default: 1) ===

Tels: typo

2012-02-15T21:51:09Z

typo

← Older revision		Revision as of 21:51, 15 February 2012
Line 53:		Line 53:
	If true, the message is always shown, regardless of the CVAR. It is wise to set force to 1 for messages that are not pop-up messages, but instead overlay titles. Think of the "movie titles" '''Brideport, late night" that appear transparent over the entire screen. You don't want these to disappear just because the user has the CVAR (see below) set to off.		If true, the message is always shown, regardless of the CVAR. It is wise to set force to 1 for messages that are not pop-up messages, but instead overlay titles. Think of the "movie titles" '''Brideport, late night" that appear transparent over the entire screen. You don't want these to disappear just because the user has the CVAR (see below) set to off.

	=== gui (string, filename, default "guis/tdm_message.gui")		=== gui (string, filename, default "guis/tdm_message.gui") ===

	Name of the GUI file, which is used to display the message.		Name of the GUI file, which is used to display the message.

Tels: add gui spawnarg

2012-02-15T21:50:47Z

add gui spawnarg

← Older revision		Revision as of 21:50, 15 February 2012
Line 52:		Line 52:

	If true, the message is always shown, regardless of the CVAR. It is wise to set force to 1 for messages that are not pop-up messages, but instead overlay titles. Think of the "movie titles" '''Brideport, late night" that appear transparent over the entire screen. You don't want these to disappear just because the user has the CVAR (see below) set to off.		If true, the message is always shown, regardless of the CVAR. It is wise to set force to 1 for messages that are not pop-up messages, but instead overlay titles. Think of the "movie titles" '''Brideport, late night" that appear transparent over the entire screen. You don't want these to disappear just because the user has the CVAR (see below) set to off.

			=== gui (string, filename, default "guis/tdm_message.gui")

			Name of the GUI file, which is used to display the message.

	== CVAR ==		== CVAR ==

Tels: update doc

2012-02-15T21:49:34Z

update doc

← Older revision		Revision as of 21:49, 15 February 2012
Line 29:		Line 29:
	=== show (float, default: 0) ===		=== show (float, default: 0) ===

	~~Time~~ in seconds the message will be ~~shown~~.		The time in seconds the message is shown, will be longer by approx. one second to fade the message out. If set to 0, shows the message for 6 seconds plus 1s fade out.

	=== delay (float, default: 0) ===		=== delay (float, default: 0) ===
Line 47:		Line 47:
	=== lines (int, default: 1) ===		=== lines (int, default: 1) ===

	The number of lines, will influence the vertical alignment of the text.		The number of lines, will is relayed to the GUI and can influence the vertical alignment of the text.

	=== ~~is_long~~ (boolean, default: 0) ===		=== force (boolean, default: 0) ===

	If ~~set to~~ true, ~~a long~~ message is ~~assumed~~, ~~this will influence~~ the ~~default show time, which~~ is ~~longer~~ for ~~long message~~.		If true, the message is always shown, regardless of the CVAR. It is wise to set force to 1 for messages that are not pop-up messages, but instead overlay titles. Think of the "movie titles" '''Brideport, late night" that appear transparent over the entire screen. You don't want these to disappear just because the user has the CVAR (see below) set to off.

			== CVAR ==

			=== tdm_show_trainer_messages ===

			If true, the messages are shown, if false, suppressed unless they have "force" on them.

	{{editing}}		{{editing}}