Tips, Tricks and Workarounds - Revision history

Philmasterplus: /* Capturing an Abort */ Formatting improvements

2021-07-03T20:37:58Z

Capturing an Abort: Formatting improvements

← Older revision		Revision as of 20:37, 3 July 2021
Line 36:		Line 36:
	== Capturing an Abort ==		== Capturing an Abort ==

	Several ASH functions return a {{type\|boolean}} to indicate success (<code>true</code>) or failure (<code>false</code>). While useful for error handling, it's easy to accidentally forget to check this value. To help script authors, KoLmafia automatically checks the value for you and aborts the script~~, but only~~ if the value is not used.		Several ASH functions return a {{type\|boolean}} to indicate success (<code>true</code>) or failure (<code>false</code>). While useful for error handling, it's easy to accidentally forget to check this value. To help script authors, KoLmafia automatically checks the value for you and aborts the script ''if the value is not used''.

	For example, suppose you call the {{f\|hermit}} function. If you call it without using the return value in any way, KoLmafia will abort if the function fails:		For example, suppose you call the {{f\|hermit}} function. If you call it without using the return value in any way, KoLmafia will abort if the function fails:
Line 117:		Line 117:
	* and possibly more...		* and possibly more...

	Note: ~~This~~ does not ~~affect~~ user-defined functions		Note: KoLmafia does not check the return value of user-defined functions.

	== Syntax Highlighting for Notepad++ ==		== Syntax Highlighting for Notepad++ ==

Philmasterplus: /* Capturing an Abort */ Add sweet_synthesis()

2021-07-03T20:36:38Z

Capturing an Abort: Add sweet_synthesis()

← Older revision		Revision as of 20:36, 3 July 2021
Line 103:		Line 103:
	* {{f\|retrieve_item}}		* {{f\|retrieve_item}}
	* {{f\|sell}}		* {{f\|sell}}
	* {{f\|~~synthesize_effect}}~~		* {{f\|sweet_synthesis}}
	* {{f\|synthesize_pair}}
	* {{f\|take_closet}}		* {{f\|take_closet}}
	* {{f\|take_display}}		* {{f\|take_display}}

Philmasterplus: /* Capturing an Abort */ Add list of special functions

2021-07-03T12:54:47Z

Capturing an Abort: Add list of special functions

@@ Line 36: / Line 36: @@
 == Capturing an Abort ==
