Variables - Revision history

TopAce: singular preference in titles

2010-04-15T20:33:45Z

singular preference in titles

← Older revision		Revision as of 20:33, 15 April 2010
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:~~		#Redirect: [[Variable]]

	~~is-destroyed-delay~~
	2
	~~GTT Spomer~~
	~~send-message~~
	#~~Command~~
	~~High~~
	~~Spomer destroyed~~

	All these values are fixed. If you wanted Command to send a message five (not two) seconds after the Spomer is destroyed, you would need a second Event with 5 instead of 2. If, however, the "delay" value (2) were a variable, you could manipulate the delay between the Spomer's death and Command sending the message in a more convenient and flexible way in one Event. Variables are dynamic values that can be changed during the course of the mission.

	~~==Basics==~~
	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.
	**In our example, let's create a number-based variable that is named "MessageDelay" and its default value is 2.
	*'''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.~~
	**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.

	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]].

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

	~~There are four types of 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).

	'''Player-persistent:''' This type of persistent variable is stored in the pilot file. Further, they are stored immediately when they are created/changed from within a mission. This means that any change is going to be there regardless of the later outcome of the mission. Player-persistent variables can be accessed and changed from any campaign played with the same pilot.

	'''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.

	'''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. ''

	~~== Variables and Messages ==~~
	Variables can also be used in messages. To do this, use the variable's name preceded by the '$' token (for example "$killcount"), and in-game this will be replaced with the value of the variable. It works for both numeric and string variables.

	~~==Example Mission==~~
	~~:''Main Article: [[Variables example mission]]''~~

	This is a mission in which the player must take down all four of the Sathanas's main beam weapons to win the mission. This is like [[Bearbaiting]], except this mission is solely made as a variables tutorial. The juggernaut will not fire at you or jump out.

	~~==Links==~~

	*[http://homepage.ntlworld.com/karajorma/FAQ/fredretail.html#variables Karajorma's FreeSpace FAQ on variables]
	* Fred Zone examples for variables [http://fredzone.hard-light.net/cetanu_adv-fred-lessons.shtml] [http://fredzone.hard-light.net/cetanu_adv-fred-lessons-2.shtml]

	~~[[Category:FRED~~]]

TopAce: consistency with capitals in headers

2009-03-29T12:21:48Z

consistency with capitals in headers

← Older revision		Revision as of 12:21, 29 March 2009
Line 37:		Line 37:
	Variables can also be used in messages. To do this, use the variable's name preceded by the '$' token (for example "$killcount"), and in-game this will be replaced with the value of the variable. It works for both numeric and string variables.		Variables can also be used in messages. To do this, use the variable's name preceded by the '$' token (for example "$killcount"), and in-game this will be replaced with the value of the variable. It works for both numeric and string variables.

	==Example ~~mission~~==		==Example Mission==
	:''Main Article: [[Variables example mission]]''		:''Main Article: [[Variables example mission]]''

TopAce: Per dragonsniper's feedback

2009-01-11T11:47:27Z

Per dragonsniper's feedback

← Older revision		Revision as of 11:47, 11 January 2009
Line 9:		Line 9:
	Spomer destroyed		Spomer destroyed

	All these values are fixed. If you wanted Command to send a ~~his~~ message five (not two) seconds after the Spomer is destroyed, you would need a second Event with 5 instead of 2. If, however, the "delay" value (2) were a variable, you could manipulate the delay between the Spomer's death and Command sending the message in a more convenient and flexible way in one Event. Variables are dynamic values that can be changed during the course of the mission.		All these values are fixed. If you wanted Command to send a message five (not two) seconds after the Spomer is destroyed, you would need a second Event with 5 instead of 2. If, however, the "delay" value (2) were a variable, you could manipulate the delay between the Spomer's death and Command sending the message in a more convenient and flexible way in one Event. Variables are dynamic values that can be changed during the course of the mission.

	==Basics==		==Basics==

TopAce: /* Example mission */

2009-01-10T17:53:58Z

Example mission

← Older revision		Revision as of 17:53, 10 January 2009
Line 38:		Line 38:

	==Example mission==		==Example mission==
	:''Main Article: [[Variables example mission]] ~~(to be written and submitted)~~''		:''Main Article: [[Variables example mission]]''

	This is a mission in which the player must take down all four of the Sathanas's main beam weapons to win the mission. This is like [[Bearbaiting]], except this mission is solely made as a variables tutorial. The juggernaut will not fire at you or jump out.		This is a mission in which the player must take down all four of the Sathanas's main beam weapons to win the mission. This is like [[Bearbaiting]], except this mission is solely made as a variables tutorial. The juggernaut will not fire at you or jump out.

TopAce at 16:42, 10 January 2009

2009-01-10T16:42:47Z

← Older revision		Revision as of 16:42, 10 January 2009
Line 2:		Line 2:

	is-destroyed-delay		is-destroyed-delay
			2
	GTT Spomer		GTT Spomer
	2
	send-message		send-message
	#Command		#Command

TopAce at 16:33, 10 January 2009

2009-01-10T16:33:08Z

← Older revision		Revision as of 16:33, 10 January 2009
Line 1:		Line 1:
	'''Variables''', implemented in retail FS2, ~~can be a powerful FRED tool. [[FREDder]]s use variables for the same two reasons that programmers do. One, they~~ allow you to ~~easily~~ store pieces of information ~~for later use, which can be modified and used to do cool things. Two, they let you avoid hard-coded or "magic" numbers for arguments~~ that you use ~~several times~~ in ~~your~~ mission~~'s events~~.		'''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:

	~~Using variables~~ is ~~simple. You can use variables in place of any SEXP argument where you would normally use a string or number. Right~~-~~click on~~ the argument in the Events list and look at the three options at the bottom of the menu, '''Add Variable''', '''Modify Variable''', and '''Insert Variable'''. Click '''Add Variable''' to create a new variable. '''Modify Variable''' allows you to change a variable that you've already created. '''Insert Variable''' replaces the currently selected SEXP argument with the variable of your choice.		is-destroyed-delay
			GTT Spomer
			2
			send-message
			#Command
			High
			Spomer destroyed

	~~== Three Types~~ of Variables ==		All these values are fixed. If you wanted Command to send a his message five (not two) seconds after the Spomer is destroyed, you would need a second Event with 5 instead of 2. If, however, the "delay" value (2) were a variable, you could manipulate the delay between the Spomer's death and Command sending the message in a more convenient and flexible way in one Event. Variables are dynamic values that can be changed during the course of the mission.

	There are ~~three~~ types of variables.		==Basics==
			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.
			**In our example, let's create a number-based variable that is named "MessageDelay" and its default value is 2.
			*'''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.
			**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.

			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]].

			== Four Types of Variables ==

			There are four types of 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).

	'''Player-persistent:''' This type of persistent variable is stored in the pilot file. Further, they are stored immediately when they are created/changed from within a mission. This means that any change is going to be there regardless of the later outcome of the mission. Player-persistent variables can be accessed and changed from any campaign played with the same pilot.		'''Player-persistent:''' This type of persistent variable is stored in the pilot file. Further, they are stored immediately when they are created/changed from within a mission. This means that any change is going to be there regardless of the later outcome of the mission. Player-persistent variables can be accessed and changed from any campaign played with the same pilot.
