Kolmafia - User contributions [en]

Hidden Features

2025-02-20T01:35:53Z

AlbinoRhino: update commit link to one that works

{{TOCright}}
Mafia has several features that aren't listed in the preferences. In order to enable these features you have to change properties with a CLI command. To issue a CLI command simply type the listed command in the text entry box at the bottom of the "Graphical CLI" window. Capitalization counts, so copy/paste is recommended.

=== Beep on Private Message ===
You can instruct chat to beep if you receive a private message. If this is enabled it will affect all characters. To enable this, issue the CLI command:

set chatBeep = true

=== Chat Broadcast & System Messages ===
By default KoLmafia's chat GUI will show KoL's broadcast messages and system messages on all open chat channels at the same time. You can change that behavior to show them only in the Events tab by setting it to false.

set broadcastEvents = false

=== Disable Image Caching ===
Normally all images are cached locally to save on bandwidth and server usage. This can be disabled although doing so will cause almost anyone to experience slower load times. Not recommended unless you've got a very good reason.

set useImageCache = false

=== Maximizer Price Checking ===
Normally, the maximizer will only search the mall for prices that are over 7 days old. For prices that were checked within the last week, it will use those historical prices without bothering to check the price in the mall at this moment. This saves a lot of time since prices on potions are rarely that volatile. If you want to change that behavior to always check prices once for each session, that can be changed with the following command.

set maximizerCurrentMallPrices = true

Set it back to false if you want to restore the default behavior.

=== Most Recently Used Modifier Maximizer Expression ===
At the top of the Modifier Maximizer drop-down it shows the most recently evaluated expressions. The number of most recently evaluated expressions can be changed by altering maximizerMRUSize. When enabled, the drop down will contain (at most) maximizerMRUSize entries with the most frequently used expression at the top. By default this number is five, but it can be changed to other values or disabled by changing it to zero. This is enabled on a per character basis.

set maximizerMRUSize = 20

will enable the feature and set the length of the menu to 20.

=== Most Recently Used Script Menu ===
You can alter your script menu to only show the most recently used scripts. This is enabled by setting scriptMRULength to a value greater than zero. When enabled the Script menu will contain (at most) scriptMRULength entries with the most frequently used script at the top. This list is automatically refreshed or can be manually refreshed by using the Refresh menu option. Scripts that are not on the list can be run by using the Load script option. This is enabled on a per character basis.

set scriptMRULength = 10

will enable the feature and set the length of the menu to 10. Although it is not enforced by the code, it is suggested that values greater than 45 or thereabouts be avoided. Note that the list is case sensitive. If your operating system allows you to invoke the file Ascend.ash by typing ascend then it is possible that both "Ascend" and "ascend" will appear on the list. Note also that the definition of "used" includes run from the Scripts menu, run from the gCLI or called from a running script using the "call" command.

=== Number of Custom Combat Buttons ===
In the Browser section of Preferences, we can mark the checkbox for "Add custom buttons to the top of fight pages." The number of buttons on the right side, that vary according to which skills have been used, is set to 5 by default. CLI command to change this is:

set relaySkillButtonCount=x

Where x is the number of variable buttons desired. Unusual values for x here might cause unexpected results. It should be a non-zero, whole number. This is a global setting, meaning it will not change according to which account is logged in.

=== Outfit Names Can Execute Some Commands===
Custom outfits can trigger actions when equipped, by including one (or more) of the following strings in their name:

F= - change familiar
E= - equip familiar item
M= - change mood
C= - arbitrary CLI command

