Disable

From Kolmafia
Revision as of 15:12, 10 March 2010 by imported>Grotfang
Jump to navigation Jump to search

Function Syntax

void disable(string func )

  • func is the name of the function you wish to disable.

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.

Important considerations:

  1. 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.
  2. 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.
  3. 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.
  4. 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")".

Code Samples

DESCRIPTION OF CODE

CODE GOES HERE

See Also

enable()