Line 14:		Line 35:

	== Variables and Messages ==		== Variables and Messages ==
			Variables can also be used in messages. To do this, use the variable's name preceded by the '$' token (for example "$killcount"), and in-game this will be replaced with the value of the variable. It works for both numeric and string variables.

			==Example mission==
			:''Main Article: [[Variables example mission]] (to be written and submitted)''

	~~Variables can also be used~~ in ~~messages. To do this, use~~ the ~~variable~~'s ~~name preceded by~~ the ~~'$' token (for example "$killcount")~~, ~~and in-game~~ this will ~~be replaced with the value of the variable. It works for both numeric and string variables~~.		This is a mission in which the player must take down all four of the Sathanas's main beam weapons to win the mission. This is like [[Bearbaiting]], except this mission is solely made as a variables tutorial. The juggernaut will not fire at you or jump out.

	==Links==		==Links==

Karajorma: /* Three Types of Variables */

2009-01-10T10:50:02Z

Three Types of Variables

← Older revision		Revision as of 10:50, 10 January 2009
Line 11:		Line 11:
	'''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.		'''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.

	'''Network~~-persistent~~''' ~~variables~~ are only relevant in a multiplayer game. ~~They affect~~ all ~~players in~~ the ~~current game~~. ~~''Someone with multiplayer experience, please expand on this~~.''		'''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. ''

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

TopAce at 19:27, 2 October 2008

2008-10-02T19:27:47Z

← Older revision		Revision as of 19:27, 2 October 2008
Line 1:		Line 1:
	Variables, implemented in retail FS2, can be a powerful FRED tool. ~~FREDers~~ use variables for the same two reasons that programmers do. One, they allow you to easily store pieces of information for later use, which can be modified and used to do cool things. Two, they let you avoid hard-coded or "magic" numbers for arguments that you use several times in your mission's events.		'''Variables''', implemented in retail FS2, can be a powerful FRED tool. [[FREDder]]s use variables for the same two reasons that programmers do. One, they allow you to easily store pieces of information for later use, which can be modified and used to do cool things. Two, they let you avoid hard-coded or "magic" numbers for arguments that you use several times in your mission's events.

	Using variables is simple. You can use variables in place of any SEXP argument where you would normally use a string or number. Right-click on the argument in the Events list and look at the three options at the bottom of the menu, '''Add Variable''', '''Modify Variable''', and '''Insert Variable'''. Click '''Add Variable''' to create a new variable. '''Modify Variable''' allows you to change a variable that you've already created. '''Insert Variable''' ~~replace~~ the currently selected SEXP argument with the variable of your choice.		Using variables is simple. You can use variables in place of any SEXP argument where you would normally use a string or number. Right-click on the argument in the Events list and look at the three options at the bottom of the menu, '''Add Variable''', '''Modify Variable''', and '''Insert Variable'''. Click '''Add Variable''' to create a new variable. '''Modify Variable''' allows you to change a variable that you've already created. '''Insert Variable''' replaces the currently selected SEXP argument with the variable of your choice.

	== Three Types of Variables ==		== Three Types of Variables ==
Line 11:		Line 11:
	'''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.		'''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.

	'''Network-persistent''' variables are only ~~relevent~~ in a multiplayer game. They affect all players in the current game. ''Someone with multiplayer experience, please expand on this.''		'''Network-persistent''' variables are only relevant in a multiplayer game. They affect all players in the current game. ''Someone with multiplayer experience, please expand on this.''

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

Shade: Added info on variables in messages

2008-06-22T16:46:23Z

Added info on variables in messages

← Older revision		Revision as of 16:46, 22 June 2008
Line 12:		Line 12:

	'''Network-persistent''' variables are only relevent in a multiplayer game. They affect all players in the current game. ''Someone with multiplayer experience, please expand on this.''		'''Network-persistent''' variables are only relevent in a multiplayer game. They affect all players in the current game. ''Someone with multiplayer experience, please expand on this.''

			== Variables and Messages ==

			Variables can also be used in messages. To do this, use the variable's name preceded by the '$' token (for example "$killcount"), and in-game this will be replaced with the value of the variable. It works for both numeric and string variables.

	==Links==		==Links==

Mustang19: added a link to kara's faq on variables

2008-03-20T20:38:11Z

added a link to kara's faq on variables

← Older revision		Revision as of 20:38, 20 March 2008
Line 1:		Line 1:
	Variables, implemented in retail FS2, can be a powerful FRED tool~~, although are often more of a convenience than an absolute necessity~~. FREDers use variables for the same two reasons that programmers do. One, they allow you to easily store pieces of information for later use. Two, they let you avoid hard-coded or "magic" numbers for arguments that you use several times in your mission's events.		Variables, implemented in retail FS2, can be a powerful FRED tool. FREDers use variables for the same two reasons that programmers do. One, they allow you to easily store pieces of information for later use, which can be modified and used to do cool things. Two, they let you avoid hard-coded or "magic" numbers for arguments that you use several times in your mission's events.

	Using variables is simple. You can use variables in place of any SEXP argument where you would normally use a string or number. Right-click on the argument in the Events list and look at the three options at the bottom of the menu, '''Add Variable''', '''Modify Variable''', and '''Insert Variable'''. Click '''Add Variable''' to create a new variable. '''Modify Variable''' allows you to change a variable that you've already created. '''Insert Variable''' replace the currently selected SEXP argument with the variable of your choice.		Using variables is simple. You can use variables in place of any SEXP argument where you would normally use a string or number. Right-click on the argument in the Events list and look at the three options at the bottom of the menu, '''Add Variable''', '''Modify Variable''', and '''Insert Variable'''. Click '''Add Variable''' to create a new variable. '''Modify Variable''' allows you to change a variable that you've already created. '''Insert Variable''' replace the currently selected SEXP argument with the variable of your choice.
Line 13:		Line 13:
	'''Network-persistent''' variables are only relevent in a multiplayer game. They affect all players in the current game. ''Someone with multiplayer experience, please expand on this.''		'''Network-persistent''' variables are only relevent in a multiplayer game. They affect all players in the current game. ''Someone with multiplayer experience, please expand on this.''

	~~''Fred Zone examples of uses for variables''~~		==Links==

	[http://fredzone.hard-light.net/cetanu_adv-fred-lessons.shtml ~~Example 1~~]		*[http://homepage.ntlworld.com/karajorma/FAQ/fredretail.html#variables Karajorma's FreeSpace FAQ on variables]
			* Fred Zone examples for variables [http://fredzone.hard-light.net/cetanu_adv-fred-lessons.shtml] [http://fredzone.hard-light.net/cetanu_adv-fred-lessons-2.shtml]
	[http://fredzone.hard-light.net/cetanu_adv-fred-lessons-2.shtml ~~Example 2~~]

	[[Category:FRED]]		[[Category:FRED]]