Writing Script Objects - Revision history

Tels: Tels moved page Writing script objects to Writing Script Objects

2014-10-03T11:19:36Z

← Older revision	Revision as of 11:19, 3 October 2014
(No difference)

2014-10-03T11:19:17Z

add more info

@@ Line 81: / Line 81: @@
 For a more complete example see '''script/tdm_location_settings.script'''.
 === Notes ===
-Avoid method names that already exist in the C++ code. For instance "Restore()", "Save()", "Spawn()" etc. These all might cause unwanted side-effects or crashes. They also make it impossible to be called from the C++ code.
+* Avoid method names that already exist in the C++ code. For instance "Restore()", "Save()", "Spawn()" etc. These all might cause unwanted side-effects or crashes. They also make it impossible to be called from the C++ code.
 {{infobox|Note: Make sure to include it from '''script/tdm_custom_scripts.script''', and '''not''' from your main map script. Otherwise savegames cannot be loaded!}}

2012-09-01T09:35:00Z

use the right name

← Older revision		Revision as of 09:35, 1 September 2012
Line 86:		Line 86:
	Avoid method names that already exist in the C++ code. For instance "Restore()", "Save()", "Spawn()" etc. These all might cause unwanted side-effects or crashes. They also make it impossible to be called from the C++ code.		Avoid method names that already exist in the C++ code. For instance "Restore()", "Save()", "Spawn()" etc. These all might cause unwanted side-effects or crashes. They also make it impossible to be called from the C++ code.

	It is sensible to put your script object in its own file. ~~If you do so, make~~ sure to include it from ''script/~~tdm_custom_include~~.script'', '''not''' from your main map script. Otherwise savegames cannot be loaded!		It is sensible to put your script object in its own file.

			{{infobox\|Note: Make sure to include it from '''script/tdm_custom_scripts.script''', and '''not''' from your main map script. Otherwise savegames cannot be loaded!}}

	== Pre-made Script Objects ==		== Pre-made Script Objects ==

2012-09-01T09:11:22Z

Notes

← Older revision		Revision as of 09:11, 1 September 2012
Line 85:		Line 85:

	Avoid method names that already exist in the C++ code. For instance "Restore()", "Save()", "Spawn()" etc. These all might cause unwanted side-effects or crashes. They also make it impossible to be called from the C++ code.		Avoid method names that already exist in the C++ code. For instance "Restore()", "Save()", "Spawn()" etc. These all might cause unwanted side-effects or crashes. They also make it impossible to be called from the C++ code.

			It is sensible to put your script object in its own file. If you do so, make sure to include it from ''script/tdm_custom_include.script'', '''not''' from your main map script. Otherwise savegames cannot be loaded!

	== Pre-made Script Objects ==		== Pre-made Script Objects ==

2011-01-15T11:21:38Z

remove double text

← Older revision		Revision as of 11:21, 15 January 2011
Line 89:		Line 89:

	TDM already contains some useful script objects that you can attach to entities, see [[Script objects]] for a list.		TDM already contains some useful script objects that you can attach to entities, see [[Script objects]] for a list.

	~~=== tdm_suicide ===~~

	~~<pre>~~
	~~"script_object" "tdm_suicide"~~
	~~"remove_delay" "100" // remove this entity 100 seconds after spawning it~~
	~~</pre>~~

	~~=== tdm_light_holder ===~~

	~~<pre>~~
	~~"script_object" "tdm_light_holder"~~
	~~"extinguished" "1" // the light starts off, but can be lit by the player~~
	~~</pre>~~

	This is typical attached to either lights (an electrical lamp f.i.) or light holders (a candle holder with attached candle + flame, or a torch with attached flame). This script object has handy methods to toggle all lights that this holder has, regardless how many (multiple flames?) or where (flame on holder or flame on candle on holder?).

	~~This script object also makes the entity react to fire stims, an/or triggers like when you link a button/lever/trigger to this entity.~~

	{{scripting}}		{{scripting}}

2011-01-15T11:20:42Z

update after split

← Older revision		Revision as of 11:20, 15 January 2011
Line 88:		Line 88:
	== Pre-made Script Objects ==		== Pre-made Script Objects ==

	TDM already contains some useful script objects that you can attach to entities:		TDM already contains some useful script objects that you can attach to entities, see [[Script objects]] for a list.

	=== tdm_suicide ===		=== tdm_suicide ===

2011-01-15T11:18:31Z

Script object moved to Writing script objects: Divide page into "write them" and "these exist"

← Older revision	Revision as of 11:18, 15 January 2011
(No difference)

2010-12-27T19:47:03Z

fix typo

← Older revision		Revision as of 19:47, 27 December 2010
Line 56:		Line 56:
	void the_script_object_name_here::RestoreScriptObject()		void the_script_object_name_here::RestoreScriptObject()
	{		{
	// print out that we are constructed for ~~debuggin;~~		// print out that we are constructed for debugging:
	sys.println ("the_script_object_name_here::RestoreScriptObject() called");		sys.println ("the_script_object_name_here::RestoreScriptObject() called");

2010-11-27T12:43:28Z

and another one

← Older revision		Revision as of 12:43, 27 November 2010
Line 64:		Line 64:
	}		}

	void the_script_object_name_here::~~RestoreScriptObject~~()		void the_script_object_name_here::updateLoop()
	{		{
	// endless loop		// endless loop

2010-11-27T12:43:01Z

fix typo

← Older revision		Revision as of 12:43, 27 November 2010
Line 57:		Line 57:
	{		{
	// print out that we are constructed for debuggin;		// print out that we are constructed for debuggin;
	sys.println ("the_script_object_name_here::~~init~~() called");		sys.println ("the_script_object_name_here::RestoreScriptObject() called");

	// We have to do nothing by default, everything is already restored		// We have to do nothing by default, everything is already restored