Scripting Documentation - Revision history

Ringwaul at 20:22, 5 October 2011

2011-10-05T20:22:50Z

← Older revision		Revision as of 20:22, 5 October 2011
Line 89:		Line 89:

	====Make it Bounce!====		====Make it Bounce!====
	For this example, we'll make ~~a secondary function that~~ the Hit~~() function will call~~. ~~While not quite necessary, this~~ is a ~~good way to become familiar~~ with ~~how functions work~~.		For this example, we'll make use of the variables given by the Hit callback. The Hit callback is a function called by the engine whenever an object strikes the ground with sufficient force.

	~~Underneath~~ the Hit ~~function~~, ~~start a new function called 'Bounce~~'. ~~The syntax should look~~ as such:		The Hit function used in the previous example didn't make use of the variables which the Hit callback uses, so we'll have to add those into the script. Formerly the Hit function was written as such:
	~~[[File:BounceFunction.png\|border]]~~		<pre width=40>
			protected func Hit()
			{
			//
			}
			</pre>

	~~Where~~ the ~~commented line is ( // )~~, ~~remove that and~~ add ~~this function: 'SetYDir(level);'~~. ~~Under that line, add a~~		Within the brackets, add "int xdir, int ydir". This will allow the Hit callback to receive the x speed and y speed of the object when it hit the ground. Now we can use these variables within the Hit function and manipulate the object's speed to simulate a bounce.
	~~'return 1;'~~ to ~~end~~ the ~~function~~. Now ~~let's look back at~~ the Hit() function~~. Remove~~ the '~~Explode()' function there. This time, write in: 'Bounce(-20);'~~.

	~~Now when~~ the ~~Hit~~() function ~~is called~~, ~~it will call~~ the ~~Bounce~~ function~~, passing '-20' as~~ the ~~'level'~~ parameter~~. Test it out in game, see if it works~~.		To do this, a simple reversal of the ydir is enough. To set an object's y speed, we use the function "SetYDir()". The new speed we wish the object to have will be written inside the brackets (the first parameter). Of course, to reverse a value, all we have to do is multiply the number by negative one. There is another thing we need to pay attention to specific to the Hit function; the variables for xdir and ydir have a precision value of 100. Therefore, in the SetYDir function we must define that (the second parameter).

	~~'''Todo~~: ~~Some more basic tuts'''~~		The script should be written something like this:
			<pre width=50>
			protected func Hit(int xdir, int ydir)
			{
			SetYDir(ydir * -1, 100);
			return 1;
			}</pre>

Ringwaul: /* The DefCore */

2011-10-05T19:03:27Z

The DefCore

← Older revision		Revision as of 19:03, 5 October 2011
Line 25:		Line 25:
	[DefCore]		[DefCore]
	id=TemplateObject		id=TemplateObject
	Version=4,10,0,0		Version=5,2,0,1
	Category=C4D_Object		Category=C4D_Object
	Width=8		Width=8
Line 44:		Line 44:
	[DefCore]		[DefCore]
	id=MyObject		id=MyObject
	Version=4,10,0,0		Version=5,2,0,1
	...etc.		...etc.
	</pre>		</pre>

Ringwaul: /* The DefCore */

2011-10-05T19:02:39Z

The DefCore

@@ Line 40: / Line 40: @@
 </pre>
-What do all these things do? Here's a breakdown of the definitions we're using:
+DefCores contain a fair amount of basic object data, but for now we only need to change the ID to something unique; for example:
 <pre width=40>
 [DefCore]

Ringwaul: /* Creating your First Object */

2011-10-05T18:58:51Z

Creating your First Object

← Older revision		Revision as of 18:58, 5 October 2011
Line 13:		Line 13:
	Here we will cover the basic steps on creating a new object usable within OpenClonk.		Here we will cover the basic steps on creating a new object usable within OpenClonk.

	Because creating each new object from scratch would be tedious, repetitive work, we provide a template object to work with~~. This is available within the base Objects.ocd (TemplateObject.ocd)~~.		Because creating each new object from scratch would be tedious, repetitive work, we provide a template object to work with.

	'''Step 1'''		'''Step 1'''

Ringwaul: /* Make it Bounce! */

2011-05-22T22:10:58Z

Make it Bounce!

← Older revision		Revision as of 22:10, 22 May 2011
Line 162:		Line 162:

	Now when the Hit() function is called, it will call the Bounce function, passing '-20' as the 'level' parameter. Test it out in game, see if it works.		Now when the Hit() function is called, it will call the Bounce function, passing '-20' as the 'level' parameter. Test it out in game, see if it works.


	Unfortunately, this bounce isn't very realistic. And further unfortunately, due to when the hit function is called we can't simply put 'SetYDir((GetYDir() * -1) / 2);' into the Hit Function for a quick and realistic bounce. This problem requires an effect to get the last vertical speed (ydir) before it hit the ground (which is now zero, causing no bounce to occur).

	~~Make your script as such for a realistic bounce:~~

	~~<pre>~~
	~~local currentydir;~~
	~~local lastydir;~~

	~~protected func Initialize()~~
	{
	~~lastydir = 0;~~
	~~currentydir = 0;~~
	~~AddEffect("Bounce", this, 1,1,this);~~
	}

	~~protected func Hit()~~
	{
	~~Sound("RockHit*");~~
	~~SetYDir((lastydir * -1) / 2);~~
	~~return 1;~~
	}

	~~func FxBounceTimer(object target, int num, int timer)~~
	{
	~~lastydir = crntydir;~~
	~~currentydir = GetYDir();~~
	}
	~~</pre>~~

	Here we are using some local variables for the object, and a timed effect. The FxBounceTimer function sets the 'lastydir' to the previous 'currentydir' and updates the 'currentydir' variable to the actual vertical speed at the current frame. Thus two variables are stored; last frame's vertical speed and the current frame's vertical speed.

	~~Now in the Hit() function, we can use the 'lastydir' variable. Test it in game, and watch your object bounce about. :]~~

	~~Remember, to quickly test objects use '/script GetCursor()->CreateContents(MyObject)', where 'MyObject' is the ID of your object.~~

	'''Todo: Some more basic tuts'''		'''Todo: Some more basic tuts'''

