Variable - Revision history

Jg18 at 03:12, 7 August 2022

2022-08-07T03:12:29Z

← Older revision		Revision as of 03:12, 7 August 2022
Line 50:		Line 50:
	==See Also==		==See Also==
	*[[Counting with variables]]		*[[Counting with variables]]
			*[[SEXP Container]]
	~~==See also==~~

	* [[SEXP Container]]

	==Links==		==Links==

Jg18 at 03:02, 7 August 2022

2022-08-07T03:02:43Z

← Older revision		Revision as of 03:02, 7 August 2022
Line 1:		Line 1:
	'''Variables''' (also called '''SEXP variables''') allow you to store pieces of information for later use. Normally, SEXP trees use ~~fix~~ values. Consider this basic one:		'''Variables''' (also called '''SEXP variables''') allow you to store pieces of information for later use. Normally, SEXP trees use fixed values. Consider this basic one:

	is-destroyed-delay		is-destroyed-delay
Line 50:		Line 50:
	==See Also==		==See Also==
	*[[Counting with variables]]		*[[Counting with variables]]

			==See also==

			* [[SEXP Container]]

	==Links==		==Links==

Jg18 at 02:00, 7 August 2022

2022-08-07T02:00:29Z

← Older revision		Revision as of 02:00, 7 August 2022
Line 1:		Line 1:
	'''Variables''' allow you to store pieces of information for later use. Normally, SEXP trees use fix values. Consider this basic one:		'''Variables''' (also called '''SEXP variables''') allow you to store pieces of information for later use. Normally, SEXP trees use fix values. Consider this basic one:

	is-destroyed-delay		is-destroyed-delay

Wookieejedi: Update eternal type info

2020-07-01T01:10:10Z

Update eternal type info

← Older revision		Revision as of 01:10, 1 July 2020
Line 38:		Line 38:
	'''Save on Mission Close:''' A type of persistent variable that will save when the player leaves the mission. If the player is killed or quits during a mission, and changes made to this variable are stored. They are reset upon the reset of the current campaign, or the selection of a new campaign.		'''Save on Mission Close:''' A type of persistent variable that will save when the player leaves the mission. If the player is killed or quits during a mission, and changes made to this variable are stored. They are reset upon the reset of the current campaign, or the selection of a new campaign.

	'''Eternal:''' ~~A type of persistent~~ variable ~~that~~ is ~~stored in the player file~~. It does not reset upon the ~~reset~~ of the current campaign, or the selection of a new campaign. Thus it can be used and referred to by other campaigns.		'''Eternal:''' Eternal is a flag you can add to BOTH 'Save on Mission Complete' and 'Save on Mission Close' to tell the game to not delete that variable even if the campaign ends or a different campaign is started. It does not reset upon the end of the current campaign, or the selection of a new campaign. Thus it can be used and referred to by other campaigns.

	== Variables and Messages ==		== Variables and Messages ==

Wookieejedi: update format

2020-06-30T18:10:34Z

update format

← Older revision		Revision as of 18:10, 30 June 2020
Line 30:		Line 30:
	There are five types of variables. Hover the mouse over each variable name in the variable window to display additional information.		There are five types of variables. Hover the mouse over each variable name in the variable window to display additional information.

	'''Standard variables''' This type of variables are used in one mission only. If the player ends the mission in any way (jumping out, dying, restarting, etc.), all the standard variables will be reset to their default values. Whether the player is allowed to progress in the campaign or not is inconclusive (compare campaign-persistent variables). This is the default variable type, and requires no boxes to be checked in the variable window.		'''Standard variables:''' This type of variables are used in one mission only. If the player ends the mission in any way (jumping out, dying, restarting, etc.), all the standard variables will be reset to their default values. Whether the player is allowed to progress in the campaign or not is inconclusive (compare campaign-persistent variables). This is the default variable type, and requires no boxes to be checked in the variable window.

	'''Network variables''' are only relevant in a multiplayer game. Non-network variables are only ever altered on the server. This means that they can not be used in messages or scripting because all the client machines will only ever have the default value. If you need to have the value of a variable display in a message you will need to mark it as a network variable. ''		'''Network variables:''' are only relevant in a multiplayer game. Non-network variables are only ever altered on the server. This means that they can not be used in messages or scripting because all the client machines will only ever have the default value. If you need to have the value of a variable display in a message you will need to mark it as a network variable. ''

	'''Save on Mission Complete:''' A type of persistent variable that will save when the player clicks Accept to go to the next mission. If the player is killed or quits during a mission, and changes made to this variable are not stored. They are reset upon the reset of the current campaign, or the selection of a new campaign.		'''Save on Mission Complete:''' A type of persistent variable that will save when the player clicks Accept to go to the next mission. If the player is killed or quits during a mission, and changes made to this variable are not stored. They are reset upon the reset of the current campaign, or the selection of a new campaign.

