Kolmafia - User contributions [en]

To coinmaster

2017-07-11T19:49:20Z

Fronobulax: Fixed typo - returns coinmaster, not boolean

{{
#vardefine:name|to_coinmaster}}{{
#vardefine:return_type|coinmaster}}{{

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=coinmaster|
return_also={{#var:return_also}}|
parameter1={{Param|string|store}}|
p1desc={{pspan|store}} is hopefully the name of a coinmaster|
}}|

code1={{CodeSample|
title=Code Sample|
description=This sells off all the Island War vendor Frat boy trash to the hippy coinmaster for dimes.|
code=
<syntaxhighlight>
foreach trash in $items[red class ring, blue class ring, white class ring, PADL Phone]
if(item_amount(trash) > 0)
sell(to_coinmaster("Dimemaster"), item_amount(trash), trash);
</syntaxhighlight>
}}|

see_also={{SeeAlso|visit|is_accessible|buys_item|sells_item}}|
}}

[[Category:Item Management]]

Reporting a Bug/Requesting a Feature

2017-04-15T20:36:12Z

Fronobulax: Created page with "A Bug Report is submitted when KoLmafia is doing the wrong thing because of a coding error, design flaw or some other oversight on the part of a developer. A Feature Request..."

A Bug Report is submitted when KoLmafia is doing the wrong thing because of a coding error, design flaw or some other oversight on the part of a developer.

A Feature Request is submitted when KoLmafia is functioning as designed but a user would like it to so something different.

New Content is reported when something is added to or changed in KoL itself and KoLmafia could/should be changed to support that.

A Bug Report, Feature Request or New Content notification can be made by starting a new thread at http://kolmafia.us/forumdisplay.php?24-Bug-Reports

There are several prefixes appended to threads in that section. Non-Moderators should only use Bug, Feature or New Content. The Moderators will change the prefix to indicate status.

Bug - Confirmed indicates that someone other than the original reporter has been able to reproduce the bug.

Bug - Not a Bug indicates that the behavior described as a Bug is actually what KoLmafia is supposed to be doing.

Bug - Won't Fix indicates that bug exists but no changes will be made to fix it.

Bug - Fixed indicates that code to fix the bug has been written and checked in to SourceForge, thus making it part of the next build.

Bug - Cannot Reproduce indicates that no one besides the original reporter knows how to make the bug happen.

Bug - Waiting for Info indicates that a developer has asked questions about the report and is waiting for the reporter to answer.

For both Feature and New Content

Implemented means that KoLmafia has been changed in response.

Rejected means that no code has been changed and none is likely to do so.

Features are often rejected if it is something that can easily be done or has already been done, in a script.

The prefixes and the implied workflow are sometimes to developer's looking for tasks and developers planning releases.

It is worth reading http://kolmafia.us/showthread.php?5934-Bug-Report-Procedures-(please-read-me) before submitting reports.

This thread http://kolmafia.us/showthread.php?4326-Show-Estimated-Damage contains some discussion which led to the creation of this page.

Main Page

2017-04-15T20:02:11Z

Fronobulax: Bug/Features

<center>
<div align="center" style="margin: 0 0 20px 0; text-align: center; border: none;">
<span style="font-size: 1.4em;">Welcome to the KoLmafia Wiki!</span><br />
<span style="font-size: 1em; line-height: 1.6em;">Progress level: [[Special:Statistics|{{NUMBEROFARTICLES}}]]</span>
</div>

