Disable - Revision history

Bale at 05:32, 22 May 2010

2010-05-22T05:32:19Z

← Older revision		Revision as of 05:32, 22 May 2010
Line 6:		Line 6:

	name={{#var:name}}\|		name={{#var:name}}\|
	~~function_category=Miscellaneous\|~~

	function1={{Function\|		function1={{Function\|
Line 40:		Line 39:
	see_also={{SeeAlso\|enable}}\|		see_also={{SeeAlso\|enable}}\|
	}}		}}

			[[Category:Miscellaneous Functions]]

Jasonharper: return values

2010-03-25T08:36:32Z

return values

← Older revision		Revision as of 08:36, 25 March 2010
Line 24:		Line 24:
	#Mafia cannot differentiate between scripts that call functions of the same name. If function "foo" is disabled from script one, it will still be disabled when you run script two, unless you enable "foo" or restart mafia.		#Mafia cannot differentiate between scripts that call functions of the same name. If function "foo" is disabled from script one, it will still be disabled when you run script two, unless you enable "foo" or restart mafia.
	#Remember that CLI commands will be disabled if they have the same name (or can be disabled deliberately with this function).		#Remember that CLI commands will be disabled if they have the same name (or can be disabled deliberately with this function).
	#If a disabled function is incorporated into a condition (eg. "if(disabled_function())" ), then mafia will not just skip the entire conditional~~. If an else statement is present~~, ~~the condition is treated as false and the else code will be performed~~.		#A disabled function still returns a value - the default value for its declared return type (false, 0, "", $item[none], an empty map, etc.). If a disabled function is incorporated into a condition (eg. "if(disabled_function())" ), then mafia will not just skip the entire conditional - execution will continue as normal, based on that default value.
	#Using "all" as the string parameter will disable all ASH ~~functions including enable. It also disables all~~ CLI functions with the exception of enable and disable. Therefore, to re-enable all functions, you must type "enable all" into the CLI - ~~don~~'~~t depend on ASH to sort~~ it ~~out~~.		#Using "all" as the string parameter will disable all ASH and CLI functions with the exception of enable and disable. Therefore, to re-enable all functions, you must type "enable all" into the CLI - ASH enable("all") would technically work, but at that point you'd have no way of invoking a script that contains it.
	#~~Despite "all" working in the manner specified above,~~ disable() and enable() cannot be disabled using disable() ~~when specified individually~~.		#disable() and enable() cannot be individually disabled using disable(), either.
	\|		\|

Bale at 05:50, 25 March 2010

2010-03-25T05:50:22Z

← Older revision		Revision as of 05:50, 25 March 2010
Line 26:		Line 26:
	#If a disabled function is incorporated into a condition (eg. "if(disabled_function())" ), then mafia will not just skip the entire conditional. If an else statement is present, the condition is treated as false and the else code will be performed.		#If a disabled function is incorporated into a condition (eg. "if(disabled_function())" ), then mafia will not just skip the entire conditional. If an else statement is present, the condition is treated as false and the else code will be performed.
	#Using "all" as the string parameter will disable all ASH functions including enable. It also disables all CLI functions with the exception of enable and disable. Therefore, to re-enable all functions, you must type "enable all" into the CLI - don't depend on ASH to sort it out.		#Using "all" as the string parameter will disable all ASH functions including enable. It also disables all CLI functions with the exception of enable and disable. Therefore, to re-enable all functions, you must type "enable all" into the CLI - don't depend on ASH to sort it out.
	#Despite "all" working in the manner specified above, disable() and enable() cannot be disabled using disable() when specified individually~~. Even if you use "disable("all")", you still cannot disable enable() or disable()~~.		#Despite "all" working in the manner specified above, disable() and enable() cannot be disabled using disable() when specified individually.
	\|		\|

Bale: That's how it is read.

2010-03-25T05:47:22Z

That's how it is read.

← Older revision		Revision as of 05:47, 25 March 2010
Line 26:		Line 26:
	#If a disabled function is incorporated into a condition (eg. "if(disabled_function())" ), then mafia will not just skip the entire conditional. If an else statement is present, the condition is treated as false and the else code will be performed.		#If a disabled function is incorporated into a condition (eg. "if(disabled_function())" ), then mafia will not just skip the entire conditional. If an else statement is present, the condition is treated as false and the else code will be performed.
	#Using "all" as the string parameter will disable all ASH functions including enable. It also disables all CLI functions with the exception of enable and disable. Therefore, to re-enable all functions, you must type "enable all" into the CLI - don't depend on ASH to sort it out.		#Using "all" as the string parameter will disable all ASH functions including enable. It also disables all CLI functions with the exception of enable and disable. Therefore, to re-enable all functions, you must type "enable all" into the CLI - don't depend on ASH to sort it out.
	#Despite "all" working in the manner specified above, disable() and enable() cannot be disabled using disable() when specified individually. ~~The only way to disable enable() is to~~ use "disable("all")".		#Despite "all" working in the manner specified above, disable() and enable() cannot be disabled using disable() when specified individually. Even if you use "disable("all")", you still cannot disable enable() or disable().
	\|		\|

Line 40:		Line 40:
	see_also={{SeeAlso\|enable}}\|		see_also={{SeeAlso\|enable}}\|
	}}		}}
	{{RFI\|I'm pretty darn sure that this thread[http://kolmafia.us/showthread.php?3801-Me-Being-Annoying-About-Disable%28%29] says that enable() and disable() can't be disabled (both the ASH and the CLI form). Can someone confirm that I'm reading this correctly?}}

Heeheehee: Minor formatting, raised a question that may need confirmation.

2010-03-24T23:09:16Z

Minor formatting, raised a question that may need confirmation.

← Older revision		Revision as of 23:09, 24 March 2010
Line 17:		Line 17:
	}}\|		}}\|

	function_description=This function allows you to disable commands and/or functions by name. String {{pspan\|func}} specifies the name of a CLI command or ASH function that you do not wish to be carried out. Note these include custom ASH functions (that you name yourself), but not aliases.~~</p>~~		function_description=This function allows you to disable commands and/or functions by name. String {{pspan\|func}} specifies the name of a CLI command or ASH function that you do not wish to be carried out. Note these include custom ASH functions (that you name yourself), but not aliases.
	~~<p>~~Mafia has an internal array of function names which are disabled. At the start of each session, this array starts empty. Disable adds names to this array and mafia will not allow functions to be called that are named after any on the disabled list (with the exception of disable and enable). This is useful for debugging scripts, as you can quickly disable functions from the top of a script without digging through the code. In addition, when a disabled function is called, mafia will print a line informing you of this fact, while not acting on it.~~</p><p>~~Important considerations:
	~~<ol>~~		Mafia has an internal array of function names which are disabled. At the start of each session, this array starts empty. Disable adds names to this array and mafia will not allow functions to be called that are named after any on the disabled list (with the exception of disable and enable). This is useful for debugging scripts, as you can quickly disable functions from the top of a script without digging through the code. In addition, when a disabled function is called, mafia will print a line informing you of this fact, while not acting on it.
	~~<li>~~Mafia cannot differentiate between scripts that call functions of the same name. If function "foo" is disabled from script one, it will still be disabled when you run script two, unless you enable "foo" or restart mafia.~~</li>~~
	~~<li>~~Remember that CLI commands will be disabled if they have the same name (or can be disabled deliberately with this function).~~</li>~~		Important considerations:
	~~<li>~~If a disabled function is incorporated into a condition (eg. "if(disabled_function())" ), then mafia will not just skip the entire conditional. If an else statement is present, the condition is treated as false and the else code will be performed.~~</li>~~		#Mafia cannot differentiate between scripts that call functions of the same name. If function "foo" is disabled from script one, it will still be disabled when you run script two, unless you enable "foo" or restart mafia.
	~~<li>~~Using "all" as the string parameter will disable all ASH functions including enable. It also disables all CLI functions with the exception of enable and disable. Therefore, to re-enable all functions, you must type "enable all" into the CLI - don't depend on ASH to sort it out.~~</li>~~		#Remember that CLI commands will be disabled if they have the same name (or can be disabled deliberately with this function).
	~~<li>~~Despite "all" working in the manner specified above, disable() and enable() cannot be disabled using disable() when specified individually. The only way to disable enable() is to use "disable("all")".~~</li>~~		#If a disabled function is incorporated into a condition (eg. "if(disabled_function())" ), then mafia will not just skip the entire conditional. If an else statement is present, the condition is treated as false and the else code will be performed.
	~~</ol>~~\|		#Using "all" as the string parameter will disable all ASH functions including enable. It also disables all CLI functions with the exception of enable and disable. Therefore, to re-enable all functions, you must type "enable all" into the CLI - don't depend on ASH to sort it out.
			#Despite "all" working in the manner specified above, disable() and enable() cannot be disabled using disable() when specified individually. The only way to disable enable() is to use "disable("all")".
			\|

	code1={{CodeSample\|		code1={{CodeSample\|
Line 38:		Line 40:
	see_also={{SeeAlso\|enable}}\|		see_also={{SeeAlso\|enable}}\|
	}}		}}
			{{RFI\|I'm pretty darn sure that this thread[http://kolmafia.us/showthread.php?3801-Me-Being-Annoying-About-Disable%28%29] says that enable() and disable() can't be disabled (both the ASH and the CLI form). Can someone confirm that I'm reading this correctly?}}

Grotfang at 13:07, 24 March 2010

2010-03-24T13:07:51Z

← Older revision		Revision as of 13:07, 24 March 2010
Line 23:		Line 23:
	<li>Remember that CLI commands will be disabled if they have the same name (or can be disabled deliberately with this function).</li>		<li>Remember that CLI commands will be disabled if they have the same name (or can be disabled deliberately with this function).</li>
	<li>If a disabled function is incorporated into a condition (eg. "if(disabled_function())" ), then mafia will not just skip the entire conditional. If an else statement is present, the condition is treated as false and the else code will be performed.</li>		<li>If a disabled function is incorporated into a condition (eg. "if(disabled_function())" ), then mafia will not just skip the entire conditional. If an else statement is present, the condition is treated as false and the else code will be performed.</li>
	<li>Using "all" as the string parameter will disable all ASH functions including enable~~. This will require a restart of KoLmafia to resolve, so use with care~~. It also disables the ~~usual logout function~~, ~~so will require exiting mafia by clicking~~ "X".</li>		<li>Using "all" as the string parameter will disable all ASH functions including enable. It also disables all CLI functions with the exception of enable and disable. Therefore, to re-enable all functions, you must type "enable all" into the CLI - don't depend on ASH to sort it out.</li>
	<li>Despite "all" working in the manner specified above, disable() and enable() cannot be disabled using disable() when specified individually. The only way to disable enable() is to use "disable("all")".</li>		<li>Despite "all" working in the manner specified above, disable() and enable() cannot be disabled using disable() when specified individually. The only way to disable enable() is to use "disable("all")".</li>
	</ol>\|		</ol>\|

Grotfang at 23:47, 10 March 2010

2010-03-10T23:47:30Z

← Older revision		Revision as of 23:47, 10 March 2010
Line 36:		Line 36:
	}}\|		}}\|

	see_also={{SeeAlso\|enable~~\|map_to_file~~}}\|		see_also={{SeeAlso\|enable}}\|
	}}		}}

