Fundamental Scripting Guide - Revision history

Dragofer: Redirected page to A to Z Scripting

2020-12-21T11:17:04Z

Dragofer at 09:16, 21 December 2020

2020-12-21T09:16:05Z

← Older revision		Revision as of 09:16, 21 December 2020
Line 20:		Line 20:
	! # !! Article !! Contents		! # !! Article !! Contents
	\|-		\|-
	\| 1 \|\| [[A-Z Scripting: Anatomy of a script]] \|\| Basic script literacy.		\| 1 \|\| [[A to Z Scripting: Anatomy of a script]] \|\| Basic script literacy.
	\|-		\|-
	\| 2 \|\| [[A-Z Scripting: More scripting basics]] \|\| Further basics, including how to use the [[TDM Script Reference]].		\| 2 \|\| [[A to Z Scripting: More scripting basics]] \|\| Further basics, including how to use the [[TDM Script Reference]].
	\|-		\|-
	\| 3 \|\| [[A-Z Scripting: Setting up the .script files]] \|\| How to add scripts to your mission or game.		\| 3 \|\| [[A to Z Scripting: Setting up the .script files]] \|\| How to add scripts to your mission or game.
	\|-		\|-
	\| 4 \|\| [[A-Z Scripting: Ways of calling a script]] \|\| Using trigger brushes, objectives and many other ways to initiate scripts.		\| 4 \|\| [[A to Z Scripting: Ways of calling a script]] \|\| Using trigger brushes, objectives and many other ways to initiate scripts.
	\|-		\|-
	\| 5 \|\| [[A-Z Scripting: ~~"Get"ting~~ map information]] \|\| ~~Finding~~		\| 5 \|\| [[A to Z Scripting: Getting map information]] \|\| Pulling information, such as an entity's location, from the map for use in a script.
	\|-		\|-
	\| 6 \|\| [[A-Z Scripting: Practical exercise: subtle teleportation]] \|\| A guided exercise in creating a		\| 6 \|\| [[A to Z Scripting: Practical exercise: subtle teleportation]] \|\| A guided exercise in creating a wizard's tower style teleportation.
	\|-		\|-
	\| 7 \|\| [[A-Z Scripting: Scripts that use input variables]] \|\| ~~Example~~		\| 7 \|\| [[A to Z Scripting: Scripts that use input variables]] \|\| Giving scripts input so the same script can easily be called on various entities with varying results.
	\|-		\|-
	\| 8 \|\| [[A-Z Scripting: Conditionals]] \|\| ~~Example~~		\| 8 \|\| [[A to Z Scripting: Conditionals]] \|\| Making the execution of a script depend on whether conditions are met.
	\|-		\|-
	\| 9 \|\| [[A-Z Scripting: Looping a script]] \|\| ~~Example~~		\| 9 \|\| [[A to Z Scripting: Looping a script]] \|\| Various ways of continuously running a script or until a task has been completed.
	\|-		\|-
	\| 10 \|\| [[A-Z Scripting: Scripting with...]] \|\| ~~Example~~		\| 10 \|\| [[A to Z Scripting: Scripting with...]] \|\| Useful things to know when writing scripts that involve i.e. AIs or sounds.
	\|-		\|-
	\| 11 \|\| [[A-Z Scripting: Special methods]] \|\| ~~Example~~		\| 11 \|\| [[A to Z Scripting: Special methods]] \|\| Running a script on every entity of a certain type or in a volume, spawning entities and more.
	\|-		\|-
	\| 12 \|\| [[A-Z Scripting: Scriptobjects]] \|\| ~~Example~~		\| 12 \|\| [[A to Z Scripting: Scriptobjects]] \|\| Creating entities with scripted behaviours.
	\|-		\|-
	\| 13 \|\| [[A-Z Scripting: Utility scripts]] \|\| ~~Example~~		\| 13 \|\| [[A to Z Scripting: Utility scripts]] \|\| Writing scripts that are designed to be used like script events.
	\|-		\|-
	\| 14 \|\| [[A-Z Scripting: Script addons for players]] \|\| ~~Example~~		\| 14 \|\| [[A to Z Scripting: Script addons for players]] \|\| Modifying a player's TDM experience, i.e. by getting rid of all spiders at every map start.
	\|-		\|-
	\| 15 \|\| [[A-Z Scripting: Troubleshooting]] \|\| ~~Example~~		\| 15 \|\| [[A to Z Scripting: Troubleshooting]] \|\| Techniques for solving problems; commonly encountered errors.
	\|}		\|}

Dragofer at 21:42, 20 December 2020

2020-12-20T21:42:59Z