Ringwaul: /* Make it Bounce! */

2011-05-18T02:19:37Z

Make it Bounce!

← Older revision		Revision as of 02:19, 18 May 2011
Line 158:		Line 158:
	[[File:BounceFunction.png\|border]]		[[File:BounceFunction.png\|border]]

	Where the commented line is ( // ), remove that and add this function: 'SetYDir(~~-20~~);'. Under that line, add a		Where the commented line is ( // ), remove that and add this function: 'SetYDir(level);'. Under that line, add a
	'return 1;' to end the function. Now let's look back at the Hit() function. Remove the 'Explode()' function there. This time, write in: 'Bounce(~~GetYDir()~~);'.		'return 1;' to end the function. Now let's look back at the Hit() function. Remove the 'Explode()' function there. This time, write in: 'Bounce(-20);'.

	Now when the Hit() function is called, it will call the Bounce function, passing '-20' as the 'level' parameter. Test it out in game, see if it works.		Now when the Hit() function is called, it will call the Bounce function, passing '-20' as the 'level' parameter. Test it out in game, see if it works.

Ringwaul at 01:17, 18 May 2011

2011-05-18T01:17:03Z

← Older revision		Revision as of 01:17, 18 May 2011
Line 6:		Line 6:
	As a side note, the name 'C4Script' comes from the first game it was used in, Clonk 4. Each following game in the series has vastly expanded on and improved the language since it's inception.		As a side note, the name 'C4Script' comes from the first game it was used in, Clonk 4. Each following game in the series has vastly expanded on and improved the language since it's inception.

	===An Introduction to C4Script===		==An Introduction to C4Script==

	Learning a new script language can be difficult, especially if you do not have any previous programming knowledge. This introduction will appeal to these users, as we do not expect any new developer to have a firm basis in C before starting. ;-)		Learning a new script language can be difficult, especially if you do not have any previous programming knowledge. This introduction will appeal to these users, as we do not expect any new developer to have a firm basis in C before starting. ;-)

Ringwaul: /* C4Script */

2011-05-18T01:16:31Z

C4Script

← Older revision		Revision as of 01:16, 18 May 2011
Line 1:		Line 1:
	===C4Script===		=C4Script=
	C4Script is the C-like script-language used by OpenClonk. C4Script controls in-game objects; from the Clonk to the GUI, everything is programmed with C4Script.		C4Script is the C-like script-language used by OpenClonk. C4Script controls in-game objects; from the Clonk to the GUI, everything is programmed with C4Script.

Ringwaul: moved Scripting documentation to Scripting Documentation: capitalization of Documentation ;)

2011-05-18T01:15:51Z

moved Scripting documentation to Scripting Documentation: capitalization of Documentation ;)

← Older revision	Revision as of 01:15, 18 May 2011
(No difference)

Ringwaul at 01:07, 18 May 2011

2011-05-18T01:07:54Z

← Older revision		Revision as of 01:07, 18 May 2011
Line 1:		Line 1:
	~~a couple of lines on what is c4script and why it is uses~~

	~~Links to the c4script documentation~~

	~~A list of examples of how to use library functions to achieve some minor tasks (create a bomb, position an object somewhere, move an object, and so on)~~

	===C4Script===		===C4Script===
	C4Script is the C-like script-language used by OpenClonk. C4Script controls in-game objects; from the Clonk to the GUI, everything is programmed with C4Script.		C4Script is the C-like script-language used by OpenClonk. C4Script controls in-game objects; from the Clonk to the GUI, everything is programmed with C4Script.