Example outfit name: Sea Adventuring f=hound e=Das Boot m=SeaBuff
Usage: "outfit Sea Adventuring" or "outfit Sea Adventuring f=hound e=Das Boot m=SeaBuff", in the cli, will both accomplish the changes. You can also select and change the outfit as normal in the relay browser.
Note that the commands are executed BEFORE the actual outfit change. [https://github.com/kolmafia/kolmafia/commit/a4e73d255139bbc3aebafcdedd9b03faa05f1f46 See r6876]

=== Prompt About Crafting===
By default mafia will issue a prompt when you are going to spend an adventure crafting, until mafia is told it's okay. Once you say it is okay you will not receive a prompt the next time. This behavior can be modified by using the alwaysPromptAboutCrafting property.

set promptAboutCrafting = 1 (default)
set promptAboutCrafting = 2 (always prompt)
set promptAboutCrafting = 0 (never prompt)

Issue the command without the part in parenthesis. I only added that to advise you on its meaning.

===Quests: Doc Galaktik's Quest===
By default Doc Galaktik's quest to find medicinal herbs will be accepted by KoLmafia when you ascend. If you want to turn this off...

set autostartGalaktikQuest = false

===Resting in Chateau/Getaway Campsite vs Campground===
If you have access to Chateau Mantegna, KoLmafia will rest there by default before the Campground or Your Campsite Away From Your Campsite. If you do not want to rest at your Chateau by default, you can tell mafia not to do that with this command:

set restUsingChateau = false

If you have access to Your Campsite Away From Your Campsite, KoLmafia will rest there by default before the Campground. If you would rather rest at the campground by default, you can tell mafia to not rest at your Campsite Away From Your Campsite with this command:

set restUsingCampAwayTent = false

===Save window size ===
You can save the size of the KoLmafia window. This is especially useful for people with smaller monitors. This preference is character specific so you will need to use the following CLI command for each character.

set rememberDesktopSize = true

When it is not set, KoLmafia will determine the size of windows at startup. In the case of variable sized windows (such as the panel containing Daily Deeds) the computed size is too big for small displays. Setting this to true will remember the last size of the main window and use it instead of a computed size.

===Shadow Noodles===
Stationary buttons and automatic combat entangling will not normally use Shadow Noodles since it is so expensive. If you want Shadow Noodles to be used you need to enable it in preferences.

set considerShadowNoodles = true

===Use Huggler Channel===
Normally all messages on Huggler Radio are displayed in the /pvp channel. If you want Mafia to split out the Huggler Radio into it's own channel, you can enable that with:

set useHugglerChannel = true

Hidden Features

2021-06-03T09:42:43Z

AlbinoRhino: /* Outfit Names Can Execute Some Commands */

{{TOCright}}
Mafia has several features that aren't listed in the preferences. In order to enable these features you have to change properties with a CLI command. To issue a CLI command simply type the listed command in the text entry box at the bottom of the "Graphical CLI" window. Capitalization counts, so copy/paste is recommended.

=== Beep on Private Message ===
You can instruct chat to beep if you receive a private message. If this is enabled it will affect all characters. To enable this, issue the CLI command:

set chatBeep = true

=== Chat Broadcast & System Messages ===
By default KoLmafia's chat GUI will show KoL's broadcast messages and system messages on all open chat channels at the same time. You can change that behavior to show them only in the Events tab by setting it to false.

set broadcastEvents = false

=== Disable Image Caching ===
Normally all images are cached locally to save on bandwidth and server usage. This can be disabled although doing so will cause almost anyone to experience slower load times. Not recommended unless you've got a very good reason.

set useImageCache = false

=== Maximizer Price Checking ===
Normally, the maximizer will only search the mall for prices that are over 7 days old. For prices that were checked within the last week, it will use those historical prices without bothering to check the price in the mall at this moment. This saves a lot of time since prices on potions are rarely that volatile. If you want to change that behavior to always check prices once for each session, that can be changed with the following command.

set maximizerCurrentMallPrices = true

Set it back to false if you want to restore the default behavior.

=== Most Recently Used Modifier Maximizer Expression ===
At the top of the Modifier Maximizer drop-down it shows the most recently evaluated expressions. The number of most recently evaluated expressions can be changed by altering maximizerMRUSize. When enabled, the drop down will contain (at most) maximizerMRUSize entries with the most frequently used expression at the top. By default this number is five, but it can be changed to other values or disabled by changing it to zero. This is enabled on a per character basis.

set maximizerMRUSize = 20

will enable the feature and set the length of the menu to 20.

=== Most Recently Used Script Menu ===
You can alter your script menu to only show the most recently used scripts. This is enabled by setting scriptMRULength to a value greater than zero. When enabled the Script menu will contain (at most) scriptMRULength entries with the most frequently used script at the top. This list is automatically refreshed or can be manually refreshed by using the Refresh menu option. Scripts that are not on the list can be run by using the Load script option. This is enabled on a per character basis.

set scriptMRULength = 10

will enable the feature and set the length of the menu to 10. Although it is not enforced by the code, it is suggested that values greater than 45 or thereabouts be avoided. Note that the list is case sensitive. If your operating system allows you to invoke the file Ascend.ash by typing ascend then it is possible that both "Ascend" and "ascend" will appear on the list. Note also that the definition of "used" includes run from the Scripts menu, run from the gCLI or called from a running script using the "call" command.

=== Number of Custom Combat Buttons ===
In the Browser section of Preferences, we can mark the checkbox for "Add custom buttons to the top of fight pages." The number of buttons on the right side, that vary according to which skills have been used, is set to 5 by default. CLI command to change this is:

set relaySkillButtonCount=x

Where x is the number of variable buttons desired. Unusual values for x here might cause unexpected results. It should be a non-zero, whole number. This is a global setting, meaning it will not change according to which account is logged in.

=== Outfit Names Can Execute Some Commands===
Custom outfits can trigger actions when equipped, by including one (or more) of the following strings in their name:

F= - change familiar
E= - equip familiar item
M= - change mood
C= - arbitrary CLI command

Example outfit name: Sea Adventuring f=hound e=Das Boot m=SeaBuff
Usage: "outfit Sea Adventuring" or "outfit Sea Adventuring f=hound e=Das Boot m=SeaBuff", in the cli, will both accomplish the changes. You can also select and change the outfit as normal in the relay browser.
Note that the commands are executed BEFORE the actual outfit change. [https://kol.msurl.net/?q=revision%3D6876 See r6876]

=== Prompt About Crafting===
By default mafia will issue a prompt when you are going to spend an adventure crafting, until mafia is told it's okay. Once you say it is okay you will not receive a prompt the next time. This behavior can be modified by using the alwaysPromptAboutCrafting property.

set promptAboutCrafting = 1 (default)
set promptAboutCrafting = 2 (always prompt)
set promptAboutCrafting = 0 (never prompt)

Issue the command without the part in parenthesis. I only added that to advise you on its meaning.

===Quests: Doc Galaktik's Quest===
By default Doc Galaktik's quest to find medicinal herbs will be accepted by KoLmafia when you ascend. If you want to turn this off...

set autostartGalaktikQuest = false

===Resting in Chateau vs Campground===
If you have access to Chateau Mantegna, KoLmafia will rest there by default instead of the campground. If you want to rest only at the campground (maybe you have really nice housing) you can tell mafia to do that with this command:

set restUsingChateau = false

===Save window size ===
You can save the size of the KoLmafia window. This is especially useful for people with smaller monitors. This preference is character specific so you will need to use the following CLI command for each character.

set rememberDesktopSize = true

When it is not set, KoLmafia will determine the size of windows at startup. In the case of variable sized windows (such as the panel containing Daily Deeds) the computed size is too big for small displays. Setting this to true will remember the last size of the main window and use it instead of a computed size.

===Shadow Noodles===
Stationary buttons and automatic combat entangling will not normally use Shadow Noodles since it is so expensive. If you want Shadow Noodles to be used you need to enable it in preferences.

set considerShadowNoodles = true

===Use Huggler Channel===
Normally all messages on Huggler Radio are displayed in the /pvp channel. If you want Mafia to split out the Huggler Radio into it's own channel, you can enable that with:

set useHugglerChannel = true

Hidden Features

2021-06-03T09:31:06Z

AlbinoRhino: /* Outfit Names Can Execute Some Commands */

{{TOCright}}
Mafia has several features that aren't listed in the preferences. In order to enable these features you have to change properties with a CLI command. To issue a CLI command simply type the listed command in the text entry box at the bottom of the "Graphical CLI" window. Capitalization counts, so copy/paste is recommended.

=== Beep on Private Message ===
You can instruct chat to beep if you receive a private message. If this is enabled it will affect all characters. To enable this, issue the CLI command:

set chatBeep = true

=== Chat Broadcast & System Messages ===
By default KoLmafia's chat GUI will show KoL's broadcast messages and system messages on all open chat channels at the same time. You can change that behavior to show them only in the Events tab by setting it to false.

set broadcastEvents = false

=== Disable Image Caching ===
Normally all images are cached locally to save on bandwidth and server usage. This can be disabled although doing so will cause almost anyone to experience slower load times. Not recommended unless you've got a very good reason.

set useImageCache = false

=== Maximizer Price Checking ===
Normally, the maximizer will only search the mall for prices that are over 7 days old. For prices that were checked within the last week, it will use those historical prices without bothering to check the price in the mall at this moment. This saves a lot of time since prices on potions are rarely that volatile. If you want to change that behavior to always check prices once for each session, that can be changed with the following command.

set maximizerCurrentMallPrices = true

Set it back to false if you want to restore the default behavior.

=== Most Recently Used Modifier Maximizer Expression ===
At the top of the Modifier Maximizer drop-down it shows the most recently evaluated expressions. The number of most recently evaluated expressions can be changed by altering maximizerMRUSize. When enabled, the drop down will contain (at most) maximizerMRUSize entries with the most frequently used expression at the top. By default this number is five, but it can be changed to other values or disabled by changing it to zero. This is enabled on a per character basis.

set maximizerMRUSize = 20

will enable the feature and set the length of the menu to 20.

=== Most Recently Used Script Menu ===
You can alter your script menu to only show the most recently used scripts. This is enabled by setting scriptMRULength to a value greater than zero. When enabled the Script menu will contain (at most) scriptMRULength entries with the most frequently used script at the top. This list is automatically refreshed or can be manually refreshed by using the Refresh menu option. Scripts that are not on the list can be run by using the Load script option. This is enabled on a per character basis.

set scriptMRULength = 10

will enable the feature and set the length of the menu to 10. Although it is not enforced by the code, it is suggested that values greater than 45 or thereabouts be avoided. Note that the list is case sensitive. If your operating system allows you to invoke the file Ascend.ash by typing ascend then it is possible that both "Ascend" and "ascend" will appear on the list. Note also that the definition of "used" includes run from the Scripts menu, run from the gCLI or called from a running script using the "call" command.

=== Number of Custom Combat Buttons ===
In the Browser section of Preferences, we can mark the checkbox for "Add custom buttons to the top of fight pages." The number of buttons on the right side, that vary according to which skills have been used, is set to 5 by default. CLI command to change this is:

set relaySkillButtonCount=x

Where x is the number of variable buttons desired. Unusual values for x here might cause unexpected results. It should be a non-zero, whole number. This is a global setting, meaning it will not change according to which account is logged in.

=== Outfit Names Can Execute Some Commands===
Custom outfits can trigger actions when equipped, by including one (or more) of the following strings in their name:

F= - change familiar
E= - equip familiar item
M= - change mood
C= - arbitrary CLI command

Example outfit name: Sea Adventuring f=hound e=Das Boot m=SeaBuff
Note that the commands are executed BEFORE the actual outfit change. [https://kol.msurl.net/?q=revision%3D6876 See r6876]

=== Prompt About Crafting===
By default mafia will issue a prompt when you are going to spend an adventure crafting, until mafia is told it's okay. Once you say it is okay you will not receive a prompt the next time. This behavior can be modified by using the alwaysPromptAboutCrafting property.

set promptAboutCrafting = 1 (default)
set promptAboutCrafting = 2 (always prompt)
set promptAboutCrafting = 0 (never prompt)

Issue the command without the part in parenthesis. I only added that to advise you on its meaning.

===Quests: Doc Galaktik's Quest===
By default Doc Galaktik's quest to find medicinal herbs will be accepted by KoLmafia when you ascend. If you want to turn this off...

set autostartGalaktikQuest = false

===Resting in Chateau vs Campground===
If you have access to Chateau Mantegna, KoLmafia will rest there by default instead of the campground. If you want to rest only at the campground (maybe you have really nice housing) you can tell mafia to do that with this command:

set restUsingChateau = false

===Save window size ===
You can save the size of the KoLmafia window. This is especially useful for people with smaller monitors. This preference is character specific so you will need to use the following CLI command for each character.

set rememberDesktopSize = true

When it is not set, KoLmafia will determine the size of windows at startup. In the case of variable sized windows (such as the panel containing Daily Deeds) the computed size is too big for small displays. Setting this to true will remember the last size of the main window and use it instead of a computed size.

===Shadow Noodles===
Stationary buttons and automatic combat entangling will not normally use Shadow Noodles since it is so expensive. If you want Shadow Noodles to be used you need to enable it in preferences.

set considerShadowNoodles = true

===Use Huggler Channel===
Normally all messages on Huggler Radio are displayed in the /pvp channel. If you want Mafia to split out the Huggler Radio into it's own channel, you can enable that with:

set useHugglerChannel = true

Hidden Features

2021-06-03T09:27:30Z

AlbinoRhino:

{{TOCright}}
Mafia has several features that aren't listed in the preferences. In order to enable these features you have to change properties with a CLI command. To issue a CLI command simply type the listed command in the text entry box at the bottom of the "Graphical CLI" window. Capitalization counts, so copy/paste is recommended.

=== Beep on Private Message ===
You can instruct chat to beep if you receive a private message. If this is enabled it will affect all characters. To enable this, issue the CLI command:

set chatBeep = true

=== Chat Broadcast & System Messages ===
By default KoLmafia's chat GUI will show KoL's broadcast messages and system messages on all open chat channels at the same time. You can change that behavior to show them only in the Events tab by setting it to false.

set broadcastEvents = false

=== Disable Image Caching ===
Normally all images are cached locally to save on bandwidth and server usage. This can be disabled although doing so will cause almost anyone to experience slower load times. Not recommended unless you've got a very good reason.

set useImageCache = false

=== Maximizer Price Checking ===
Normally, the maximizer will only search the mall for prices that are over 7 days old. For prices that were checked within the last week, it will use those historical prices without bothering to check the price in the mall at this moment. This saves a lot of time since prices on potions are rarely that volatile. If you want to change that behavior to always check prices once for each session, that can be changed with the following command.

set maximizerCurrentMallPrices = true

Set it back to false if you want to restore the default behavior.

=== Most Recently Used Modifier Maximizer Expression ===
At the top of the Modifier Maximizer drop-down it shows the most recently evaluated expressions. The number of most recently evaluated expressions can be changed by altering maximizerMRUSize. When enabled, the drop down will contain (at most) maximizerMRUSize entries with the most frequently used expression at the top. By default this number is five, but it can be changed to other values or disabled by changing it to zero. This is enabled on a per character basis.

set maximizerMRUSize = 20

will enable the feature and set the length of the menu to 20.

=== Most Recently Used Script Menu ===
You can alter your script menu to only show the most recently used scripts. This is enabled by setting scriptMRULength to a value greater than zero. When enabled the Script menu will contain (at most) scriptMRULength entries with the most frequently used script at the top. This list is automatically refreshed or can be manually refreshed by using the Refresh menu option. Scripts that are not on the list can be run by using the Load script option. This is enabled on a per character basis.

set scriptMRULength = 10

will enable the feature and set the length of the menu to 10. Although it is not enforced by the code, it is suggested that values greater than 45 or thereabouts be avoided. Note that the list is case sensitive. If your operating system allows you to invoke the file Ascend.ash by typing ascend then it is possible that both "Ascend" and "ascend" will appear on the list. Note also that the definition of "used" includes run from the Scripts menu, run from the gCLI or called from a running script using the "call" command.

=== Number of Custom Combat Buttons ===
In the Browser section of Preferences, we can mark the checkbox for "Add custom buttons to the top of fight pages." The number of buttons on the right side, that vary according to which skills have been used, is set to 5 by default. CLI command to change this is:

set relaySkillButtonCount=x

Where x is the number of variable buttons desired. Unusual values for x here might cause unexpected results. It should be a non-zero, whole number. This is a global setting, meaning it will not change according to which account is logged in.

=== Outfit Names Can Execute Some Commands===
Custom outfits can trigger actions when equipped, by including one (or more) of the following strings in their name:

F= - change familiar
E= - equip familiar item
M= - change mood
C= - arbitrary CLI command
Note that the commands are executed BEFORE the actual outfit change. [https://kol.msurl.net/?q=revision%3D6876 See r6876]

=== Prompt About Crafting===
By default mafia will issue a prompt when you are going to spend an adventure crafting, until mafia is told it's okay. Once you say it is okay you will not receive a prompt the next time. This behavior can be modified by using the alwaysPromptAboutCrafting property.

set promptAboutCrafting = 1 (default)
set promptAboutCrafting = 2 (always prompt)
set promptAboutCrafting = 0 (never prompt)

Issue the command without the part in parenthesis. I only added that to advise you on its meaning.

===Quests: Doc Galaktik's Quest===
By default Doc Galaktik's quest to find medicinal herbs will be accepted by KoLmafia when you ascend. If you want to turn this off...

set autostartGalaktikQuest = false

===Resting in Chateau vs Campground===
If you have access to Chateau Mantegna, KoLmafia will rest there by default instead of the campground. If you want to rest only at the campground (maybe you have really nice housing) you can tell mafia to do that with this command:

set restUsingChateau = false

===Save window size ===
You can save the size of the KoLmafia window. This is especially useful for people with smaller monitors. This preference is character specific so you will need to use the following CLI command for each character.

set rememberDesktopSize = true

When it is not set, KoLmafia will determine the size of windows at startup. In the case of variable sized windows (such as the panel containing Daily Deeds) the computed size is too big for small displays. Setting this to true will remember the last size of the main window and use it instead of a computed size.

===Shadow Noodles===
Stationary buttons and automatic combat entangling will not normally use Shadow Noodles since it is so expensive. If you want Shadow Noodles to be used you need to enable it in preferences.

set considerShadowNoodles = true

===Use Huggler Channel===
Normally all messages on Huggler Radio are displayed in the /pvp channel. If you want Mafia to split out the Huggler Radio into it's own channel, you can enable that with:

set useHugglerChannel = true

Hidden Features

2021-06-03T09:26:50Z

AlbinoRhino: Outfit Names Can Execute Some Commands

{{TOCright}}
Mafia has several features that aren't listed in the preferences. In order to enable these features you have to change properties with a CLI command. To issue a CLI command simply type the listed command in the text entry box at the bottom of the "Graphical CLI" window. Capitalization counts, so copy/paste is recommended.

=== Beep on Private Message ===
You can instruct chat to beep if you receive a private message. If this is enabled it will affect all characters. To enable this, issue the CLI command:

set chatBeep = true

=== Chat Broadcast & System Messages ===
By default KoLmafia's chat GUI will show KoL's broadcast messages and system messages on all open chat channels at the same time. You can change that behavior to show them only in the Events tab by setting it to false.

set broadcastEvents = false

=== Disable Image Caching ===
Normally all images are cached locally to save on bandwidth and server usage. This can be disabled although doing so will cause almost anyone to experience slower load times. Not recommended unless you've got a very good reason.

set useImageCache = false

=== Maximizer Price Checking ===
Normally, the maximizer will only search the mall for prices that are over 7 days old. For prices that were checked within the last week, it will use those historical prices without bothering to check the price in the mall at this moment. This saves a lot of time since prices on potions are rarely that volatile. If you want to change that behavior to always check prices once for each session, that can be changed with the following command.

set maximizerCurrentMallPrices = true

Set it back to false if you want to restore the default behavior.

=== Most Recently Used Modifier Maximizer Expression ===
At the top of the Modifier Maximizer drop-down it shows the most recently evaluated expressions. The number of most recently evaluated expressions can be changed by altering maximizerMRUSize. When enabled, the drop down will contain (at most) maximizerMRUSize entries with the most frequently used expression at the top. By default this number is five, but it can be changed to other values or disabled by changing it to zero. This is enabled on a per character basis.

set maximizerMRUSize = 20

will enable the feature and set the length of the menu to 20.

=== Most Recently Used Script Menu ===
You can alter your script menu to only show the most recently used scripts. This is enabled by setting scriptMRULength to a value greater than zero. When enabled the Script menu will contain (at most) scriptMRULength entries with the most frequently used script at the top. This list is automatically refreshed or can be manually refreshed by using the Refresh menu option. Scripts that are not on the list can be run by using the Load script option. This is enabled on a per character basis.

set scriptMRULength = 10

will enable the feature and set the length of the menu to 10. Although it is not enforced by the code, it is suggested that values greater than 45 or thereabouts be avoided. Note that the list is case sensitive. If your operating system allows you to invoke the file Ascend.ash by typing ascend then it is possible that both "Ascend" and "ascend" will appear on the list. Note also that the definition of "used" includes run from the Scripts menu, run from the gCLI or called from a running script using the "call" command.

=== Number of Custom Combat Buttons ===
In the Browser section of Preferences, we can mark the checkbox for "Add custom buttons to the top of fight pages." The number of buttons on the right side, that vary according to which skills have been used, is set to 5 by default. CLI command to change this is:

set relaySkillButtonCount=x

Where x is the number of variable buttons desired. Unusual values for x here might cause unexpected results. It should be a non-zero, whole number. This is a global setting, meaning it will not change according to which account is logged in.

=== Outfit Names Can Execute Some Commands===
Custom outfits can trigger actions when equipped, by including one of the following strings in their name:

F= - change familiar
E= - equip familiar item
M= - change mood
C= - arbitrary CLI command
Note that the commands are executed BEFORE the actual outfit change. [https://kol.msurl.net/?q=revision%3D6876 See r6876]

=== Prompt About Crafting===
By default mafia will issue a prompt when you are going to spend an adventure crafting, until mafia is told it's okay. Once you say it is okay you will not receive a prompt the next time. This behavior can be modified by using the alwaysPromptAboutCrafting property.

set promptAboutCrafting = 1 (default)
set promptAboutCrafting = 2 (always prompt)
set promptAboutCrafting = 0 (never prompt)

Issue the command without the part in parenthesis. I only added that to advise you on its meaning.

===Quests: Doc Galaktik's Quest===
By default Doc Galaktik's quest to find medicinal herbs will be accepted by KoLmafia when you ascend. If you want to turn this off...

set autostartGalaktikQuest = false

===Resting in Chateau vs Campground===
If you have access to Chateau Mantegna, KoLmafia will rest there by default instead of the campground. If you want to rest only at the campground (maybe you have really nice housing) you can tell mafia to do that with this command:

set restUsingChateau = false

===Save window size ===
You can save the size of the KoLmafia window. This is especially useful for people with smaller monitors. This preference is character specific so you will need to use the following CLI command for each character.

set rememberDesktopSize = true

When it is not set, KoLmafia will determine the size of windows at startup. In the case of variable sized windows (such as the panel containing Daily Deeds) the computed size is too big for small displays. Setting this to true will remember the last size of the main window and use it instead of a computed size.

===Shadow Noodles===
Stationary buttons and automatic combat entangling will not normally use Shadow Noodles since it is so expensive. If you want Shadow Noodles to be used you need to enable it in preferences.

set considerShadowNoodles = true

===Use Huggler Channel===
Normally all messages on Huggler Radio are displayed in the /pvp channel. If you want Mafia to split out the Huggler Radio into it's own channel, you can enable that with:

set useHugglerChannel = true

Ends with

2021-01-11T12:42:47Z

AlbinoRhino:

<onlyinclude>{{{{{format|Function2}}}
|name=ends_with
|function1.return_type=boolean
|function1.description=Checks whether a string ends with a suffix string. (case-sensitive)
|function1.param1=value
|function1.param1.type=string
|function1.param1.description=String to check
|function1.param2=suffix
|function1.param2.type=string
|function1.param2.description=Suffix to search for
|description=This function was added in [https://kolmafia.us/threads/17911-add-ash-convenience-functions-boolean-starts_with-string-value-string-prefi.21624/ r17911].
|code1={{CodeSample
|title=Code Samples
|description=The following function call will return <code>true</code>:
|code=
<syntaxhighlight lang="d">
ends_with( "The quick brown fox jumps over the lazy dog", "lazy dog" );
</syntaxhighlight>
|moreinfo=
}}
|see_also={{SeeAlso/Substring Search}}
|cli_equiv=
|more_info=
|special=
|{{{1|}}}
}}</onlyinclude>
[[Category:String Handling Routines]]

Run turn

2019-10-28T05:43:57Z

AlbinoRhino:

{{
#vardefine:name|run_turn}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
return_type={{#var:return_type}}|
}}|

function_description=Will work as [[run_combat|run_combat()]] or [[run_choice|run_choice(-1)]] depending on whether you are in combat or in a choice. Proceeds to run a choice or combat, using your current KoLmafia settings. This function returns the HTML from the page (not just what is displayed, but all markup). Most commonly used to finish up adventures started via [[visit_url|visit_url()]].

Typing "ashq run_turn()" into the CLI will finish up the adventure for you using your KoLMafia settings. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This code converts your current location to its url and initiates a turn there. Whether a choice or combat, it will complete the adventure and capture the page text.|
code=
<syntaxhighlight>
void run_adv(location place)
{
string page_text = to_url(place).visit_url();
page_text = run_turn();
}
run_adv(my_location());
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url|run_combat|run_choice|my_location}}|

}}

[[Category:Adventuring]]

Get shop log

2017-12-27T07:12:11Z

AlbinoRhino:

{{
#vardefine:name|get_shop_log}}{{
#vardefine:return_type|string [int]}}{{
#vardefine:aggregate|yes}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
}}|

function_description=Returns a map of transactions in your store, keyed by the line number each is found on in your store log|

code1={{CodeSample|
title=Code Sample|
description=The following will print all lines in the shop log where the transaction amount was larger than 500,000 meat|
code=
<syntaxhighlight>
void write_big_sales(int limit) {
string[int] shopLog = get_shop_log();
matcher meat_gain;
string pattern = "for (\\d+) Meat";
int meat;

foreach i in shopLog {
meat_gain = create_matcher(pattern, shopLog[i]);
if (find(meat_gain)) {
meat = to_int(group(meat_gain, 1));
if (meat >= limit) {
print_html("" + i + " - " + shopLog[i] + "");
}
}
}
}

void main() {
write_big_sales(500000);
}
</syntaxhighlight>}}|

see_also={{SeeAlso|get_shop|create_matcher|group}}|
}}

[[Category:Item Management]]

Get shop log

2017-12-27T07:06:28Z

AlbinoRhino:

Current hit stat

2017-12-27T06:57:54Z

AlbinoRhino:

{{
#vardefine:name|current_hit_stat}}{{
#vardefine:return_type|stat}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}
}}|

function_description=Returns the stat (muscle, mysticality or moxie) that is currently being used to calculate hit percentages. This is most likely to be useful in consult ccs scripts, or scripts designed to optimise equipment usage.|

code1={{CodeSample|
title=Code Samples|
description=Checks to ensure your mainstat and hit stat are the same - to make sure you have the right type of weapon equipped. This only applies to muscle and moxie classes, so it checks to make sure you are not a mysticality class first.|
code=
<syntaxhighlight>
if(my_primestat() != $stat[mysticality]) {
if(current_hit_stat() != my_primestat()) {
print("You could probably select a more effective weapon!");
}
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|my_primestat|buffed_hit_stat}}|
special=When not logged in, this function returns $stat[muscle].
}}

[[Category:Your Character]]

Buffed hit stat

2017-12-27T06:57:16Z

AlbinoRhino:

{{
#vardefine:name|buffed_hit_stat}}{{
#vardefine:return_type|int}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}
}}|

function_description=Returns the buffed value of the stat that is currently used to calculate hit percentages. Note, ranged weapons use moxie to calculate hit percentage, melee weapons use muscle.|

code1={{CodeSample|
title=Code Samples|
description=This code will check your hit percentage against every monster in a specified location to make sure it is 50% or over for every monster.|
code=
<syntaxhighlight>
boolean safe_to_attack() {
int x = buffed_hit_stat();
monster [int] monster_list = get_monsters($location[Fantasy Airship]);
foreach int in monster_list {
float fumble = 1/22;
float hit_percentage = (((6 + (x - monster_defense(monster_list[int]))) / 10.5) * (100 - fumble));
if(hit_percentage < 50) {
return false;
}
}
return true;
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|get_monsters|monster_defense|current_hit_stat}}|
more_info=http://kol.coldfront.net/thekolwiki/index.php/Hit_Chance|
special=This function returns 0 when not logged in.
}}