<div style="width: 50%; float: left;">

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td colspan=2 style="background-color: #ffac62; padding: 4px; border-bottom: 1px solid black">Quick Links for ASH Scripters</td></tr>
<tr>
<td style="background-color: #ffc48e; padding: 4px; vertical-align: top;">
<span style="line-height: 0.875em; font-size: 0.875em; font-weight: bold; padding: 0; margin: 0 0 0 0.4em;">FUNCTION CATEGORIES</span><br />
* [[Your Character]]
* [[Item Management]]
* [[Equipment]]
* [[Skills and Effects]]
* [[Adventuring]]
* [[In-combat Consulting]]
* [[Math and Numbers]]
* [[String Handling Routines]]
* [[Money Making Game]]
* [[Datatype Conversions]]
* [[Modifier Functions]]
* [[Relay Browser Functions]]
* [[Miscellaneous Functions|Miscellaneous]]
</td>
<td style="background-color: #ffc48e; padding: 4px; vertical-align: top;">
<p><span style="line-height: 0.875em; font-size: 0.875em; font-weight: bold; padding: 0; margin: 0 0 0 0.4em;">LANGUAGE CONVENTIONS</span><br />
* [[Operators]]
* [[Data Types]]
* [[Control Structures]]
* [[Data Structures]]
* [[Proxy Records]]
* [[Miscellaneous ASH Features|Misc. ASH Features]]</p>
<p style="margin-top: 2em;"><span style="line-height: 0.875em; font-size: 0.875em; font-weight: bold; padding: 0; margin: 0 0 0 0.4em;">HELPFUL RESOURCES</span><br />
* [[ASH For Beginners]]
* [[KoLmafia Properties]]
* [[Ash Functions|Master Function List]]
* [[CLI Reference|CLI Commands]]
* [[Helpful Scripts]]</p>
</td>
</tr>
</table>

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td style="background-color: #b0ddb0; padding: 4px; border-bottom: 1px solid black">How Does KoLmafia Help?</td></tr>
<tr>
<td style="background-color: #c0ffc0; padding: 4px;">
* [[Automation]]
* [[Quests|Helping with Quests]]
* [[Basement|Basement Diving]]
</td>
</tr>
</table>

</div>

</center>
<div style="width: 50%; float: right;">

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td style="background-color: #aeaeee; padding: 4px; border-bottom: 1px solid black">New User Help</td></tr>
<tr>
<td style="background-color: #bfbfff; padding: 4px;">
* [[Installation]]
{{
Hidelist
|title=[[KoLmafia Guide]] by SinginSally
|1=[[KoLmafia Guide: Preface|Preface]]
|2=[[KoLmafia Guide: Basics (Relay Browser)|Lesson 1: Basics (Relay Browser)]]
|3=[[KoLmafia Guide: Java Interface|Lesson 2: Java Interface]]
|4=[[KoLmafia Guide: Stats-Checking|Lesson 3: Stats-Checking]]
|5=[[KoLmafia Guide: Attack Script|Lesson 4: Attack Script]]
|6=[[KoLmafia Guide: Custom Combat Script|Lesson 5: Custom Combat Script]]
|7=[[KoLmafia Guide: Auto-Adventuring|Lesson 6: Auto-Adventuring]]
|8=[[KoLmafia Guide: Automatic HP/MP Recovery|Lesson 7: Automatic HP/MP Recovery]]
|9=[[KoLmafia Guide: Goal-Oriented Adventuring|Lesson 8: Goal-Oriented Adventuring]]
|10=[[KoLmafia Guide: Setting Preferences|Lesson 9: Setting Preferences]]
|11=[[KoLmafia Guide: Setting Up Breakfast|Lesson 10: Setting Up Breakfast]]
|12=[[KoLmafia Guide: Eating & Drinking|Lesson 11: Eating & Drinking]]
|13=[[KoLmafia Guide: PvP (Beating Up People)|Lesson 12: PvP (Beating Up People)]]
|14=[[KoLmafia Guide: Running ASH Scripts|Lesson 13: Running ASH Scripts]]
|15=[[KoLmafia Guide: Useful Commands|Lesson 14: Useful Commands]]
|16=[[KoLmafia Guide: Closing Thoughts|Lesson 15: Closing Thoughts]]
}}
* [[SVN Primer]]
* [[Helpful Links]]
* [[Help:Frequently Asked Questions|KoLmafia FAQ]]
</td>
</tr>
</table>

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td style="background-color: #aeaeee; padding: 4px; border-bottom: 1px solid black">Advanced Features</td></tr>
<tr>
<td style="background-color: #bfbfff; padding: 4px;">
* [[Modifier Maximizer]]
* [[Daily Deeds]]
* [[Hidden Features]]
</td>
</tr>
</table>