-By default, whenever an ASH function returns false, everything will abort ''unless'' you somehow capture the return value (i.e. assigning it to a variable or enclosing it in a control structure). So, if you want to make use of, say, the hermit() function in a way that won't abort if the function returns false, you could:
+Several ASH functions return a {{type|boolean}} to indicate success (<code>true</code>) or failure (<code>false</code>). While useful for error handling, it's easy to accidentally forget to check this value. To help script authors, KoLmafia automatically checks the value for you and aborts the script, but only if the value is not used.
-<div style="margin-bottom: 1em; padding: 1em; margin:0px 20px;">
 {{CodeSample|
-description=Save the result as a boolean variable.|
+description=Assigning the return value to a boolean variable.|
-code=<syntaxhighlight>
+code=<syntaxhighlight lang="d">
-boolean fakeBool = hermit(1, $item[Ten-leaf clover]);
+boolean fakeBool = hermit(1, $item[ ten-leaf clover ]);
 </syntaxhighlight>}}
 {{CodeSample|
-description=Capture the result in an if() conditional.|
+description=Checking the return value in a conditional statement (e.g. <code>if</code>-block).|
-code=<syntaxhighlight>
+code=<syntaxhighlight lang="d">
-if(!hermit(1, $item[Ten-leaf clover])) print("Hermit looting failed: continuing on.");
+if (!hermit(1, $item[ ten-leaf clover ])) {
 </syntaxhighlight>}}
 {{CodeSample|
-description=An if() conditional doesn't even have to do anything.|
+description=An <code>if-</code>block can be empty.|
-code=<syntaxhighlight>
+code=<syntaxhighlight lang="d">
-if(hermit(1, $item[Ten-leaf clover])) {}
+if (hermit(1, $item[ ten-leaf clover ])) {}
 </syntaxhighlight>}}
 {{CodeSample|
-description=The most minimalistic method is to capture it with a not operator and parenthesis.|
+description=The most minimal method is to wrap it with a logical not operator (<code>!</code>) and parentheses.|
-code=<syntaxhighlight>
+code=<syntaxhighlight lang="d">
-(!hermit(1, $item[Ten-leaf clover]));
+(!hermit(1, $item[ ten-leaf clover ]));
 </syntaxhighlight>}}
-Any of these will capture the return value and prevent mafia from aborting.
+This only applies to the following built-in functions:
 == Syntax Highlighting for Notepad++ ==

Bale: /* Testing Scripts Offline */

2011-01-17T23:30:38Z

Testing Scripts Offline

← Older revision		Revision as of 23:30, 17 January 2011
Line 67:		Line 67:
	== Testing Scripts Offline ==		== Testing Scripts Offline ==

	Because KoLmafia CLI and ASH are interpreted, it is impossible to know whether there are any errors in your scripts until you run it. If you want to check only the syntax of the script, you can ~~run~~ it without logging in. From the top menu of the login pane, select "General", then "Graphical CLI". The CLI (and the rest of the mafia interface) will appear~~, and running scripts will properly~~ validate ~~them~~. ~~Note~~ that because you are not logged in, any functions or commands that use or interact with KoL will not work. Thus, testing scripts this way will not reveal any KoL-related logical errors.		Because KoLmafia CLI and ASH are interpreted, it is impossible to know whether there are any errors in your scripts until you run or validate them. If you want to check only the syntax of the script, you can validate it without logging in. From the top menu of the login pane, select "General", then "Graphical CLI". The CLI (and the rest of the mafia interface) will appear. You can then use the validate CLI command to verify their syntax. If the script is purely informational then you can even run it, but note that because you are not logged in, any functions or commands that use or interact with KoL will not work. Thus, testing scripts this way will not reveal any KoL-related logical errors.

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

PhilmASTErpLus: Added 1-liner page intro and Offline Testing seciton

2010-10-01T07:02:06Z

Added 1-liner page intro and Offline Testing seciton

← Older revision		Revision as of 07:02, 1 October 2010
Line 1:		Line 1:
	{{TOCright}}		{{TOCright}}

			This page contains various tips and tricks that may help you in using KoLmafia and writing scripts.

	==Free Pulls==		==Free Pulls==
Line 61:		Line 63:

	== Syntax Highlighting for Notepad++ ==		== Syntax Highlighting for Notepad++ ==


			== Testing Scripts Offline ==

			Because KoLmafia CLI and ASH are interpreted, it is impossible to know whether there are any errors in your scripts until you run it. If you want to check only the syntax of the script, you can run it without logging in. From the top menu of the login pane, select "General", then "Graphical CLI". The CLI (and the rest of the mafia interface) will appear, and running scripts will properly validate them. Note that because you are not logged in, any functions or commands that use or interact with KoL will not work. Thus, testing scripts this way will not reveal any KoL-related logical errors.

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

Bale: Anonymous closures

2010-09-29T07:40:05Z

Anonymous closures

@@ Line 9: / Line 9: @@
 == Anonymous closures ==
-== print() ==
+{{CodeSample|description=ASH does not seem to accept anonymous closures by default. This is an example of an anonymous closure.|
 == Capturing an Abort ==

Bale: /* Capturing an Abort */

2010-09-25T06:22:32Z

Capturing an Abort

@@ Line 12: / Line 12: @@
 == Capturing an Abort ==
 == Syntax Highlighting for Notepad++ ==
 [[Category:Scripting]]

Bale: /* Free Pulls */

2010-09-25T06:21:06Z

Free Pulls

← Older revision		Revision as of 06:21, 25 September 2010
Line 2:		Line 2:

	==Free Pulls==		==Free Pulls==

			KoLmafia considers free pulls as completely separate from other items in Hangks. Because there is no resource being consumed by pulling them, they do not use the functions involved in pulls, specifically {{f\|storage_amount}} and {{f\|take_storage}}.

			To find the quantity of a free pull in Hangks, such as a brick you need to use {{f\|available_amount}}. To remove a free pull item from Hangks you need to use {{f\|retrieve_item}}.

	== Anonymous closures ==		== Anonymous closures ==

Bale: I'm not as drunk as StDoodle and headers might be a good start

2010-09-24T06:42:27Z

I'm not as drunk as StDoodle and headers might be a good start

← Older revision		Revision as of 06:42, 24 September 2010
Line 1:		Line 1:
	~~=Tips=~~		{{TOCright}}

	=~~Tricks~~=		==Free Pulls==

	=~~Workarounds~~=		== Anonymous closures ==

			== print() ==

			== Capturing an Abort ==

			== Syntax Highlighting for Notepad++ ==

			[[Category:Scripting]]

StDoodle: Created page with '=Tips= =Tricks= =Workarounds='

2010-09-24T06:30:20Z

Created page with '=Tips= =Tricks= =Workarounds='

New page

=Tips=

=Tricks=

=Workarounds=

← Older revision		Revision as of 20:36, 3 July 2021
Line 103:		Line 103:
	* {{f\|retrieve_item}}		* {{f\|retrieve_item}}
	* {{f\|sell}}		* {{f\|sell}}
	* {{f\|~~synthesize_effect}}~~		* {{f\|sweet_synthesis}}
	* {{f\|synthesize_pair}}
	* {{f\|take_closet}}		* {{f\|take_closet}}
	* {{f\|take_display}}		* {{f\|take_display}}