[[Category:Your Character]]

Modifier Functions

2017-12-17T22:27:04Z

AlbinoRhino:

These functions allow access to the raw modifiers known to KoLmafia.
For more information on what modifiers exist, please see [[Modifiers]].
{{flink|boolean|boolean_modifier|string|string}}
{{flink|boolean|boolean_modifier|item|string|desc=Access to boolean modifiers.}}
{{flink|class|class_modifier|string|string}}
{{flink|class|class_modifier|item|string|desc=Access to modifiers that return one of the six classes (e.g. "Class").}}
{{flink|effect|effect_modifier|string|string}}
{{flink|effect|effect_modifier|item|string|desc=Access to modifiers that return an effect(e.g. "Intrinsic Effect" or, introduced more recently, "Effect").}}
{{flink|float|numeric_modifier|string|string}}
{{flink|float|numeric_modifier|item|string}}
{{flink|float|numeric_modifier|effect|string}}
{{flink|float|numeric_modifier|skill|string}}
{{flink|float|modifier_eval|string}}
{{flink|float|numeric_modifier|familiar|string|int|item|desc=Access to numeric modifiers.}}
{{flink|stat|stat_modifier|effect|string|desc=Access to modifiers that return one of the stats (e.g. "Equalize").}}
{{flink|string|string_modifier|string}}
{{flink|string|string_modifier|string|string|desc=Access to string modifiers.}}

[[Category:Scripting]]

User confirm

2017-11-19T12:40:28Z

AlbinoRhino:

{{
#vardefine:name|user_confirm}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|message}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|message}}|
parameter2={{Param|int|timeOutMillis}}|
parameter3={{Param|boolean|defaultValue}}|
p1desc={{pspan|message}} is the text to display in the confirmation pop-up|
p2desc={{pspan|timeOutMillis}} the length of time to display the dialog, in milliseconds|
p3desc={{pspan|defaultValue}} the value to return if the user does not choose an input before timeOutMillis ms|
}}|

function_description=Presents the user with a pop-up dialog box with the text in {{pspan|message}} (can use escaped characters, such as "<nowiki>\n</nowiki>" for a newline); returns true if the user selects "Yes" and false if the user selects "No."
If you wish for the dialog to "time out" and return a default value if the user does not select an option, use the three-parameter version.
Please use these sparingly, as it can defeat the purpose of scripting if the user must constantly provide information during execution.|

code1={{CodeSample|
title=Code Sample|
description=A check to see if the user truly wants to execute a script.|
code=
<syntaxhighlight>
if (!user_confirm("Are you sure you want to proceed with executing this script?") )
{
abort("Script execution canceled by user.");
}
</syntaxhighlight>}}|

}}

[[Category:Miscellaneous Functions]]

Svn info

2017-10-17T06:36:04Z

AlbinoRhino:

{{
#vardefine:name|svn_info}}{{
#vardefine:return_type|record}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|projectname}}|
p1desc={{Pspan|projectname}} is the name of a project which may exist on an SVN repo|
}}|

function_description=Provides information about a given project. {{Pspan|projectname}} will match any unique substring of any project in the /svn folder, but it is case sensitive. It returns a record with five fields:
<syntaxhighlight>
record {
string url; // The url that the project was checked out from
int revision; // The revision that the working copy is at
string last_changed_author; // The author who committed the last change
int last_changed_rev; // The revision that most recently modified this working copy (note, not necessarily the same as revision field)
string last_changed_date; // The date/time when lastChangedRevision happened
};
</syntaxhighlight>|

code1={{CodeSample|
title=Code Sample|
description=Checks svn repo for a project|
code=
<syntaxhighlight>
print( "To install ChIT, copy/paste the following line into your CLI and hit enter." );
print( "svn checkout " + svn_info( "mafiachit" ).url, "blue" );
</syntaxhighlight>}}|
cli_equiv=The CLI command "svn list" provides a list of all installed scripts.|
see_also={{SeeAlso|svn_exists|svn_at_head}}|
}}

[[Category:Miscellaneous Functions]]

User talk:Aventuristo

2017-09-28T04:43:37Z

AlbinoRhino:

Hi! I signed up for this wiki because I wanted to make some nontrivial changes to the way the ASH function documentation is arranged. I basically want to make a page for each data type, combining the basic description from the Data Types page, a list of related functions, and (if applicable) a list of proxy record fields. I've put an example of what I want to do at [[Talk:Item]]. Check it out and let me know what you think!

--[[User:Aventuristo|Aventuristo]] ([[User talk:Aventuristo|talk]]) 21:59, 27 September 2017 (EDT)

Personally, I don't see why not. It seems it would be an improvement, which one would assume is a good thing. I doubt such changes would be reverted by anyone, if that is why you are asking before doing it. This wiki seems somewhat abandoned lately. The people who could give a definitive answer seem to be MIA.

Looking at your proposed template, my only thought was that it might be nice to add some boilerplate to each type briefly explaining what proxy records are and how to use them. But maybe that's just me.

--[[User:AlbinoRhino|AlbinoRhino]] ([[User talk:AlbinoRhino|talk]]) 00:43, 28 September 2017 (EDT)

Sell price

2017-07-09T22:44:38Z

AlbinoRhino: update code sample

