A to Z Scripting: More scripting basics - Revision history

Dragofer at 11:35, 4 February 2021

2021-02-04T11:35:27Z

← Older revision		Revision as of 11:35, 4 February 2021
Line 138:		Line 138:

	A major advantage of using names is that they make it very easy to change a commonly used value: simply change the value of the name, rather than tracking down every instance in the script where the value was used.		A major advantage of using names is that they make it very easy to change a commonly used value: simply change the value of the name, rather than tracking down every instance in the script where the value was used.



	== Example: puzzle with max 3 attempts, using variables and names ==		== Example: puzzle with max 3 attempts, using variables and names ==

Dragofer: /* #defining names */

2021-02-04T11:35:03Z

#defining names

← Older revision		Revision as of 11:35, 4 February 2021
Line 127:		Line 127:

	== #defining names ==		== #defining names ==
	Naming important values makes it easier to keep track of what they stand for ~~and probably also easier to work with~~. For example, the number 60 can be defined as a "minute":		Naming important values makes it easier to keep track of what they stand for. For example, the number 60 can be defined as a "minute":
	#define MINUTE 60 //define a name "MINUTE", which stands for "60". No semicolon needed, since it's not an instruction.		#define MINUTE 60 //define a name "MINUTE", which stands for "60". No semicolon needed, since it's not an instruction.
	sys.wait(5 * MINUTE); //let the script wait for 5 * 60 = 300s, so 5 minutes		sys.wait(5 * MINUTE); //let the script wait for 5 * 60 = 300s, so 5 minutes
Line 138:		Line 138:

	A major advantage of using names is that they make it very easy to change a commonly used value: simply change the value of the name, rather than tracking down every instance in the script where the value was used.		A major advantage of using names is that they make it very easy to change a commonly used value: simply change the value of the name, rather than tracking down every instance in the script where the value was used.


	== Example: puzzle with max 3 attempts, using variables and names ==		== Example: puzzle with max 3 attempts, using variables and names ==

Dragofer at 22:19, 28 December 2020

2020-12-28T22:19:17Z

← Older revision		Revision as of 22:19, 28 December 2020
Line 138:		Line 138:

	A major advantage of using names is that they make it very easy to change a commonly used value: simply change the value of the name, rather than tracking down every instance in the script where the value was used.		A major advantage of using names is that they make it very easy to change a commonly used value: simply change the value of the name, rather than tracking down every instance in the script where the value was used.


	== Example: puzzle with max 3 attempts, using variables and names ==		== Example: puzzle with max 3 attempts, using variables and names ==
Line 160:		Line 161:
	$puzzle.setFrobable(1); //also make sure the puzzle entity is frobable		$puzzle.setFrobable(1); //also make sure the puzzle entity is frobable
	}		}


	== Using the TDM Script Reference ==		== Using the TDM Script Reference ==

Dragofer: /* #defining names */

2020-12-28T22:18:38Z

#defining names

← Older revision		Revision as of 22:18, 28 December 2020
Line 127:		Line 127:

	== #defining names ==		== #defining names ==
	~~Defining names can be seen as creating synonyms for a value, making~~ it easier to keep track of what they stand for and probably also easier to work with. For example, the number 60 can be defined as a "minute":		Naming important values makes it easier to keep track of what they stand for and probably also easier to work with. For example, the number 60 can be defined as a "minute":
	#define MINUTE 60 //define a name "MINUTE", which stands for "60". No semicolon needed, since it's not an instruction.		#define MINUTE 60 //define a name "MINUTE", which stands for "60". No semicolon needed, since it's not an instruction.
	sys.wait(5 * MINUTE); //let the script wait for 5 * 60 = 300s, so 5 minutes		sys.wait(5 * MINUTE); //let the script wait for 5 * 60 = 300s, so 5 minutes
Line 138:		Line 138:

	A major advantage of using names is that they make it very easy to change a commonly used value: simply change the value of the name, rather than tracking down every instance in the script where the value was used.		A major advantage of using names is that they make it very easy to change a commonly used value: simply change the value of the name, rather than tracking down every instance in the script where the value was used.


	== Example: puzzle with max 3 attempts, using variables and names ==		== Example: puzzle with max 3 attempts, using variables and names ==

Dragofer at 22:17, 28 December 2020

2020-12-28T22:17:37Z

← Older revision		Revision as of 22:17, 28 December 2020
Line 138:		Line 138:

	A major advantage of using names is that they make it very easy to change a commonly used value: simply change the value of the name, rather than tracking down every instance in the script where the value was used.		A major advantage of using names is that they make it very easy to change a commonly used value: simply change the value of the name, rather than tracking down every instance in the script where the value was used.


	== Example: puzzle with max 3 attempts, using variables and names ==		== Example: puzzle with max 3 attempts, using variables and names ==

