Script: CR to OC - Revision history

Newton: /* Obsolete stuff */

2014-04-29T05:40:11Z

Obsolete stuff

← Older revision		Revision as of 05:40, 29 April 2014
Line 96:		Line 96:
	* constants like <tt>C4D_</tt>, <tt>COMD_</tt>, <tt>VIS_</tt> or <tt>OCF_</tt> are now only defined as constants and not also as functions: e.g. <tt>C4D_Living<s>()</s></tt>		* constants like <tt>C4D_</tt>, <tt>COMD_</tt>, <tt>VIS_</tt> or <tt>OCF_</tt> are now only defined as constants and not also as functions: e.g. <tt>C4D_Living<s>()</s></tt>
	* Arithmetic functions like <tt>Sum()</tt>, <tt>Div()</tt>, <tt>Mul()</tt>, ... and logic functions like <tt>GreaterThan()</tt>, <tt>And()</tt>, <tt>Not</tt>, ... are gone. Use operators.		* Arithmetic functions like <tt>Sum()</tt>, <tt>Div()</tt>, <tt>Mul()</tt>, ... and logic functions like <tt>GreaterThan()</tt>, <tt>And()</tt>, <tt>Not</tt>, ... are gone. Use operators.
	* Numbered variables like <tt>Global</tt>(), <tt>Local</tt>, <tt>EffectVar</tt> are gone.		* Numbered variables like <tt>Global()</tt>, <tt>Local()</tt>, <tt>EffectVar()</tt> are gone.

	= zoomed Graphics.png =		= zoomed Graphics.png =

Newton: /* Obsolete stuff */

2014-04-29T05:39:40Z

Obsolete stuff

← Older revision		Revision as of 05:39, 29 April 2014
Line 91:		Line 91:

	= Obsolete stuff =		= Obsolete stuff =
	The backward compatibility was dropped, so certain deprecated/obsolete stuff was finally dropped. ~~So most~~ of this will not apply to someone wanting to convert something from Clonk Rage. A non exhaustive list:		The backward compatibility was dropped, so certain deprecated/obsolete stuff was finally dropped. Most of this will not apply to someone wanting to convert something from Clonk Rage. A non exhaustive list:

	* <tt>#strict</tt> is gone. All scripts are "strict".		* <tt>#strict</tt> is gone. All scripts are "strict".
	* constants like <tt>C4D_</tt>, <tt>COMD_</tt>, <tt>VIS_</tt> or <tt>OCF_*</tt> are now only defined as constants and not also as functions: e.g. <tt>C4D_Living<s>()</s></tt>		* constants like <tt>C4D_</tt>, <tt>COMD_</tt>, <tt>VIS_</tt> or <tt>OCF_</tt> are now only defined as constants and not also as functions: e.g. <tt>C4D_Living<s>()</s></tt>
	* Arithmetic functions like <tt>Sum()</tt>, <tt>Div()</tt>, <tt>Mul()</tt>, ... and logic functions like <tt>GreaterThan()</tt>, <tt>And()</tt>, <tt>Not</tt>, ... are gone. Use operators.		* Arithmetic functions like <tt>Sum()</tt>, <tt>Div()</tt>, <tt>Mul()</tt>, ... and logic functions like <tt>GreaterThan()</tt>, <tt>And()</tt>, <tt>Not</tt>, ... are gone. Use operators.
	* Numbered variables like <tt>Global</tt>(), <tt>Local</tt>, <tt>EffectVar</tt> are gone.		* Numbered variables like <tt>Global</tt>(), <tt>Local</tt>, <tt>EffectVar</tt> are gone.


	= zoomed Graphics.png =		= zoomed Graphics.png =

Newton: add section obsolete stuff

2014-04-29T05:39:01Z

add section obsolete stuff