{{
#vardefine:name|sell_price}}{{
#vardefine:return_type|int}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=int|
return_also={{#var:return_also}}|
parameter1={{Param|coinmaster|master}}|
parameter2={{Param|item|it}}|
p1desc={{pspan|master}} is the coinmaster to query|
p2desc={{pspan|it}} is the item to check|
}}|

function_description=Returns the number of tokens that {{pspan|master}} will charge you if you want him to sell {{pspan|it}} to you.|

code1={{CodeSample|
title=Code Sample|
description=This prints the price for which you can buy an item from a coinmaster.|
code=
<syntaxhighlight>
void print_price(item it) {
if(is_coinmaster_item(it)) {
coinmaster master = it.seller;
string token = master.token;
int price = sell_price(master, it);
if(price > 1) token += "s";
print("You can buy that for "+ price + " "+token +".");
} else if(is_tradeable(it))
print("You can buy that from the mall for "+mall_price(it)+ " meat.");
else print("You cannot buy that!", "red");
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|sell|buy_price}}|
}}

[[Category:Item Management]]

Sell price

2017-07-09T22:42:54Z

AlbinoRhino: correct return type

{{
#vardefine:name|sell_price}}{{
#vardefine:return_type|int}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=int|
return_also={{#var:return_also}}|
parameter1={{Param|coinmaster|master}}|
parameter2={{Param|item|it}}|
p1desc={{pspan|master}} is the coinmaster to query|
p2desc={{pspan|it}} is the item to check|
}}|

function_description=Returns the number of tokens that {{pspan|master}} will charge you if you want him to sell {{pspan|it}} to you.|

code1={{CodeSample|
title=Code Sample|
description=This prints the price for which you can buy an item from a coinmaster.|
code=
<syntaxhighlight>
void print_price(item it) {
if(is_coinmaster_item(it)) {
coinmaster master = it.buyer;
string token = master.token;
int price = buy_price(master, it);
if(price > 1) token += "s";
print("You can buy that for "+ price + " "+token +".");
} else if(is_tradeable(it))
print("You can buy that from the mall for "+mall_price(it)+ " meat.");
else print("You cannot buy that!", "red");
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|sell|buy_price}}|
}}

[[Category:Item Management]]

Buy price

2017-07-09T22:42:31Z

AlbinoRhino: correct return type

{{
#vardefine:name|buy_price}}{{
#vardefine:return_type|int}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=int|
return_also={{#var:return_also}}|
parameter1={{Param|coinmaster|master}}|
parameter2={{Param|item|it}}|
p1desc={{pspan|master}} is the coinmaster to query|
p2desc={{pspan|it}} is the item to check|
}}|

function_description=Returns the number of tokens that {{pspan|master}} will trade you if you sell {{pspan|it}} to him.|

code1={{CodeSample|
title=Code Sample|
description=This prints the price for which you can sell an item to a coinmaster.|
code=
<syntaxhighlight>
void print_price(item it) {
if(is_coinmaster_item(it)) {
coinmaster master = it.seller;
string token = master.token;
int price = buy_price(master, it);
if(price > 1) token += "s";
print("You can sell that for "+ price + " "+token +".");
} else if(is_tradeable(it))
print("You can sell that in the mall for "+mall_price(it)+ " meat.");
else if(autosell_price(it) > 0)
print("You can autosell that for "+autosell_price(it)+ " meat.");
else print("You cannot sell that!", "red");
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|buy|sell_price}}|
}}

[[Category:Item Management]]

Help:To Do List

2017-05-25T01:16:21Z

AlbinoRhino:

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r17909: Add ASH function: string numberology_prize( number )

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r17658: http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=140128#post140128

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17644: To automatically select pairs of candy, add some ASH functions:
item [int] sweet_synthesis_pair( effect )
item [int] sweet_synthesis_pair( effect, flags )

For the desired effect, pick a suitable pair of candies.
If you are in-run, it will use only "available" candy and will prefer candies that you have more of.
If you are post-run, it will consider all candies and will choose the pair with the lowest total mall price.
If you want to force "available" candies post-run, use flags = 1.

boolean sweet_synthesis( effect )
boolean sweet_synthesis( effect, flags )

The same, but it will actually perform Sweet Synthesis to get the effect.

http://kolmafia.us/showthread.php?21144-Rethinking-Candy&p=139996&viewfull=1#post139996

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

r17673: Add "shop reprice" command and reprice_shop() ash function

r17677: edpiece? command tells you the effects of the various decorations, as well as telling you which one is currently equipped.

r17817: Added CLI command "absorb"

r17819: Add ASH function to interface to KoL's /count chat command:
int slash_count( item it )

r17845: Add my_absorbs() ash function

r17892: Add a bunch of ASH support for doing interesting things with properties:
http://kolmafia.us/showthread.php?21570-Properties&p=141625&viewfull=1#post141625
http://kolmafia.us/showthread.php?21570-Properties&p=141629&viewfull=1#post141629

boolean [string] get_all_properties( string filter, boolean global )
boolean property_exists( string name )
boolean property_exists( string name, boolean global )
boolean property_has_default( string name )
string property_default_value( string name )
string get_property( string name, boolean global )
string remove_property( string name )
string remove_property( string name, boolean global )
boolean rename_property( string old_name, string new_name )

r17911: Add ASH convenience functions:
boolean starts_with( string value, string prefix );
boolean ends_with( string value, string suffix );

r17912: Add ASH function to get the full unambiguous card name from the Deck of Every Card:
string every_card_name( string name )

r17921: Add ASH get_closet() and get_storage() commands:
int [item] get_closet();
int [item] get_storage();

r17936: Add ASH function: void mood_execute( int multiplicity )
multiplicity determines the minimum number of casts (or items) a given trigger will use; if
the mood trigger is "cast 1 SKILL", multiplicty 3 will treat it as "cast 3 SKILL".
multiplicity = -1 is what KoLmafia uses internally for between battle checks.
multiplicity = 0 is what the CLI command "mood execute" uses.

r17937-8: Add ASH function: string [int] available_choice_options( boolean spoilers )
If the argument is "true", the Relay Browser choice spoilers will be appended to KoL's choice choice text (in parentheses).

r17969/17970 adds the "spacegate" command.
spacegate vaccine X
(where X is 1, 2, or 3) will visit the Spacegate Vaccinator to get the appropriate vaccine.

r18000: Add ASH function: int my_session_meat() which tracks how much meat the character has gained
or lost since login via character actions; mall sales and incoming kmail containing meat
will increment my_meat(), but not this value.

r18040: When you define a map with value as a zero-length array, file_to_map can
now populate it. The values will be variable-length array literals that
consume all the data values from the line of your file. Thus: keyVALUE(VALUE)*

You can now use foreach to iterate over an aggregate literal.

http://kolmafia.us/showthread.php?21742-Best-way-to-load-questslog-txt&p=143001&viewfull=1#post143001

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Run turn

2017-05-25T01:14:50Z

AlbinoRhino: Created page with "{{ #vardefine:name|run_turn}}{{ #vardefine:return_type|buffer}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| return_type={{#var:return_type}..."

{{
#vardefine:name|run_turn}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
return_type={{#var:return_type}}|
}}|

function_description=Will work as [[run_combat|run_combat()]] or [[run_choice|run_choice(-1)]] depending on whether you are in combat or in a choice. Proceeds to run a choice or combat, using your current KoLmafia settings. This function returns the HTML from the page (not just what is displayed, but all markup). Most commonly used to finish up adventures started via [[visit_url|visit_url()]].

Typing "ashq run_turn()" into the CLI will finish up the adventure for you using your KoLMafia settings. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire choice results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This code converts your current location to its url and initiates a turn there. Whether a choice or combat, it will complete the adventure and capture the page text.|
code=
<syntaxhighlight>
void run_adv(location place)
{
string page_text = to_url(place).visit_url();
page_text = run_turn();
}
run_adv(my_location());
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url|run_combat|run_choice|my_location}}|

}}

[[Category:Adventuring]]

Run choice

2017-05-25T00:45:54Z

AlbinoRhino:

{{
#vardefine:name|run_choice}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|choice}}|
p1desc={{Pspan|choice}} is the number of the choice option you wish to take. Use "-1" to automate the rest of the choice using existing choice adventure settings.|

}}|

function_description=Proceeds to run a choice, selecting the provided choice number (or, if the provided choice number = -1, using your current KoLmafia settings). This function returns the HTML from the choice page (not just what is displayed, but all markup). Most commonly used to finish up choices started via [[visit_url|visit_url()]].

Another handy use for this function is to finish up choices that were started in the relay browser, or were interrupted (i.e. mafia aborted for you to manually make a choice selection). Typing "ashq run_choice(choice)" into the CLI will finish up the choice for you using your selected choice. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire choice results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This is a personalized version of [[adv1|adv1()]] that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a choice is encountered it selects the appropriate choice per your settings for that choice adventure and assigns the results to the page_text variable. (Effectively the same as using run_choice(-1)). If a combat is encountered instead of a choice adventure, [[run_combat|run_combat()]] is used.|
code=
<syntaxhighlight>
int run_adv(location place) {
string page_text = to_url(place).visit_url();
string choiceAdventure = "-1";
matcher m_choice = create_matcher("whichchoice value=(\\d+)", page_text);
while(page_text.contains_text("choice.php")) {
m_choice.reset(page_text);
m_choice.find();
choiceAdventure = m_choice.group(1);
string choice_num = get_property("choiceAdventure"+ choiceAdventure);

if(choice_num == "0") abort("Manual Control for "+ choiceAdventure);
if(choice_num == "") abort("Unsupported Choice Adventure!");

page_text = run_choice(choice_num);
}
if(page_text.contains_text("Combat"))
run_combat();
return choiceAdventure.to_int();
}
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url|run_combat|run_turn}}|

}}

[[Category:Adventuring]]

Run choice

2017-05-25T00:41:28Z

AlbinoRhino:

{{
#vardefine:name|run_choice}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|choice}}|
p1desc={{Pspan|choice}} is the number of the choice option you wish to take. Use "-1" to automate the rest of the choice using existing choice adventure settings.|

}}|

function_description=Proceeds to run a choice, selecting the provided choice number (or, if the provided choice number = -1, using your current KoLmafia settings). This function returns the HTML from the choice page (not just what is displayed, but all markup). Most commonly used to finish up choices started via [[visit_url|visit_url()]].

Another handy use for this function is to finish up choices that were started in the relay browser, or were interrupted (i.e. mafia aborted for you to manually make a choice selection). Typing "ashq run_choice(choice)" into the CLI will finish up the choice for you using your selected choice. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire choice results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This is a personalized version of [[adv1|adv1()]] that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, [[run_combat|run_combat()]] is used.|
code=
<syntaxhighlight>
int run_adv(location place) {
string page_text = to_url(place).visit_url();
string choiceAdventure = "-1";
matcher m_choice = create_matcher("whichchoice value=(\\d+)", page_text);
while(page_text.contains_text("choice.php")) {
m_choice.reset(page_text);
m_choice.find();
choiceAdventure = m_choice.group(1);
string choice_num = get_property("choiceAdventure"+ choiceAdventure);

if(choice_num == "0") abort("Manual Control for "+ choiceAdventure);
if(choice_num == "") abort("Unsupported Choice Adventure!");

page_text = run_choice(choice_num);
}
if(page_text.contains_text("Combat"))
run_combat();
return choiceAdventure.to_int();
}
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url|run_combat|run_turn}}|

}}

[[Category:Adventuring]]

Run choice

2017-05-25T00:37:41Z

AlbinoRhino:

{{
#vardefine:name|run_choice}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|choice}}|
p1desc={{Pspan|choice}} is the number of the choice option you wish to take. Use "-1" to automate the rest of the choice using existing choice adventure settings.|

}}|

function_description=Proceeds to run a choice using your current KoLmafia settings. This function returns the HTML from the choice page (not just what is displayed, but all markup). Most commonly used to finish up choices started via [[visit_url|visit_url()]].

Another handy use for this function is to finish up choices that were started in the relay browser, or were interrupted (i.e. mafia aborted for you to manually make a choice selection). Typing "ashq run_choice(choice)" into the CLI will finish up the choice for you using your selected choice. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire choice results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This is a personalized version of [[adv1|adv1()]] that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, [[run_combat|run_combat()]] is used.|
code=
<syntaxhighlight>
int run_adv(location place) {
string page_text = to_url(place).visit_url();
string choiceAdventure = "-1";
matcher m_choice = create_matcher("whichchoice value=(\\d+)", page_text);
while(page_text.contains_text("choice.php")) {
m_choice.reset(page_text);
m_choice.find();
choiceAdventure = m_choice.group(1);
string choice_num = get_property("choiceAdventure"+ choiceAdventure);

if(choice_num == "0") abort("Manual Control for "+ choiceAdventure);
if(choice_num == "") abort("Unsupported Choice Adventure!");

page_text = run_choice(choice_num);
}
if(page_text.contains_text("Combat"))
run_combat();
return choiceAdventure.to_int();
}
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url|run_combat|run_turn}}|

}}

[[Category:Adventuring]]

Item drops

2017-05-24T22:39:27Z

AlbinoRhino:

{{
#vardefine:name|item_drops}}{{
#vardefine:return_type|int [item]}}{{
#vardefine:aggregate|yes}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
parameter1={{Param|monster|m}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}
}}|

function_description=Returns a map of the monster's drop rates, indexed by item names.|

code1={{CodeSample|
title=Code Samples|
description=Prints the drops of a certain monster.|
code=
<syntaxhighlight>
void drops(monster mob){
int[item] drops = item_drops(mob);
print("Monster: " + mob);
foreach i in drops {
print("Drop rate of " + i + " is " + drops[i]*(1+item_drop_modifier()/100) + "%");
}
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|meat_drop|item_drop_modifier|item_drops_array}}|
special=This function has a known limitation: if a monster drops the same item more than once, the map only returns the last rate in that monster's entry in monsters.txt, however [[item_drops_array|item_drops_array()]] can be used to bypass this limitation.
}}

[[Category:Item Management]]

Item drops

2017-05-24T22:39:02Z

AlbinoRhino:

{{
#vardefine:name|item_drops}}{{
#vardefine:return_type|int [item]}}{{
#vardefine:aggregate|yes}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
parameter1={{Param|monster|m}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}
}}|

function_description=Returns a map of the monster's drop rates, indexed by item names.|

code1={{CodeSample|
title=Code Samples|
description=Prints the drops of a certain monster.|
code=
<syntaxhighlight>
void drops(monster mob){
int[item] drops = item_drops(mob);
print("Monster: " + mob);
foreach i in drops {
print("Drop rate of " + i + " is " + drops[i]*(1+item_drop_modifier()/100) + "%");
}
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|meat_drop|item_drop_modifier_item_drops_array}}|
special=This function has a known limitation: if a monster drops the same item more than once, the map only returns the last rate in that monster's entry in monsters.txt, however [[item_drops_array|item_drops_array()]] can be used to bypass this limitation.
}}

[[Category:Item Management]]

Run combat

2017-05-24T22:35:56Z

AlbinoRhino:

{{
#vardefine:name|run_combat}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|filter}}|
p1desc={{Pspan|filter}} is a macro or the name of a combat filter function defined elsewhere in your script, with the same behavior as in the 3-paramater version of adventure(). An empty string can be passed to use your battle action or CCS as normal. Essentially, this allows the scripter to put a CCS or macro into a script.|
}}|

function_description=Proceeds to run a combat using your current KoLmafia settings. This function returns the HTML from the final round of combat (not just what is displayed, but all markup). Most commonly used to finish up combats started via [[visit_url|visit_url()]].

Another handy use for this function is to finish up combats that were started in the relay browser, or were interrupted (causing mafia to pop up the minibrowser). Typing "ashq run_combat()" into the CLI will finish up the combat for you using your current CCS/battle action. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire combat results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This is a personalized version of adv1() that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, run_combat() is used.|
code=
<syntaxhighlight>
int run_adv(location place) {
string page_text = to_url(place).visit_url();
string choiceAdventure = "-1";
matcher m_choice = create_matcher("whichchoice value=(\\d+)", page_text);
while(page_text.contains_text("choice.php")) {
m_choice.reset(page_text);
m_choice.find();
choiceAdventure = m_choice.group(1);
string choice_num = get_property("choiceAdventure"+ choiceAdventure);

if(choice_num == "0") abort("Manual Control for "+ choiceAdventure);
if(choice_num == "") abort("Unsupported Choice Adventure!");

page_text = visit_url("choice.php?pwd&whichchoice="+ choiceAdventure +"&option="+ choice_num);
}
if(page_text.contains_text("Combat"))
run_combat();
return choiceAdventure.to_int();
}
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url|run_choice|run_turn}}|

special=Will return the text of the last combat encounter when called independently of a fight page.

Using run_combat() to execute fights will not do the normal post-fight processing that mafia normally performs with [[adv1]] or [[adventure]].
*it will not cause your afterAdventureScript to run
*it will not trigger post-combat restoration
*it will not check if adventuring goals have been met
*it does not obey counter aborts (e.g. fortune cookie)
*it does not update mafia's custom quest progress properties (e.g. palindomeDudesDefeated)
|
}}

[[Category:Adventuring]]

Help:To Do List

2017-05-24T22:32:41Z

AlbinoRhino:

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r17909: Add ASH function: string numberology_prize( number )

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r17658: http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=140128#post140128

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17644: To automatically select pairs of candy, add some ASH functions:
item [int] sweet_synthesis_pair( effect )
item [int] sweet_synthesis_pair( effect, flags )

For the desired effect, pick a suitable pair of candies.
If you are in-run, it will use only "available" candy and will prefer candies that you have more of.
If you are post-run, it will consider all candies and will choose the pair with the lowest total mall price.
If you want to force "available" candies post-run, use flags = 1.

boolean sweet_synthesis( effect )
boolean sweet_synthesis( effect, flags )

The same, but it will actually perform Sweet Synthesis to get the effect.

http://kolmafia.us/showthread.php?21144-Rethinking-Candy&p=139996&viewfull=1#post139996

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

r17673: Add "shop reprice" command and reprice_shop() ash function

r17677: edpiece? command tells you the effects of the various decorations, as well as telling you which one is currently equipped.

r17817: Added CLI command "absorb"

r17819: Add ASH function to interface to KoL's /count chat command:
int slash_count( item it )

r17845: Add my_absorbs() ash function

r17892: Add a bunch of ASH support for doing interesting things with properties:
http://kolmafia.us/showthread.php?21570-Properties&p=141625&viewfull=1#post141625
http://kolmafia.us/showthread.php?21570-Properties&p=141629&viewfull=1#post141629

boolean [string] get_all_properties( string filter, boolean global )
boolean property_exists( string name )
boolean property_exists( string name, boolean global )
boolean property_has_default( string name )
string property_default_value( string name )
string get_property( string name, boolean global )
string remove_property( string name )
string remove_property( string name, boolean global )
boolean rename_property( string old_name, string new_name )

r17911: Add ASH convenience functions:
boolean starts_with( string value, string prefix );
boolean ends_with( string value, string suffix );

r17912: Add ASH function to get the full unambiguous card name from the Deck of Every Card:
string every_card_name( string name )

r17921: Add ASH get_closet() and get_storage() commands:
int [item] get_closet();
int [item] get_storage();

r17936: Add ASH function: void mood_execute( int multiplicity )
multiplicity determines the minimum number of casts (or items) a given trigger will use; if
the mood trigger is "cast 1 SKILL", multiplicty 3 will treat it as "cast 3 SKILL".
multiplicity = -1 is what KoLmafia uses internally for between battle checks.
multiplicity = 0 is what the CLI command "mood execute" uses.

r17937-8: Add ASH function: string [int] available_choice_options( boolean spoilers )
If the argument is "true", the Relay Browser choice spoilers will be appended to KoL's choice choice text (in parentheses).

r17969/17970 adds the "spacegate" command.
spacegate vaccine X
(where X is 1, 2, or 3) will visit the Spacegate Vaccinator to get the appropriate vaccine.

r18000: Add ASH function: int my_session_meat() which tracks how much meat the character has gained
or lost since login via character actions; mall sales and incoming kmail containing meat
will increment my_meat(), but not this value.

r18040: When you define a map with value as a zero-length array, file_to_map can
now populate it. The values will be variable-length array literals that
consume all the data values from the line of your file. Thus: keyVALUE(VALUE)*

You can now use foreach to iterate over an aggregate literal.

http://kolmafia.us/showthread.php?21742-Best-way-to-load-questslog-txt&p=143001&viewfull=1#post143001

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2017-05-24T22:25:38Z

AlbinoRhino:

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r17909: Add ASH function: string numberology_prize( number )

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r17658: http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=140128#post140128

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17644: To automatically select pairs of candy, add some ASH functions:
item [int] sweet_synthesis_pair( effect )
item [int] sweet_synthesis_pair( effect, flags )

For the desired effect, pick a suitable pair of candies.
If you are in-run, it will use only "available" candy and will prefer candies that you have more of.
If you are post-run, it will consider all candies and will choose the pair with the lowest total mall price.
If you want to force "available" candies post-run, use flags = 1.

boolean sweet_synthesis( effect )
boolean sweet_synthesis( effect, flags )

The same, but it will actually perform Sweet Synthesis to get the effect.

http://kolmafia.us/showthread.php?21144-Rethinking-Candy&p=139996&viewfull=1#post139996

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

r17673: Add "shop reprice" command and reprice_shop() ash function

r17677: edpiece? command tells you the effects of the various decorations, as well as telling you which one is currently equipped.

r17817: Added CLI command "absorb"

r17819: Add ASH function to interface to KoL's /count chat command:
int slash_count( item it )

r17845: Add my_absorbs() ash function

r17892: Add a bunch of ASH support for doing interesting things with properties:
http://kolmafia.us/showthread.php?21570-Properties&p=141625&viewfull=1#post141625
http://kolmafia.us/showthread.php?21570-Properties&p=141629&viewfull=1#post141629

boolean [string] get_all_properties( string filter, boolean global )
boolean property_exists( string name )
boolean property_exists( string name, boolean global )
boolean property_has_default( string name )
string property_default_value( string name )
string get_property( string name, boolean global )
string remove_property( string name )
string remove_property( string name, boolean global )
boolean rename_property( string old_name, string new_name )

r17911: Add ASH convenience functions:
boolean starts_with( string value, string prefix );
boolean ends_with( string value, string suffix );

r17912: Add ASH function to get the full unambiguous card name from the Deck of Every Card:
string every_card_name( string name )

r17921: Add ASH get_closet() and get_storage() commands:
int [item] get_closet();
int [item] get_storage();

r17936: Add ASH function: void mood_execute( int multiplicity )
multiplicity determines the minimum number of casts (or items) a given trigger will use; if
the mood trigger is "cast 1 SKILL", multiplicty 3 will treat it as "cast 3 SKILL".
multiplicity = -1 is what KoLmafia uses internally for between battle checks.
multiplicity = 0 is what the CLI command "mood execute" uses.

r17937-8: Add ASH function: string [int] available_choice_options( boolean spoilers )
If the argument is "true", the Relay Browser choice spoilers will be appended to KoL's choice choice text (in parentheses).

r17969/17970 adds the "spacegate" command.
spacegate vaccine X
(where X is 1, 2, or 3) will visit the Spacegate Vaccinator to get the appropriate vaccine.

r18000: Add ASH function: int my_session_meat() which tracks how much meat the character has gained
or lost since login via character actions; mall sales and incoming kmail containing meat
will increment my_meat(), but not this value.

r18040: When you define a map with value as a zero-length array, file_to_map can
now populate it. The values will be variable-length array literals that
consume all the data values from the line of your file. Thus: keyVALUE(VALUE)*

You can now use foreach to iterate over an aggregate literal.

http://kolmafia.us/showthread.php?21742-Best-way-to-load-questslog-txt&p=143001&viewfull=1#post143001

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Run choice

2017-05-24T22:24:47Z

AlbinoRhino: Created page with "{{ #vardefine:name|run_choice}}{{ #vardefine:return_type|buffer}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate}}|..."

{{
#vardefine:name|run_choice}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|choice}}|
p1desc={{Pspan|choice}} is the number of the choice option you wish to take. Use "-1" to automate the rest of the choice using existing choice adventure settings.|

}}|

function_description=Proceeds to run a choice using your current KoLmafia settings. This function returns the HTML from the choice page (not just what is displayed, but all markup). Most commonly used to finish up choices started via [[visit_url|visit_url()]].

Another handy use for this function is to finish up choices that were started in the relay browser, or were interrupted (i.e. mafia aborted for you to manually make a choice selection). Typing "ashq run_choice(choice)" into the CLI will finish up the choice for you using your selected choice. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire choice results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This is a personalized version of adv1() that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, run_combat() is used.|
code=
<syntaxhighlight>
int run_adv(location place) {
string page_text = to_url(place).visit_url();
string choiceAdventure = "-1";
matcher m_choice = create_matcher("whichchoice value=(\\d+)", page_text);
while(page_text.contains_text("choice.php")) {
m_choice.reset(page_text);
m_choice.find();
choiceAdventure = m_choice.group(1);
string choice_num = get_property("choiceAdventure"+ choiceAdventure);

if(choice_num == "0") abort("Manual Control for "+ choiceAdventure);
if(choice_num == "") abort("Unsupported Choice Adventure!");

page_text = run_choice(choice_num);
}
if(page_text.contains_text("Combat"))
run_combat();
return choiceAdventure.to_int();
}
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url|run_combat|run_turn}}|

}}

[[Category:Adventuring]]

Run combat

2017-05-24T22:06:04Z

AlbinoRhino:

{{
#vardefine:name|run_combat}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|filter}}|
p1desc={{Pspan|filter}} is a macro or the name of a combat filter function defined elsewhere in your script, with the same behavior as in the 3-paramater version of adventure(). An empty string can be passed to use your battle action or CCS as normal. Essentially, this allows the scripter to put a CCS or macro into a script.|
}}|

function_description=Proceeds to run a combat using your current KoLmafia settings. This function returns the HTML from the final round of combat (not just what is displayed, but all markup). Most commonly used to finish up combats started via [[visit_url|visit_url()]].

Another handy use for this function is to finish up combats that were started in the relay browser, or were interrupted (causing mafia to pop up the minibrowser). Typing "ashq run_combat()" into the CLI will finish up the combat for you using your current CCS/battle action. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire combat results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This is a personalized version of adv1() that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, run_combat() is used.|
code=
<syntaxhighlight>
int run_adv(location place) {
string page_text = to_url(place).visit_url();
string choiceAdventure = "-1";
matcher m_choice = create_matcher("whichchoice value=(\\d+)", page_text);
while(page_text.contains_text("choice.php")) {
m_choice.reset(page_text);
m_choice.find();
choiceAdventure = m_choice.group(1);
string choice_num = get_property("choiceAdventure"+ choiceAdventure);

if(choice_num == "0") abort("Manual Control for "+ choiceAdventure);
if(choice_num == "") abort("Unsupported Choice Adventure!");

page_text = visit_url("choice.php?pwd&whichchoice="+ choiceAdventure +"&option="+ choice_num);
}
if(page_text.contains_text("Combat"))
run_combat();
return choiceAdventure.to_int();
}
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url|run_choice|run_turn}}|