Dragofer: /* #defining names */

2020-12-28T22:17:15Z

#defining names

← Older revision		Revision as of 22:17, 28 December 2020
Line 132:		Line 132:


	Another example is sound channels: each sound channel has a number, and the TDM team has used #define to name each them. This allows scripters to use either a name or a float in sound script events:		Another example is sound channels: each sound channel has a number, and the TDM team has used #define to name each of them. This allows scripters to use either a name or a float in sound script events:
	#define SND_CHANNEL_VOICE 1 //define "SND_CHANNEL_VOICE" as standing for "1"		#define SND_CHANNEL_VOICE 1 //define "SND_CHANNEL_VOICE" as standing for "1"
	$func_static_1.stopSound(SND_CHANNEL_VOICE); //stop sounds playing in channel 1, aka SND_CHANNEL_VOICE		$func_static_1.stopSound(SND_CHANNEL_VOICE); //stop sounds playing in channel 1, aka SND_CHANNEL_VOICE

Dragofer: /* #defining names */

2020-12-28T22:16:36Z

#defining names

← Older revision		Revision as of 22:16, 28 December 2020
Line 130:		Line 130:
	#define MINUTE 60 //define a name "MINUTE", which stands for "60". No semicolon needed, since it's not an instruction.		#define MINUTE 60 //define a name "MINUTE", which stands for "60". No semicolon needed, since it's not an instruction.
	sys.wait(5 * MINUTE); //let the script wait for 5 * 60 = 300s, so 5 minutes		sys.wait(5 * MINUTE); //let the script wait for 5 * 60 = 300s, so 5 minutes


	Another example is sound channels: each sound channel has a number, and the TDM team has used #define to name each them. This allows scripters to use either a name or a float in sound script events:		Another example is sound channels: each sound channel has a number, and the TDM team has used #define to name each them. This allows scripters to use either a name or a float in sound script events:

Dragofer: /* Example: puzzle with max 3 attempts, using variables and names */

2020-12-28T22:14:36Z

Example: puzzle with max 3 attempts, using variables and names

← Older revision		Revision as of 22:14, 28 December 2020
Line 143:		Line 143:

	#define MAX_ATTEMPTS 3 //give the name "MAX_ATTEMPTS" to the number 3		#define MAX_ATTEMPTS 3 //give the name "MAX_ATTEMPTS" to the number 3
	float attempts_left = MAX_ATTEMPTS; //set the initial value of the variable "attempts_left" to: MAX_ATTEMPTS.		float attempts_left = MAX_ATTEMPTS; //set the initial value of the variable "attempts_left" to: MAX_ATTEMPTS, or 3.

Dragofer: /* Example: puzzle with max 3 attempts, using variables and names */

2020-12-28T22:14:15Z

Example: puzzle with max 3 attempts, using variables and names

← Older revision		Revision as of 22:14, 28 December 2020
Line 142:		Line 142:
	Say you wanted to give a player 3 attempts to solve a puzzle, with an option to reset his number of attempts:		Say you wanted to give a player 3 attempts to solve a puzzle, with an option to reset his number of attempts:

	#define MAX_ATTEMPTS 3 //give the name "MAX_ATTEMPTS" to the number 3~~. Can easily change to a different number~~		#define MAX_ATTEMPTS 3 //give the name "MAX_ATTEMPTS" to the number 3
	float attempts_left = MAX_ATTEMPTS; //set the initial value of attempts_left to: MAX_ATTEMPTS.		float attempts_left = MAX_ATTEMPTS; //set the initial value of the variable "attempts_left" to: MAX_ATTEMPTS.

Dragofer: /* Example: puzzle with max 3 attempts, using variables and names */

2020-12-28T22:12:45Z

Example: puzzle with max 3 attempts, using variables and names

← Older revision		Revision as of 22:12, 28 December 2020
Line 144:		Line 144:
	#define MAX_ATTEMPTS 3 //give the name "MAX_ATTEMPTS" to the number 3. Can easily change to a different number		#define MAX_ATTEMPTS 3 //give the name "MAX_ATTEMPTS" to the number 3. Can easily change to a different number
	float attempts_left = MAX_ATTEMPTS; //set the initial value of attempts_left to: MAX_ATTEMPTS.		float attempts_left = MAX_ATTEMPTS; //set the initial value of attempts_left to: MAX_ATTEMPTS.


	void attempt_failed() //this script is called every time the player fails an attempt		void attempt_failed() //this script is called every time the player fails an attempt
Line 158:		Line 159:
	$puzzle.setFrobable(1); //also make sure the puzzle entity is frobable		$puzzle.setFrobable(1); //also make sure the puzzle entity is frobable
	}		}




	== Using the TDM Script Reference ==		== Using the TDM Script Reference ==