Creating Functions - Revision history

CoDEmanX at 18:39, 28 July 2009

2009-07-28T18:39:03Z

← Older revision		Revision as of 18:39, 28 July 2009
Line 1:		Line 1:
	== [[Creating Functions]] ==		{{Note\|A custom function is a good way to use repeat sections of code more efficiently. For example, if you often use the same sequence of code, you can template them into a custom function. Imagine this is your code...}}

			== Creating Functions ==

	[[Image:Nutshell.png]] A custom function is a good way to use repeat sections of code more efficiently. For example, if you often use the same sequence of code, you can template them into a custom function. Imagine this is your code...
	<pre>		<pre>
	{		{
Line 63:		Line 64:

	for the same effect.		for the same effect.

			[[Category:Call of Duty]]
			[[Category:Scripting]]

Novemberdobby at 23:39, 23 October 2008

2008-10-23T23:39:09Z

← Older revision		Revision as of 23:39, 23 October 2008
Line 1:		Line 1:
	== [[Creating Functions]] ==		== [[Creating Functions]] ==

	[[Image:Nutshell.png]] A custom function is a good way to use repeat sections of code more efficiently. For example, if you often use		[[Image:Nutshell.png]] A custom function is a good way to use repeat sections of code more efficiently. For example, if you often use the same sequence of code, you can template them into a custom function. Imagine this is your code...
	the same sequence of code, you can template them into a custom function. Imagine this is your code...		<pre>
			{
	wait 1;		wait 1;
	brush1 moveZ(320, 5);		brush1 moveZ(320, 5);
Line 10:		Line 10:
	brush2 moveZ(540, 3);		brush2 moveZ(540, 3);
	brush2 waittill("movedone");		brush2 waittill("movedone");
			}
			</pre>
	This can be simplified using a custom function, lets call this function "_moveEnt" (it is common practice to use an underscore as the first character of a function)		This can be simplified using a custom function, lets call this function "_moveEnt" (it is common practice to use an underscore as the first character of a function)

Line 18:		Line 19:

	Now lets look at the full code with custom function in use...		Now lets look at the full code with custom function in use...
			<pre>
	{		{
	_moveEnt(brush1, 320, 5);		_moveEnt(brush1, 320, 5);
Line 30:		Line 31:
	ent waittill("movedone");		ent waittill("movedone");
	}		}
			</pre>
			As the above code shows, the custom function can simply be called using the required arguements, which are passed along and used in the new function.

	As the ~~above code shows~~, the ~~custom function can simply be called using~~ the ~~required arguements, each time~~ it is called~~, the details are changed in the custom function and are processed~~.		Once the custom function has finished, the script returns to the original location from where it was called.

	~~Once they are finished, it goes back to the main function.~~		Functions can also return values to the original script, or even entities.

	Functions can also return values, ~~for example performaing mathmatical equations.~~
	~~A new function to get 3D area..~~.

			A simple function to calculate volume from the width, height and depth:
			<pre>
	{		{
	area = _areaEquation(2, 4, 6);		area = _areaEquation(2, 4, 6);
	}		}

	_areaEquation(a, b, c)		_areaEquation(x, y, z)
	{		{
	answer = (a * b) * c;		answer = x * y * z;
	return answer;		return answer;
	}		}
			</pre>
	Once the code calls the function '_areaEquation' the function works out the 'answer', 'answer' is the returned.		Once the code calls the function '_areaEquation' the function works out the 'answer', 'answer' is the returned.
	This declares a new variable (area). The variable area, is the answer that is returned by the function.		This declares a new variable (area). The variable area, is the answer that is returned by the function.

			The two lines:

			answer = x * y * z;
			return answer;

			could be replace by

			return x * y * z;

			for the same effect.

Zeroy: New page: == Creating Functions == Image:Nutshell.png A custom function is a good way to use repeat sections of code more efficiently. For example, if you often use the same sequence of cod...

2008-10-15T16:53:36Z

New page: == Creating Functions == Image:Nutshell.png A custom function is a good way to use repeat sections of code more efficiently. For example, if you often use the same sequence of cod...

New page

== [[Creating Functions]] ==

[[Image:Nutshell.png]] A custom function is a good way to use repeat sections of code more efficiently. For example, if you often use
the same sequence of code, you can template them into a custom function. Imagine this is your code...

wait 1;
brush1 moveZ(320, 5);
brush1 waittill("movedone");
wait 1;
brush2 moveZ(540, 3);
brush2 waittill("movedone");

This can be simplified using a custom function, lets call this function "_moveEnt" (it is common practice to use an underscore as the first character of a function)

_moveEnt(ent, dist, time)

As the above shows, we are going to need 3 arguements, ent (entity), dist (distance) and time.

Now lets look at the full code with custom function in use...

{
_moveEnt(brush1, 320, 5);
_moveEnt(brush2, 540, 3);
}

_moveEnt(ent, dist, time)
{
wait 1;
ent moveZ(dist, time);
ent waittill("movedone");
}

As the above code shows, the custom function can simply be called using the required arguements, each time it is called, the details are changed in the custom function and are processed.

Once they are finished, it goes back to the main function.

Functions can also return values, for example performaing mathmatical equations.
A new function to get 3D area...

{
area = _areaEquation(2, 4, 6);
}

_areaEquation(a, b, c)
{
answer = (a * b) * c;
return answer;
}

Once the code calls the function '_areaEquation' the function works out the 'answer', 'answer' is the returned.
This declares a new variable (area). The variable area, is the answer that is returned by the function.