special=Will return the text of the last combat encounter when called independently of a fight page.

Using run_combat() to execute fights will not do the normal post-fight processing that mafia normally performs with [[adv1]] or [[adventure]].
*run_combat() will not cause your afterAdventureScript to run
*run combat() will not trigger post-combat restoration
*run combat() will not check if adventuring goals have been met
*run combat() does not obey counter aborts (e.g. fortune cookie)
*run combat() does not update mafia's custom quest progress properties (e.g. palindomeDudesDefeated)
|
}}

[[Category:Adventuring]]

Run combat

2017-05-24T21:59:47Z

AlbinoRhino:

{{
#vardefine:name|run_combat}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|filter}}|
p1desc={{Pspan|filter}} is a macro or the name of a combat filter function defined elsewhere in your script, with the same behavior as in the 3-paramater version of adventure(). An empty string can be passed to use your battle action or CCS as normal. Essentially, this allows the scripter to put a CCS or macro into a script.|
}}|

function_description=Proceeds to run a combat using your current KoLmafia settings. This function returns the HTML from the final round of combat (not just what is displayed, but all markup). Most commonly used to finish up combats started via [[visit_url|visit_url()]].

Another handy use for this function is to finish up combats that were started in the relay browser, or were interrupted (causing mafia to pop up the minibrowser). Typing "ashq run_combat()" into the CLI will finish up the combat for you using your current CCS/battle action. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire combat results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This is a personalized version of adv1() that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, run_combat() is used.|
code=
<syntaxhighlight>
int run_adv(location place) {
string page_text = to_url(place).visit_url();
string choiceAdventure = "-1";
matcher m_choice = create_matcher("whichchoice value=(\\d+)", page_text);
while(page_text.contains_text("choice.php")) {
m_choice.reset(page_text);
m_choice.find();
choiceAdventure = m_choice.group(1);
string choice_num = get_property("choiceAdventure"+ choiceAdventure);

if(choice_num == "0") abort("Manual Control for "+ choiceAdventure);
if(choice_num == "") abort("Unsupported Choice Adventure!");

page_text = visit_url("choice.php?pwd&whichchoice="+ choiceAdventure +"&option="+ choice_num);
}
if(page_text.contains_text("Combat"))
run_combat();
return choiceAdventure.to_int();
}
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url}}|

special=Will return the text of the last combat encounter when called independently of a fight page.

Using run_combat() to execute fights will not do the normal post-fight processing that mafia normally performs with [[adv1]] or [[adventure]].
*run_combat() will not cause your afterAdventureScript to run
*run combat() will not trigger post-combat restoration
*run combat() will not check if adventuring goals have been met
*run combat() does not obey counter aborts (e.g. fortune cookie)
*run combat() does not update mafia's custom quest progress properties (e.g. palindomeDudesDefeated)
|
}}

[[Category:Adventuring]]

Eudora

2017-05-24T21:51:03Z

AlbinoRhino:

{{
#vardefine:name|eudora}}{{
#vardefine:return_type|boolean}}{{
#vardefine:return_also|string}}{{

FunctionPage|

name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
parameter1={{Param|string|correspondent}}|
}}|

function2={{Function|
name={{#var:name}}|
return_type=string|
p1desc={{pspan|correspondent}} which eudora correspondent to switch to. (Penpal, Game Magazine, Xi?, New-You Club) |
}}|

function_description=Similar to the CLI "eudora" commmand. The boolean version switches between correspondents. It returns true if the switch was successful. The string version returns the current correspondent. (see KoLMafia r16978)|

code1={{CodeSample|
title=Code Sample|
description=Check if your current correspondent is the New-You Club, and if not, switch to it.|
code=
<syntaxhighlight>
if (eudora() != "New-You Club")
{
eudora("New-You Club");
}
</syntaxhighlight>
}}|

cli_equiv=eudora (penpal, game, xi, newyou) - switch to the specified correspondent. If no parameter is provided, the command will report your current correspondent.|
}}

[[Category:Your Character]]

Help:To Do List

2017-05-24T07:03:17Z

AlbinoRhino:

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r17909: Add ASH function: string numberology_prize( number )

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r17658: http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=140128#post140128

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17644: To automatically select pairs of candy, add some ASH functions:
item [int] sweet_synthesis_pair( effect )
item [int] sweet_synthesis_pair( effect, flags )

For the desired effect, pick a suitable pair of candies.
If you are in-run, it will use only "available" candy and will prefer candies that you have more of.
If you are post-run, it will consider all candies and will choose the pair with the lowest total mall price.
If you want to force "available" candies post-run, use flags = 1.

boolean sweet_synthesis( effect )
boolean sweet_synthesis( effect, flags )

The same, but it will actually perform Sweet Synthesis to get the effect.

http://kolmafia.us/showthread.php?21144-Rethinking-Candy&p=139996&viewfull=1#post139996

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

r17673: Add "shop reprice" command and reprice_shop() ash function

r17677: edpiece? command tells you the effects of the various decorations, as well as telling you which one is currently equipped.

r17817: Added CLI command "absorb"

r17819: Add ASH function to interface to KoL's /count chat command:
int slash_count( item it )

r17845: Add my_absorbs() ash function

r17892: Add a bunch of ASH support for doing interesting things with properties:
http://kolmafia.us/showthread.php?21570-Properties&p=141625&viewfull=1#post141625
http://kolmafia.us/showthread.php?21570-Properties&p=141629&viewfull=1#post141629

boolean [string] get_all_properties( string filter, boolean global )
boolean property_exists( string name )
boolean property_exists( string name, boolean global )
boolean property_has_default( string name )
string property_default_value( string name )
string get_property( string name, boolean global )
string remove_property( string name )
string remove_property( string name, boolean global )
boolean rename_property( string old_name, string new_name )

r17911: Add ASH convenience functions:
boolean starts_with( string value, string prefix );
boolean ends_with( string value, string suffix );

r17912: Add ASH function to get the full unambiguous card name from the Deck of Every Card:
string every_card_name( string name )

r17921: Add ASH get_closet() and get_storage() commands:
int [item] get_closet();
int [item] get_storage();

r17936: Add ASH function: void mood_execute( int multiplicity )
multiplicity determines the minimum number of casts (or items) a given trigger will use; if
the mood trigger is "cast 1 SKILL", multiplicty 3 will treat it as "cast 3 SKILL".
multiplicity = -1 is what KoLmafia uses internally for between battle checks.
multiplicity = 0 is what the CLI command "mood execute" uses.

r17937-8: Add ASH function: string [int] available_choice_options( boolean spoilers )
If the argument is "true", the Relay Browser choice spoilers will be appended to KoL's choice choice text (in parentheses).

r17969/17970 adds the "spacegate" command.
spacegate vaccine X
(where X is 1, 2, or 3) will visit the Spacegate Vaccinator to get the appropriate vaccine.

r18000: Add ASH function: int my_session_meat() which tracks how much meat the character has gained
or lost since login via character actions; mall sales and incoming kmail containing meat
will increment my_meat(), but not this value.

r18040: When you define a map with value as a zero-length array, file_to_map can
now populate it. The values will be variable-length array literals that
consume all the data values from the line of your file. Thus: keyVALUE(VALUE)*

You can now use foreach to iterate over an aggregate literal.

http://kolmafia.us/showthread.php?21742-Best-way-to-load-questslog-txt&p=143001&viewfull=1#post143001

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Eudora

2017-05-08T22:15:24Z

AlbinoRhino: more cli info

Your Character

2017-05-08T22:08:08Z

AlbinoRhino: /* Misc. */