← Older revision		Revision as of 21:42, 20 December 2020
Line 12:		Line 12:

	A lot can be said about scripting as this series shows, but as kingsal once said, even "a little scripting goes a long way", giving access to all kinds of new scripted effects and synergising with other systems.		A lot can be said about scripting as this series shows, but as kingsal once said, even "a little scripting goes a long way", giving access to all kinds of new scripted effects and synergising with other systems.


			== The A to Z Scripting series ==

			{\| class="wikitable"
			\|-
			! # !! Article !! Contents
			\|-
			\| 1 \|\| [[A-Z Scripting: Anatomy of a script]] \|\| Basic script literacy.
			\|-
			\| 2 \|\| [[A-Z Scripting: More scripting basics]] \|\| Further basics, including how to use the [[TDM Script Reference]].
			\|-
			\| 3 \|\| [[A-Z Scripting: Setting up the .script files]] \|\| How to add scripts to your mission or game.
			\|-
			\| 4 \|\| [[A-Z Scripting: Ways of calling a script]] \|\| Using trigger brushes, objectives and many other ways to initiate scripts.
			\|-
			\| 5 \|\| [[A-Z Scripting: "Get"ting map information]] \|\| Finding
			\|-
			\| 6 \|\| [[A-Z Scripting: Practical exercise: subtle teleportation]] \|\| A guided exercise in creating a
			\|-
			\| 7 \|\| [[A-Z Scripting: Scripts that use input variables]] \|\| Example
			\|-
			\| 8 \|\| [[A-Z Scripting: Conditionals]] \|\| Example
			\|-
			\| 9 \|\| [[A-Z Scripting: Looping a script]] \|\| Example
			\|-
			\| 10 \|\| [[A-Z Scripting: Scripting with...]] \|\| Example
			\|-
			\| 11 \|\| [[A-Z Scripting: Special methods]] \|\| Example
			\|-
			\| 12 \|\| [[A-Z Scripting: Scriptobjects]] \|\| Example
			\|-
			\| 13 \|\| [[A-Z Scripting: Utility scripts]] \|\| Example
			\|-
			\| 14 \|\| [[A-Z Scripting: Script addons for players]] \|\| Example
			\|-
			\| 15 \|\| [[A-Z Scripting: Troubleshooting]] \|\| Example
			\|}

Dragofer at 21:16, 20 December 2020

2020-12-20T21:16:52Z

← Older revision		Revision as of 21:16, 20 December 2020
Line 9:		Line 9:
	Mappers in TDM are fortunate to have a large selection of entities and systems, such as the objective and stim/response systems, that allow them to access scripted effects. Those systems are already quite powerful, allowing for relatively complex setups without ever writing a single line.		Mappers in TDM are fortunate to have a large selection of entities and systems, such as the objective and stim/response systems, that allow them to access scripted effects. Those systems are already quite powerful, allowing for relatively complex setups without ever writing a single line.

	Knowing your way around scripts, however, adds a whole new level of control ~~to what goes on in the mission~~. While a teleportation entity can only teleport something to a predetermined position, a script can automatically calculate the destination, what to teleport and whether to teleport. As kingsal once said, "a little scripting goes a long way"~~: just knowing how~~ to		Knowing your way around scripts, however, adds a whole new level of control. While a teleportation entity can only teleport something to a predetermined position, a script can automatically calculate the destination, what to teleport and whether to teleport.

			A lot can be said about scripting as this series shows, but as kingsal once said, even "a little scripting goes a long way", giving access to all kinds of new scripted effects and synergising with other systems.

Dragofer at 19:23, 20 December 2020

2020-12-20T19:23:21Z

← Older revision		Revision as of 19:23, 20 December 2020
Line 4:		Line 4:

	The first sections up to "Practical exercise: subtly teleporting the player" are written more in the style of a beginner's guide, while later sections aim to collect everything related to scripting in one place and out of one hand. So the recommended usage of this resource for a beginner would be to use the initial sections to learn the basics, then gradually acquire the remaining techniques & principles whenever you need something new for what you're trying to do.		The first sections up to "Practical exercise: subtly teleporting the player" are written more in the style of a beginner's guide, while later sections aim to collect everything related to scripting in one place and out of one hand. So the recommended usage of this resource for a beginner would be to use the initial sections to learn the basics, then gradually acquire the remaining techniques & principles whenever you need something new for what you're trying to do.


			== Why script? ==
			Mappers in TDM are fortunate to have a large selection of entities and systems, such as the objective and stim/response systems, that allow them to access scripted effects. Those systems are already quite powerful, allowing for relatively complex setups without ever writing a single line.

			Knowing your way around scripts, however, adds a whole new level of control to what goes on in the mission. While a teleportation entity can only teleport something to a predetermined position, a script can automatically calculate the destination, what to teleport and whether to teleport. As kingsal once said, "a little scripting goes a long way": just knowing how to

Dragofer at 14:21, 20 December 2020

2020-12-20T14:21:04Z