Wookieejedi: Update variable types

2020-06-30T18:09:43Z

Update variable types

← Older revision		Revision as of 18:09, 30 June 2020
Line 28:		Line 28:
	== Four Types of Variables ==		== Four Types of Variables ==

	There are ~~four~~ types of variables.		There are five types of variables. Hover the mouse over each variable name in the variable window to display additional information.

	'''Standard variables''' This type of variables are used in one mission only. If the player ends the mission in any way (jumping out, dying, restarting, etc.), all the standard variables will be reset to their default values. Whether the player is allowed to progress in the campaign or not is inconclusive (compare campaign-persistent variables).		'''Standard variables''' This type of variables are used in one mission only. If the player ends the mission in any way (jumping out, dying, restarting, etc.), all the standard variables will be reset to their default values. Whether the player is allowed to progress in the campaign or not is inconclusive (compare campaign-persistent variables). This is the default variable type, and requires no boxes to be checked in the variable window.

	'''~~Player-persistent:~~''' ~~Player~~-~~persistent~~ variables ~~always retain~~ the ~~last value you gave them, regardless of~~ the ~~outcome of~~ the ~~mission~~. ~~They are reset upon~~ the ~~reset of the current campaign, or the selection~~ of a ~~new campaign~~.		'''Network variables''' are only relevant in a multiplayer game. Non-network variables are only ever altered on the server. This means that they can not be used in messages or scripting because all the client machines will only ever have the default value. If you need to have the value of a variable display in a message you will need to mark it as a network variable. ''

	'''~~Campaign-persistent~~:''' ~~These~~ persistent ~~variables are stored in~~ the ~~campaign file, and are only stored when a campaign progresses~~ to ~~a new~~ mission. ~~So if~~ the player is killed or quits during a mission, and changes made to ~~a campaign-persistent~~ variable are not stored.		'''Save on Mission Complete:''' A type of persistent variable that will save when the player clicks Accept to go to the next mission. If the player is killed or quits during a mission, and changes made to this variable are not stored. They are reset upon the reset of the current campaign, or the selection of a new campaign.

	'''~~Network variables~~''' are ~~only relevant in a multiplayer game~~. ~~Non-network variables~~ are ~~only ever altered on~~ the ~~server~~. ~~This means~~ that ~~they can~~ not ~~be used in messages or scripting because all~~ the ~~client machines will only ever have~~ the ~~default value. If you need to have~~ the ~~value~~ of a ~~variable display in a message you will need~~ to ~~mark it as a network variable~~. ''		'''Save on Mission Close:''' A type of persistent variable that will save when the player leaves the mission. If the player is killed or quits during a mission, and changes made to this variable are stored. They are reset upon the reset of the current campaign, or the selection of a new campaign.

			'''Eternal:''' A type of persistent variable that is stored in the player file. It does not reset upon the reset of the current campaign, or the selection of a new campaign. Thus it can be used and referred to by other campaigns.

	== Variables and Messages ==		== Variables and Messages ==

Wookieejedi: Update variable box image

2020-06-30T18:00:06Z

Update variable box image

