ASH For Beginners - Revision history

Philmasterplus: /* Windows */ Rewrite section, add VS Code, update links

2021-07-02T09:22:11Z

Windows: Rewrite section, add VS Code, update links

← Older revision		Revision as of 09:22, 2 July 2021
Line 10:		Line 10:

	=== Windows===		=== Windows===
	~~Windows users beware; using Microsoft Word to create ASH files will lead to no end of headaches! The built-in program notepad will work,~~ as ~~can wordpad when configured with the option "No Wrap" for text. However, having a program that can handle~~ syntax-highlighting ~~can be very beneficial. Many scripters recommend~~ [http://notepad-plus.~~sourceforge.net~~/~~uk/site.htm~~ Notepad++] ~~for ASH (~~and ~~other programmatic) scripting~~. ~~In this case, it's also beneficial to have~~ a ~~style configuration that works well with ASH, and one example can be found~~ [http://kolmafia.us/showthread.php?3164-How-do-you-write-an-ASH-file&p=21567&viewfull=1#post21567 ~~here~~].		Several dedicated code editors provide useful features such as syntax highlighting and code suggestions:

			* [http://notepad-plus-plus.org/ Notepad++]: Lightweight and easy-to-use editor. There is a [http://kolmafia.us/showthread.php?3164-How-do-you-write-an-ASH-file&p=21567&viewfull=1#post21567 code style configuration for ASH].
			* <p>[https://code.visualstudio.com/ Visual Studio Code]: More complex than Notepad++, but fast enough for most users. Also great for editing HTML, CSS, and JavaScript. Install the [https://marketplace.visualstudio.com/items?itemName=danielyxie.vscode-kolmafia-ash KoLmafia ASH++] extension to enable syntax highlighting and code suggestions.</p><p>Not to be confused with [https://visualstudio.microsoft.com/ Visual Studio], which is a much bigger program.</p>
			* Notepad: Can be used for quick-and-dirty code editing, but lacks many useful code editing features.

			'''Do not use Microsoft Word or Wordpad for editing ASH files.''' These programs are suited for writing formatted documents, and can corrupt your code if you are not careful.

	==Saving ==		==Saving ==

Mcroft: /* Mac */ link to syntax module for BBEdit

2021-04-08T22:54:59Z

Mac: link to syntax module for BBEdit

← Older revision		Revision as of 22:54, 8 April 2021
Line 4:		Line 4:

	===Mac===		===Mac===
	While the built in editor TextEdit will work fine (as long as you remember to write only in plaintext), [https://www.barebones.com/products/bbedit/ BBEdit] is a much more powerful tool. It may not be designed for ASH scripting specifically, but it was written for a similar purpose. It can has a paid mode with more features, but those features are optional. BBEdit users can install the ASH Language Module to provide syntax colorization.		While the built in editor TextEdit will work fine (as long as you remember to write only in plaintext), [https://www.barebones.com/products/bbedit/ BBEdit] is a much more powerful tool. It may not be designed for ASH scripting specifically, but it was written for a similar purpose. It can has a paid mode with more features, but those features are optional. BBEdit users can install the [[Media:Ash plist.xml\|BBEdit ASH Language Module]] to provide syntax colorization.

	===Linux===		=== Linux===
	If you use Linux, you probably already know about the options available for text editing. Emacs, Vi, etc. are all fine for creating ASH scripts.		If you use Linux, you probably already know about the options available for text editing. Emacs, Vi, etc. are all fine for creating ASH scripts.

	===Windows===		=== Windows===
	Windows users beware; using Microsoft Word to create ASH files will lead to no end of headaches! The built-in program notepad will work, as can wordpad when configured with the option "No Wrap" for text. However, having a program that can handle syntax-highlighting can be very beneficial. Many scripters recommend [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] for ASH (and other programmatic) scripting. In this case, it's also beneficial to have a style configuration that works well with ASH, and one example can be found [http://kolmafia.us/showthread.php?3164-How-do-you-write-an-ASH-file&p=21567&viewfull=1#post21567 here].		Windows users beware; using Microsoft Word to create ASH files will lead to no end of headaches! The built-in program notepad will work, as can wordpad when configured with the option "No Wrap" for text. However, having a program that can handle syntax-highlighting can be very beneficial. Many scripters recommend [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] for ASH (and other programmatic) scripting. In this case, it's also beneficial to have a style configuration that works well with ASH, and one example can be found [http://kolmafia.us/showthread.php?3164-How-do-you-write-an-ASH-file&p=21567&viewfull=1#post21567 here].

	==Saving==		==Saving ==
	ASH scripts need to be saved with the file extension ".ash" to be properly recognized by KoLmafia. If you're using a built-in text editor on a Windows machine, it may automatically save your files with the ".txt" extension by default. (So you may end up with a file called "script.ash.txt" instead of the desired "script.ash".) One way around this on Windows that usually works is to put quotes around the file name when you save it, including the extension.		ASH scripts need to be saved with the file extension ".ash" to be properly recognized by KoLmafia. If you're using a built-in text editor on a Windows machine, it may automatically save your files with the ".txt" extension by default. (So you may end up with a file called "script.ash.txt" instead of the desired "script.ash".) One way around this on Windows that usually works is to put quotes around the file name when you save it, including the extension.

Line 38:		Line 38:
	Functions are groupings of operations that can be applied multiple times by referencing the function name. Basically, they avoid having to re-type the same code over and over.		Functions are groupings of operations that can be applied multiple times by referencing the function name. Basically, they avoid having to re-type the same code over and over.

	====Built-in functions====		==== Built-in functions====
	Many functions are built-in to KoLmafia, and examples can be found all over this wiki. Examples on the wiki are given in the following format:		Many functions are built-in to KoLmafia, and examples can be found all over this wiki. Examples on the wiki are given in the following format:

Line 74:		Line 74:
	Note that scope (discussed above, under [[ASH_For_Beginners#Variables\|Variables]]) also applies to user-defined functions. Also, functions built into KoLmafia have priority over any user-defined functions with the same name and parameters.		Note that scope (discussed above, under [[ASH_For_Beginners#Variables\|Variables]]) also applies to user-defined functions. Also, functions built into KoLmafia have priority over any user-defined functions with the same name and parameters.

	===String Concatenation===		===String Concatenation ===
	The basics to string concatenation: "Hello" + "world" yields "Helloworld". Likewise, variables can be strung together in this fashion. Unless the variables are both numbers (floats, booleans, or ints), they will be converted to strings, then concatenated. For instance: "3x " + $item[Polka Pop] yields "3x Polka Pop".		The basics to string concatenation: "Hello" + "world" yields "Helloworld". Likewise, variables can be strung together in this fashion. Unless the variables are both numbers (floats, booleans, or ints), they will be converted to strings, then concatenated. For instance: "3x " + $item[Polka Pop] yields "3x Polka Pop".

Mcroft: Adding BBEdit Language definitions for ASH

2021-04-08T22:28:45Z

Adding BBEdit Language definitions for ASH

← Older revision		Revision as of 22:28, 8 April 2021
Line 4:		Line 4:

	===Mac===		===Mac===
	While the built in editor TextEdit will work fine (as long as you remember to write only in plaintext), [https://www.barebones.com/products/bbedit/ BBEdit] is a much more powerful tool. It may not be designed for ASH scripting specifically, but it was written for a similar purpose. It can has a paid mode with more features, but those features are optional.		While the built in editor TextEdit will work fine (as long as you remember to write only in plaintext), [https://www.barebones.com/products/bbedit/ BBEdit] is a much more powerful tool. It may not be designed for ASH scripting specifically, but it was written for a similar purpose. It can has a paid mode with more features, but those features are optional. BBEdit users can install the ASH Language Module to provide syntax colorization.

	===Linux===		===Linux===

Mcroft: replaced TextWrangler with BBEdit. Welcome to the modern era!

2021-04-08T22:24:40Z

replaced TextWrangler with BBEdit. Welcome to the modern era!

← Older revision		Revision as of 22:24, 8 April 2021
Line 4:		Line 4:

	===Mac===		===Mac===
	While the built in editor TextEdit will work fine (as long as you remember to write only in plaintext), [~~http~~://www.barebones.com/products/~~textwrangler~~/ ~~TextWrangler~~] is a much more powerful tool. It may not be designed for ASH scripting specifically, but it was written for a similar purpose.		While the built in editor TextEdit will work fine (as long as you remember to write only in plaintext), [https://www.barebones.com/products/bbedit/ BBEdit] is a much more powerful tool. It may not be designed for ASH scripting specifically, but it was written for a similar purpose. It can has a paid mode with more features, but those features are optional.

	===Linux===		===Linux===

QVamp: added section on how to run scripts.

2011-09-16T15:17:44Z

added section on how to run scripts.

← Older revision		Revision as of 15:17, 16 September 2011
Line 49:		Line 49:
	The parameter names are used for reference on the rest of the page (so you can match descriptions of parameters to the parameter in question, which is especially useful if the function takes more than one parameter with the same datatype).		The parameter names are used for reference on the rest of the page (so you can match descriptions of parameters to the parameter in question, which is especially useful if the function takes more than one parameter with the same datatype).

	Note that, as with assignments of a ~~fucntion~~'s return value, it is important to match the parameter datatypes when using the function. If you have a function with the parameter <b>item it</b>, and you supply the name of the item as text in quotes (which is how a string is written), you will get an error for doing so.		Note that, as with assignments of a function's return value, it is important to match the parameter datatypes when using the function. If you have a function with the parameter <b>item it</b>, and you supply the name of the item as text in quotes (which is how a string is written), you will get an error for doing so.

	====Custom-coded functions====		====Custom-coded functions====
Line 76:		Line 76:
	===String Concatenation===		===String Concatenation===
	The basics to string concatenation: "Hello" + "world" yields "Helloworld". Likewise, variables can be strung together in this fashion. Unless the variables are both numbers (floats, booleans, or ints), they will be converted to strings, then concatenated. For instance: "3x " + $item[Polka Pop] yields "3x Polka Pop".		The basics to string concatenation: "Hello" + "world" yields "Helloworld". Likewise, variables can be strung together in this fashion. Unless the variables are both numbers (floats, booleans, or ints), they will be converted to strings, then concatenated. For instance: "3x " + $item[Polka Pop] yields "3x Polka Pop".

			==Running a Script==
			Once your script is saved, you can run it. Scripts saved in the scripts directory will appear in Mafia under the scripts menu. Simply clicking on one will run it. You may also run your script from the command line by typing "exec" followed by the script name For instance: exec myscript.

			The script looks for the function 'main()' in order to know where to start.

			{{CodeSample\|description=Generally the function will look like this:\|code=<syntaxhighlight>
			void main() {
			// the rest of your code
			}
			</syntaxhighlight>}}

			The main function can contain variables, other code and calls to other functions within the script.

			You may also have an input into your main function. By requiring an input, this will cause KoLmafia to show a textbox to the user in order to get input into the script. This textbox can be filled in and submitted, or cancelled.

	[[Category:Scripting]]		[[Category:Scripting]]

PhilmASTErpLus: /* Programming */ grammar fix

2010-11-10T17:49:46Z

Programming: grammar fix

← Older revision		Revision as of 17:49, 10 November 2010
Line 22:		Line 22:

	==Programming==		==Programming==
	You should first read through the various pages listed under "LANGUAGE CONVENTIONS" on the [[Main Page]]. One should also be aware that, with the exception of [[Control Structures]], all ASH commands need to end with a semi-colon. Also, every identifier in ASH—variables, functions, and other various keywords—are case-insensitive, so <code>string myVar="abb"</code> and <code>STRing MYvar="abb"</code> ~~produces~~ the same results.		You should first read through the various pages listed under "LANGUAGE CONVENTIONS" on the [[Main Page]]. One should also be aware that, with the exception of [[Control Structures]], all ASH commands need to end with a semi-colon. Also, every identifier in ASH—variables, functions, and other various keywords—are case-insensitive, so <code>string myVar="abb"</code> and <code>STRing MYvar="abb"</code> produce the same results.

	===Variables===		===Variables===

PhilmASTErpLus: /* Programming / Wow, ASH is case-insensitive. Boggles*

2010-11-10T17:29:09Z

Programming: Wow, ASH is case-insensitive. *Boggles*

← Older revision		Revision as of 17:29, 10 November 2010
Line 22:		Line 22:

	==Programming==		==Programming==
	You should first read through the various pages listed under "LANGUAGE CONVENTIONS" on the [[Main Page]]. One should also be aware that, with the exception of [[Control Structures]], all ASH commands need to end with a semi-colon.		You should first read through the various pages listed under "LANGUAGE CONVENTIONS" on the [[Main Page]]. One should also be aware that, with the exception of [[Control Structures]], all ASH commands need to end with a semi-colon. Also, every identifier in ASH—variables, functions, and other various keywords—are case-insensitive, so <code>string myVar="abb"</code> and <code>STRing MYvar="abb"</code> produces the same results.

	===Variables===		===Variables===

PhilmASTErpLus: It bothers me that several articles have top-level section headings using

, not

. Unless there is a specific reason for this, I will correct them whenever I see one.

2010-09-27T23:19:32Z

It bothers me that several articles have top-level section headings using <h1>, not <h2>. Unless there is a specific reason for this, I will correct them whenever I see one.

← Older revision		Revision as of 23:19, 27 September 2010
Line 1:		Line 1:
	{{TOCright}}		{{TOCright}}
	=File Editing=		==File Editing==
	To create and edit ASH scripts, you need a text editing program that doesn't automatically add line-breaks for word wrapping.		To create and edit ASH scripts, you need a text editing program that doesn't automatically add line-breaks for word wrapping.

	==Mac==		===Mac===
	While the built in editor TextEdit will work fine (as long as you remember to write only in plaintext), [http://www.barebones.com/products/textwrangler/ TextWrangler] is a much more powerful tool. It may not be designed for ASH scripting specifically, but it was written for a similar purpose.		While the built in editor TextEdit will work fine (as long as you remember to write only in plaintext), [http://www.barebones.com/products/textwrangler/ TextWrangler] is a much more powerful tool. It may not be designed for ASH scripting specifically, but it was written for a similar purpose.

	==Linux==		===Linux===
	If you use Linux, you probably already know about the options available for text editing. Emacs, Vi, etc. are all fine for creating ASH scripts.		If you use Linux, you probably already know about the options available for text editing. Emacs, Vi, etc. are all fine for creating ASH scripts.

	==Windows==		===Windows===
	Windows users beware; using Microsoft Word to create ASH files will lead to no end of headaches! The built-in program notepad will work, as can wordpad when configured with the option "No Wrap" for text. However, having a program that can handle syntax-highlighting can be very beneficial. Many scripters recommend [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] for ASH (and other programmatic) scripting. In this case, it's also beneficial to have a style configuration that works well with ASH, and one example can be found [http://kolmafia.us/showthread.php?3164-How-do-you-write-an-ASH-file&p=21567&viewfull=1#post21567 here].		Windows users beware; using Microsoft Word to create ASH files will lead to no end of headaches! The built-in program notepad will work, as can wordpad when configured with the option "No Wrap" for text. However, having a program that can handle syntax-highlighting can be very beneficial. Many scripters recommend [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] for ASH (and other programmatic) scripting. In this case, it's also beneficial to have a style configuration that works well with ASH, and one example can be found [http://kolmafia.us/showthread.php?3164-How-do-you-write-an-ASH-file&p=21567&viewfull=1#post21567 here].

	=Saving=		==Saving==
	ASH scripts need to be saved with the file extension ".ash" to be properly recognized by KoLmafia. If you're using a built-in text editor on a Windows machine, it may automatically save your files with the ".txt" extension by default. (So you may end up with a file called "script.ash.txt" instead of the desired "script.ash".) One way around this on Windows that usually works is to put quotes around the file name when you save it, including the extension.		ASH scripts need to be saved with the file extension ".ash" to be properly recognized by KoLmafia. If you're using a built-in text editor on a Windows machine, it may automatically save your files with the ".txt" extension by default. (So you may end up with a file called "script.ash.txt" instead of the desired "script.ash".) One way around this on Windows that usually works is to put quotes around the file name when you save it, including the extension.

Line 21:		Line 21:
	Relay browser scripts are the exception to the rule: they must be saved in the "relay" directory. Relay browser overrides need to be saved in the top level of "relay," and must be named the same as the page they will override, except with an ".ash" extension. For example, to override "charpane.php" your script would need to be named "charpane.ash". For user-interface scripts, the script name needs to start with "relay_" and end with ".ash". These scripts must also be saved in the top-level of the "relay" directory.		Relay browser scripts are the exception to the rule: they must be saved in the "relay" directory. Relay browser overrides need to be saved in the top level of "relay," and must be named the same as the page they will override, except with an ".ash" extension. For example, to override "charpane.php" your script would need to be named "charpane.ash". For user-interface scripts, the script name needs to start with "relay_" and end with ".ash". These scripts must also be saved in the top-level of the "relay" directory.

	=Programming=		==Programming==
	You should first read through the various pages listed under "LANGUAGE CONVENTIONS" on the [[Main Page]]. One should also be aware that, with the exception of [[Control Structures]], all ASH commands need to end with a semi-colon.		You should first read through the various pages listed under "LANGUAGE CONVENTIONS" on the [[Main Page]]. One should also be aware that, with the exception of [[Control Structures]], all ASH commands need to end with a semi-colon.

	==Variables==		===Variables===
	Variables are used to hold information that you need to access multiple times. They must be declared before they can be used, by specifying the [[Data Types\|Data Type]] that they will hold, followed by the variable name.		Variables are used to hold information that you need to access multiple times. They must be declared before they can be used, by specifying the [[Data Types\|Data Type]] that they will hold, followed by the variable name.
	{{CodeSample\|description=For example:\|code=<syntaxhighlight>int count;</syntaxhighlight>}}		{{CodeSample\|description=For example:\|code=<syntaxhighlight>int count;</syntaxhighlight>}}
Line 35:		Line 35:
	Declaring a variable multiple times will generate an [[ASH Errors#Variable is already defined\|error]]. Note that this only applies to variable with overlapping scope; if one function uses a variable named "bob" that is declared inside of the function, another function can declare another variable with the same name, even as a different datatype. However, the error will still occur if you have a globally-defined variable, and then declare a variable with the same name inside of a function (as their scopes overlap).		Declaring a variable multiple times will generate an [[ASH Errors#Variable is already defined\|error]]. Note that this only applies to variable with overlapping scope; if one function uses a variable named "bob" that is declared inside of the function, another function can declare another variable with the same name, even as a different datatype. However, the error will still occur if you have a globally-defined variable, and then declare a variable with the same name inside of a function (as their scopes overlap).

	==Functions==		===Functions===
	Functions are groupings of operations that can be applied multiple times by referencing the function name. Basically, they avoid having to re-type the same code over and over.		Functions are groupings of operations that can be applied multiple times by referencing the function name. Basically, they avoid having to re-type the same code over and over.

	===Built-in functions===		====Built-in functions====
	Many functions are built-in to KoLmafia, and examples can be found all over this wiki. Examples on the wiki are given in the following format:		Many functions are built-in to KoLmafia, and examples can be found all over this wiki. Examples on the wiki are given in the following format:

Line 51:		Line 51:
	Note that, as with assignments of a fucntion's return value, it is important to match the parameter datatypes when using the function. If you have a function with the parameter <b>item it</b>, and you supply the name of the item as text in quotes (which is how a string is written), you will get an error for doing so.		Note that, as with assignments of a fucntion's return value, it is important to match the parameter datatypes when using the function. If you have a function with the parameter <b>item it</b>, and you supply the name of the item as text in quotes (which is how a string is written), you will get an error for doing so.

	===Custom-coded functions===		====Custom-coded functions====
	It's also possible to write your own functions. To do so, you declare them similarly to a variable as above. However, a function can also have the datatype of "void," which is not allowed for variables. A "void" function is one that does not return any value; it simply does what it's programmed to do and the rest of your program moves on, regardless of the results (unless of course an [[ASH Errors\|error]] occurs, including a call to [[abort\|abort()]].)		It's also possible to write your own functions. To do so, you declare them similarly to a variable as above. However, a function can also have the datatype of "void," which is not allowed for variables. A "void" function is one that does not return any value; it simply does what it's programmed to do and the rest of your program moves on, regardless of the results (unless of course an [[ASH Errors\|error]] occurs, including a call to [[abort\|abort()]].)
	{{CodeSample\|description=For example, this simple function will double an integer:\|code=<syntaxhighlight>		{{CodeSample\|description=For example, this simple function will double an integer:\|code=<syntaxhighlight>
Line 74:		Line 74:
	Note that scope (discussed above, under [[ASH_For_Beginners#Variables\|Variables]]) also applies to user-defined functions. Also, functions built into KoLmafia have priority over any user-defined functions with the same name and parameters.		Note that scope (discussed above, under [[ASH_For_Beginners#Variables\|Variables]]) also applies to user-defined functions. Also, functions built into KoLmafia have priority over any user-defined functions with the same name and parameters.

	==String Concatenation==		===String Concatenation===
	The basics to string concatenation: "Hello" + "world" yields "Helloworld". Likewise, variables can be strung together in this fashion. Unless the variables are both numbers (floats, booleans, or ints), they will be converted to strings, then concatenated. For instance: "3x " + $item[Polka Pop] yields "3x Polka Pop".		The basics to string concatenation: "Hello" + "world" yields "Helloworld". Likewise, variables can be strung together in this fashion. Unless the variables are both numbers (floats, booleans, or ints), they will be converted to strings, then concatenated. For instance: "3x " + $item[Polka Pop] yields "3x Polka Pop".

	[[Category:Scripting]]		[[Category:Scripting]]

StDoodle at 04:02, 27 September 2010

2010-09-27T04:02:52Z

← Older revision		Revision as of 04:02, 27 September 2010
Line 1:		Line 1:
	{{TOCright}}		{{TOCright}}
	==File Editing==		=File Editing=
	To create and edit ASH scripts, you need a text editing program that doesn't automatically add line-breaks for word wrapping.		To create and edit ASH scripts, you need a text editing program that doesn't automatically add line-breaks for word wrapping.

	===Mac===		==Mac==
	While the built in editor TextEdit will work fine (as long as you remember to write only in plaintext), [http://www.barebones.com/products/textwrangler/ TextWrangler] is a much more powerful tool. It may not be designed for ASH scripting specifically, but it was written for a similar purpose.		While the built in editor TextEdit will work fine (as long as you remember to write only in plaintext), [http://www.barebones.com/products/textwrangler/ TextWrangler] is a much more powerful tool. It may not be designed for ASH scripting specifically, but it was written for a similar purpose.

	===Linux===		==Linux==
	If you use Linux, you probably already know about the options available for text editing. Emacs, Vi, etc. are all fine for creating ASH scripts.		If you use Linux, you probably already know about the options available for text editing. Emacs, Vi, etc. are all fine for creating ASH scripts.

	===Windows===		==Windows==
	Windows users beware; using Microsoft Word to create ASH files will lead to no end of headaches! The built-in program notepad will work, as can wordpad when configured with the option "No Wrap" for text. However, having a program that can handle syntax-highlighting can be very beneficial. Many scripters recommend [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] for ASH (and other programmatic) scripting. In this case, it's also beneficial to have a style configuration that works well with ASH, and one example can be found [http://kolmafia.us/showthread.php?3164-How-do-you-write-an-ASH-file&p=21567&viewfull=1#post21567 here].		Windows users beware; using Microsoft Word to create ASH files will lead to no end of headaches! The built-in program notepad will work, as can wordpad when configured with the option "No Wrap" for text. However, having a program that can handle syntax-highlighting can be very beneficial. Many scripters recommend [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] for ASH (and other programmatic) scripting. In this case, it's also beneficial to have a style configuration that works well with ASH, and one example can be found [http://kolmafia.us/showthread.php?3164-How-do-you-write-an-ASH-file&p=21567&viewfull=1#post21567 here].

	==Saving==		=Saving=
	ASH scripts need to be saved with the file extension ".ash" to be properly recognized by KoLmafia. If you're using a built-in text editor on a Windows machine, it may automatically save your files with the ".txt" extension by default. (So you may end up with a file called "script.ash.txt" instead of the desired "script.ash".) One way around this on Windows that usually works is to put quotes around the file name when you save it, including the extension.		ASH scripts need to be saved with the file extension ".ash" to be properly recognized by KoLmafia. If you're using a built-in text editor on a Windows machine, it may automatically save your files with the ".txt" extension by default. (So you may end up with a file called "script.ash.txt" instead of the desired "script.ash".) One way around this on Windows that usually works is to put quotes around the file name when you save it, including the extension.

Line 21:		Line 21:
	Relay browser scripts are the exception to the rule: they must be saved in the "relay" directory. Relay browser overrides need to be saved in the top level of "relay," and must be named the same as the page they will override, except with an ".ash" extension. For example, to override "charpane.php" your script would need to be named "charpane.ash". For user-interface scripts, the script name needs to start with "relay_" and end with ".ash". These scripts must also be saved in the top-level of the "relay" directory.		Relay browser scripts are the exception to the rule: they must be saved in the "relay" directory. Relay browser overrides need to be saved in the top level of "relay," and must be named the same as the page they will override, except with an ".ash" extension. For example, to override "charpane.php" your script would need to be named "charpane.ash". For user-interface scripts, the script name needs to start with "relay_" and end with ".ash". These scripts must also be saved in the top-level of the "relay" directory.

	==Programming==		=Programming=
	You should first read through the various pages listed under "LANGUAGE CONVENTIONS" on the [[Main Page]]. One should also be aware that, with the exception of [[Control Structures]], all ASH commands need to end with a semi-colon.		You should first read through the various pages listed under "LANGUAGE CONVENTIONS" on the [[Main Page]]. One should also be aware that, with the exception of [[Control Structures]], all ASH commands need to end with a semi-colon.

	===Variables===		==Variables==
	Variables are used to hold information that you need to access multiple times. They must be declared before they can be used, by specifying the [[Data Types\|Data Type]] that they will hold, followed by the variable name.		Variables are used to hold information that you need to access multiple times. They must be declared before they can be used, by specifying the [[Data Types\|Data Type]] that they will hold, followed by the variable name.
	{{CodeSample\|description=For example:\|code=<syntaxhighlight>int count;</syntaxhighlight>}}		{{CodeSample\|description=For example:\|code=<syntaxhighlight>int count;</syntaxhighlight>}}
Line 35:		Line 35:
	Declaring a variable multiple times will generate an [[ASH Errors#Variable is already defined\|error]]. Note that this only applies to variable with overlapping scope; if one function uses a variable named "bob" that is declared inside of the function, another function can declare another variable with the same name, even as a different datatype. However, the error will still occur if you have a globally-defined variable, and then declare a variable with the same name inside of a function (as their scopes overlap).		Declaring a variable multiple times will generate an [[ASH Errors#Variable is already defined\|error]]. Note that this only applies to variable with overlapping scope; if one function uses a variable named "bob" that is declared inside of the function, another function can declare another variable with the same name, even as a different datatype. However, the error will still occur if you have a globally-defined variable, and then declare a variable with the same name inside of a function (as their scopes overlap).

	===Functions===		==Functions==
	Functions are groupings of operations that can be applied multiple times by referencing the function name. Basically, they avoid having to re-type the same code over and over. Many functions are built-in to KoLmafia, and examples can be found all over this wiki. It's also possible to write your own functions. To do so, you declare them similarly to a variable as above. However, a function can also have the datatype of "void," which is not allowed for variables. A "void" function is one that does not return any value; it simply does what it's programmed to do and the rest of your program moves on, regardless of the results (unless of course an [[ASH Errors\|error]] occurs, including a call to [[abort\|abort()]].)		Functions are groupings of operations that can be applied multiple times by referencing the function name. Basically, they avoid having to re-type the same code over and over.

			===Built-in functions===
			Many functions are built-in to KoLmafia, and examples can be found all over this wiki. Examples on the wiki are given in the following format:

			<b>datatypeReturned function_name([datatype1 parameter1] ...)</b>

			The first part is the datatype that the function returns. Though you don't have to make use of this in a script, you would almost always want to (except for some functions that return a boolean). You need to be careful to match datatypes (though sometimes an implicit conversion is done; ie KoLmafia will usually translate a float into an int, and many commands that output text will implicitly convert from most datatypes). For example, if you have a variable of the datatype string, it is often an error to assign to it a function that returns an item.

			The function name follows and then parentheses, which may have nothing or multiple sets of datatypes & parameters.

			The parameter names are used for reference on the rest of the page (so you can match descriptions of parameters to the parameter in question, which is especially useful if the function takes more than one parameter with the same datatype).

			Note that, as with assignments of a fucntion's return value, it is important to match the parameter datatypes when using the function. If you have a function with the parameter <b>item it</b>, and you supply the name of the item as text in quotes (which is how a string is written), you will get an error for doing so.

			===Custom-coded functions===
			It's also possible to write your own functions. To do so, you declare them similarly to a variable as above. However, a function can also have the datatype of "void," which is not allowed for variables. A "void" function is one that does not return any value; it simply does what it's programmed to do and the rest of your program moves on, regardless of the results (unless of course an [[ASH Errors\|error]] occurs, including a call to [[abort\|abort()]].)
	{{CodeSample\|description=For example, this simple function will double an integer:\|code=<syntaxhighlight>		{{CodeSample\|description=For example, this simple function will double an integer:\|code=<syntaxhighlight>
	int double_it(int value) {		int double_it(int value) {
Line 58:		Line 74:
	Note that scope (discussed above, under [[ASH_For_Beginners#Variables\|Variables]]) also applies to user-defined functions. Also, functions built into KoLmafia have priority over any user-defined functions with the same name and parameters.		Note that scope (discussed above, under [[ASH_For_Beginners#Variables\|Variables]]) also applies to user-defined functions. Also, functions built into KoLmafia have priority over any user-defined functions with the same name and parameters.

	===String Concatenation===		==String Concatenation==
	The basics to string concatenation: "Hello" + "world" yields "Helloworld". Likewise, variables can be strung together in this fashion. Unless the variables are both numbers (floats, booleans, or ints), they will be converted to strings, then concatenated. For instance: "3x " + $item[Polka Pop] yields "3x Polka Pop".		The basics to string concatenation: "Hello" + "world" yields "Helloworld". Likewise, variables can be strung together in this fashion. Unless the variables are both numbers (floats, booleans, or ints), they will be converted to strings, then concatenated. For instance: "3x " + $item[Polka Pop] yields "3x Polka Pop".

	[[Category:Scripting]]		[[Category:Scripting]]

Heeheehee: /* String Concatenation */ Removed the "argh, me tired" bit, added a tiny sample.

2010-07-27T16:37:27Z

String Concatenation: Removed the "argh, me tired" bit, added a tiny sample.

← Older revision		Revision as of 16:37, 27 July 2010
Line 59:		Line 59:

	===String Concatenation===		===String Concatenation===
	The basics to string concatenation: "Hello" + "world" yields "Helloworld". Likewise, variables can be strung together in this fashion. Unless the variables are both numbers (floats, booleans, or ints), they will be converted to strings, then concatenated.		The basics to string concatenation: "Hello" + "world" yields "Helloworld". Likewise, variables can be strung together in this fashion. Unless the variables are both numbers (floats, booleans, or ints), they will be converted to strings, then concatenated. For instance: "3x " + $item[Polka Pop] yields "3x Polka Pop".
	~~Argh, me tired, finish later~~.

	[[Category:Scripting]]		[[Category:Scripting]]