Grotfang at 23:39, 10 March 2010

2010-03-10T23:39:41Z

← Older revision		Revision as of 23:39, 10 March 2010
Line 36:		Line 36:
	}}\|		}}\|

	see_also={{SeeAlso\|enable}}\|		see_also={{SeeAlso\|enable\|map_to_file}}\|
	}}		}}

Grotfang at 23:39, 10 March 2010

2010-03-10T23:39:17Z

← Older revision		Revision as of 23:39, 10 March 2010
Line 29:		Line 29:
	code1={{CodeSample\|		code1={{CodeSample\|
	title=Code Samples\|		title=Code Samples\|
	description=This mini scriptlet generates a map that is outputted to a data file. In testing ~~I don't~~ want to do this every time, so I disable map_to_file().\|		description=This mini scriptlet generates a map that is outputted to a data file. In testing you might not want to do this every time, so you can disable map_to_file().\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>

Grotfang at 23:36, 10 March 2010

2010-03-10T23:36:27Z

← Older revision		Revision as of 23:36, 10 March 2010
Line 29:		Line 29:
	code1={{CodeSample\|		code1={{CodeSample\|
	title=Code Samples\|		title=Code Samples\|
	description=This mini scriptlet ~~has~~ a ~~bug in it~~ that ~~makes it loop~~. I want to ~~test what is making the script run oddly~~, ~~but can't see immediately where the looping conditional is.~~ I ~~can use~~ disable ~~to knock out functions sequentially to test where the fault arises~~.\|		description=This mini scriptlet generates a map that is outputted to a data file. In testing I don't want to do this every time, so I disable map_to_file().\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
	disable("~~adventure_me~~");		disable("map_to_file");
	~~void adventure_me(){~~
	~~int my_adv = my_adventures();~~
	~~while(my_adv > 0){~~
	~~adventure(1 , $location[giant's castle]);~~
	}
	~~return;~~
	}

	~~void main(){~~
	~~adventure_me();~~
	~~print("Finish");~~
	}
	</syntaxhighlight>		</syntaxhighlight>
	}}\|		}}\|