← Older revision		Revision as of 14:21, 20 December 2020
Line 20:		Line 20:
	\| Scriptobject \|\| This is a powerful set of scripts that are assigned to single entities. It allows creating entities with scripted behaviours, i.e. a candle holder that controls the skin, particle, lit state etc. of its candle.		\| Scriptobject \|\| This is a powerful set of scripts that are assigned to single entities. It allows creating entities with scripted behaviours, i.e. a candle holder that controls the skin, particle, lit state etc. of its candle.
	\|-		\|-
	\| Variables \|\| Variables store a piece of data, such as an entity's name or a position, which can be used ~~or modified~~ by a script event. They are another basic building block, allowing a script to have variable effects and to store data for later use. ~~Each~~ variable ~~must be named~~ and ~~given~~ a data type.		\| Variables \|\| Variables store a piece of data, such as an entity's name or a position, which can be modified or used by a script event. They are another basic building block, allowing a script to have variable effects and to store data for later use. Every variable needs to have a name and a data type.
	\|-		\|-
	\| Data types \|\| This informs the engine whether a piece of data is a text (string), number (float), vector etc. Every variable and every input/output of a script event needs to have a data type~~. This is needed to inform the engine whether it should be read as a text (string), number (float), vector etc~~.		\| Data types \|\| This informs the engine whether a piece of data is a text (string), number (float), vector etc. Every variable and every input/output of a script event needs to have a data type.
	\|}		\|}

Line 34:		Line 34:

	* sys.		* sys.
	** Every script event ~~must~~ be ~~called~~ on an entity. ~~For very~~ generic events like "wait"~~, sys is~~ typically used, shorthand for the system entity.		** Every script event needs to be used on an entity. Very generic events like "wait" are typically used on sys, which is shorthand for the system entity.

	* wait(3)		* wait(3)
Line 48:		Line 48:
	$player1.setOrigin('0 150 0');		$player1.setOrigin('0 150 0');

	* $player1		* $player1.
	** Notice the $ sign: this means the script engine should look for a specific entity in the game with that name. The player is always called "player1".		** Notice the $ sign: this means the script engine should look for a specific entity in the game with that name. The player is always called "player1".

Dragofer at 10:42, 20 December 2020

2020-12-20T10:42:06Z

← Older revision		Revision as of 10:42, 20 December 2020
Line 14:		Line 14:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	\| Script events \|\| ~~Script events are an~~ action of some kind, i.e. waiting x seconds or triggering an entity. They are the basic building blocks of scripting.		\| Script events \|\| For purposes of this guide, a script event is a single action of some kind, i.e. waiting x seconds or triggering an entity. They are the basic building blocks of scripting.
	\|-		\|-
	\| Script function \|\| ~~This~~ is ~~the technically correct term for~~ a "script"~~. Script functions often contain many script events, and some can also be used like script events ("utility scripts")~~. Usually this guide will refer to them simply as "scripts".		\| Script function \|\| For purposes of this guide, a script function is what one thinks of as a "script": a set of instructions. Usually this guide will refer to them simply as "scripts".
	\|-		\|-
	\| Scriptobject \|\| This is a powerful set of scripts that are ~~applied~~ to single entities. ~~This~~ allows ~~you to write code once~~, ~~but let it apply to an unlimited number of entities without conflicts~~. ~~An example is the tdm_light_holder scriptobject, which~~ controls the skin, particle, lit state etc. of its candle.		\| Scriptobject \|\| This is a powerful set of scripts that are assigned to single entities. It allows creating entities with scripted behaviours, i.e. a candle holder that controls the skin, particle, lit state etc. of its candle.
	\|-		\|-
	\| Variables \|\| Variables are another basic building block ~~and allow~~ a script to have variable effects and to store data for ~~further~~ use ~~elsewhere~~. Each variable must be named and given a data type.		\| Variables \|\| Variables store a piece of data, such as an entity's name or a position, which can be used or modified by a script event. They are another basic building block, allowing a script to have variable effects and to store data for later use. Each variable must be named and given a data type.
	\|-		\|-
	\| Data types \|\| Every variable and every input/output of a script event needs to have a data type. This is needed to inform the engine whether it should be read as a text (string), number (float), vector etc.		\| Data types \|\| This informs the engine whether a piece of data is a text (string), number (float), vector etc. Every variable and every input/output of a script event needs to have a data type. This is needed to inform the engine whether it should be read as a text (string), number (float), vector etc.
	\|}		\|}

Geep: /* Example: sending a message to the console */ In 1st println example, replaced asymmetric double quotes with symmetric

2020-12-20T00:46:39Z

Example: sending a message to the console: In 1st println example, replaced asymmetric double quotes with symmetric

← Older revision		Revision as of 00:46, 20 December 2020
Line 63:		Line 63:
	void test_script()		void test_script()
	{		{
	sys.println(~~“Test~~ message.”);		sys.println("Test message.");
	}		}

Line 78:		Line 78:

	* sys.println("Test message");		* sys.println("Test message");
	** This is a script event which prints a text to the console and then leaves a line (ln) so that every text is on its own line.		** This is a script event which prints a text to the console and then leaves a line (ln) so that every text is on its own line.


	==== Example: simple cutscene ====		==== Example: simple cutscene ====

Dragofer at 17:32, 18 December 2020

2020-12-18T17:32:53Z

Show changes

Dragofer at 17:15, 18 December 2020

2020-12-18T17:15:01Z

Show changes