<table style="width: 90%; border: 2px solid black; margin: 5px 5px 15px 5px;" cellpadding="0" cellspacing="0">
<tr><td style="background-color: #aeaeee; padding: 4px; border-bottom: 1px solid black">Contributing to the KoLmafia Project</td></tr>
<tr>
<td style="background-color: #bfbfff; padding: 4px;">
* [[Compiling from Source]]
* [[Mafia's Code]]
* [[Making a Patch]]
* [[Reporting a Bug/Requesting a Feature]]
* [[Help:Editing|Editing the Wiki Documentation]]
* [[Help:To Do List|Wiki "To Do" List]]
</td>
</tr>
</table>

</div>

Restore mp

2011-12-17T21:40:44Z

Fronobulax:

{{
#vardefine:name|restore_mp}}{{
#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|target}}|
p1desc={{pspan|target}} is the minimum MP desired after the function is run.|
}}|

function_description=Restores your MP, following your current recovery settings as closely as possible. This function only attempts to surpass {{pspan|target}}, not to arrive as closely as possible to it. If your current KoLmafia recovery settings are lower than your current MP (or off), this function will restore the bare minimum necessary to reach {{pspan|target}} using the restores you have checked. If, however, you have your recovery setting set to "Try to recover up to 100% mana," this function will follow that preference if possible.</p>
<p>If {{pspan|target}} is zero then it will restore MP according to KoLmafia's recovery settings. Note that the definition of "current recovery settings" may be different if a {{pspan|recoveryScript}} is specified.</p>
<p>If a recoveryScript is present and returns TRUE then this function returns TRUE. If a recoveryScript is present and returns FALSE then this function returns the results of mafia's internal restoration attempt. If no recoveryScript is specified then the results of mafia's internal restoration attempt will be returned.

If you use a recoveryScript and call restore_mp then it is your responsibility to deal with the possibility that restore_mp will return TRUE but the desired amount of MP will not have been reached.
|

code1={{CodeSample|
title=Code Sample|
description=This sample attempts to restore your MP to full.|
code=
<syntaxhighlight>
if (my_mp() < my_maxmp()) {
restore_mp(my_maxmp());
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|my_hp|my_mp|my_maxhp|my_maxmp|restore_hp}}|
cli_equiv=The CLI command "restore" has similar functionality.|
special=Note: the return value can be over-ridden by a [[Miscellaneous_ASH_Features#Recovery_.28recoveryScript.29|recoveryScript]] if in use. If your script's behavior changes based on the return value of this function, it is recommended that you explicitly state which, if any, recoveryScripts it can support when publicly releasing your script.
}}

[[Category:Skills and Effects]]

Hidden Features

2011-11-23T14:21:25Z

Fronobulax:

{{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

=== 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.

=== 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

=== 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.

=== Most Recently Used Modifier Maximizer Expression ===
You can alter your Modifier Maximizer drop down to show the most recently evaluated expression. This is enabled by setting maximizerMRULength to a value greater than zero. When enabled the drop down will contain (at most) maximizerMRULength entries with the most frequently used expression at the top. This is enabled on a per character basis.

set maximizerMRULength = 40

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

Hidden Features

2011-07-13T15:54:20Z

Fronobulax:

Hidden Features

2011-07-13T12:17:54Z

Fronobulax:

Hidden Features

2011-07-13T12:12:08Z

Fronobulax:

Talk:My name

2010-03-17T18:42:24Z

Fronobulax: Created page with '[http://kolmafia.us/showthread.php?3684-My-first-attempt-at-a-script&p=26025#post26025] mentions some possible issues with case sensitivity when using my_name as a string index t…'

[http://kolmafia.us/showthread.php?3684-My-first-attempt-at-a-script&p=26025#post26025] mentions some possible issues with case sensitivity when using my_name as a string index to a map. That should be verified but, if true, the code examples might be better examples if they used lower case, i.e. if (my_name() == "fronobulax") instead of if (my_name == "Fronobulax") If both examples actually work then I would check the equality operator for case sensitivity, possibly update the wiki or file a Bug Report :-)