Scripting - Revision history

Silverfish: Added script documentation path for Linux.

2015-09-07T11:29:44Z

Added script documentation path for Linux.

← Older revision		Revision as of 04:29, 7 September 2015
Line 10:		Line 10:

	'''in Linux'''		'''in Linux'''
	*~~???~~		*under ~/.local/share/Overgrowth

	http://blog.wolfire.com/2015/02/Overgrowth-a209-video-changelog		http://blog.wolfire.com/2015/02/Overgrowth-a209-video-changelog

Poddus: /* Checking for User Input: */

2015-02-12T17:56:02Z

Checking for User Input:

Show changes

Poddus: /* Checking for User Input: */ made multi-column

2015-02-12T17:44:04Z

Checking for User Input:: made multi-column

Show changes

Poddus at 16:12, 12 February 2015

2015-02-12T16:12:08Z

@@ Line 1: / Line 1: @@
 Overgrowth uses [http://www.angelcode.com/angelscript/ AngelScript] as its core '''scripting''' language.  The [http://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript Manual] is the best place to start learning.
 ==File Locations==
@@ Line 251: / Line 265: @@
 Writing you scripts separate from the game files makes your code easier to develop and update!

Poddus at 16:11, 12 February 2015

2015-02-12T16:11:20Z

← Older revision		Revision as of 09:11, 12 February 2015
Line 14:		Line 14:
	{{stub}}		{{stub}}

	In these locations you will see various files, many of which have the suffix '''.as'''~~. This stands~~ for AngelScript (also for ActionScript, but that's another story)~~, and~~ can be opened and edited with your favorite text editor. Any changes made while the game is running ~~are '''~~updated in real time~~'''~~.		In these locations you will see various files, many of which have the suffix '''.as''', for AngelScript (also for ActionScript, but that's another story). They can be opened and edited with your favorite text editor. Any changes made while the game is running will be updated in real time. Be sure to make backups!

	==General Usage Scenarios==		==General Usage Scenarios==

Poddus: file locations

2015-02-12T16:10:04Z

file locations

← Older revision		Revision as of 09:10, 12 February 2015
Line 1:		Line 1:
	Overgrowth uses [http://www.angelcode.com/angelscript/ AngelScript] as its core '''scripting''' language. The [http://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript Manual] is the best place to start learning.		Overgrowth uses [http://www.angelcode.com/angelscript/ AngelScript] as its core '''scripting''' language. The [http://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript Manual] is the best place to start learning.

	As of Alpha 209, the game automatically generates a header file showing all the parameters that are exposed to the scripting layer, including comments and parameter names. This file is named aschar_docs.h and can be found		==File Locations==

			===OSX===

	~~'''~~in ~~Windows'''~~		Overgrowth comes as an Application Package. Within this package are folders, which can be navigated by first right-clicking on Overgrowth.app in the Finder and selecting "Show Package Contents" from the contextual menu. To access the scripting files, navigate to
	*under ~\Documents\Wolfire\Overgrowth

	~~'''in~~ Mac ~~OSX'''~~		<pre>Overgrowth/Contents/Mac\ OS/Data/Scripts/</pre>
	*under ~/~~Library~~/~~Application\ Support~~/~~Overgrowth~~

	~~'''in~~ Linux~~'''~~		===Windows===
	*???		{{stub}}
			===Linux===
			{{stub}}

	~~http://blog~~.~~wolfire~~.~~com/2015/02/Overgrowth-a209-video-changelog~~		In these locations you will see various files, many of which have the suffix '''.as'''. This stands for AngelScript (also for ActionScript, but that's another story), and can be opened and edited with your favorite text editor. Any changes made while the game is running are '''updated in real time'''.

	== Checking for User Input: ==		==General Usage Scenarios==
			=== Checking for User Input: ===
	You can check for keypresses by using the '''boolean''' check function '''GetInputDown()''':		You can check for keypresses by using the '''boolean''' check function '''GetInputDown()''':

Line 222:		Line 225:
	[[Category:Overgrowth]]		[[Category:Overgrowth]]

	== Writing classes and functions in your own script: ==		=== Writing classes and functions in your own script: ===
	Scripts can be written outside of the game code, and interact with it using objects and function calls. These do not need to be written as classes and could be simple functions. A simple class might look like this:		Scripts can be written outside of the game code, and interact with it using objects and function calls. These do not need to be written as classes and could be simple functions. A simple class might look like this:
	<pre>		<pre>
Line 248:		Line 251:

	Writing you scripts separate from the game files makes your code easier to develop and update!		Writing you scripts separate from the game files makes your code easier to develop and update!


			----
			As of Alpha 209, the game automatically generates a header file showing all the parameters that are exposed to the scripting layer, including comments and parameter names. This file is named aschar_docs.h and can be found

			'''in Windows'''
			*under ~\Documents\Wolfire\Overgrowth

			'''in Mac OSX'''
			*under ~/Library/Application\ Support/Overgrowth

			'''in Linux'''
			*???

			http://blog.wolfire.com/2015/02/Overgrowth-a209-video-changelog

Poddus: aschar_docs.h

2015-02-12T15:16:16Z

aschar_docs.h

← Older revision		Revision as of 08:16, 12 February 2015
Line 1:		Line 1:
	Overgrowth uses [http://www.angelcode.com/angelscript/ AngelScript] as its core '''scripting''' language. The [http://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript Manual] is the best place to start learning.		Overgrowth uses [http://www.angelcode.com/angelscript/ AngelScript] as its core '''scripting''' language. The [http://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript Manual] is the best place to start learning.

	As of Alpha 209, the game automatically generates a file showing all the parameters that are exposed to the scripting layer, including comments and parameter names.		As of Alpha 209, the game automatically generates a header file showing all the parameters that are exposed to the scripting layer, including comments and parameter names. This file is named aschar_docs.h and can be found

			'''in Windows'''
			*under ~\Documents\Wolfire\Overgrowth

			'''in Mac OSX'''
			*under ~/Library/Application\ Support/Overgrowth

			'''in Linux'''
			*???

			http://blog.wolfire.com/2015/02/Overgrowth-a209-video-changelog

	== Checking for User Input: ==		== Checking for User Input: ==

Poddus: updated intro for a209

2015-02-12T11:44:49Z

updated intro for a209

← Older revision		Revision as of 04:44, 12 February 2015
Line 1:		Line 1:
	Overgrowth uses [http://www.angelcode.com/angelscript/ AngelScript] as its core '''scripting''' language. The [http://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript Manual] is the best place to start learning.		Overgrowth uses [http://www.angelcode.com/angelscript/ AngelScript] as its core '''scripting''' language. The [http://www.angelcode.com/angelscript/sdk/docs/manual/index.html AngelScript Manual] is the best place to start learning.

			As of Alpha 209, the game automatically generates a file showing all the parameters that are exposed to the scripting layer, including comments and parameter names.

	== Checking for User Input: ==		== Checking for User Input: ==

Dindresto: Surrounded "path_to_script" with code tags

2013-02-23T11:02:50Z

Surrounded "path_to_script" with code tags

← Older revision		Revision as of 04:02, 23 February 2013
Line 230:		Line 230:
	ex1.print_var();		ex1.print_var();
	</pre>		</pre>
	This script could be included in any of those in Data/Scripts, by writing <code>#include "path_to_script.as"</code>, where path_to_script would just be your script name if it were in the scripts folder.		This script could be included in any of those in Data/Scripts, by writing <code>#include "path_to_script.as"</code>, where <code>path_to_script</code> would just be your script name if it were in the scripts folder.

	It can then be used to create new classes, or use ones defined in your script.		It can then be used to create new classes, or use ones defined in your script.

	Writing you scripts separate from the game files makes your code easier to develop and update!		Writing you scripts separate from the game files makes your code easier to develop and update!

Dindresto: Better code formatting

2013-02-23T10:59:12Z

Better code formatting

← Older revision		Revision as of 03:59, 23 February 2013
Line 213:		Line 213:
	<pre>		<pre>
	class Example {		class Example {
	int example_variable; //~~variables~~ cannot be initialized here		int example_variable; // Variables cannot be initialized here

	Example() {		Example() {
	example_variable = 1;		example_variable = 1;
	print_var();		print_var();
	}		}

	void print_var() {		void print_var() {
	Print(example_variable);		Print(example_variable);
	}		}
	};		};
	//Initialize a class that the game can use
			// Initialize a class that the game can use
	Example ex1 = Example();		Example ex1 = Example();
	ex1.example_variable = 2;		ex1.example_variable = 2;
	ex1.print_var();		ex1.print_var();
	</pre>		</pre>
	This script could be included in any of those in Data/Scripts, by writing		This script could be included in any of those in Data/Scripts, by writing <code>#include "path_to_script.as"</code>, where path_to_script would just be your script name if it were in the scripts folder.
	#include "path_to_script.as", where path_to_script would just be your script name if it were in the scripts folder.

	It can then be used to create new classes, or use ones defined in your script.		It can then be used to create new classes, or use ones defined in your script.

	Writing you scripts separate from the game files makes your code easier to develop and update!		Writing you scripts separate from the game files makes your code easier to develop and update!