← Older revision		Revision as of 05:39, 29 April 2014
Line 89:		Line 89:
	// wrong: Collect(my_item, clonk);		// wrong: Collect(my_item, clonk);
	</code>		</code>

			= Obsolete stuff =
			The backward compatibility was dropped, so certain deprecated/obsolete stuff was finally dropped. So most of this will not apply to someone wanting to convert something from Clonk Rage. A non exhaustive list:

			* <tt>#strict</tt> is gone. All scripts are "strict".
			* constants like <tt>C4D_</tt>, <tt>COMD_</tt>, <tt>VIS_</tt> or <tt>OCF_*</tt> are now only defined as constants and not also as functions: e.g. <tt>C4D_Living<s>()</s></tt>
			* Arithmetic functions like <tt>Sum()</tt>, <tt>Div()</tt>, <tt>Mul()</tt>, ... and logic functions like <tt>GreaterThan()</tt>, <tt>And()</tt>, <tt>Not</tt>, ... are gone. Use operators.
			* Numbered variables like <tt>Global</tt>(), <tt>Local</tt>, <tt>EffectVar</tt> are gone.


	= zoomed Graphics.png =		= zoomed Graphics.png =

Newton: /* zoomed Graphics.png */

2014-04-29T05:12:00Z

zoomed Graphics.png

← Older revision		Revision as of 05:12, 29 April 2014
Line 96:		Line 96:
	Overlay.4.png		Overlay.4.png
	</pre>		</pre>
			Graphics like these will be shown at 1:1 if zoomed in x4.

	= 3D Models =		= 3D Models =

Newton: add example to nil value

2014-04-29T05:10:59Z

add example to nil value

← Older revision		Revision as of 05:10, 29 April 2014
Line 65:		Line 65:

	= nil value =		= nil value =
	Variables can now have the value "nil" which simply stands for "nothing". An unassigned variable will now have the value "nil" instead of "0" in ClonkRage		Variables can now have the value "nil" which simply stands for "nothing". An unassigned variable will now have the value "nil" instead of "0" in ClonkRage.

			A good example:
			<code type="c4script">
			// create rock, the owner of the rock is the controller of the calling object
			CreateObject(Rock, 0, 10);
			// same as above
			CreateObject(Rock, 0, 10, nil);
			// create rock, the owner is player 0!
			CreateObject(Rock, 0, 10, 0);
			</code>
			So, nil is not 0. It is normally used to deliberately not specify optional parameters.

	= -> for function calls =		= -> for function calls =

Newton: controls

2014-03-22T06:11:52Z

controls

