Tutorial - Basic Scripting - Revision history

TopAce: mostly commas added

2009-01-09T21:32:51Z

mostly commas added

Wanderer: changed direct scripting.html link to command line option link

2007-11-17T10:44:52Z

changed direct scripting.html link to command line option link

← Older revision		Revision as of 10:44, 17 November 2007
Line 7:		Line 7:
	==Very Basics==		==Very Basics==

	First take a good look at the [[Scripting.tbl]] page. From there you can see the hooks you can use for scripting. Also in [~~http://fs2source.warpcore.org/temp/scripting.html scripting~~.html]- ''~~dead~~ link~~, someone please fix- [[Mustang19]]~~'' are listed several conditional hooks. In addition to these it is possible to use scripting also with subsystem animation.		First take a good look at the [[Scripting.tbl]] page. From there you can see the hooks you can use for scripting. Also in [[Command-Line_Reference#-output_scripting\|Scripting.html]] ''(link to command line option for outputting the scripting.html)'' are listed several conditional hooks. In addition to these it is possible to use scripting also with subsystem animation.
	<br><br>		<br><br>
	All the hooks require square brackets after them into where the actual script is inserted.		All the hooks require square brackets after them into where the actual script is inserted.

Mustang19: dead link that i hope someone will get around to fixing

2007-11-12T17:02:34Z

dead link that i hope someone will get around to fixing

← Older revision		Revision as of 17:02, 12 November 2007
Line 7:		Line 7:
	==Very Basics==		==Very Basics==

	First take a good look at the [[Scripting.tbl]] page. From there you can see the hooks you can use for scripting. Also in [http://fs2source.warpcore.org/temp/scripting.html scripting.html] are listed several conditional hooks. In addition to these it is possible to use scripting also with subsystem animation.		First take a good look at the [[Scripting.tbl]] page. From there you can see the hooks you can use for scripting. Also in [http://fs2source.warpcore.org/temp/scripting.html scripting.html]- ''dead link, someone please fix- [[Mustang19]]'' are listed several conditional hooks. In addition to these it is possible to use scripting also with subsystem animation.
	<br><br>		<br><br>
	All the hooks require square brackets after them into where the actual script is inserted.		All the hooks require square brackets after them into where the actual script is inserted.

Wanderer: updated for post-369 builds

2007-02-01T12:32:58Z

updated for post-369 builds

Show changes

Wanderer: typo

2006-09-04T08:17:01Z

typo

← Older revision		Revision as of 08:17, 4 September 2006
Line 3:		Line 3:
	Simple mission with single fighter placed alone to the game. Intended for testing the use of scripts in FreeSpace Open, [http://koti.mbnet.fi/vekkup/FS2/FSPage/Scriptingtest.rar Scriptingtest.rar]		Simple mission with single fighter placed alone to the game. Intended for testing the use of scripts in FreeSpace Open, [http://koti.mbnet.fi/vekkup/FS2/FSPage/Scriptingtest.rar Scriptingtest.rar]
	<br><br>		<br><br>
	'''Please post any comments or questions ~~conserning~~ the basic scripting tutorial to the [[Talk:Tutorial_-_Basic_Scripting\|talk page]]'''		'''Please post any comments or questions concerning the basic scripting tutorial to the [[Talk:Tutorial_-_Basic_Scripting\|talk page]]'''
	<br><br>		<br><br>
	==Very Basics==		==Very Basics==

Wanderer: added a notice

2006-09-01T06:03:19Z

added a notice

← Older revision		Revision as of 06:03, 1 September 2006
Line 2:		Line 2:
	<br><br>		<br><br>
	Simple mission with single fighter placed alone to the game. Intended for testing the use of scripts in FreeSpace Open, [http://koti.mbnet.fi/vekkup/FS2/FSPage/Scriptingtest.rar Scriptingtest.rar]		Simple mission with single fighter placed alone to the game. Intended for testing the use of scripts in FreeSpace Open, [http://koti.mbnet.fi/vekkup/FS2/FSPage/Scriptingtest.rar Scriptingtest.rar]
			<br><br>
			'''Please post any comments or questions conserning the basic scripting tutorial to the [[Talk:Tutorial_-_Basic_Scripting\|talk page]]'''
			<br><br>
	==Very Basics==		==Very Basics==

Wanderer: removed the extra section

2006-08-22T18:29:42Z

removed the extra section

← Older revision		Revision as of 18:29, 22 August 2006
Line 285:		Line 285:

	#End</pre>		#End</pre>

	~~==Drawing Scripted Weapon Effect==~~

	[[Category:Tutorials\|Basic Scripting]]		[[Category:Tutorials\|Basic Scripting]]

Wanderer: added another section

2006-08-22T18:06:19Z

added another section

@@ Line 171: / Line 171: @@
 #End</pre>
 ==Using Statements==
 ==Drawing Scripted Weapon Effect==

Wanderer: added file link

2006-08-22T16:26:34Z

added file link

← Older revision		Revision as of 16:26, 22 August 2006
Line 1:		Line 1:
	As scripting seems to be something difficult for most people to even start utilizing i thought it might be a good idea to write a short tutorial about the issue. Basic understanding of Lua or practically any other scripting or coding language is helpful but is not actually required as there is an abundance of well written guides to scripting in the internet. Some of these have been gathered to the links section in the [[Scripting.tbl]] page. Especially the [http://lua-users.org/wiki/TutorialDirectory Tutorial Directory] in [http://lua-users.org/wiki/ Lua-Users wiki] is very usefull in learning to use Lua scripting with FreeSpace Open.		As scripting seems to be something difficult for most people to even start utilizing i thought it might be a good idea to write a short tutorial about the issue. Basic understanding of Lua or practically any other scripting or coding language is helpful but is not actually required as there is an abundance of well written guides to scripting in the internet. Some of these have been gathered to the links section in the [[Scripting.tbl]] page. Especially the [http://lua-users.org/wiki/TutorialDirectory Tutorial Directory] in [http://lua-users.org/wiki/ Lua-Users wiki] is very usefull in learning to use Lua scripting with FreeSpace Open.
			<br><br>
			Simple mission with single fighter placed alone to the game. Intended for testing the use of scripts in FreeSpace Open, [http://koti.mbnet.fi/vekkup/FS2/FSPage/Scriptingtest.rar Scriptingtest.rar]
	==Very Basics==		==Very Basics==

Wanderer: rest of the particle stuff

2006-08-22T15:16:50Z

rest of the particle stuff

← Older revision		Revision as of 15:16, 22 August 2006
Line 13:		Line 13:
	...		...
	]</pre>		]</pre>

	~~Commenting rest of the line away is done with double dashes, like so '''''– –'''''.~~

	==First Example==		==First Example==

	Lets start with creating a small script that writes text to the screen. That is the very old '''Hello, World''' example. To achieve that effect we first need to create a scripting.tbl file and then also to create the needed sections. In order to achieve that goal first create a plain text document using (for example) notepad or similar non-~~formatting~~ text editor.		Lets start with creating a small script that writes text to the screen. That is the very old '''Hello, World''' example. To achieve that effect we first need to create a scripting.tbl file and then also to create the needed sections. In order to achieve that goal first create a plain text document using (for example) notepad or similar non-autoformatting text editor.
	*Name the empty text file as scripting.tbl		*Name the empty text file as scripting.tbl
	*Move it to '''''data/tables''''' directory		*Move it to '''''data/tables''''' directory
Line 31:		Line 29:

	To write text (or rather a text string) to the screen we need to use certain Lua functions. The needed function '''''drawString()''''' is located in the '''Graphics''' library (abbreviated '''gr'''), [http://fs2source.warpcore.org/temp/scripting.html#Graphics Graphic library in Scripting.html]. To use that function we first need to create a '''''$HUD:''''' hook where we can place it. The function also needs some arguments and we ought to give it the required arguments. First we need the string ''''Hello, World'''' followed by the location coordinates (pixels) where the game is instructed to draw the string. Also note that as the function is from the '''Graphics''' library we need to add '''''gr.''''' before the function (that is to write gr.drawString instead of just drawString).		To write text (or rather a text string) to the screen we need to use certain Lua functions. The needed function '''''drawString()''''' is located in the '''Graphics''' library (abbreviated '''gr'''), [http://fs2source.warpcore.org/temp/scripting.html#Graphics Graphic library in Scripting.html]. To use that function we first need to create a '''''$HUD:''''' hook where we can place it. The function also needs some arguments and we ought to give it the required arguments. First we need the string ''''Hello, World'''' followed by the location coordinates (pixels) where the game is instructed to draw the string. Also note that as the function is from the '''Graphics''' library we need to add '''''gr.''''' before the function (that is to write gr.drawString instead of just drawString).
			<br><br>
			Notice that we can comment (the rest of) the line away with double dashes, like so '''''– –'''''. This is usefull for adding notes to the scripts for later reference or for preventing certain lines of the script to be read.
	<br><br>		<br><br>
	'''Scripting.tbl'''		'''Scripting.tbl'''
Line 118:		Line 118:

	--2nd draw the particle		--2nd draw the particle
	ts.createParticle(nullvec,nullvec,1,20,'Debug')		ts.createParticle(nullvec,nullvec,0.25,20,'Debug')

	]		]
Line 141:		Line 141:
	particletexture = gr.loadTexture('laserglow03')		particletexture = gr.loadTexture('laserglow03')

	ts.createParticle(nullvec,nullvec,1,20,'Bitmap', -1, false, particletexture)		ts.createParticle(nullvec,nullvec,0.25,20,'Bitmap', -1, false, particletexture)

	]		]
Line 147:		Line 147:
	#End</pre>		#End</pre>

			===Animations and Moving Particles===

			We can load animations as particle graphics and use these for creating new effects. This is done simply by adding to '''gr.loadTexture()''' function a new argument. We can also try moving both the particle effect and the changing the velocity of the spawned particle effect. Procedure is very similar to static and centered effect but this time we need create new vector objects for the particle velocity and the particle position.
			<br><br>
			'''Scripting.tbl'''
			<pre>#Global Hooks

			$Simulation:

			[

			--Create the new vectors
			movevec = ma.newVector(0,20,0)
			velvec = ma.newVector(20,0,1000)

			--Load animation, true is needed for loading the animation
			particletexture = gr.loadTexture('exp04',true)

			ts.createParticle(movevec,velvec,1,20,'Bitmap', -1, false, particletexture)

			]

			#End</pre>
	==Using Statements==		==Using Statements==


	==Drawing Scripted Weapon Effect==		==Drawing Scripted Weapon Effect==