{{TOCright}}
==Viewable Info==
{{flink|string|my_name|desc=Returns your character's name in lowercase.}}
{{flink|string|my_id|desc=Returns your character ID.}}
{{flink|int|get_clan_id|desc=Returns the ID number of the character's current clan.}}
{{flink|string|get_clan_name|desc=Returns the name of the character's current clan.}}
{{Flink|int|my_ascensions|desc=Returns the number of times your character has ascended.}}
{{flink|class|my_class|desc=Returns your class.}}
{{flink|int|my_level|desc=Returns your level.}}
{{flink|int|my_adventures|desc=Returns the number of adventures you have remaining.}}
{{flink|int|total_turns_played|desc=Returns total turns played since the character was created.}}
{{flink|int|turns_played}}
{{flink|int|my_turncount|desc=Both functions return the number of adventures used this ascension.}}
{{flink|int|my_daycount|desc=Return the number of days used this ascension.}}
{{flink|stat|my_primestat|desc=Returns the main stat of your current class.}}
{{flink|int|my_basestat|stat|desc=Returns your base value in the given stat (or substat).}}
{{flink|int|my_buffedstat|stat|desc=Returns your buffed value in the given stat (or substat).}}
{{flink|boolean|hippy_stone_broken|desc=Reports if your Hippy Stone is currently broken.}}
{{flink|int|pvp_attacks_left|desc=Returns number of PvP attacks remaining.}}
{{flink|int|total_free_rests|desc=Returns the total number of free rests available to your character.}}
{{flink|thrall|my_thrall|desc=Returns your current pasta thrall.}}

==Resources==
{{flink|int|my_hp|desc=Returns your current HP.}}
{{flink|int|my_mp|desc=Returns your current MP.}}
{{flink|int|my_maxhp|desc=Returns your current maximum HP.}}
{{flink|int|my_maxmp|desc=Returns your current maximum MP.}}
{{flink|int|my_soulsauce|desc=Returns your current Soulsauce.}}
{{flink|int|my_audience|desc=Returns your current Audience.}}
{{flink|int|my_thunder|desc=Returns your current Thunder.}}
{{flink|int|my_rain|desc=Returns your current Rain.}}
{{flink|int|my_lightning|desc=Returns your current Lightning.}}

==Familiars and Substitutes==
{{flink|familiar|my_familiar|desc=Returns your current familiar.}}
{{flink|int|familiar_weight|familiar|desc=Returns the base weight of the specified familiar.}}
{{flink|boolean|is_familiar_equipment_locked|desc=Returns lock status of familiar equipment.}}
{{flink|void|lock_familiar_equipment|boolean|desc=Locks or Unlocks familiar equipment.}}
{{flink|int|minstrel_level|desc=Reports Clancy's level.}}
{{flink|item|minstrel_instrument|desc=Reports Clancy's equipped item.}}
{{flink|boolean|minstrel_quest|desc=Reports if Clancy has a new quest for you.}}
{{flink|string|my_companion|desc=Returns your current companion.}}

==Hidden Info==
{{flink|string|my_hash|desc=Returns the password hash for your current session.}}
{{flink|stat|current_hit_stat|desc=Returns the stat currently used to calculate to-hit percentage.}}
{{flink|int|buffed_hit_stat|desc=Returns the buffed value of your currently used to-hit stat.}}
{{flink|int|raw_damage_absorption|desc=Returns your current DA total.}}
{{flink|float|damage_absorption_percent|desc=Returns the percentage of damage mitigated by your DA.}}
{{flink|int|damage_reduction|desc=Returns the amount of damage reduction your character currently has.}}
{{flink|float|elemental_resistance|element|desc=Returns the percentage of damage reduction to the given element based on your current resistance to that element.}}
{{flink|float|combat_rate_modifier|desc=Returns the percentage adjustment to your combat rate.}}
{{flink|float|initiative_modifier|desc=Returns the percentage adjustment to your chance of gaining initiative.}}
{{flink|float|experience_bonus|desc=Returns the amount of bonus experience your receive after combat.}}
{{flink|float|meat_drop_modifier|desc=Returns the percentage adjustment to meat drops after combat.}}
{{flink|float|item_drop_modifier|desc=Returns the percentage adjustment to item drops after combat.}}
{{flink|int|monster_level_adjustment|desc=Returns the total +ML you have active, including your sign-specific device.}}
{{flink|stat|stat_bonus_today}}
{{flink|stat|stat_bonus_tomorrow|desc=These two functions report on what stat has a stat-day bonus or $stat[none] if it isn't a stat day.}}
{{flink|int|current_mcd|desc=Returns the current setting of your sign-specific +ML device.}}
{{flink|int|weight_adjustment|desc=Returns the cumulative total of all familiar weight adjustments from all sources.}}
{{flink|boolean|get_ignore_zone_warnings|desc=Returns the value of the KoL option to disable "This area might be too tough for you" warnings.}}
{{flink|string [location] [int]|get_florist_plants|desc=Returns the a map of all plants currently planted in every location.}}

==Sign & Path==
{{flink|boolean|can_eat|desc=Reports on whether your characters path allows food consumption.}}
{{flink|boolean|can_drink|desc=Reports on whether your characters path allows booze consumption}}
{{flink|boolean|can_interact|desc=Reports on whether your character can access the mall, gift packages, etc.}}
{{flink|boolean|in_hardcore|desc=Reports on whether your character is under Hardcore restrictions.}}
{{flink|item|daily_special|desc=Returns the daily special at your sign eatery.}}
{{flink|boolean|in_moxie_sign}}
{{flink|boolean|in_muscle_sign}}
{{flink|boolean|in_mysticality_sign}}
{{flink|boolean|in_bad_moon|desc=These four functions report on the stat gains granted by your character's ascension moon sign.}}
{{flink|string|my_path|desc=The ascension path your character chose.}}
{{flink|string|my_sign|desc=The moon sign your character ascended under.}}

==Consumption==
{{flink|int|my_fullness|desc=Returns how full you are.}}
{{flink|int|fullness_limit|desc=Returns your maximum fullness.}}
{{flink|int|my_inebriety|desc=Returns your current drunkenness.}}
{{flink|int|inebriety_limit|desc=Returns your maximum safe drunk (before overdrinking).}}
{{flink|int|my_spleen_use|desc=Returns your current spleen use.}}
{{flink|int|spleen_limit|desc=Returns your spleen limit.}}

==Location Availability==
{{flink|boolean|black_market_available|desc=Returns the availability of the Black Market.}}
{{flink|boolean|canadia_available|desc=Returns the availability of Little Canadia.}}
{{flink|boolean|dispensary_available|desc=Returns the availability of the Knob Dispensary.}}
{{flink|boolean|florist_available|desc=Returns the availability of The Florist Friar's Cottage.}}
{{flink|boolean|gnomads_available|desc=Returns the availability of the Gnomish Gnomad Camp.}}
{{flink|boolean|guild_store_available|desc=Returns the availability of your guild store.}}
{{flink|boolean|hidden_temple_unlocked|desc=Returns the availability of the Hidden Temple.}}
{{flink|boolean|hippy_store_available|desc=Returns the availability of the Hippy Store.}}
{{flink|boolean|knoll_available|desc=Returns the availability of the Degrassi Knoll.}}
{{flink|boolean|white_citadel_available|desc=Returns the availability of White Citadel.}}

==Misc.==
{{Flink|string|eudora|desc=Returns your current Eudora correspondent.}}
{{Flink|boolean|galaktik_cures_discounted|desc=Returns whether Doc's offers you a discount for quest completion.}}
{{Flink|int|is_unrestricted|desc=Checks whether a given game resource is available.}}
{{Flink|int|moon_light|desc=Returns the total lit moon segments.}}
{{Flink|int|moon_phase|desc=Returns the phase (0-15) of the main moons.}}

[[Category:Scripting]]

Ash Functions

2017-05-08T22:04:41Z

AlbinoRhino: add eudora function

{{TOCright}}
Master list of all ASH functions. All functions as of r8144 are listed; this list is intended to be kept current, but it is possible that some functions added since the above revision may be missing. (Please feel free to add in any you notice.)
===a===
{{Flink|void|abort|{{opt|string}}}}
{{Flink|void|add_item_condition|int|item}}
{{Flink|boolean|adv1|location|int|string}}
{{Flink|int|adv_cost|skill}}
{{Flink|boolean|adventure|int|location|{{opt|string}}}}
{{Flink|string [int]|all_normal_outfits}}
{{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}}}
{{Flink|buffer|append|buffer|string}}
{{Flink|buffer|append_replacement|matcher|buffer|string}}
{{Flink|buffer|append_tail|matcher|buffer}}
{{Flink|buffer|attack}}
{{Flink|boolean|autosell|int|item}}
{{Flink|int|autosell_price|item}}
{{Flink|int|available_amount|item}}
{{Flink|string [int]|available_choice_options|{{opt|boolean}}}}

===b===
{{Flink|boolean|batch_close}}
{{Flink|void|batch_open}}
{{Flink|boolean|bjornify_familiar|familiar}}
{{Flink|boolean|black_market_available}}
{{Flink|boolean|boolean_modifier|{{opt|string}}|string}}
{{Flink|boolean|boolean_modifier|item|string}}
{{Flink|int|buffed_hit_stat}}
{{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}
{{Flink|int|buy|int|item|int}}
{{Flink|int|buy_price|coinmaster|item}}
{{Flink|boolean|buy_using_storage|int|item}}
{{Flink|int|buy_using_storage|int|item|int}}
{{Flink|boolean|buys_item|coinmaster|item}}

===c===
{{Flink|boolean|can_drink}}
{{Flink|boolean|can_eat}}
{{Flink|boolean|can_equip|item}}
{{Flink|boolean|can_faxbot|monster}}
{{Flink|boolean|can_interact}}
{{flink|boolean|canadia_available}}
{{Flink|int|ceil|float}}
{{Flink|boolean|change_mcd|int}}
{{Flink|string|char_at|string|int}}
{{Flink|void|chat_clan|string|{{opt|string}}}}
{{Flink|void|chat_macro|string}}
{{Flink|void|chat_notify|string|string}}
{{Flink|void|chat_private|string|string}}
{{Flink|boolean|chew|int|item}}
{{Flink|class|class_modifier|string|string}}
{{Flink|class|class_modifier|item|string}}
{{Flink|void|clear|aggregate}}
{{Flink|boolean|cli_execute|string}}
{{Flink|int|closet_amount|item}}
{{Flink|int|combat_mana_cost_modifier}}
{{Flink|float|combat_rate_modifier}}
{{Flink|boolean|contains_text|string|string}}
{{Flink|void|council}}
{{Flink|int|count|aggregate}}
{{Flink|boolean|craft|string|int|item|item}}
{{Flink|string|craft_type|item}}
{{Flink|int|creatable_amount|item}}
{{Flink|int|creatable_turns|{{opt|item}}|{{opt|int}}|{{opt|boolean}}}}
{{Flink|boolean|create|int|item}}
{{Flink|matcher|create_matcher|string|string}}
{{Flink|stat|current_hit_stat}}
{{Flink|int|current_mcd}}

===d===
{{Flink|element|dad_sea_monkee_weakness|int}}
{{Flink|item|daily_special}}
{{Flink|float|damage_absorption_percent}}
{{Flink|int|damage_reduction}}
{{Flink|buffer|delete|buffer|int|int}}
{{Flink|void|disable|string}}
{{flink|boolean|dispensary_available}}
{{Flink|int|display_amount|item}}
{{Flink|boolean|drink|int|item}}

===e===
{{Flink|boolean|eat|int|item}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|effect|effect_modifier|string|string}}
{{Flink|effect|effect_modifier|item|string}}
{{Flink|float|elemental_resistance|element}}
{{Flink|float|elemental_resistance|{{opt|monster}}}}
{{Flink|boolean|empty_closet}}
{{Flink|void|enable|string}}
{{Flink|int|end|matcher|{{opt|int}}}}
{{Flink|boolean|enthrone_familiar|familiar}}
{{Flink|string|entity_decode|string}}
{{Flink|string|entity_encode|string}}
{{Flink|boolean|equip|{{opt|slot}}|item}}
{{Flink|boolean|equip_all_familiars}}
{{Flink|int|equipped_amount|item}}
{{Flink|item|equipped_item|slot}}
{{Flink|string|eudora}}
{{Flink|boolean|eudora|string}}
{{Flink|int|expected_damage|{{opt|monster}}}}
{{Flink|float|experience_bonus}}
{{Flink|float|expression_eval}}
{{Flink|int [item]|extract_items|string}}
{{Flink|int|extract_meat|string}}

===f===
{{Flink|item|familiar_equipment|familiar}}
{{Flink|item|familiar_equipped_equipment|familiar}}
{{Flink|int|familiar_weight|familiar}}
{{Flink|boolean [familiar]|favorite_familiars|}}
{{Flink|boolean|faxbot|monster}}
{{Flink|boolean|file_to_map|string|aggregate|{{opt|boolean}}}}
{{Flink|boolean|find|matcher}}
{{Flink|int|floor|float}}
{{Flink|boolean|florist_available}}
{{Flink|string|form_field|string}}
{{Flink|string [string]|form_fields}}
{{Flink|string|format_date_time|string|string|string}}
{{Flink|boolean|friars_available}}
{{Flink|int|fullness_limit}}

===g===
{{Flink|boolean|galaktik_cures_discounted}}
{{Flink|int|gameday_to_int}}
{{Flink|string|gameday_to_string}}
{{Flink|int|gametime_to_int}}
{{Flink|boolean [string] |get_all_properties|string|boolean}}
{{Flink|int|get_auto_attack}}
{{Flink|int [item]|get_campground}}
{{Flink|string |get_ccs_action|int}}
{{Flink|int [item]|get_chateau}}
{{Flink|int|get_clan_id}}
{{Flink|int [item]|get_clan_lounge}}
{{Flink|string|get_clan_name}}
{{Flink|string|get_counters|string|int|int}}
{{Flink|string [int]|get_custom_outfits}}
{{Flink|item|get_dwelling}}
{{Flink|string [location, 3]|get_florist_plants}}
{{Flink|string [int]|get_goals}}
{{Flink|boolean|get_ignore_zone_warnings}}
{{Flink|int [item]|get_ingredients|item}}
{{Flink|int [item]|get_inventory}}
{{Flink|monster [int]|get_monsters|location}}
{{Flink|string [int]|get_moods}}
{{Flink|string [int]|get_outfits}}
{{Flink|string|get_path}}
{{Flink|string|get_path_full}}
{{Flink|string|get_path_variables}}
{{Flink|string|get_player_id|string}}
{{Flink|int|get_power|item}}
{{Flink|string|get_property|string|{{opt|boolean}}}}
{{Flink|int [item]|get_related|item|string}}
{{Flink|int|get_revision}}
{{Flink|int [item]|get_shop}}
{{Flink|string|get_version}}
{{flink|boolean|gnomads_available}}
{{flink|boolean|goal_exists|string}}
{{Flink|string|group|matcher|{{opt|int}}}}
{{Flink|int|group_count|matcher}}
{{Flink|string [int, int]|group_string|string|string}}
{{Flink|boolean|guild_store_available}}

===h===
{{Flink|boolean|have_bartender}}
{{Flink|boolean|have_chef}}
{{Flink|boolean|have_display}}
{{Flink|int|have_effect|effect}}
{{Flink|boolean|have_equipped|item}}
{{Flink|boolean|have_familiar|familiar}}
{{Flink|boolean|have_mushroom_plot}}
{{Flink|boolean|have_outfit|string}}
{{Flink|boolean|have_servant|servant}}
{{Flink|boolean|have_shop}}
{{Flink|boolean|have_skill|skill}}
{{Flink|boolean|hermit|int|item}}
{{flink|boolean|hidden_temple_unlocked}}
{{Flink|boolean|hippy_stone_broken}}
{{Flink|boolean|hippy_store_available}}
{{Flink|float|historical_age|item}}
{{Flink|int|historical_price|item}}
{{Flink|string|holiday}}

===i===
{{Flink|monster|image_to_monster|strict_string}}
{{Flink|boolean|in_bad_moon}}
{{Flink|boolean|in_hardcore}}
{{Flink|boolean|in_moxie_sign}}
{{Flink|boolean|in_muscle_sign}}
{{Flink|boolean|in_mysticality_sign}}
{{Flink|string|inaccessible_reason|coinmaster}}
{{Flink|int|index_of|string|string|{{opt|int}}}}
{{Flink|int|inebriety_limit}}
{{Flink|float|initiative_modifier}}
{{Flink|buffer|insert|buffer|int|string}}
{{Flink|boolean|is_accessible|coinmaster}}
{{Flink|boolean|is_banished|monster}}
{{Flink|boolean|is_coinmaster_item|item}}
{{Flink|boolean|is_discardable|item}}
{{Flink|boolean|is_displayable|item}}
{{Flink|boolean|is_familiar_equipment_locked}}
{{Flink|boolean|is_giftable|item}}
{{Flink|boolean|is_goal|item}}
{{Flink|boolean|is_integer|string}}
{{Flink|boolean|is_npc_item|item}}
{{Flink|boolean|is_online|string}}
{{Flink|boolean|is_tradeable|item}}
{{Flink|boolean|is_trendy|item/familiar/skill/string}}
{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
{{Flink|boolean|is_wearing_outfit|string}}
{{Flink|int|item_amount|item}}
{{Flink|float|item_drop_modifier}}
{{Flink|int [item]|item_drops|{{opt|monster}}}}
{{Flink|record [int]|item_drops_array|{{opt|monster}}}}
{{Flink|string|item_type|item}}

===j===
{{flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}}}

===k===
{{flink|boolean|knoll_available}}

===l===
{{Flink|int|last_choice}}
{{Flink|int|last_index_of|string|string|{{opt|int}}}}
{{Flink|string|last_item_message}}
{{Flink|monster|last_monster}}
{{Flink|string|last_skill_message}}
{{Flink|int|length|string}}
{{Flink|int|lightning_cost}}
{{Flink|string|limit_mode}}
{{Flink|buffer|load_html|string}}
{{Flink|void|lock_familiar_equipment|boolean}}
{{Flink|void|logprint|string}}

===m===
{{Flink|string|make_url|string|boolean|boolean}}
{{Flink|int|mall_price|item}}
{{Flink|int|mana_cost_modifier}}
{{Flink|boolean|map_to_file|aggregate|string|{{opt|boolean}}}}
{{Flink|float|max|float|float}}
{{Flink|int|max|int|int}}
{{Flink|boolean|maximize|string|boolean}}
{{Flink|boolean|maximize|string|int|int|boolean}}
{{Flink|record [int]|maximize|string|int|int|boolean|boolean}}
{{Flink|int|meat_drop|{{opt|monster}}}}
{{Flink|float|meat_drop_modifier}}
{{Flink|float|min|float|float}}
{{Flink|int|min|int|int}}
{{Flink|item|minstrel_instrument}}
{{Flink|int|minstrel_level}}
{{Flink|boolean|minstrel_quest}}
{{Flink|int|mmg_bet_amount|int}}
{{Flink|string|mmg_bet_owner|int}}
{{Flink|int|mmg_bet_owner_id|int}}
{{Flink|string|mmg_bet_taker}}
{{Flink|string|mmg_bet_taker_id}}
{{Flink|int|mmg_bet_winnings}}
{{Flink|int|mmg_make_bet|int|boolean}}
{{Flink|int [int]|mmg_my_bets}}
{{Flink|int [int]|mmg_offered_bets}}
{{Flink|boolean|mmg_retract_bet|int}}
{{Flink|void|mmg_search|int|int}}
{{Flink|int|mmg_take_bet|int|boolean}}
{{Flink|void|mmg_visit}}
{{Flink|int|mmg_wait_event|int}}
{{Flink|float|modifier_eval|string}}
{{Flink|int|monster_attack|{{opt|monster}}}}
{{Flink|int|monster_defense|{{opt|monster}}}}
{{Flink|element|monster_element|{{opt|monster}}}}
{{Flink|float|monster_eval|string}}
{{Flink|int|monster_hp|{{opt|monster}}}}
{{Flink|int|monster_initiative|{{opt|monster}}}}
{{Flink|int|monster_level_adjustment}}
{{Flink|phylum|monster_phylum|{{opt|monster}}}}
{{Flink|int|moon_light}}
{{Flink|int|moon_phase}}
{{Flink|int|mp_cost|skill}}
{{Flink|int|my_adventures}}
{{Flink|int|my_ascensions}}
{{Flink|int|my_audience}}
{{Flink|int|my_basestat|stat}}
{{Flink|familiar|my_bjorned_familiar}}
{{Flink|int|my_buffedstat|stat}}
{{Flink|class|my_class}}
{{Flink|int|my_closet_meat}}
{{Flink|string|my_companion}}
{{Flink|int|my_daycount}}
{{Flink|int|my_discomomentum}}
{{Flink|familiar|my_effective_familiar}}
{{Flink|int [effect]|my_effects}}
{{Flink|familiar|my_enthroned_familiar}}
{{Flink|familiar|my_familiar}}
{{Flink|int|my_fullness}}
{{Flink|int|my_fury}}
{{Flink|string|my_hash}}
{{Flink|int|my_hp}}
{{Flink|string|my_id}}
{{Flink|int|my_inebriety}}
{{Flink|int|my_level}}
{{flink|int|my_lightning}}
{{Flink|location|my_location}}
{{Flink|int|my_maxfury}}
{{Flink|int|my_maxhp}}
{{Flink|int|my_maxmp}}
{{Flink|int|my_meat}}
{{Flink|int|my_mp}}
{{Flink|string|my_name}}
{{flink|string|my_path}}
{{Flink|stat|my_primestat}}
{{flink|int|my_rain}}
{{Flink|servant|my_servant|servant}}
{{flink|string|my_sign}}
{{flink|int|my_soulsauce}}
{{Flink|int|my_spleen_use}}
{{Flink|int|my_storage_meat}}
{{flink|thrall|my_thrall}}
{{flink|int|my_thunder}}
{{Flink|int|my_turncount}}

===n===
{{Flink|float|now_to_string|string}}
{{Flink|int|npc_price|item}}
{{Flink|float|numeric_modifier|{{opt|string}}|string}}
{{Flink|float|numeric_modifier|item|string}}
{{Flink|float|numeric_modifier|effect|string}}
{{Flink|float|numeric_modifier|skill|string}}
{{Flink|float|numeric_modifier|familiar|string|int|item}}

===o===
{{Flink|boolean|outfit|string}}
{{Flink|item [int]|outfit_pieces|string}}
{{Flink|string|outfit_tattoo|{{opt|string}}}}
{{Flink|boolean|overdrink|int|item}}

===p===
{{Flink|void|print|string|{{opt|string}}}}
{{Flink|void|print_html|string}}
{{Flink|string|property_default_value|string}}
{{Flink|boolean|property_exists|string|{{opt|boolean}}}}
{{Flink|boolean|property_has_default|string}}
{{Flink|int|pulls_remaining}}
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|int|pvp_attacks_left}}

===r===
{{Flink|int|rain_cost|skill}}
{{Flink|int|random|int}}
{{Flink|int|raw_damage_absorption}}
{{Flink|void|refresh_shop}}
{{Flink|void|refresh_stash}}
{{Flink|void|refresh_status}}
{{Flink|void|remove_item_condition|int|item}}
{{Flink|void|remove_property|string|{{opt|boolean}}}}
{{Flink|boolean|rename_property|string|string}}
{{Flink|boolean|replace|buffer|int|int|string}}
{{Flink|string|replace_all|matcher|string}}
{{Flink|string|replace_first|matcher|string}}
{{Flink|buffer|replace_string|buffer|string|string}}
{{Flink|buffer|replace_string|string|string|string}}
{{Flink|matcher|reset|matcher|{{opt|string}}}}
{{Flink|boolean|restore_hp|int}}
{{Flink|boolean|restore_mp|int}}
{{Flink|boolean|retrieve_item|int|item}}
{{Flink|int|round|float}}
{{Flink|buffer|run_choice|int}}
{{Flink|buffer|run_combat|{{opt|string}}}}
{{Flink|buffer|run_turn}}
{{Flink|buffer|runaway}}

===s===
{{Flink|boolean|sell|coinmaster|int|item}}
{{Flink|int|sell_price|coinmaster|item}}
{{Flink|boolean|sells_item|coinmaster|item}}
{{Flink|string [int]|session_logs|{{opt|string}}|int}}
{{Flink|void|set_auto_attack|int}}
{{Flink|void|set_length|buffer|int}}
{{Flink|void|set_location|location}}
{{Flink|void|set_property|string|string}}
{{Flink|int|shop_amount|item}}
{{Flink|int|shop_price|item}}
{{Flink|int|soulsauce_cost|skill}}
{{Flink|int|spleen_limit}}
{{Flink|string [int]|split_string|string|{{opt|string}}}}
{{Flink|float|square_root|float}}
{{Flink|int|start|matcher|{{opt|int}}}}
{{Flink|int|stash_amount|item}}
{{Flink|stat|stat_bonus_today}}
{{Flink|stat|stat_bonus_tomorrow}}
{{Flink|stat|stat_modifier|effect|string}}
{{Flink|buffer|steal}}
{{Flink|int|stills_available}}
{{Flink|int|storage_amount|item}}
{{Flink|string|string_modifier|{{opt|string}}|string}}
{{Flink|skill|stun_skill}}
{{Flink|string|substring|string|int|{{opt|int}}}}
{{Flink|boolean|svn_at_head|string}}
{{Flink|boolean|svn_exists|string}}
{{Flink|record|svn_info|string}}

===t===
{{Flink|boolean|take_closet|int|{{opt|item}}}}
{{Flink|boolean|take_display|int|item}}
{{Flink|boolean|take_shop|{{opt|int}}|item}}
{{Flink|boolean|take_stash|int|item}}
{{Flink|boolean|take_storage|int|item}}
{{Flink|int|tavern|{{opt|string}}}}
{{Flink|buffer|throw_item|item}}
{{Flink|buffer|throw_items|item|item}}
{{Flink|int|thunder_cost|skill}}
{{Flink|buffer|time_to_string}}
{{Flink|boolean|to_boolean|any}}
{{Flink|bounty|to_bounty|strict_string}}
{{Flink|class|to_class|strict_string/int}}
{{Flink|coinmaster|to_coinmaster|strict_string}}
{{Flink|effect|to_effect|int}}
{{Flink|effect|to_effect|strict_string}}
{{Flink|effect|to_effect|skill}}
{{Flink|element|to_element|strict_string}}
{{Flink|familiar|to_familiar|int}}
{{Flink|familiar|to_familiar|strict_string}}
{{Flink|float|to_float|any}}
{{Flink|int|to_int|any}}
{{Flink|item|to_item|strict_string}}
{{Flink|item|to_item|int}}
{{Flink|item|to_item|string|int}}
{{Flink|string|to_json|aggregate}}
{{Flink|location|to_location|strict_string}}
{{Flink|location|to_location|int}}
{{Flink|string|to_lower_case|string}}
{{Flink|monster|to_monster|strict_string}}
{{Flink|phylum|to_phylum|string}}
{{Flink|string|to_plural|item}}
{{Flink|servant|to_servant|int}}
{{Flink|servant|to_servant|strict_string}}
{{Flink|skill|to_skill|effect}}
{{Flink|skill|to_skill|int}}
{{Flink|skill|to_skill|strict_string}}
{{Flink|slot|to_slot|item}}
{{Flink|skill|to_slot|strict_string}}
{{Flink|stat|to_stat|string}}
{{Flink|string|to_string|any}}
{{Flink|thrall|to_thrall|{{opt|string}}|{{opt|int}}}}
{{Flink|string|to_upper_case|string}}
{{Flink|string|to_url|location}}
{{Flink|string|today_to_string}}
{{flink|int|total_free_rests}}
{{flink|int|total_turns_played}}
{{Flink|int|truncate|float}}
{{Flink|int|turns_per_cast|skill}}
{{Flink|int|turns_played}}

===u===
{{Flink|string|url_decode|string}}
{{Flink|string|url_encode|string}}
{{Flink|boolean|use|int|item}}
{{Flink|boolean|use_familiar|familiar}}
{{Flink|boolean|use_servant|servant}}
{{Flink|boolean|use_skill|int|skill|{{opt|string}}}}
{{Flink|buffer|use_skill|skill}}
{{Flink|boolean|user_confirm|string}}
{{Flink|boolean|user_confirm|string|int|boolean}}

===v===
{{Flink|boolean|visit|coinmaster}}
{{Flink|buffer|visit_url|{{opt|string}}|{{opt|boolean}}|{{opt|boolean}}}}

===w===
{{Flink|void|wait|int}}
{{Flink|void|waitq|int}}
{{Flink|int|weapon_hands|item}}
{{Flink|stat|weapon_type|item}}
{{Flink|int|weight_adjustment}}
{{Flink|boolean|white_citadel_available}}
{{Flink|boolean [string]|who_clan|{{opt|string}}}}
{{Flink|boolean|will_usually_dodge}}
{{Flink|boolean|will_usually_miss}}
{{Flink|void|write|string}}
{{Flink|void|writeln|string}}

===x===
{{Flink|string[int]|xpath|string|string}}

[[Category:Scripting]]

Eudora

2017-05-08T21:58:48Z

AlbinoRhino: category

Eudora

2017-05-08T21:52:14Z

AlbinoRhino: Initial page

Put shop

2017-04-05T10:32:17Z

AlbinoRhino:

{{
#vardefine:name|put_shop}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|price}}|
parameter2={{Param|int|limit}}|
parameter3={{Param|item|it}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|price}}|
parameter2={{Param|int|limit}}|
parameter3={{Param|int|qty}}|
parameter4={{Param|item|it}}|
p1desc={{pspan|price}} is the price to set; using 0 will result in the max-price of 999,999,999 if item is not currently in your store|
p2desc={{pspan|limit}} is the limit per player per day, or no limit if set to 0|
p3desc={{pspan|qty}} an optional parameter for the quantity of items to put in your shop (defaults to all if not provided)|
p4desc={{pspan|it}} is the item to put in your mall store.|
}}|

function_description=Places items in your mall store with settings as described above. Returns true if placement is successful and false if placement fails.
Note that attempting to put an item in your store at less than minimum mall price will automatically reset the price to mall minimum.
Note that attempting to put a negative amount of an item in your store will not do anything, but will still return true.
Note that you cannot specify a quantity of 0 to change prices, but the function will still return true.|

code1={{CodeSample|
title=Code Sample|
description=The following example will put all of your broken skulls in your mall store for 500 meat at a limit of 5.|
code=
<syntaxhighlight>
put_shop(500 , 5 , $item[broken skull]);
</syntaxhighlight>}}|

see_also={{SeeAlso|have_shop|shop_amount|take_shop}}|
cli_equiv=The CLI command "mallsell" works similarly.|
}}

[[Category:Item Management]]