← Older revision		Revision as of 06:11, 22 March 2014
Line 140:		Line 140:
	= Map Scripts =		= Map Scripts =
	Additionally to static bitmap landscapes and dynamic Landscape.txt landscapes, one can define dynamic maps in script, also at runtime. The old Landscape.txt landscape generation is not obsolete but can still be used. [http://docs.openclonk.org/en/sdk/script/MapScript.html See reference].		Additionally to static bitmap landscapes and dynamic Landscape.txt landscapes, one can define dynamic maps in script, also at runtime. The old Landscape.txt landscape generation is not obsolete but can still be used. [http://docs.openclonk.org/en/sdk/script/MapScript.html See reference].

			= Controls =
			The player controls are defined completely in script now, using PlayerControls.txt. So, to create controls similar as they were in Clonk Rage should be possible. Even on a per-scenario basis. [http://docs.openclonk.org/en/sdk/playercontrols.html See reference].

Newton: add map scripts

2014-03-22T06:02:13Z

add map scripts

← Older revision		Revision as of 06:02, 22 March 2014
Line 137:		Line 137:

	So, to make a complex object properly savable into a scenario, it needs to define which properties should be saved. See the [http://docs.openclonk.org/en/sdk/definition/script.html#ScenSave reference] for more information.		So, to make a complex object properly savable into a scenario, it needs to define which properties should be saved. See the [http://docs.openclonk.org/en/sdk/definition/script.html#ScenSave reference] for more information.

			= Map Scripts =
			Additionally to static bitmap landscapes and dynamic Landscape.txt landscapes, one can define dynamic maps in script, also at runtime. The old Landscape.txt landscape generation is not obsolete but can still be used. [http://docs.openclonk.org/en/sdk/script/MapScript.html See reference].

Newton: add docs links

2014-03-22T05:58:48Z

add docs links

← Older revision		Revision as of 05:58, 22 March 2014
Line 61:		Line 61:
	Collect(axe);		Collect(axe);
	</code>		</code>

			The reference has an overview over the [http://docs.openclonk.org/en/sdk/definition/properties.html object properties] and (remaining) [http://docs.openclonk.org/en/sdk/definition/defcore.html DefCore values].

	= nil value =		= nil value =

Newton: add saving as scenario

2014-03-22T05:56:55Z

add saving as scenario

← Older revision		Revision as of 05:56, 22 March 2014
Line 110:		Line 110:
	</code>		</code>
	There are also some standard properties like "Interval" that you can use to change the interval at which Fx*Timer is called (see the [http://docs.openclonk.org/en/sdk/script/Effects.html#Properties reference])		There are also some standard properties like "Interval" that you can use to change the interval at which Fx*Timer is called (see the [http://docs.openclonk.org/en/sdk/script/Effects.html#Properties reference])

			= Scenario saving =
			Remember the hassle with the "saving as scenario" in editor mode? There is no huge Objects.txt anymore, instead, all the objects placed in the editor mode are serialized into a script, Objects.c. Only standard properties are saved and only if they are different from the default. This makes scenarios created in the editor much more maintainable.

			Each object can define certain properties which shall be saved on a scenario save, for example some switch will save its target object:

			<code type="c4script">local target;

			func SetTarget(object new_target) { target = new_target; return true; }

			func SaveScenarioObject(props)
			{
			if (!inherited(props, ...)) return false;
			if (target) props->AddCall("Target", this, "SetTarget", target);
			return true;
			}</code>

			This results in the generation of this script on scenario save in Objects.c:

			<code type="c4script">var door235 = CreateObject(Door,2354,124);
			...
			var switch001 = CreateObject(Switch,124,354);
			switch001->SetTarget(door235);</code>

			So, to make a complex object properly savable into a scenario, it needs to define which properties should be saved. See the [http://docs.openclonk.org/en/sdk/definition/script.html#ScenSave reference] for more information.

Zapper: /* Effect variables */

2013-02-04T10:49:57Z

Effect variables

← Older revision		Revision as of 10:49, 4 February 2013
Line 97:		Line 97:
	Remember "EffectVar" from ClonkRage that you could use to store variables in effects? The effect is now a proplist and that means that you can simply assign properties to it if you need variables:		Remember "EffectVar" from ClonkRage that you could use to store variables in effects? The effect is now a proplist and that means that you can simply assign properties to it if you need variables:
	<code>		<code>
	func FxMyEffectStart(object target, ~~proplist~~ effect, bool temp)		func FxMyEffectStart(object target, effect fx, bool temp)
	{		{
	// invent new property!		// invent new property!
	~~effect~~.max_time = 100;		fx.max_time = 100;
	}		}

	func FxMyEffectTimer(object target, ~~proplist~~ effect, int time)		func FxMyEffectTimer(object target, effect fx, int time)
	{		{
	if (time > ~~effect~~.max_time) return -1;		if (time > fx.max_time) return -1;
	Message("Not over yet!");		Message("Not over yet!");
	}		}
	</code>		</code>
	There are also some standard properties like "Interval" that you can use to change the interval at which Fx*Timer is called (see the [http://docs.openclonk.org/en/sdk/script/Effects.html#Properties reference])		There are also some standard properties like "Interval" that you can use to change the interval at which Fx*Timer is called (see the [http://docs.openclonk.org/en/sdk/script/Effects.html#Properties reference])