← Older revision		Revision as of 18:00, 30 June 2020
Line 14:		Line 14:
	Right-click on any argument in the Events list and look at the three options at the bottom of the menu, '''Add Variable''', '''Modify Variable''', and '''Replace Variable'''. If your Events window is empty, create an Event.		Right-click on any argument in the Events list and look at the three options at the bottom of the menu, '''Add Variable''', '''Modify Variable''', and '''Replace Variable'''. If your Events window is empty, create an Event.

	[[Image:~~AddVariable~~.~~JPG~~\|center\|The Add Variable window]]		[[Image:VariableBox.png\|center\|The Add Variable window]]

	*'''Add Variable''' allows you to create a new variable. If you're using FreeSpace Open, your Add Variable window looks like the image above. You can add a number or a string-based variable. Number-based variables must contain numbers only, while string-based values can use letters. From a technical point of view, it's unimportant how you name your variable. Then set your variable's default value.		*'''Add Variable''' allows you to create a new variable. If you're using FreeSpace Open, your Add Variable window looks like the image above. You can add a number or a string-based variable. Number-based variables must contain numbers only, while string-based values can use letters. From a technical point of view, it's unimportant how you name your variable. Then set your variable's default value.

TopAce: redundancy removed

2013-02-13T09:53:37Z

redundancy removed

← Older revision		Revision as of 09:53, 13 February 2013
Line 1:		Line 1:
	'''Variables'''~~, implemented in retail FS2,~~ allow you to store pieces of information ~~that you can~~ use ~~later in a mission or a campaign~~. Normally, SEXP trees use fix values. Consider this basic one:		'''Variables''' allow you to store pieces of information for later use. Normally, SEXP trees use fix values. Consider this basic one:

	is-destroyed-delay		is-destroyed-delay

TopAce: just a punctuation mark

2012-10-17T07:50:35Z

just a punctuation mark

← Older revision		Revision as of 07:50, 17 October 2012
Line 22:		Line 22:
	**If you clicked on "0" in the example, you could change it to TurretsDown using Replace Variable --> TurretsDown. If the "0" is changed to TurretsDown (which receives a red icon), then you've been successful. Now the Event will come true if TurretsDown equals 3.		**If you clicked on "0" in the example, you could change it to TurretsDown using Replace Variable --> TurretsDown. If the "0" is changed to TurretsDown (which receives a red icon), then you've been successful. Now the Event will come true if TurretsDown equals 3.

	Variable values can be changed using the [[modify-variable]] SEXP, which you can find under Add Operator --> Change --> Special. A sample Event that adds 1 to a number-based variable looks like		Variable values can be changed using the [[modify-variable]] SEXP, which you can find under Add Operator --> Change --> Special. A sample Event that adds 1 to a number-based variable looks like:

	[[Image:VariableEvent.JPG\|center]].		[[Image:VariableEvent.JPG\|center]]

	== Four Types of Variables ==		== Four Types of Variables ==

TopAce: /* Basics */ added pic, misc relevant edits

2012-09-13T05:58:34Z

Basics: added pic, misc relevant edits

← Older revision		Revision as of 05:58, 13 September 2012
Line 14:		Line 14:
	Right-click on any argument in the Events list and look at the three options at the bottom of the menu, '''Add Variable''', '''Modify Variable''', and '''Replace Variable'''. If your Events window is empty, create an Event.		Right-click on any argument in the Events list and look at the three options at the bottom of the menu, '''Add Variable''', '''Modify Variable''', and '''Replace Variable'''. If your Events window is empty, create an Event.

	*'''Add Variable''' allows you to create a new variable. If you're using FreeSpace Open, your Add Variable window looks ~~somewhat~~ like ~~[[:Image:AddVariable.JPG\|this]]~~. You can add a number or a string-based variable. Number-based variables must contain numbers only, while string-based values can use letters. From a technical point of view, it's unimportant how you name your variable. Then set your variable's default value.		[[Image:AddVariable.JPG\|center\|The Add Variable window]]
	**In our example, let's create a number-based variable that is named "~~MessageDelay~~" and its default value is 2.
			*'''Add Variable''' allows you to create a new variable. If you're using FreeSpace Open, your Add Variable window looks like the image above. You can add a number or a string-based variable. Number-based variables must contain numbers only, while string-based values can use letters. From a technical point of view, it's unimportant how you name your variable. Then set your variable's default value.
			**In our example, let's create a number-based variable that is named "TurretsDown" and its default value is 0.
	*'''Modify Variable''' allows you to change a variable that you've already created. You can modify only one variable at a time. This feature is not to be confused with the [[modify-variable]] one.		*'''Modify Variable''' allows you to change a variable that you've already created. You can modify only one variable at a time. This feature is not to be confused with the [[modify-variable]] one.
	*'''Replace Variable''' replaces the currently selected SEXP argument with the variable of your choice.		*'''Replace Variable''' replaces the currently selected SEXP argument with the variable of your choice.
	**If you clicked on "2" in the example, you could change it to ~~MessageDelay~~ using Replace Variable --> ~~MessageDelay~~. If the "2" is changed to ~~MessageDelay~~ (which receives a red icon), then you've been successful.		**If you clicked on "0" in the example, you could change it to TurretsDown using Replace Variable --> TurretsDown. If the "0" is changed to TurretsDown (which receives a red icon), then you've been successful. Now the Event will come true if TurretsDown equals 3.

			Variable values can be changed using the [[modify-variable]] SEXP, which you can find under Add Operator --> Change --> Special. A sample Event that adds 1 to a number-based variable looks like

	~~Variable values can be changed using the~~ [[~~modify-variable]] SEXP, which you can find under Add Operator --> Change --> Special. A sample Event that adds 1 to a number-based variable looks like [[:~~Image:VariableEvent.JPG\|~~this~~]].		[[Image:VariableEvent.JPG\|center]].

	== Four Types of Variables ==		== Four Types of Variables ==