SEXP Container - Revision history

Jg18: clarify persistence

2023-06-17T18:40:36Z

clarify persistence

← Older revision		Revision as of 18:40, 17 June 2023
Line 120:		Line 120:
	[[File:Containers persistence options.png\|200px\|thumb\|right\|FRED's Add/Modify Container dialog with the Persistence options highlighted.]]		[[File:Containers persistence options.png\|200px\|thumb\|right\|FRED's Add/Modify Container dialog with the Persistence options highlighted.]]

	Containers support the same persistence options that variables do, except for "Network" (Issue #3708).		Containers support the same persistence options that variables do, except for "Network" ([https://github.com/scp-fs2open/fs2open.github.com/issues/3708 Issue #3708]).

			For a persistent container to be replaced with a saved container during mission load, the container type, data type (and, if a map container, key type) must all match.

			Replacing a persistent container in this way ''replaces'' the contents and does ''not'' combine them.

	===Multidimensionality===		===Multidimensionality===

Jg18 at 22:24, 9 June 2023

2023-06-09T22:24:46Z

← Older revision		Revision as of 22:24, 9 June 2023
Line 6:		Line 6:

	As opposed to a [[Variable\|SEXP variable]], which stores only one value, a SEXP container stores a collection of values.		As opposed to a [[Variable\|SEXP variable]], which stores only one value, a SEXP container stores a collection of values.

			Containers aren't a replacement for variables but rather a supplement to them.

	Containers first appeared in FS2 Open 22.2.0.		Containers first appeared in FS2 Open 22.2.0.
Line 11:		Line 13:
	==Prerequisites==		==Prerequisites==

	Since containers are related to [[Variable\|variables]] ~~but '''much''' more powerful~~, FREDders should first become comfortable with using variables.		Since containers are related to [[Variable\|variables]], FREDders should first become comfortable with using variables.

	Coding experience (in any programming language) is helpful ''but not required''.		Coding experience (in any programming language) is helpful ''but not required''.

Jg18 at 22:12, 9 June 2023

2023-06-09T22:12:59Z

← Older revision		Revision as of 22:12, 9 June 2023
Line 11:		Line 11:
	==Prerequisites==		==Prerequisites==

	Since containers are related to [[Variable\|variables]] but ''`much''` more powerful, FREDders should first become comfortable with using variables.		Since containers are related to [[Variable\|variables]] but '''much''' more powerful, FREDders should first become comfortable with using variables.

	Coding experience (in any programming language) is helpful ''but not required''.		Coding experience (in any programming language) is helpful ''but not required''.

Jg18 at 22:10, 9 June 2023

2023-06-09T22:10:12Z

← Older revision		Revision as of 22:10, 9 June 2023
Line 7:		Line 7:
	As opposed to a [[Variable\|SEXP variable]], which stores only one value, a SEXP container stores a collection of values.		As opposed to a [[Variable\|SEXP variable]], which stores only one value, a SEXP container stores a collection of values.

	Since containers ~~allow for handling data in~~ much more ~~sophisticated ways than variables~~, ~~it's recommended that~~ FREDders become comfortable with using variables ~~before trying to use containers~~.		Containers first appeared in FS2 Open 22.2.0.

			==Prerequisites==

			Since containers are related to [[Variable\|variables]] but ''`much''` more powerful, FREDders should first become comfortable with using variables.

	~~Containers first appeared~~ in ~~FS2 Open 22.2.0~~.		Coding experience (in any programming language) is helpful ''but not required''.

	==Overview==		==Overview==

Jg18 at 21:46, 9 June 2023

2023-06-09T21:46:41Z

← Older revision		Revision as of 21:46, 9 June 2023
Line 15:		Line 15:
	Get started with containers using FRED's "Add/Modify Container" dialog, which you can reach from the right-click menu in the Events Editor's SEXP tree.		Get started with containers using FRED's "Add/Modify Container" dialog, which you can reach from the right-click menu in the Events Editor's SEXP tree.

			[[File:Fred right click menu.png\|200px\|thumb\|right\|FRED's Events Editor with the "Add/Modify Container" right-click menu option highlighted.]]

	The new [[#SEXPs and Replace Container Name\|Replace Container Name]] and [[#Replace Container Data\|Replace Container Data]] submenus are explained below.		The new [[#SEXPs and Replace Container Name\|Replace Container Name]] and [[#Replace Container Data\|Replace Container Data]] submenus are explained below.

Jg18 at 21:23, 9 June 2023

2023-06-09T21:23:04Z

← Older revision		Revision as of 21:23, 9 June 2023
Line 7:		Line 7:
	As opposed to a [[Variable\|SEXP variable]], which stores only one value, a SEXP container stores a collection of values.		As opposed to a [[Variable\|SEXP variable]], which stores only one value, a SEXP container stores a collection of values.

	~~Consequently,~~ containers allow for handling data in much more sophisticated ways than variables~~. Therefore~~, FREDders ~~should be~~ comfortable with using variables before trying to use containers.		Since containers allow for handling data in much more sophisticated ways than variables, it's recommended that FREDders become comfortable with using variables before trying to use containers.

	Containers first appeared in FS2 Open 22.2.0.		Containers first appeared in FS2 Open 22.2.0.

Jg18 at 19:44, 27 May 2023

2023-05-27T19:44:02Z

← Older revision		Revision as of 19:44, 27 May 2023
Line 3:		Line 3:
	[[File:Containers_sample.png\|200px\|thumb\|right\|FRED's Events Editor with many different examples of how SEXP containers can be used.]]		[[File:Containers_sample.png\|200px\|thumb\|right\|FRED's Events Editor with many different examples of how SEXP containers can be used.]]

	'''SEXP containers''' allow ~~you~~ to store groups of pieces of information for later use.		'''SEXP containers''' allow FREDders to store groups of pieces of information for later use.

	As opposed to a [[Variable\|SEXP variable]], which stores only one value, a SEXP container stores a collection of values.		As opposed to a [[Variable\|SEXP variable]], which stores only one value, a SEXP container stores a collection of values.

	Consequently, containers allow for handling data in much more sophisticated ways than variables.		Consequently, containers allow for handling data in much more sophisticated ways than variables. Therefore, FREDders should be comfortable with using variables before trying to use containers.

	Containers first appeared in FS2 Open 22.2.0.		Containers first appeared in FS2 Open 22.2.0.

Jg18 at 06:32, 27 May 2023

2023-05-27T06:32:12Z

← Older revision		Revision as of 06:32, 27 May 2023
Line 133:		Line 133:
	====Multidimensionality example 1====		====Multidimensionality example 1====

	In the ~~above~~ screen shots, if the random-of in the first screen shot happens to select "Taurus" as the special argument, then the ship "Taurus" will send the message "Ah! A plot is revealed".		In the screen shots on the right, if the random-of in the first screen shot happens to select "Taurus" as the special argument, then the ship "Taurus" will send the message "Ah! A plot is revealed".

	====Multidimensionality example 2====		====Multidimensionality example 2====

Jg18 at 06:16, 27 May 2023

2023-05-27T06:16:31Z

← Older revision		Revision as of 06:16, 27 May 2023
Line 13:		Line 13:
	==Overview==		==Overview==

	Get started with containers using FRED's "Add/Modify Container" dialog, which you can reach from the right-click menu:		Get started with containers using FRED's "Add/Modify Container" dialog, which you can reach from the right-click menu in the Events Editor's SEXP tree.

Jg18 at 05:41, 27 May 2023

2023-05-27T05:41:34Z

← Older revision		Revision as of 05:41, 27 May 2023
Line 1:		Line 1:
	''This page is about the FRED feature. For cargo containers, see [[Containers]].''		''This page is about the FRED feature. For cargo containers, see [[Containers]].''

	[[File:Containers_sample.png\|200px\|thumb\|right\|~~A screen shot of~~ FRED's Events Editor ~~demonstrating~~ many different ~~ways in which~~ SEXP containers can be used.]]		[[File:Containers_sample.png\|200px\|thumb\|right\|FRED's Events Editor with many different examples of how SEXP containers can be used.]]

	'''SEXP containers''' allow you to store groups of pieces of information for later use.		'''SEXP containers''' allow you to store groups of pieces of information for later use.
Line 119:		Line 119:
	===Multidimensionality===		===Multidimensionality===

			[[File:Containers sample multidim.png\|200px\|thumb\|right\|Example of multidimensionality with containers (part 1). The last three lines mean, "From the (map) container named Traitors, get the value whose key is the special argument. The value should be the name of a container with '&' added to the front and end of the name. Then, from that container, get the value whose key is 'MESSAGE - Treason'."]]

			[[File:Containers sample multidim2.png\|200px\|thumb\|right\|Example of multidimensionality with containers (part 2). This shows the contents of the "Traitors" container. If the selected special argument is "Taurus", then the associated value is "&Taurus&", which refers to getting data from the container named "Taurus".]]

			[[File:Containers sample multidim3.png\|200px\|thumb\|right\|Example of multidimensionality with containers (part 3). This shows the contents of the container named "Taurus". It shows that the key "MESSGE-Treason" is mapped to the string "Taurus - Treason".]]

			[[File:Containers sample multidim4.png\|200px\|thumb\|right\|Example of multidimensionality with containers (part 4). This shows that "Taurus - Treason" is the name of a message whose text is "Ah! A plot is revealed".]]




	For both text replacement and Replace Container Data, you can chain accesses to container data. The data stored in the first container should be formatted as &ContainerName&.		For both text replacement and Replace Container Data, you can chain accesses to container data. The data stored in the first container should be formatted as &ContainerName&.

	Unlike the other containers features, there is no equivalent for variables.		Unlike the other containers features, there is no equivalent feature for variables.

	====Multidimensionality example 1====		====Multidimensionality example 1====

	In the above screen shots, if the random-of in the first screen shot happens to select "Taurus" as the special argument, then the ship "Taurus" will send the message "Ah! A plot is revealed!".		In the above screen shots, if the random-of in the first screen shot happens to select "Taurus" as the special argument, then the ship "Taurus" will send the message "Ah! A plot is revealed".

	====Multidimensionality example 2====		====Multidimensionality example 2====