Kolmafia - User contributions [en]

Modifier eval

2012-09-25T20:25:13Z

Slyz: add all the modifier variables

{{
#vardefine:name|modifier_eval}}{{
#vardefine:return_type|float}}{{

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|expression}}|
p1desc={{pspan|expression}} is a mathematical expression to be solved.|
}}|

function_description= Evaluates an expression in the format used by variable modifiers:

* No spaces are allowed within the expression, except as part of a zone/location name.
* + - * / ( ) have their usual mathematical meaning and precedence.
* ^ is exponentiation, with the highest precedence.
* Functions available: ceil(x) floor(x) sqrt(x) min(x,y) max(x,y)
* Location functions: loc(text) zone(text)
** These have a value of 1 if the current adventure location or zone contains the specified text, 0 elsewhere.
* Familiar function: fam(text)
** This has a value of 1 if the player's familiar type contains the text, else 0.
* Preferences function: pref(text)
** This must be used on preferences with a float value ONLY - merely retrieving an integer pref will corrupt it!
* There could be at most one of each text function in an expression.
** This is no longer the case however and multiple of the same text functions should now work properly.
* All upper-case letters are reserved for internally-used variables. The available variables are:
** A - number of Ascensions
** B - Blood of Wereseal effect
** C - Clancy's level
** D - Drunkenness
** E - active (nonintrinsic) Effects
** F - Fullness
** G - Grimace darkness (0..5)
** H - Hobo Power
** J - 1 on Festival of Jarlsberg, 0 otherwise
** L - player Level
** M - total Moonlight (0..9)
** R - Reagent potion duration
** S - Spleenness
** T - Turns remaining of this effect
** U - telescope Upgrades
** W - familiar Weight
** X - gender (-1=male, 1=female)
* This wrapper allows user-defined variables to be used as well, which must have names starting with a lower-case letter (or underscore) to distinguish them from built-in variables. Variables are supplied as a float[string] map.
 |

code1={{CodeSample|
title=Code Sample|
description=This script expands modifier_eval() to include support for user-defined variables. It is extremely complex, but it is extremely useful to anyone who wants to use modifier_eval().|
code=
<syntaxhighlight>
float eval(string expr, float[string] vars) {
buffer b;
matcher m = create_matcher( "\\b[a-z_][a-zA-Z0-9_]*\\b", expr );
while (m.find()) {
string var = m.group(0);
if (vars contains var) {
m.append_replacement(b, vars[var].to_string());
}
// could implement functions, pref access, etc. here
}
m.append_tail(b);
return modifier_eval(b.to_string());
}

# Everything below this line shows how to make use of eval().
# TESTING:

float[string] v;
v["pi"] = 3.14159265;
v["ten"] = 10;
print(eval("2+3", v));
print(eval("max(pi^ten,ten^pi)", v));
print(eval("sqrt(pi)*L", v));
print(eval("undefined/2", v));

</syntaxhighlight>}}|
special=Note that modifier_eval '''never''' generates errors - a malformed expression will just print a message, and return an arbitrary value.|
}}

[[Category:Math and Numbers]]

KoLmafia Properties

2011-10-13T09:14:07Z

Slyz: add raveCombo properties

{{TOCright}}
Inside your KoLmafia "settings" directory, you should find several files. KoLmafia properties are stored in the files that end with "_prefs.txt". One of these files will start with "GLOBAL"; the settings inside are shared by all characters using the program (and some of these properties are needed by KoLmafia even when no character is logged in). The other files ending with "_prefs.txt" will start with the name of a character, one for each who has been logged in to date. (Note: the names will all be converted to lowercase.)

==Choice Adventures==
A large number of the preferences saved by KoLmafia are used to determine the default behavior when a choice adventure is automated (either through auto-adventuring or use of the "auto" button in the relay browser). The number of choice adventures in KoL is too large and too often updated to list each individual preference here. Please consult the main wiki's [http://kol.coldfront.net/thekolwiki/index.php/Choice_Adventures_by_Number Choice Adventures by Number] page for a comprehensive list. Note that each preference follows the same numbering scheme as KoL itself. For example, the adventure "Minnesota Incorporeals" is number 77 in KoL, and its KoLmafia preference is "choiceAdventure77".

Each choiceAdventure is set to a number, which corresponds to which choice you want to make from the available options in KoL (or in the GUI, in the case that mafia provides more options than KoL). According to Holatuwol ([http://kolmafia.us/index.php/topic,1155.0.html here]), the settings map to "X=pick the Xth Option" and "X+1=pick an item you don't have" (i.e., complete the outfit). Many preferences also have a "Show in [Mini] Browser" option, which corresponds to a setting of 0.

This is a list of all the Property variables included in KoLmafia. It was automatically generated from r7582. Note that, however, the latest (and most up-to-date) data is located in Mafia's internally-stored datafile defaults.txt (available for viewing at [https://kolmafia.svn.sourceforge.net/svnroot/kolmafia/src/data/defaults.txt the SourceForge page]).

==Global Variables==
{| class="wikitable" border="1"
|-
! Variable Name
! scope="col" width="300" | Default Value
! Notes
|-
| addChatCommandLine
| false
|
|-
| addCreationQueue
| true
|
|-
| addStatusBarToFrames
| false
|
|-
| allowCloseableDesktopTabs
| false
|
|-
| allowNegativeTally
| true
|
|-
| allowNonMoodBurning
| true
|
|-
| alwaysGetBreakfast
| false
|
|-
| autoLogin
|
|
|-
| allowSocketTimeout
| true
|
|-
| autoHighlightOnFocus
| true
|
|-
| autoPlantHardcore
| false
|
|-
| autoPlantSoftcore
| false
|
|-
| autoSatisfyWithCloset
| true
|
|-
| autoSatisfyWithMall
| true
|
|-
| autoSatisfyWithNPCs
| true
|
|-
| autoSatisfyWithStash
| false
|
|-
| breakfastHardcore
| Advanced Saucecrafting,Pastamastery,Advanced Cocktailcrafting
|
|-
| breakfastSoftcore
| Advanced Saucecrafting,Pastamastery,Advanced Cocktailcrafting
|
|-
| browserBookmarks
|
|
|-
| cacheMallSearches
| false
|
|-
| charsheetDropdown
| 1
|
|-
| chatBeep
| false
| Beep on private message in chat
|-
| chatFontSize
|
|
|-
| chatLinksUseRelay
| false
|
|-
| chatStyle
| 0
|
|-
| cloverProtectActive
| true
|
|-
| combatHotkey0
|
|
|-
| combatHotkey1
|
|
|-
| combatHotkey2
|
|
|-
| combatHotkey3
|
|
|-
| combatHotkey4
|
|
|-
| combatHotkey5
|
|
|-
| combatHotkey6
|
|
|-
| combatHotkey7
|
|
|-
| combatHotkey8
|
|
|-
| combatHotkey9
|
|
|-
| commandLineNamespace
|
|
|-
| connectViaAddress
| false
|
|-
| cookies.inventory
|
|
|-
| copyAsHTML
| false
|
|-
| createHackerSummons
| true
|
|-
| customizedTabs
| false
|
|-
| debugPathnames
| true
|
|-
| defaultBorderColor
| blue
|
|-
| defaultDropdown1
| 0
|
|-
| defaultDropdown2
| 1
|
|-
| defaultDropdownSplit
| 0
|
|-
| defaultLimit
| 5
|
|-
| defaultLoginServer
| 1
|
|-
| displayName
|
|
|-
| eSoluScriptType
| 0
|
|-
| getBreakfast
|
|
|-
| grabCloversHardcore
| false
|
|-
| grabCloversSoftcore
| true
|
|-
| greenScreenProtection
| false
|
|-
| grimoireSkillsHardcore
| none
|
|-
| grimoireSkillsSoftcore
| Summon Hilarious Objects
|
|-
| guiUsesOneWindow
| false
|
|-
| harvestGardenHardcore
| none
| The crop that breakfast will harvest, if in your garden.
|-
| harvestGardenSoftcore
| none
| The crop that breakfast will harvest, if in your garden.
|-
| hideServerDebugText
| false
|
|-
| highlightList
|
|
|-
| http.proxyHost
|
|
|-
| http.proxyPassword
|
|
|-
| http.proxyPort
|
|
|-
| http.proxyUser
|
|
|-
| initialDesktop
| AdventureFrame,CommandDisplayFrame, MallSearchFrame,GearChangeFrame,SkillBuffFrame
| starting tab configuration
|-
| initialFrames
| RecentEventsFrame
|
|-
| innerChatColor
| #ffa98c
|
|-
| innerTabColor
| #8ca9ff
|
|-
| itemManagerIndex
| 0
|
|-
| lastBuffRequestType
| 0
|
|-
| lastRelayUpdate
|
|
|-
| lastRssUpdate
| 0
|
|-
| lastRssVersion
|
|
|-
| lastUserAgent
|
|
|-
| lastUsername
|
|
|-
| libramSkillsHardcore
| none
|
|-
| libramSkillsSoftcore
| none
|
|-
| logAcquiredItems
| true
|
|-
| logBattleAction
| true
|
|-
| logBrowserInteractions
| false
|
|-
| logChatMessages
| true
|
|-
| logDecoratedResponses
| false
|
|-
| logFamiliarActions
| false
|
|-
| logGainMessages
| true
|
|-
| logReadableHTML
| false
|
|-
| loginRecoveryHardcore
| false
|
|-
| loginRecoverySoftcore
| true
|
|-
| loginScript
|
|
|-
| loginServerName
|
|
|-
| loginWindowLogo
| lantern.jpg
|
|-
| logMonsterHealth
| false
|
|-
| logoutScript
|
|
|-
| logReverseOrder
| false
|
|-
| logStatGains
| true
|
|-
| logStatusEffects
| false
|
|-
| logStatusOnLogin
| false
|
|-
| mementoListActive
| false
|
|-
| mergeHobopolisChat
| false
|
|-
| outerChatColor
| #b4460f
|
|-
| outerTabColor
| #0f46b4
|
|-
| pathedSummonsHardcore
| true
|
|-
| pathedSummonsSoftcore
| false
|
|-
| preferredWebBrowser
|
|
|-
| previousNotifyList
| <>
|
|-
| previousUpdateVersion
|
|
|-
| protectAgainstOverdrink
| true
|
|-
| proxySet
| false
|
|-
| readManualHardcore
| true
|
|-
| readManualSoftcore
| true
|
|-
| relayAddsCustomCombat
| true
|
|-
| relayAddsGraphicalCLI
| false
|
|-
| relayAddsKoLSimulator
| false
|
|-
| relayAddsQuickScripts
| false
|
|-
| relayAddsRestoreLinks
| true
|
|-
| relayAddsRoundNumber
| false
|
|-
| relayAddsUpArrowLinks
| true
|
|-
| relayAddsUseLinks
| true
|
|-
| relayAddsWikiLinks
| false
|
|-
| relayAllowsOverrides
| false
|
|-
| relayBrowserOnly
| false
|
|-
| relayBrowserOnly
| false
|
|-
| relayFormatsChatText
| true
|
|-
| relayHidesJunkMallItems
| true
|
|-
| relayMaintainsEffects
| false
|
|-
| relayMaintainsHealth
| true
|
|-
| relayMaintainsMana
| false
|
|-
| relayTextualizesEffects
| false
|
|-
| relayTrimsZapList
| true
|
|-
| relayUsesCachedImages
| false
|
|-
| relayUsesInlineLinks
| false
|
|-
| relayUsesIntegratedChat
| false
|
|-
| relayViewsCustomItems
| false
|
|-
| removeMalignantEffects
| true
|
|-
| saveSettingsOnSet
| true
|
|-
| saveState
|
|
|-
| saveStateActive
|
|
|-
| scriptButtonPosition
| 0
|
|-
| scriptList
| restore hp | restore mp
|
|-
| showAllRequests
| false
|
|-
| stealthLogin
| true
|
|-
| swingLookAndFeel
|
|
|-
| switchEquipmentForBuffs
| true
|
|-
| tomeSkillsHardcore
| Summon Snowcone
|
|-
| tomeSkillsSoftcore
| Summon Snowcone
|
|-
| toolbarPosition
| 1
|
|-
| useChatMonitor
| false
|
|-
| useChatToolbar
| true
|
|-
| useContactsFrame
| true
|
|-
| useCrimboToysHardcore
| false
|
|-
| useCrimboToysSoftcore
| true
|
|-
| useDecoratedTabs
|
|
|-
| useLastUserAgent
| false
|
|-
| useSeparateChannels
| true
|
|-
| useShinyTabbedChat
| true
|
|-
| useSystemTrayIcon
| false
|
|-
| useTabbedChatFrame
| true
|
|-
| useToolbars
| true
|
|-
| useZoneComboBox
| false
|
|-
| userAgent
|
|
|-
| visitLoungeHardcore
| true
|
|-
| visitLoungeSoftcore
| true
|
|-
| visitRumpusHardcore
| true
|
|-
| visitRumpusSoftcore
| true
|
|}

==Per-Account Variables==
[[KoLmafia Properties#Daily Variables|Daily]] and [[KoLmafia Properties#Choice Adventures|Choice Adventure]] preferences have been omitted. Each of those has their own section.
{| class="wikitable" border="1"
|-
! Variable Name
! scope="col" width="300" | Default Value
! Notes
|-
| autoAbortThreshold
| -0.05
| Abort adventuring at this percentage of HP. (-0.05 means if HP restoration failed)
|-
| autoAntidote
| 0
| Use antidotes in combat
|-
| autoBuyPriceLimit
| 20000
| Don't auto purchase anything that costs more than this
|-
| autoEntangle
| false
| Use Entangling Noodles at the beginning of combat
|-
| autoManaRestore
| true
| Restore MP in combat
|-
| autoOlfact
|
| Automatically cast Olfaction
|-
| autoPotionID
| false
| Attempt to ID ! potions in combat
|-
| autoPutty
|
| Automatically use Spooky Putty
|-
| autoRepairBoxServants
| true
| Create in-a-boxen before cooking or mixing
|-
| autoSphereID
| false
| Attempt to ID spheres from the Hidden City
|-
| autoSteal
| true
| Attempt to pickpocket in combat
|-
| autostartGalaktikQuest
| true
| Get Doc Galaktik's Quest at the start of ascension
|-
| availableDimes
| 0
|
|-
| availableLucre
| 0
|
|-
| availableQuarters
| 0
|
|-
| availableSandDollars
| 0
|
|-
| barrelGoal
| 1
|
|-
| barrelLayout
| ?????????
|
|-
| basementMallPrices
| 1
|
|-
| battleAction
| attack with weapon
|
|-
| betweenBattleScript
|
|
|-
| birdformCold
| 0
|
|-
| birdformHot
| 0
|
|-
| birdformRoc
| 0
|
|-
| birdformSleaze
| 0
|
|-
| birdformSpooky
| 0
|
|-
| birdformStench
| 0
|
|-
| blackPuddingsDefeated
| 0
|
|-
| blankOutUsed
| 0
| Tracks current amount of active Blank-out
|-
| bootsCharged
| false
| Are fairy worn boots currently ready to stomp
|-
| breakfastCompleted
| false
|
|-
| buffBotCasting
|
|
|-
| buffBotMessageDisposal
| 0
|
|-
| buffBotPhilanthropyType
| 1
|
|-
| burrowgrubHiveUsed
| false
|
|-
| burrowgrubSummonsRemaining
| 0
|
|-
| buyScript
|
|
|-
| cameraMonster
|
|
|-
| cellarLayout
| 0
|
|-
| chatbotScript
|
|
|-
| chatbotScriptExecuted
| false
|
|-
| chosenTrip
|
|
|-
| clanAttacksEnabled
| false
|
|-
| cocktailSummons
| 0
|
|-
| concertVisited
| false
|
|-
| currentBountyItem
| 0
|
|-
| currentFullness
| 0
|
|-
| currentHippyStore
| none
|
|-
| currentJunkyardTool
|
|
|-
| currentJunkyardLocation
|
|
|-
| currentMojoFilters
| 0
|
|-
| currentMood
| default
|
|-
| currentNunneryMeat
| 0
|
|-
| currentPvpVictories
|
|
|-
| currentSpleenUse
| 0
|
|-
| currentWheelPosition
| muscle
|
|-
| customCombatScript
| default
|
|-
| dailyDungeonDone
| false
|
|-
| defaultAutoAttack
| 0
|
|-
| defaultFlowerLossMessage
|
|
|-
| defaultFlowerWinMessage
|
|
|-
| demonName1
|
| Name of demon that gives pies
|-
| demonName2
|
| Name of demon that gives Preternatural Greed
|-
| demonName3
|
| Name of demon that gives Fit To Be Tide
|-
| demonName4
|
| Name of demon that gives Big Flaming Whip
|-
| demonName5
|
| Name of demon that gives Demonic Taint
|-
| demonName6
| Tatter
| Name of demon that gives pile of smoking rags
|-
| demonName7
| Ak'gyxoth
| Name of demon that gives drinks
|-
| demonName8
|
| Name of demon found in the Nemesis' Lair
|-
| demonName9
|
| Name of demon that gives Burning, Man
|-
| demonSummoned
| false
|
|-
| expressCardUsed
| false
|
|-
| extraRolloverAdventures
| 0
|
|-
| flyeredML
| 0
|
|-
| fossilB
| 0
| Number of bat teeth on the fossilized necklace
|-
| fossilD
| 0
| Number of demon teeth on the fossilized necklace
|-
| fossilN
| 0
| Number of baboon teeth on the fossilized necklace
|-
| fossilP
| 0
| Number of spider teeth on the fossilized necklace
|-
| fossilS
| 0
| Number of serpent teeth on the fossilized necklace
|-
| fossilW
| 0
| Number of wyrm teeth on the fossilized necklace
|-
| fratboysDefeated
| 0
|
|-
| friarsBlessingReceived
| false
|
|-
| gongPath
| 0
|
|-
| gourdItemCount
| 5
|
|-
| grimoire1Summons
| 0
|
|-
| grimoire2Summons
| 0
|
|-
| guardTurtlesFreed
| 0
| Number of times that [http://kol.coldfront.net/thekolwiki/index.php/Cold-Blooded_Warm_Fuzzies guard turtles have been freed] this ascension.
|-
| guyMadeOfBeesCount
| 0
|
|-
| guyMadeOfBeesDefeated
| false
|
|-
| heroDonationBoris
| 0
| Meat donated to Boris
|-
| heroDonationJarlsberg
| 0
| Meat donated to Jarlsberg
|-
| heroDonationSneakyPete
| 0
| Meat donated to Sneaky Pete
|-
| [[hiddenCityLayout]]
| 0000000000000000000000000
| The map of the Hidden City
|-
| hiddenCitySquare
| 0
| The last square explored in the Hidden City. This square will be auto-adventured.
|-
| hippiesDefeated
| 0
|
|-
| hpAutoRecovery
| -0.05
|
|-
| hpAutoRecoveryItems
| cannelloni cocoon;scroll of drastic healing;tongue of the walrus;lasagna bandages;doc galaktik's ailment ointment
|
|-
| hpAutoRecoveryTarget
| 1.0
|
|-
| invalidBuffMessage
| You sent an amount which does not correspond to a valid buff amount.
|
|-
| kingLiberated
| false
|
|-
| knownAscensions
| -1
|
|-
| lastAdventure
|
|
|-
| lastBarrelSmashed
| 0
|
|-
| lastBangPotion819
|
|
|-
| lastBangPotion820
|
|
|-
| lastBangPotion821
|
|
|-
| lastBangPotion822
|
|
|-
| lastBangPotion823
|
|
|-
| lastBangPotion824
|
|
|-
| lastBangPotion825
|
|
|-
| lastBangPotion826
|
|
|-
| lastBangPotion827
|
|
|-
| lastBangPotionReset
| -1
|
|-
| lastBarrelSmashed
| 0
|
|-
| lastBattlefieldReset
| -1
|
|-
| lastBreakfast
| -1
|
|-
| lastCellarReset
| -1
|
|-
| lastChanceBurn
|
| CLI command executed at lastChanceThreshold ("#" is replaced by the amount of MP to burn)
|-
| lastChanceThreshold
| 100
| amount of unburned MP at which alternatives to extending existing buffs will be considered
|-
| lastCouncilVisit
| 0
|
|-
| lastCounterDay
| -1
|
|-
| lastDustyBottle2271
|
|
|-
| lastDustyBottle2272
|
|
|-
| lastDustyBottle2273
|
|
|-
| lastDustyBottle2274
|
|
|-
| lastDustyBottle2275
|
|
|-
| lastDustyBottle2276
|
|
|-
| lastDustyBottleReset
| -1
|
|-
| lastDwarfDiceRolls
|
|
|-
| lastDwarfDigitRunes
| -------
|
|-
| lastDwarfEquipmentRunes
|
|
|-
| lastDwarfFactoryItem118
|
|
|-
| lastDwarfFactoryItem119
|
|
|-
| lastDwarfFactoryItem120
|
|
|-
| lastDwarfFactoryItem360
|
|
|-
| lastDwarfFactoryItem361
|
|
|-
| lastDwarfFactoryItem362
|
|
|-
| lastDwarfFactoryItem363
|
|
|-
| lastDwarfFactoryItem364
|
|
|-
| lastDwarfFactoryItem365
|
|
|-
| lastDwarfFactoryItem910
|
|
|-
| lastDwarfFactoryItem3199
|
|
|-
| lastDwarfOfficeItem3208
|
|
|-
| lastDwarfOfficeItem3209
|
|
|-
| lastDwarfOfficeItem3210
|
|
|-
| lastDwarfOfficeItem3211
|
|
|-
| lastDwarfOfficeItem3212
|
|
|-
| lastDwarfOfficeItem3213
|
|
|-
| lastDwarfOfficeItem3214
|
|
|-
| lastDwarfOreRunes
|
|
|-
| lastDwarfFactoryReset
| -1
|
|-
| lastDwarfHopper1
|
|
|-
| lastDwarfHopper2
|
|
|-
| lastDwarfHopper3
|
|
|-
| lastDwarfHopper4
|
|
|-
| lastEVHelmetValue
| 0
|
|-
| lastEVHelmetReset
| -1
|
|-
| lastEmptiedStorage
| -1
| Number of the last ascension that Hangk's storage was emptied.
|-
| lastFilthClearance
| -1
|
|-
| lastGalleryUnlock
| -1
|
|-
| lastGuildStoreOpen
| -1
|
|-
| lastGuyMadeOfBeesReset
| -1
|
|-
| lastHiddenCityAscension
| 0
|
|-
| lastFratboyCall
| -1
|
|-
| lastHippyCall
| -1
|
|-
| lastKingLiberation
| -1
|
|-
| lastLouvreMap
| 0
|
|-
| lastMessageId
|
|
|-
| lastMiningReset
| -1
|
|-
| lastPaperStripReset
| -1
|
|-
| lastPaperStrip3144
|
|
|-
| lastPaperStrip4138
|
|
|-
| lastPaperStrip4139
|
|
|-
| lastPaperStrip4140
|
|
|-
| lastPaperStrip4141
|
|
|-
| lastPaperStrip4142
|
|
|-
| lastPaperStrip4143
|
|
|-
| lastPaperStrip4144
|
|
|-
| lastPastamancerGhostReset
| -1
|
|-
| lastPirateEphemera
|
|
|-
| lastPirateEphemeraReset
| -1
|
|-
| lastPirateInsult1
| false
|
|-
| lastPirateInsult2
| false
|
|-
| lastPirateInsult3
| false
|
|-
| lastPirateInsult4
| false
|
|-
| lastPirateInsult5
| false
|
|-
| lastPirateInsult6
| false
|
|-
| lastPirateInsult7
| false
|
|-
| lastPirateInsult8
| false
|
|-
| lastPirateInsultReset
| -1
|
|-
| lastPyramidReset
| -1
|
|-
| lastQuartetAscension
| -1
|
|-
| lastQuartetRequest
| 0
|
|-
| lastSecondFloorUnlock
| -1
|
|-
| lastSemirareReset
| -1
|
|-
| lastStoneSphere2174
|
|
|-
| lastStoneSphere2175
|
|
|-
| lastStoneSphere2176
|
|
|-
| lastStoneSphere2177
|
|
|-
| lastStoneSphereReset
| -1
|
|-
| lastTavernAscension
| 0
|
|-
| lastTavernSquare
| 0
|
|-
| lastTelescopeReset
| -1
|
|-
| lastTowerClimb
| -1
|
|-
| lastVioletFogMap
| 0
|
|-
| lastZapperWand
| 0
|
|-
| libramSummons
| 0
|
|-
| libraryCardUsed
| false
|
|-
| louvreDesiredGoal
| 7
|
|-
| louvreGoal
| 0
|
|-
| louvreLayout
|
|
|-
| louvreOverride
|
|
|-
| luckySewerAdventure
| stolen accordion
|
|-
| manaBurnSummonThreshold
| 10
|
|-
| manaBurningThreshold
| -0.05
|
|-
| maxManaBurn
| 1000
|
|-
| mayflyExperience
| 0
| Uses of mayfly bait necklace. Reset each ascension.
|-
| mineLayout1
|
|
|-
| mineLayout2
|
|
|-
| mineLayout3
|
|
|-
| moleTunnelLevel
| 0
|
|-
| mpAutoRecovery
| 0.0
|
|-
| mpAutoRecoveryItems
| phonics down;knob goblin superseltzer;mountain stream soda;magical mystery juice;knob goblin seltzer;cherry cloaca cola;soda water
|
|-
| mpAutoRecoveryTarget
| 0.3
|
|-
| munchiesPillsUsed
| 0
|
|-
| noodleSummons
| 0
|
|-
| nunsVisits
| 0
|
|-
| oceanAction
| savecontinue
|
|-
| oceanDestination
| manual
|
|-
| olfactedMonster
| unknown
|
|-
| oscusSodaUsed
| false
|
|-
| outrageousSombreroUsed
| false
|
|-
| pastamancerGhostExperience
| 0
|
|-
| pastamancerGhostName
|
|
|-
| pastamancerGhostSummons
| 0
|
|-
| pastamancerGhostType
|
|
|-
| plantingDate
|
|
|-
| plantingDay
| -1
|
|-
| plantingLength
|
|
|-
| plantingScript
|
|
|-
| postAscensionScript
|
|
|-
| preAscensionScript
|
|
|-
| preBlackbirdFamiliar
|
|
|-
| prismaticSummons
| 0
|
|-
| pyramidPosition
| 0
|
|-
| pyramidBombUsed
| false
|
|-
| rageGlandVented
| false
|
|-
| raveCombo1
|
| Rave Nirvana
|-
| raveCombo2
|
| Rave Knockout
|-
| raveCombo3
|
| Rave Bleeding
|-
| raveCombo4
|
| Rave Steal
|-
| raveCombo5
|
| Rave Substats
|-
| raveCombo6
|
| Random Rave
|-
| reagentSummons
| 0
|
|-
| recentLocations
| 5
|
|-
| recoveryScript
|
|
|-
| relayCounters
|
|
|-
| requireBoxServants
| false
|
|-
| requireSewerTestItems
| false
|
|-
| retrieveContacts
| true
|
|-
| seaodesFound
| 0
|
|-
| semirareCounter
| 0
|
|-
| semirareLocation
|
|
|-
| serverAddsCustomCombat
| false
|
|-
| setAutoAttack
| true
|
|-
| showGainsPerUnit
| false
|
|-
| sideDefeated
| neither
|
|-
| sidequestArenaCompleted
| none
|
|-
| sidequestFarmCompleted
| none
|
|-
| sidequestJunkyardCompleted
| none
|
|-
| sidequestLighthouseCompleted
| none
|
|-
| sidequestNunsCompleted
| none
|
|-
| sidequestOrchardCompleted
| none
|
|-
| skillLevel46
| 2
|
|-
| skillLevel47
| 1
|
|-
| skillLevel48
| 2
|
|-
| slimelingFullness
| 0
|
|-
| sortByRoom
| true
|
|-
| spadingData
|
|
|-
| spiceMelangeUsed
| false
|
|-
| spookyPuttyCopiesMade
| 0
|
|-
| spookyPuttyMonster
|
|
|-
| stationaryButton1
|
|
|-
| stationaryButton2
|
|
|-
| stationaryButton3
|
|
|-
| stationaryButton4
|
|
|-
| stationaryButton5
|
|
|-
| styxPixieVisited
| false
|
|-
| [[tavernLayout]]
| 0000000000000000000000000
|
|-
| telescope1
|
|
|-
| telescope2
|
|
|-
| telescope3
|
|
|-
| telescope4
|
|
|-
| telescope5
|
|
|-
| telescope6
|
|
|-
| telescope7
|
|
|-
| telescopeLookedHigh
| false
|
|-
| telescopeUpgrades
| 0
|
|-
| tempuraSummons
| 0
|
|-
| thanksMessage
| Thank you for the donation!
|
|-
| timesRested
| 99
|
|-
| tomeSummons
| 0
|
|-
| trapperOre
| chrome ore
|
|-
| usable1HWeapons
| 3
|
|-
| usable1xAccs
| 1
|
|-
| usable2HWeapons
| 1
|
|-
| usable3HWeapons
| 1
|
|-
| usableAccessories
| 3
|
|-
| usableHats
| 2
|
|-
| usableOffhands
| 1
|
|-
| usableOther
| 1
|
|-
| usablePants
| 1
|
|-
| usableShirts
| 1
|
|-
| violetFogGoal
| 0
|
|-
| violetFogLayout
|
|
|-
| warProgress
| unstarted
|
|-
| welcomeBackAdv
| 0
|
|-
| unknownRecipe3542
| true
|
|-
| unknownRecipe3543
| true
|
|-
| unknownRecipe3544
| true
|
|-
| unknownRecipe3545
| true
|
|-
| unknownRecipe3546
| true
|
|-
| unknownRecipe3547
| true
|
|-
| unknownRecipe3548
| true
|
|-
| unknownRecipe3749
| true
|
|-
| unknownRecipe3751
| true
|
|-
| unknownRecipe4172
| true
|
|-
| unknownRecipe4173
| true
|
|-
| unknownRecipe4174
| true
|
|}

==Daily Variables==
These per-account variables are reset to default value at the beginning of each day.
{| class="wikitable" border="1"
|-
! Variable Name
! scope="col" width="300" | Default Value
! Notes
|-
| _absintheDrops
| 0
|
|-
| _aguaDrops
| 0
|
|-
| _aprilShower
| 0
|
|-
| _astralDrops
| 0
|
|-
| _badlyRomanticArrows
| 0
|
|-
| _bagOfCandy
| false
|
|-
| _bagOTricksUsed
| false
| Has the Bag of Tricks been used today?
|-
| _ballpit
| false
|
|-
| _banderRunaways
| 0
|
|-
| _benettonsCasts
| 0
|
|-
| _bootStomps
| 0
|
|-
| _borrowedTimeUsed
| false
|
|-
| _boxingGloveArrows
| 0
|
|-
| _brickoFights
| Number of times Bricko monsters have been fought today
|
|-
| _cameraUsed
| false
|
|-
| _candySummons
| 0
|
|-
| _carboLoaded
| 0
|
|-
| _chipBags
| 0
|
|-
| _companionshipCasts
| false
|
|-
| _crimboTree
| false
|
|-
| _deluxeKlawSummons
| 0
|
|-
| _distentionPillUsed
| false
|
|-
| _donhosCasts
| false
|
|-
| _elronsCasts
| false
|
|-
| _feastedFamiliars
| semicolon separated list of familiars
|
|-
| _feastUsed
| 0
| Number of times moveable feast is used
|-
| _fingertrapArrows
| false
|
|-
| _gapBuffs
| 0
| Greatest American Pants buffs
|-
| _gibbererAdv
| 0
|
|-
| _gongDrops
| 0
|
|-
| _hareAdv
| 0
|
|-
| _hipsterAdv
| 0
|
|-
| _hotTubSoaks
| 0
|
|-
| _iceballUses
| 0
|
|-
| _inigosCasts
| false
|
|-
| _ironicMoustache
| false
|
|-
| _klawSummons
| 0
|
|-
| _lastZomboEye
| 0
|
|-
| _leafblowerML
| 1
|
|-
| _legendaryBeat
| false
|
|-
| _lookingGlass
| false
|
|-
| _lunchBreak
| false
| Has the Lunch Break skill been used?
|-
| _madTeaParty
| false
|
|-
| _mayflySummons
| 0
| Mayfly summonings today
|-
| _navelRunaways
| 0
|
|-
| _pasteDrops
| 0
| Number of times Stomping Boots have stomped (badly named)
|-
| _photocopyUsed
| false
|
|-
| _pieDrops
| 0
| Number of pies made by Knob Goblin Organ Grinder
|-
| _poisonArrows
| 0
| Obtuse Angel ability
|-
| _poolGames
| 0
|
|-
| _poolGames
| 0
|
|-
| _precisionCasts
| 0
|
|-
| _riftletAdv
| 0
|
|-
| _sealFigurineUses
| 0
|
|-
| _sealsSummoned
| 0
|
|-
| _sexChanged
| false
|
|-
| _skateBuff1
| false
| lutz
|-
| _skateBuff2
| false
| comet
|-
| _skateBuff3
| false
| band shell
|-
| _skateBuff4
| false
| skate eels
|-
| _skateBuff5
| false
| merry-go-round
|-
| _stinkyCheeseCount
| 0
|
|-
| _stressBallSqueezes
| 0
|
|-
| _syntheticDogHairPillUsed
| 0
|
|-
| _thingfinderCasts
| 0
|
|-
| _timeHelmetAdv
| 0
|
|-
| _toastSummons
| 0
|
|-
| _tokenDrops
| 0
| Rogue Program drop
|-
| _transponderDrops
| 0
|
|-
| _userMods
|
|
|-
| _vmaskAdv
| 0
|
|-
| _zapCount
| 0
|
|-
|}

==User-defined variables==
In addition to setting the variables that KoLmafia predefines, you can also create any others to cover any information you wish. As you do so, keep in mind that while you can clear a variable’s value to the null string, there is currently no way to delete a key (aside from editing the .txt file in the text processor of your choice and deleting the line that contains the key).
{{SeeAlso|get_property|set_property}}

[[Category:Scripting]]

ASH Errors

2011-06-24T11:25:21Z

Slyz: added "Function undefined" error

{{TOCright}}
Errors happen. When they do, it helps to have some idea of what what wrong.

===Abort===

Whenever a script runs the [[abort|abort()]] function, this error is generated.

{{CodeSample|
description=The zero-parameter form:|
code=
<syntaxhighlight>
abort();
</syntaxhighlight>}}
will stop the execution and print: KoLmafia declares world peace. Note that this message may also appear as a result of pressing Esc in the Main Interface or hitting "stop now" in the Adventure tab.

{{CodeSample|
description=The one-parameter form:|
code=
<syntaxhighlight>
abort("Aborting script...");
</syntaxhighlight>}}
will stop the execution and print: Aborting script...

===Cannot initialize parameter [parameter]===

This error is created when an assignment is attempted inside a function declaration.
The following code results in an error.

{{CodeSample|
code=
<syntaxhighlight>
/* test.ash */

void my_function( string myvar = "value" )
{
/* Do something */
}
</syntaxhighlight>}}
will halt the script and print: Cannot initialize parameter myvar (test.ash, line X)

===Cannot return [datatype] from [datatype] function===

This indicates that the return value does not match the function's type.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int stuff(){
return "4";
}
</syntaxhighlight>}}
will cause this error: Cannot return string value from int function (test.ash, line 2)

{{CodeSample|
description=Similarly, for void functions:|
code=
<syntaxhighlight>
void stuff(){
return 4;
}
</syntaxhighlight>}}
will cause this error: Cannot return a value from a void function (test.ash, line 2)

===Encountered '[break|continue]' outside loop===

This indicates that the control structure in question was not in a loop.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
continue;
</syntaxhighlight>}}
will cause this error: Encountered 'continue' outside of loop (test.ash, line 1)

===Expected===

This generally indicates a syntax problem (missing ending semi-colon, unmatched braces, unmatched parenthesis etc...).

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int a = 1
print(a);
</syntaxhighlight>}}
will cause this error: Expected ;, found print (test.ash, line 2)

===Function defined multiple times===

This indicates that the function in question has already been defined.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int abs(int a){
return a*((a>0).to_int()*2 - 1);
}
int abs(int a){
if(a<0) a = -a;
return a;
}
</syntaxhighlight>}}
will cause this error: Function <nowiki>'abs( int )'</nowiki> defined multiple times (test.ash, line 4)

===Function undefined===

This happens when calling a function that KoLMafia doesn't know, either because the script uses a built-in ASH function that doesn't exist yet in the user's build, or because the function hasn't been defined yet, neither in the imported scripts nor in the script itself.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
my_function();

void my_function(){
print( "hello world" );
}
</syntaxhighlight>}}
will cause this error: Function <nowiki>'my_function()'</nowiki> undefined. This script may require a more recent version of KoLmafia and/or its supporting scripts. (test.ash, line 1)

==="if" requires a boolean conditional expression ===

This indicates that the condition inside an if statement is not a boolean.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
if(42) {
print("Don't panic.");
}
</syntaxhighlight>}}
will cause this error: "if" requires a boolean conditional expression (test.ash, line 1)

===Index type is not a primitive type===

This indicates that the map's index is not a standard datatype (float, int, string, etc.).

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
record alpha{
int a;
int b;
};
int[alpha] map;
</syntaxhighlight>}}
will cause this error: Index type 'alpha' is not a primitive type (test.ash, line 5)

===Invalid field name===

This indicates that the record does not contain the field in question.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
record my_record {
string a;
string b;
};

my_record [int] my_map;
my_map[1].c = "hello";
</syntaxhighlight>}}
will cause this error: Invalid field name 'c' (test.ash, line 7)

Note that this error may also be encountered when neglecting to name a field.
{{CodeSample|
description= For instance:|
code=
<syntaxhighlight>
record my_record {
string;
};
</syntaxhighlight>}}
will cause this error: Invalid field name ';' (test.ash, line 2)

===Invalid type name===

This indicates that the specified type is not recognized by Mafia.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int[fruit] map;
</syntaxhighlight>}}
will cause this error: Invalid type name 'fruit' (test.ash, line 1)

===Main method must appear at top level===

This indicates that the script's main method is inside another method, for some reason. This is usually caused by a missing brace.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
void stuff() {
// stuff happens here

void main() {
stuff();
}
</syntaxhighlight>}}
will cause this error: main method must appear at top level (test.ash, line 6)

===Map modified within foreach===

You cannot add or remove new entries into a map within a <code>[[foreach]]</code> loop, with the exception of removing the current key. This can happen if you accidentally wrap the name of a string variable with double-quotes for referencing a map entry.

{{CodeSample|
description=For example, the following code:|
code=
<syntaxhighlight>
/* test.ash */
item [string] my_map;
/* Populate my_map with several entries */
foreach str in my_map
print( str + " => " + my_map[ "str" ] );
</syntaxhighlight>}}
Yields: Map modified within foreach (test.ash, line X)

===Missing return value===

The last line of a user-defined function has to be "return <value>;" (although the [[Control_Structures#return|return]] command can be used before too).

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int my_function( int a, int b ) {
if ( a > b ) return a ;
else return b ;
}
</syntaxhighlight>}}
will cause this error: Missing return value (test.ash, line 4)

===No closing found===

This can be caused by forgetting to put a '''"''' or a ''']''' at the end of an argument

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
buy(1000 , $item[disco ball, 225);
</syntaxhighlight>}}
will cause this error: No closing ] found (testing.ash, line 1)

===Record expected===

This indicates that an unrecognized record was found. This often appears when you forget to append "()" to a function name.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
print(4.to_string);
</syntaxhighlight>}}
will cause this error: Record expected (test.ash, line 2)

===Record name is already defined===

This indicates that the record name has already been defined, and so cannot be reused. The solution is to change the record name.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
record str {
string a;
string b;
};
record str {
int a;
int b;
};
</syntaxhighlight>}}
will cause this error: Record name 'str' is already defined (test.ash, line 5)

===Return needs [datatype] value===

This indicates that the return value is void when the function is not.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int stuff() {
return;
}
</syntaxhighlight>}}
will cause this error: Return needs int value (test.ash, line 2)

===Reserved word cannot be a [function|record|variable] name===

This indicates that the desired name has been [[Reserved Words|reserved]], and so cannot be used. The solution is to use a different name.

{{CodeSample|
description=An invalid name:|
code=
<syntaxhighlight>
int float(float a) {
return round(a);
}
</syntaxhighlight>}}
will cause this error: Reserved word 'float' cannot be used as a function name (test.ash, line 1)

An interesting point to note is that ASH functions take precedent over identically named custom functions rather than throw an exception.

{{CodeSample|
description=An invalid record name:|
code=
<syntaxhighlight>
record string {
string a;
string b;
};
</syntaxhighlight>}}
will cause this error: Reserved word 'string' cannot be a record name (test.ash, line 1)

{{CodeSample|
description=An invalid variable name:|
code=
<syntaxhighlight>
string item = "bottle of gin";
</syntaxhighlight>}}
will cause this error: Reserved word 'item' cannot be a variable name (test.ash, line 1)

===Script parsing error===

This generally indicates a syntax problem, as in having an excess amount of braces or a variable/function/record name that starts with an invalid character.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
put_shop(0 ,0 ,$item[wolf mask]);
put_shop(0 ,0 ,$item[rave whistle]);
put_shop(0 ,0 ,$item[giant needle]);
cli_execute ("undercut");
}
</syntaxhighlight>}}
will cause this error: Script parsing error (test.ash, line 5)

===Variable is already defined===

This indicates that the same variable has been declared twice.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int Drops ;
int Meat ;
int Drops = numeric_modifier("Item Drop");
</syntaxhighlight>}}
will cause this error: Variable Drops is already defined (test.ash, line 3)

{{RFI|Obviously, a lot more info is needed here.}}

[[Category:Scripting]]

Retrieval order

2011-06-20T02:52:20Z

Slyz: updated

This is the current order in which retrieval options are tried for both the CLI command "retrieve" and the ASH command [[retrieve_item|retrieve_item()]], as of about r8200. Note that this is an extremely condensed summary of several hundred lines of internal code, and that the details are subject to change
* items already in inventory
* items currently equipped
* items equipped on a non-current familiar
* if needed, retrieval of worthless items by using 31337 scrolls or using chewing gums
* untinkering a dictionary to get the bridge
* items in closet, if enabled
* free pulls from Hagnk's
* items in storage, if no longer under ronin/HC restrictions (note that all of the item is pulled, not just the amount requested)
* retrieval of coffee pixie sticks by trying to retrieve game grid tickets and redeeming them
* retrieval of Lunar Lunch-o-Mat items by trying to retrieve lunar isotopes and redeeming them
* items in the clan stash, if enabled
* item creation, up to the quantity creatable from ingredients on hand (this can be overriden by a buyScript)
* trading worthless items to the Hermit
* trading yeti furs to the Tr4pz0r
* retrieval of Ye Wizard's Shack Game Shoppe Free Snacks items by trying to retrieve snack vouchers and redeeming them
* NPC purchase (if enabled), or Mall purchase (if enabled, and none of the ingredients on hand)
* use budgeted pulls from storage if in Ronin
* item creation, unless buying the item is enabled and appears to be cheaper than the cost of acquiring all the ingredients
* one final attempt at Mall purchase, if enabled and everything else has failed

[[Category:Scripting]]

Adventure

2011-06-07T08:42:02Z

Slyz:

{{
#vardefine:name|adventure}}{{
#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|adventures}}|
parameter2={{Param|location|place}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|adventures}}|
parameter2={{Param|location|place}}|
parameter3={{Param|string|filter}}|
p1desc={{Pspan|int}} is the number of adventures to spend.|
p2desc={{Pspan|place}} is the adventuring location.|
p3desc={{Pspan|filter}} is a combat action filter. If {{Pspan|filter}} contains a semicolon it is interpreted as a macro, otherwise this is the name of a top-level function which modifies the current CCS. A combat filter function takes the parameters of a consult script, but returns lines like a CCS, not like a consult script. Essentially, this allows the scripter to put a CCS or macro into a script.|
}}|

function_description=This function runs the specified number of {{pspan|adventures}} at the given {{pspan|place}}, keeping up your current mood & obeying restore settings.
If {{Pspan|filter}} contains a semicolon it will use {{Pspan|filter}} as a macro.
If {{Pspan|filter}} is omitted or assigned an empty string, this function will use your current CCS / battle action.
This function returns true if the specified number of adventures were used, and false if not. Possible reasons for returning false include being out of adventures, a location being unavailable, conditions being statisfied ''before'' {{Pspan|adventures}} were used up and all [[auto-stops]], including encountering a demon name or hobo glyph.
Note that {{Pspan|adventures}} is the number of adventures to spend in the specified location {{pspan|place}}. Any "free" turns (choiceadventures that don't consume an adventure, usually) or adventures spend in other locations (by a counterScript or a betweenBattleScript for example) will not count towards this total.
As with auto-adventuring from the Adventure tab, adventure() checks against goals set via [[add_item_condition|add_item_condition()]] or via other methods of specifying goals in KoLmafia, and will auto-stop if all goals were satisfied.|

code1={{CodeSample|
title=Code Sample|
description=Adventure 5 times at the Giant's Castle:|
code=
<syntaxhighlight>
adventure(5 , $location[giant's castle]);
</syntaxhighlight>}}
{{CodeSample|
title=Example of a Combat Filter|
description=This uses the combat filter to automatically olfact Goth Giants while adventuring.|
code=
<syntaxhighlight>

string olfact_goth(int round, string opp, string text) {
if(opp != "Goth Giant")
return get_ccs_action(round);
if(round == 1 && have_effect($effect[On the Trail]) < 1)
return "skill transcendent olfaction"
else
return get_ccs_action(round - 1);
}

adventure(5 , $location[giant castle], "olfact_goth");
</syntaxhighlight>}}
{{CodeSample|
description=Uses a combat filter to ensure that all sewer monsters are being cleeshed while you try to make your way to Hobopolis.|
code=
<syntaxhighlight>
string combat_cleesh(int round, string opp, string text) {
if (opp == $monster[frog].to_string() || opp == $monster[newt].to_string()
|| opp == $monster[salamander].to_string()) {
return "attack";
}
return "skill CLEESH";
}

adventure(1, $location[a maze of sewer tunnels], "combat_cleesh");
</syntaxhighlight>}}
{{CodeSample|
description=This makes use of the combat filter to ensure that salve is being used.|
code=
<syntaxhighlight>
// Adds salve to beginning of combat if it doesn't already exist in the CCS.
// Otherwise it simply returns the current CCS.
string insert_salve(int round, string opp, string text) {
boolean salve = false;
for i from 1 to 30
if(get_ccs_action(round) == "skill saucy salve")
salve = true;
if(salve)
return get_ccs_action(round);
else {
if(round == 1)
return "skill saucy salve";
if(round > 1)
round = round - 1; // compensate for insertion
return get_ccs_action(round); // for the rest of the combat, executes your existing ccs
}
}

adventure(5 , $location[giant castle], "insert_salve");
</syntaxhighlight>}}|

see_also={{SeeAlso|adv1}}|
cli_equiv=The CLI command "adv" works similarly.|
special=This function will return false if KoLmafia conditions are met before completing the specified number of turns.Also, if the filter function is not top-level code, it will not be found, since it's being called outside of ASH. As a result, it will return "void", which may result in the use of $item[ovoid leather thing].
}}

[[Category:Adventuring]]

Mall price

2011-05-24T14:06:00Z

Slyz: mall-price() does only one mall search per item per session

{{
#vardefine:name|mall_price}}{{
#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}}|
parameter1={{Param|item|shop_for}}|
p1desc={{Pspan|shop_for}} is the item to inquire on the mall price of|
}}|

function_description=Returns the current mall price of the given item, ignoring the first five items listed to compensate for stores with limits and min-priced sales. To prevent abuse, this will only perform an actual Mall search once per item per session; subsequent calls for the same item will return a cached value. The cache will be updated after attempts to purchase the item (even unsuccessful ones), but not in any other conditions.|

needscode=yes|

see_also={{SeeAlso|historical_price|buy|retrieve_item}}|
cli_equiv=The CLI command "searchmall" also returns current mall prices.|
special=Items not listed in the mall will return 0 (untradeable items will return 0 without any server requests). When not logged in, this function returns -1.|
}}

[[Category:Item Management]]

Data Structures

2011-04-11T22:39:21Z

Slyz: /* Records */ small typo

{{TOCright}}

KoLmafia supports complex data structures such as maps and records made from simple [[Data Types|data types]].

== Maps ==
Most of this information was copied directly from ASH Maps Tutorial, by Veracity (http://kolmafia.sourceforge.net/advanced.html#maps)

A map is indexed by one data type (the key) and associates that key with another (or the same) data type (the value). The key can be any ASH simple data type: boolean, int, float, string, item, location, class, stat, skill, effect, familiar, slot, or monster. The value can be any ASH data type at all: a simple type, a record, or can be another map. This effectively allows multi-dimensional maps and. In fact, that's how the syntax we provide for multi-dimensional maps actually operate: maps of maps of maps ...

You can declare a map any time you can declare a variable: as a top level (global) variable, as a function parameter, or as a local variable in any scope.

You can fetch data from a map any time you can provide a data value: in an expression, as a function parameter, on the right side of an assignment statement, from a "return" statement, as so on. You can pass around entire maps, individual elements, or intermediate maps: "slices".

=== Declarations ===

The syntax for declaring the data type of a map:

<pre>
<data type> [ <key type>, ... ] <aggregate_name>
</pre>

For example:

{{CodeSample
|code=<syntaxhighlight>
string [item] map1;
float [class, string, int] another_map;
</syntaxhighlight>}}

=== Assignments ===

If you use a map on the left side of an assignment, you set the whole map at once to the new value.

{{CodeSample
|code=<syntaxhighlight>
int [item] my_pricelist;
int [item] new_pricelist;

/* Some code that updates new_pricelist */

my_pricelist = new_pricelist;
</syntaxhighlight>}}

If you specify a map and a complete set of indices (of the correct types) on the left side of an assignment statement, you set a single element.

{{CodeSample
|code=<syntaxhighlight>
int [item] my_pricelist;
my_pricelist[ $item[ pail ] ] = 1000;
</syntaxhighlight>}}

If you specify a map and a prefix of indices (of the correct type), you directly set one of the intermediate maps, a "slice".

{{CodeSample
|code=<syntaxhighlight>
float [string, int, string] my_map;
float [int, string] slice1;

/* Some code that fills slice1 */
my_map[ "slice1" ] = slice1;
</syntaxhighlight>}}

=== References ===

The syntax for referencing an element (or slice) of a map:

<pre>
<aggregate name>[ <key expression>, ... ]
</pre>

All the key expressions will be evaluated at run time. If you specify all the keys the map expects, you fetch data of the type specified by the map. If you specify fewer keys than the map expects, you get an intermediate map, a "slice".

As an example:
{{
CodeSample|
code=
<syntaxhighlight>
boolean [string, string] props;
</syntaxhighlight>}}

might be used to hold "properties" associated with names.
{{
CodeSample|
code=
<syntaxhighlight>
props[ "dog", "mammal" ] = true;
props[ "dog", "pet" ] = true;
props[ "dog", "fun" ] = false;
props[ "turtle", "mammal" ] = false;
props[ "turtle", "pet" ] = true;
props[ "turtle", "fun" ] = false;
props[ "aardvark", "mammal" ] = true;
props[ "aardvark", "pet" ] = false;
props[ "aardvark", "fun" ] = true;
</syntaxhighlight>}}

references:

<pre>
props[ "dog", "mammal"] => true
boolean [string] animal = props[ "turtle" ];
animal[ "fun" ] => false
</pre>

=== Contains ===

You can test the presence of a key in a map using the "contains" operator:

<pre>
<aggregate reference expression> contains <key expression>
</pre>

Where <aggregate reference expression> must evaluate at run time to a map or slice, and must evaluate at run time to a key of the appropriate type. (Note that that is enforced at parse time; ASH can tell the datatype any expression will produce).

<pre>
props contains "dog" => true
props contains "elephant" => false
props[ "aardvark" ] contains "fun" => true
animal contains "pet" => true
animal contains "favorite food" => false
</pre>

=== Remove ===

You can remove a key-value association from a map using the "remove" unary operator:

<pre>
remove <aggregate reference>
</pre>

For clarification, an aggregate reference is "<map name>[ <index 1> ... <index n> ]" where <map name>[ <index 1> ... <index n-1> ] specifies the "slice" and <index n> specifies the "key". Which is just what you expect, if you fully specify the indices; for a single dimensional map, "map[10]" -> "map" is the slice and 10 is the key. The "remove" operator removes the "key" from the "slice". For example:

{{CodeSample|code=<syntaxhighlight>
string [int] map1;
map1[5] = "foo";
print( count( map1 ) + " " + map1 contains 5 + " " + map1[5] );
print( "remove: " + remove map1[5] );
print( count( map1 ) + " " + map1 contains 5 + " " + map1[5] );
print( "remove: " + remove map1[5] );
int [string, string] map2;
map2["me","you"] = 17;
print( count( map2["me"] ) + " " + map2["me"] contains "you" + " " + map2["me","you"] );
print( "remove: " + remove map2["me", "you"] );
print( count( map2["me"] ) + " " + map2["me"] contains "you" + " " + map2["me","you"] );
print( "remove: " + remove map2["me", "you"] );
print( count( map2 ) + " " + map2["me"] );
print( "remove: " + remove map2["me"] );
print( count( map2 ) + " " + map2["me"] );
</syntaxhighlight>}}

yields:

<pre>
1 true foo
remove: foo
0 false
remove:
1 true 17
remove: 17
0 false 0
remove: 0
1 aggregate int [string]
remove: aggregate int [string]
0 aggregate int [string]
</pre>

=== Clear ===

You can remove all <code>key => value</code> entries from a map using the {{f|clear}} function:

{{CodeSample|code=<syntaxhighlight>clear( <aggregate> );</syntaxhighlight>}}

=== Sort ===

From http://kolmafia.us/showthread.php?t=1738

The syntax is:
{{CodeSample|code=<syntaxhighlight>sort aggregate by keyExpr;</syntaxhighlight>}}
<code>aggregate</code> is a reference to the object to be sorted - arrays are probably the most useful things to sort, but any mapping type can be used (even multidimensional maps, but note that you can only sort along a single dimension at a time). The reference must not be enclosed in parentheses, as that would look like a call to a function named <code>sort()</code> - which is still perfectly valid, "sort" has not become a [[Reserved Words|reserved word]].

<code>keyExpr</code> is an arbitrary expression that defines how the items should be ordered. It is evaluated once for every entry in the aggregate, in a scope with two additional variables implicitly defined: '<code>index</code>' and '<code>value</code>', holding the details of that entry. The value of the <code>keyExpr</code> is used as the sort key; typically it would be an <code>int</code> or <code>string</code>, but can be any ASH type that can be compared via "<" and the other relational operators.

The most basic form of sorting would therefore be "<code>sort ... by value</code>", but many useful things can be done with the use of a more complex <code>keyExpr</code> - the only real restriction is that the expression should not modify the object you're sorting. For example, if you had an array of items, you could sort it "<code>by autosell_price(value)</code>". An array of weapon items could be sorted "<code>by -get_power(value)</code>" to put it in decreasing order of power. If the elements of your aggregate are records, you'd need to use something like "<code>by value.fieldName</code>", since the records themselves can't be meaningfully compared.

After the sort statement, the aggregate will have exactly the same sets of keys and values as before (even if the keys weren't consecutive), and the iteration order of the keys will be the same, but the values will likely be associated with different keys. The sort is stable - in other words, elements with sort keys that compare as equal will remain in the same order. This means that you can sort on multiple criteria by simply performing separate sorts for each of the criteria, in increasing order of significance.

A few more examples of things you can do:
* "<code>by -value</code>" sorts integers in decreasing order (there's no similar trick for <code>string</code> values).
* "<code>by -index</code>" reverses the existing order of an array (or map with integer keys).
* "<code>by random(1000000)</code>" shuffles into a random order.
* "<code>by otherArray[index]</code>" uses values from a parallel array as the sort keys (you'd then need to do "<code>sort otherArray by value;</code>" if you wanted the two arrays to remain in sync).

== Records ==

(copy-pasted from Veracity's post introducing the record [http://kolmafia.us/showthread.php?t=280])

Starting with SVN revision 1311 of KoLmafia, ASH now supports a new kind of structured data: the record. Here is a little example of how you declare a record and variables of the new type you've created by doing so.

{{CodeSample|code=<syntaxhighlight>
record my_type {
int ifield;
string sfield;
record {
int first;
int second;
} rfield;
int [int, int] mfield;
};

my_type rvar;
my_type [int] mrvar;
</syntaxhighlight>}}

What I've done with the above is declare a new data type which I've named "my_type". Having declared the new type, I can use it (almost) anywhere that I can use a built-in type name. I declared a variable, "rvar", of that type, and I defined a map, "mrvar", which maps keys of type integer to values of type my_type.

The new type, "my_type" is a "composite" type. It contains four fields. "ifield" is an integer. "sfield" is a string. "rfield" is another composite field: an anonymous record containing two integers named "first" and "second". Finally, "mfield" is a map from [int, int] to int.

As you can see, a record can combine data of all the types ASH supports: primitive, aggregate, and composite.

Having defined the new data type and several variables using it, here are some examples of how to access the fields.

{{CodeSample|code=<syntaxhighlight>
rvar.ifield = 10;
rvar.sfield = "secret";
rvar.rfield.first = 1000;
rvar.rfield.second = 2000;
rvar.mfield[ 2, 3 ] = 12;

mrvar[ 1 ] = rvar;

foreach key in mrvar
foreach key1, key2 in mrvar[key].mfield
print( "val = " + mrvar[key].mfield[key1,key2] );
</syntaxhighlight>}}

As you can see, if you have a variable that is a record, you access the fields of the record by following the variable name with ".<field name>". The resulting value will be of whatever type you declared in the definition of the record. If the value is a map, you can give a list of keys within [], just like any other map. If the value is another record, you can access the fields of the nested record by using another ".<field name>".

If you are familiar with Pascal "records" or C/C++ "structs", this should all be comfortably familiar.

Finally, if you create a map whose values is a record, the file_to_map and map_to_file built-in ASH functions will Do The Right Thing; they will efficiently and reliably save and restore your data.
{{RFI|I, for one, don't have a good handle on multi-dimensional maps. Any effort to clarify how they are defined & accessed would be greatly appreciated.|Don't worry about formatting for now; I'll get to that once the info is there, unless you're feeling super-ambitious.}}
{{Format}}

[[Category:Scripting]]

Control Structures

2011-04-03T21:05:37Z

Slyz: add try / finally (these should be added as ASH keywords I think)

{{TOCright}}
==Conditional==
===if===
{{
CodeSample|
code=
<syntaxhighlight>
if ( boolean )
{
// any statements here
// are only going to be executed
// if the boolean returns true
}
</syntaxhighlight>}}
{{
CodeSample|
description=Single-statement conditionals may omit the curly braces.|
code=
<syntaxhighlight>
if ( boolean )
// curly braces aren't required if only one statement follows the conditional
</syntaxhighlight>}}
===else===
{{
CodeSample|
code=
<syntaxhighlight>
if ( boolean )
{
// statements if true
}
else
{
// the statements here
// are only going to be executed
// if the boolean returns false
}
</syntaxhighlight>}}

===else if===
{{
CodeSample|
code=
<syntaxhighlight>
if ( boolean 1 )
{
// statements if true
}
else if ( boolean 2 )
{
// the statements here
// are only going to be executed
// if boolean 1 returns false
// & boolean 2 returns true
}
</syntaxhighlight>}}

===switch===
{{
CodeSample|
code=
<syntaxhighlight>
switch ( variable )
{
case value:
// statements if variable == value
// more such statements
break;
//repeat above for as many values as desired
default:
// statements executed if
// none of the cases were true
}
</syntaxhighlight>}}

Note that each "case" can only test against a single value; that value can be a variable itself, but not a test expression.

{{
CodeSample|
description=If switch has no parameter, then each case is evaluated as a boolean expression, like a string of if-then statements.|
code=
<syntaxhighlight>
switch
{
case boolean expression:
// if the expression is true, this statement is executed
// more such statements
break;
//repeat above for as many conditionals as desired
default:
// statements executed if
// none of the cases were true
}
</syntaxhighlight>}}

==Unconditional==
===try / finally===
{{
CodeSample|
description=Block1 is executed as normal, and then block2 is executed regardless of whether
block1 finished normally, generated an error, or encountered a 'return',
'break', or 'continue' statement.|
code=
<syntaxhighlight>
try
{
// block1
}
finally
{
// block2
}
</syntaxhighlight>}}

==Loops==
===while===
{{
CodeSample|
code=
<syntaxhighlight>
while ( boolean )
{
// as with an if statement
// this area is only entered
// if the boolean tests true
// once all this is done
// it goes back to the begining
// and will keep executing
// as long as the boolean remains true
}
</syntaxhighlight>}}

===repeat until===

This is similar to the [http://en.wikipedia.org/wiki/Do_while_loop do...while loop], but only ends the loop when the <code>boolean</code> expression evaluates to <code>true</code>.

{{
CodeSample|
code=
<syntaxhighlight>
repeat
{
// this is the same
// as the while loop above
// with one exception:
// all of this code will
// execute at least once
// as the test doesn't occur
// until the very end
} until ( boolean );
</syntaxhighlight>}}

===for===
{{
CodeSample|
code=
<syntaxhighlight>
for x from a to b by c {
//do stuff
}
</syntaxhighlight>}}
Above is the general case. You don't need to specify whether it's going up or down - although doing so by using upto or downto does allow a runtime check to make sure you didn't screw up.

If you don't specify "c", it defaults to incrementing/decrementing by 1. The first iteration is at a and the last is at b (that is to say, it goes from a to b, inclusive).

===foreach===
{{
CodeSample|
code=
<syntaxhighlight>
foreach key in aggregate {
//do stuff
}
</syntaxhighlight>}}
Assigns each key in the supplied map or slice to "<code>key</code>" and iterates through the map. Due to how maps are handled, <code>foreach</code> is guaranteed to iterate through the map in sorted order.

{{
CodeSample|
description=For example:|
code=
<syntaxhighlight>
boolean [int][string] map;
map[15]["test"] = true;
foreach int_index in map {
print(int_index); //this will print '15' once, since there is only one valid value for this index
foreach string_index in map[int_index] //this iterates over the "slice" of the map where 1 is fixed as the index
{
print(string_index); //This will print "test" once, since there is only one valid value for this index
print(map[int_index][string_index]); //this will print "true"
}
}
</syntaxhighlight>|
moreinfo=
So the output is
<pre>
15
test
true
</pre>}}
{{
CodeSample|
description=For a multidimensional map, instead of nesting <code>foreach</code> statements two iterators can be used inline.|
code=
<syntaxhighlight>
foreach x, y in map {
//do stuff
}
</syntaxhighlight>}}
{{
CodeSample|
description=This is identical to:|
code=
<syntaxhighlight>
foreach x in map {
foreach y in map[x] {
//do stuff
}
}
</syntaxhighlight>}}

{{CodeSample|
description=You can also directly specify the value stored in the map by specifying one more variable than the number of keys in the map:|
code=
<syntaxhighlight>
//string [string, int, item] my_map;
foreach s, i, m, value in my_map {
print( s + ", " + i + ", " + m + " => " + value );
}
</syntaxhighlight>
}}

See the page for [[Data Structures]] for more information on aggregates.

==Continuation & Exiting==
Like many languages with looping structures, ASH supports the break and continue statements. All looping structures (for, while, repeat until, and foreach) support these statements.

===break===
Breaks out of the smallest enclosing loop. In a switch statement, breaks out of the switch statement. Execution resumes at the first statement after the end of the loop/switch statement.

===continue===
Continues on to the next iteration of the loop (skipping any statements in this iteration that occur after the continue statement). In a switch statement, continue is allowed iff the switch is inside a loop, and acts as any other continue.

===return===
Exits the function and returns the value following the return statement, if specified. Note that the value's datatype must match that of the function itself (void functions can only use return by itself).

===exit===
Exits the script. Using return when in main() achieves the same effect. Note that while this will end the current script, it will not stop automation.

[[Category:Scripting]]

Miscellaneous ASH Features

2011-02-21T08:18:38Z

Slyz: "command" takes 2 "m"s

{{TOCright}}
==Special Syntax Functions==

'''[[notify]]'''

Used to send a simple kmail to the script's author, letting them know you use their script.

'''[[import]]'''

Used to load an external script into your current one.

'''[[call]]'''

Enables the script writer to invoke a function whose name is known at runtime.

'''[[new]]'''

Constructor function used to populate a record.

==Comments==

Adding '''[[Comments]]''' to your code can make it much easier to maintain, and helps other users understand what's going on.

==Errors==

For help when things go wrong, please see the page on [[ASH Errors]].

==Additional Script Uses==

In addition to regular scripts, relay override scripts, and consult scripts, mafia has a few other hooks for adding event-driven scripts. These situations are listed below, along with the preference that you can set a script name to (in parentheses).

'''Between Battle (betweenBattleScript)'''
*Executed whenever mafia is about to enter a combat. That means before every adventure if auto-adventuring, or before using an item that could lead to combat such as black pudding or drum machine.
*The betweenBattleScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.
*This only works for automated adventuring. The script will not fire if you're using the relay browser.
*Example: Zarqon's [http://kolmafia.us/showthread.php?t=1240 Best Between Battle]

'''Buy (buyScript)'''
*Will execute whenever mafia needs to determine if it is to purchase or create an item.
*Requires a special main declaration boolean main(item itm, int qty, int ingredientLevel, boolean defaultBuy). These values will be supplied by mafia when the script is automatically called. A return value of true will instruct mafia to purchase the item and false will cause it to create the item possibly leading to other buy/create decisions.
**''itm'' and ''qty'' specify the item under consideration.
**''ingredientLevel'' indicates what's already available:
***0 = none of the ingredients
***1 = some of them
***2 = enough to create at least one of the requested item
**defaultBuy indicates what KoLmafia would have done otherwise; returning this value is the safest thing your script could do. It will normally be true if ingredientLevel is 0, false if 2. The default at level 1 depends on the item, and is subject to change - normally, anything made with star charts, pixels, the Malus, or multi-use are bought, anything else is created.
*Example: Bale's [http://kolmafia.us/showthread.php?p=18313#post18313 potionBuy].

'''Chatbot (chatbotScript)'''
*Will execute whenever a private message is received
*Requires a special main declaration which can have an optional third parameter:
*:void main(string sender, string message)
*:void main(string sender, string message, string channel)
**'sender' is the name of the player who sent the message
**'message' is the message that was sent
**'channel' is "/clan" for clan messages and the empty string for private messages

'''Counters (counterScript)'''
*Will execute whenever a counter will expire as a result of an intended use of adventures.
*Requires a special main declaration: boolean main(string name, int remain). These values will be supplied by mafia when the script is automatically called and the return value will determine whether mafia continues operation (true) or aborts (false).
**''name'' will be the name of the counter that is about to expire.
**''remain'' is the number of turns remaining before the counter expires. Remain will usually be 0, but may be higher if you are about to multi-create items, adventure underwater, or take a vacation. It may be negative if the counter was informational (one that doesn't abort adventuring), and it actually expired in the middle of an action that used multiple turns at once.
*Example: Bale's [http://kolmafia.us/showthread.php?t=2519 CounterChecker].

'''Login (loginScript)'''
:This script is immediately executed once your character is logged in. The loginScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.

'''Logout (logoutScript)'''
:Same as the loginScript, but runs on logout. Note that an [[abort|abort()]] in the script won't stop a logout unless the logout was called in (specific ways, please list).

'''Planting (plantingScript)'''
*This script can be used to manage the mushroom fields, which are available when under a muscle zodiac sign. It runs after logging in, if you have a mushroom field. Main function takes no arguments. Generally should take into account current [[moon phase]] so that it can be started in the middle of a cycle.
*The plantingScript has to be the name of an ASH file without the extension (if the plantingScript setting is "plant", KoLMafia will call "plant.ash").
*Example: [http://kolmafia.us/showthread.php?563-Modified-mushroom-script-to-produce-3rd-4th-gen-crop&p=7507&viewfull=1#post7507 Sandiman's mushroom planting script].

'''Post-Ascension (postAscensionScript)'''
:Executed at once when your character starts a new ascension. (Example: Bales's [http://kolmafia.us/showthread.php?t=2769 newLife]). The postAscensionScript setting is executed like a CLI command. If it is the name of an ASH script, that script does not require any special main() declaration.

'''Pre-Ascension (preAscensionScript)'''
:Same as the Post-Ascension, but executed right before entering Valhalla.

'''Recovery (recoveryScript)'''
*Executed whenever mafia would recover your HP / MP.
*Requires a special main() declaration: boolean main(string type, int amount). These values will be supplied when mafia automatically calls the script, and the return value will instruct mafia if it should attempt to use mafia's default healing after the script concludes.
**''type'' is either "HP" or "MP".
**''amount'' is the desired amount of restoration needed or 0 to use mafia's default recovery level and target.
*Example: Bale's [http://kolmafia.us/showthread.php?t=1780 Universal Recovery]

==A little CLI help==

Three CLI commands are of great use to ASH scripters:
* [[ashref]] allows one to get a list of ASH functions
* [[ash (CLI)|ash]] or [[ash (CLI)|ashq]] allows one to run ASH directly on the CLI.
* [[ashwiki]] allows you to search this wiki by launching a web browser.

==Useful forum threads==
[http://kolmafia.us/showthread.php?523-Did-you-know...-It-s-a-secret-feature.&p=2968&viewfull=1#post2968 This thread], started by holatuwol, is a tidy compilation of various undocumented features in KoLmafia.

[[Category:Scripting]]

Miscellaneous ASH Features

2011-02-21T08:17:07Z

Slyz: Added info about which preferences (I called them 'settings') can be CLI commands.

{{TOCright}}
==Special Syntax Functions==

'''[[notify]]'''

Used to send a simple kmail to the script's author, letting them know you use their script.

'''[[import]]'''

Used to load an external script into your current one.

'''[[call]]'''

Enables the script writer to invoke a function whose name is known at runtime.

'''[[new]]'''

Constructor function used to populate a record.

==Comments==

Adding '''[[Comments]]''' to your code can make it much easier to maintain, and helps other users understand what's going on.

==Errors==

For help when things go wrong, please see the page on [[ASH Errors]].

==Additional Script Uses==

In addition to regular scripts, relay override scripts, and consult scripts, mafia has a few other hooks for adding event-driven scripts. These situations are listed below, along with the preference that you can set a script name to (in parentheses).

'''Between Battle (betweenBattleScript)'''
*Executed whenever mafia is about to enter a combat. That means before every adventure if auto-adventuring, or before using an item that could lead to combat such as black pudding or drum machine.
*The betweenBattleScript setting is executed like a CLI comand. If it is the name of an ASH script, that script does not require any special main() declaration.
*This only works for automated adventuring. The script will not fire if you're using the relay browser.
*Example: Zarqon's [http://kolmafia.us/showthread.php?t=1240 Best Between Battle]

'''Buy (buyScript)'''
*Will execute whenever mafia needs to determine if it is to purchase or create an item.
*Requires a special main declaration boolean main(item itm, int qty, int ingredientLevel, boolean defaultBuy). These values will be supplied by mafia when the script is automatically called. A return value of true will instruct mafia to purchase the item and false will cause it to create the item possibly leading to other buy/create decisions.
**''itm'' and ''qty'' specify the item under consideration.
**''ingredientLevel'' indicates what's already available:
***0 = none of the ingredients
***1 = some of them
***2 = enough to create at least one of the requested item
**defaultBuy indicates what KoLmafia would have done otherwise; returning this value is the safest thing your script could do. It will normally be true if ingredientLevel is 0, false if 2. The default at level 1 depends on the item, and is subject to change - normally, anything made with star charts, pixels, the Malus, or multi-use are bought, anything else is created.
*Example: Bale's [http://kolmafia.us/showthread.php?p=18313#post18313 potionBuy].

'''Chatbot (chatbotScript)'''
*Will execute whenever a private message is received
*Requires a special main declaration which can have an optional third parameter:
*:void main(string sender, string message)
*:void main(string sender, string message, string channel)
**'sender' is the name of the player who sent the message
**'message' is the message that was sent
**'channel' is "/clan" for clan messages and the empty string for private messages

'''Counters (counterScript)'''
*Will execute whenever a counter will expire as a result of an intended use of adventures.
*Requires a special main declaration: boolean main(string name, int remain). These values will be supplied by mafia when the script is automatically called and the return value will determine whether mafia continues operation (true) or aborts (false).
**''name'' will be the name of the counter that is about to expire.
**''remain'' is the number of turns remaining before the counter expires. Remain will usually be 0, but may be higher if you are about to multi-create items, adventure underwater, or take a vacation. It may be negative if the counter was informational (one that doesn't abort adventuring), and it actually expired in the middle of an action that used multiple turns at once.
*Example: Bale's [http://kolmafia.us/showthread.php?t=2519 CounterChecker].

'''Login (loginScript)'''
:This script is immediately executed once your character is logged in. The loginScript setting is executed like a CLI comand. If it is the name of an ASH script, that script does not require any special main() declaration.

'''Logout (logoutScript)'''
:Same as the loginScript, but runs on logout. Note that an [[abort|abort()]] in the script won't stop a logout unless the logout was called in (specific ways, please list).

'''Planting (plantingScript)'''
*This script can be used to manage the mushroom fields, which are available when under a muscle zodiac sign. It runs after logging in, if you have a mushroom field. Main function takes no arguments. Generally should take into account current [[moon phase]] so that it can be started in the middle of a cycle.
*The plantingScript has to be the name of an ASH file without the extension (if the plantingScript setting is "plant", KoLMafia will call "plant.ash").
*Example: [http://kolmafia.us/showthread.php?563-Modified-mushroom-script-to-produce-3rd-4th-gen-crop&p=7507&viewfull=1#post7507 Sandiman's mushroom planting script].

'''Post-Ascension (postAscensionScript)'''
:Executed at once when your character starts a new ascension. (Example: Bales's [http://kolmafia.us/showthread.php?t=2769 newLife]). The postAscensionScript setting is executed like a CLI comand. If it is the name of an ASH script, that script does not require any special main() declaration.

'''Pre-Ascension (preAscensionScript)'''
:Same as the Post-Ascension, but executed right before entering Valhalla.

'''Recovery (recoveryScript)'''
*Executed whenever mafia would recover your HP / MP.
*Requires a special main() declaration: boolean main(string type, int amount). These values will be supplied when mafia automatically calls the script, and the return value will instruct mafia if it should attempt to use mafia's default healing after the script concludes.
**''type'' is either "HP" or "MP".
**''amount'' is the desired amount of restoration needed or 0 to use mafia's default recovery level and target.
*Example: Bale's [http://kolmafia.us/showthread.php?t=1780 Universal Recovery]

==A little CLI help==

Three CLI commands are of great use to ASH scripters:
* [[ashref]] allows one to get a list of ASH functions
* [[ash (CLI)|ash]] or [[ash (CLI)|ashq]] allows one to run ASH directly on the CLI.
* [[ashwiki]] allows you to search this wiki by launching a web browser.

==Useful forum threads==
[http://kolmafia.us/showthread.php?523-Did-you-know...-It-s-a-secret-feature.&p=2968&viewfull=1#post2968 This thread], started by holatuwol, is a tidy compilation of various undocumented features in KoLmafia.

[[Category:Scripting]]

Control Structures

2010-11-12T18:22:31Z

Slyz: /* Continuation & Exiting */ added exit

{{TOCright}}
==Conditional==
===if===
{{
CodeSample|
code=
<syntaxhighlight>
if ( boolean )
{
// any statements here
// are only going to be executed
// if the boolean returns true
}
</syntaxhighlight>}}
{{
CodeSample|
description=Single-statement conditionals may omit the curly braces.|
code=
<syntaxhighlight>
if ( boolean )
// curly braces aren't required if only one statement follows the conditional
</syntaxhighlight>}}
===else===
{{
CodeSample|
code=
<syntaxhighlight>
if ( boolean )
{
// statements if true
}
else
{
// the statements here
// are only going to be executed
// if the boolean returns false
}
</syntaxhighlight>}}

===else if===
{{
CodeSample|
code=
<syntaxhighlight>
if ( boolean 1 )
{
// statements if true
}
else if ( boolean 2 )
{
// the statements here
// are only going to be executed
// if boolean 1 returns false
// & boolean 2 returns true
}
</syntaxhighlight>}}

===switch===
{{
CodeSample|
code=
<syntaxhighlight>
switch ( variable )
{
case value:
// statements if variable == value
// more such statements
break;
//repeat above for as many values as desired
default:
// statements executed if
// none of the cases were true
}
</syntaxhighlight>}}

Note that each "case" can only test against a single value; that value can be a variable itself, but not a test expression.

{{
CodeSample|
description=If switch has no parameter, then each case is evaluated as a boolean expression, like a string of if-then statements.|
code=
<syntaxhighlight>
switch
{
case boolean expression:
// if the expression is true, this statement is executed
// more such statements
break;
//repeat above for as many conditionals as desired
default:
// statements executed if
// none of the cases were true
}
</syntaxhighlight>}}

==Loops==
===while===
{{
CodeSample|
code=
<syntaxhighlight>
while ( boolean )
{
// as with an if statement
// this area is only entered
// if the boolean tests true
// once all this is done
// it goes back to the begining
// and will keep executing
// as long as the boolean remains true
}
</syntaxhighlight>}}

===repeat until===

This is similar to the [http://en.wikipedia.org/wiki/Do_while_loop do...while loop], but only ends the loop when the <code>boolean</code> expression evaluates to <code>true</code>.

{{
CodeSample|
code=
<syntaxhighlight>
repeat
{
// this is the same
// as the while loop above
// with one exception:
// all of this code will
// execute at least once
// as the test doesn't occur
// until the very end
} until ( boolean );
</syntaxhighlight>}}

===for===
{{
CodeSample|
code=
<syntaxhighlight>
for x from a to b by c {
//do stuff
}
</syntaxhighlight>}}
Above is the general case. You don't need to specify whether it's going up or down - although doing so by using upto or downto does allow a runtime check to make sure you didn't screw up.

If you don't specify "c", it defaults to incrementing/decrementing by 1. The first iteration is at a and the last is at b (that is to say, it goes from a to b, inclusive).

===foreach===
{{
CodeSample|
code=
<syntaxhighlight>
foreach key in aggregate {
//do stuff
}
</syntaxhighlight>}}
Assigns each key in the supplied map or slice to "<code>key</code>" and iterates through the map. Due to how maps are handled, <code>foreach</code> is guaranteed to iterate through the map in sorted order.

{{
CodeSample|
description=For example:|
code=
<syntaxhighlight>
boolean [int][string] map;
map[15]["test"] = true;
foreach int_index in map {
print(int_index); //this will print '15' once, since there is only one valid value for this index
foreach string_index in map[int_index] //this iterates over the "slice" of the map where 1 is fixed as the index
{
print(string_index); //This will print "test" once, since there is only one valid value for this index
print(map[int_index][string_index]); //this will print "true"
}
}
</syntaxhighlight>|
moreinfo=
So the output is
<pre>
15
test
true
</pre>}}
{{
CodeSample|
description=For a multidimensional map, instead of nesting <code>foreach</code> statements two iterators can be used inline.|
code=
<syntaxhighlight>
foreach x, y in map {
//do stuff
}
</syntaxhighlight>}}
{{
CodeSample|
description=This is identical to:|
code=
<syntaxhighlight>
foreach x in map {
foreach y in map[x] {
//do stuff
}
}
</syntaxhighlight>}}

{{CodeSample|
description=You can also directly specify the value stored in the map by specifying one more variable than the number of keys in the map:|
code=
<syntaxhighlight>
//string [string, int, item] my_map;
foreach s, i, m, value in my_map {
print( s + ", " + i + ", " + m + " => " + value );
}
</syntaxhighlight>
}}

See the page for [[Data Structures]] for more information on aggregates.

==Continuation & Exiting==
Like many languages with looping structures, ASH supports the break and continue statements. All looping structures (for, while, repeat until, and foreach) support these statements.

===break===
Breaks out of the smallest enclosing loop. In a switch statement, breaks out of the switch statement. Execution resumes at the first statement after the end of the loop/switch statement.

===continue===
Continues on to the next iteration of the loop (skipping any statements in this iteration that occur after the continue statement). In a switch statement, continue is allowed iff the switch is inside a loop, and acts as any other continue.

===return===
Exits the function and returns the value following the return statement, if specified. Note that the value's datatype must match that of the function itself (void functions can only use return by itself).

===exit===
Exits the script. Works like return when used in main().

[[Category:Scripting]]

Regular Expressions

2010-11-09T16:31:52Z

Slyz: removed an extra ')' in the example for a case-insensitive matcher

{{TOCright}}

== Introduction ==

Regular expressions, (commonly shortened to regex), are a language designed to enable creating very explicit patterns for searching strings. The regex language has wildcards for virtually every possible pattern of characters you might want to search for. Only some of the generally most common forms of regexes will be described on this page. For more details you are advised to search the internet where you will find many detailed resources on the subject. This writer will point the student at [http://www.regular-expressions.info/tutorial.html this tutorial] in particular.

== Commonly used Regular Expressions ==

===Literal Characters===
A character will match the first instance of itself in a string.

*E.g. {{Pspan|a}} will match the first a in "J{{Pspan|a}}ck is a dull boy."
*E.g. {{Pspan|cat}} is a set of three literal character which will find a match in "about {{Pspan|cat}}s and dogs."

===Special Characters===
It's often more interesting to search for less specific patterns than literal characters. There are a number of characters reserved for this purpose. These special characters are often called "metacharacters". If you want to use any of these characters as a literal in a regex, you need to escape them with a backslash.

* Backslash '''\'''
*: Used to grant special meaning to a normally literal character or employ a special character as a literal.
*: E.g. If you want to find the beginning of a word, the combination {{Pspan|\b}} will match a word's boundary.
*: E.g. to match "1+1=2", the correct regex is 1\+1=2. Otherwise, the plus sign will have a special meaning.
* Question mark '''?'''
*: The question mark makes the preceding token in the regular expression optional.
*: E.g. {{Pspan|colou?r}} matches both "colour" and "color".
* Asterisk or star '''*'''
*: The asterisk attempts to match the preceding token zero or more times.
* Plus sign '''+'''
*: The plus attempts to match the preceding token once or more.
* Period or dot '''.'''
*: Matches any character except for line breaks.
* Caret '''^'''
*: Matches the beginning of the string only.
*: E.g. {{Pspan|^the}} will match only the first word in "{{Pspan|the}} way of the world."
* Dollar sign '''$'''
*: Matches the end of the string only.
*: E.g. {{Pspan|dog$}} will match only the last word in "dog eat {{Pspan|dog}}".
* Opening and closing round brackets '''(''' and ''')'''
*: Used for grouping allowing a regex operator (like +) to be applied to the entire group. It also creates a capturing group for storing the match.
* Opening and closing square bracket '''[''' and ''']'''
*: Used to create "character sets" to match only one of several characters. Inside these brackets different rules apply to several characters: ^-
*: E.g. {{Pspan|gr[ae]y}} will match either "gray" or "grey", but it will not match "graey".
* Opening and closing braces '''{''' and '''}'''
*: This is a limited repetition operator matching only {min,max} of what preceeds it.
*: E.g. {{Pspan|\b[1-9][0-9]{2,4}\b}} matches a number between 100 and 99999. (\b matches a word boundry.)
* Vertical bar or pipe symbol '''|'''
*: This is an "or" operator to match one of several possibilities.
*: E.g. \b(cat|dog|fish)\b will match either "cat", "dog" or "fish".

===Other Common Matchers===
{|
| \w
| Matches any word character (alphanumeric & underscore).
|-
| \W
| Matches any character that is not a word character (alphanumeric & underscore).
|-
| \d
| Matches any digit character (0-9).
|-
| \D
| Matches any character that is not a digit character (0-9).
|-
| \s
| Matches any whitespace character (spaces, tabs, line breaks).
|-
| \S
| Matches any character that is not a whitespace character (spaces, tabs, line breaks).
|-
| \n
| Line break character.
|-
| \t
| Tab character.
|-
| \b
| Matches a word boundary position such as whitespace or the beginning or end of the string.
|-
| \B
| Matches any position that is not a word boundary.
|-
| [A-Za-z]
| Matches any single character in the range a-z or A-Z.
|-
| [^A-Za-z]
| Matches any single character, except for the range a-z or A-Z.
|}

===Greedy vs Lazy Matching===
Beware greedy matching! Matchers that can match multiple tokens will attempt to match as much as possible.
: E.g. {{Pspan|<.+>}} will match "This is a {{Pspan|<nowiki>test</nowiki>}}." instead of matching '''only''' the html tag as you might have expected.

To fix this, you can make the match lazy, by adding a ? after the greedy character.
: E.g. {{Pspan|<.+?>}} will match "This is a {{Pspan|<nowiki></nowiki>}}test<nowiki></nowiki>." so that you can pick out html tags.

===Special Groups===
These are special types of groups that can allow you to do more advanced things with regex. For the most part, they can be declared by adding a question mark to the beginning of a special group.

Noncapturing groups are declared by adding a colon after the question mark.
: E.g. {{Pspan|(?:hello)}} will match "{{Pspan|hello}}world" without actually creating a new capturing group.

Special quantifiers can be used in a standalone special group that has a length of 0.
: E.g. {{Pspan|(?i)hello}} will match "{{Pspan|HELLO}}", since {{Pspan|(?i)}} tells the regex to ignore case.

Negative/positive lookahead/lookbehind can help you finetune your regex by restricting what can appear without capturing more of the target string
: E.g. {{Pspan|(?<!\\S)([\\d]+)(?!\\S)}} uses negative lookahead and negative lookbehind, and so it will only match a series of digits not bounded by non-space characters, which is to say, a series of digits bounded by spaces. Presumably it would be functionally identical to {{Pspan|<nowiki>(?<=\\s)([\\d]+)(?=\\s)</nowiki>}}.

Since ASH's regular expressions are directly passed to Java, ASH does not support named groups.

===Testing Resources===
If you're not sure if your regex will work, try testing it with one of these resources:
* [http://gskinner.com/RegExr/ gskinner.com]
* [http://www.regexplanet.com/simple/ regexplanet.com]

==Using Regexes in KoLmafia==
Regular expressions in ASH are wrappers for the Java java.util.regex package. You can find detailed information about that in this [http://java.sun.com/docs/books/tutorial/essential/regex/index.html Java Tutorial]. Only the highlights will be described in this section.

Using regular expressions in ash follows this basic formula:
#First a regular expression needs to be defined with the [[matcher]] datatype. Defining a matcher also requires the use of the [[create_matcher|create_matcher()]] function.
#:'''Important''': in ash backslashes have special meaning inside a string, so any backslashes need to be backslashed or else ash will interpret them differently.
#Then the matcher can be operated upon by the various [[String Handling Routines#Regular Expressions|regex functions]], notably [[find|find()]].
#Finally, if there were capturing groups in the matcher, they can be checked using the [[group|group()]] function.

{{CodeSample|
description=This example will use a regular expression to determine how many chamois are left in the slime tube's bucket.|
code=
<syntaxhighlight>
// Visit the bucket to get the page's text
string page = visit_url("clan_slimetube.php?action=bucket");

// In the following matcher: (is|are) will match either word
// (\\d+) will match and capture 1 or more digits. Note the double-backslash!
matcher cham_left = create_matcher("(There (is|are) (\\d+) chamoi(s|x))( in the bucket.)" , page);

// Then you use find to capture patterns with the parenthesis.
if(cham_left.find()) {

// Finally group() is used to reference the patterns that were captured.
print(cham_left.group(1)+ " left"+ cham_left.group(5), "blue");
} else
print("The bucket is empty.", "blue");
</syntaxhighlight>}}

[[Category:String Handling Routines]][[Category:Scripting]]

Auto-stops

2010-06-30T16:51:42Z

Slyz:

Auto-stops are places where mafia's automation will automatically stop, just as the name suggests. Except for the Ultra-Rare monsters, these are all KoL non-combats. If mafia detects one of these auto-stop non-combats then automation will cease immediately after the encounter.

There is just one trick to using auto-stops: mafia will only auto-stop when there are no conditions set (although it will always auto-stop on Ultra-Rare monsters). If conditions are set then mafia will continue automation until it reaches those conditions and stop normally. This is to prevent auto-stops from interfering with regular automation.

* Sleazy Back Alley: {{kolwiki|Under the Knife}}
* Misspelled Cemetary: {{kolwiki|A Grave Situation}}
* Haunted Library: {{kolwiki|Take a Look, it's in a Book! (Rise)|Rise}} and {{kolwiki|Take a Look, it's in a Book! (Fall)|Fall}} of Take a Look, it's in a Book!
* Whitey's Grove: {{kolwiki|It's A Sign!}}
* Teleportitis: {{kolwiki|The Oracle Will See You Now}}
* Barrrney's Barrr: {{kolwiki|Step Up to the Table, Put the Ball in Play}}
* Arid, Extra-Dry Desert: Auto-stops every time you want to start adventuring at the Oasis or if you need to get an item:
*# {{kolwiki|A Sietch in Time}}
*# {{kolwiki|No Colors Anymore}} (without can of black paint). With paint, adventuring continues to Walk Without Rhythm.
*# {{kolwiki|Walk Without Rhythm}}
*# {{kolwiki|Walk Without Rhythm 2}} (Only occurs if you didn't have a drum machine at previous auto-stop.)
*# {{kolwiki|The Sleeper Has Awakened}}
* Agua de vida: Auto-stop when a bottle is consumed.
* Auto-stop when a demon name is learned and opens mini-browser to display it.
* Auto-stop when a hobo code is learned and opens mini-browser to display it.
* Auto-stop when an Ultra Rare adventure is encountered and opens mini-browser to display it.

{{CodeSample|description=Unlocking the White Citadel can make use of the auto-stop to be this simple.|
code=<syntaxhighlight>
adventure( my_adventures(), $location[whitey's grove] );
adventure( my_adventures(), $location[white citadel );
</syntaxhighlight>}}
{{CodeSample|description=Unlocking the Pyramid, using the magic of auto-stops. Note that this assumes you have enough adventures to complete it. A better script would check the questlog to verify current quest progress before beginning adventuring.|
code=<syntaxhighlight>
cli_execute("condition clear"); # conditions must be clear or stops won't be automatic.
# Adventure until: A Sietch in Time
adventure( my_adventures(), $location[Desert (Ultrahydrated)] );
cli_execute("condition set 1 stone rose, 1 drum machine");
adventure( my_adventures(), $location[Oasis] );
# Adventure until: Walk Without Rhythm
retrieve_item(1, $item[can of black paint]);
adventure( my_adventures(), $location[Desert (Ultrahydrated)] );
cli_execute("condition set worm-riding manual pages 3-15");
adventure( my_adventures(), $location[Oasis] );
# Adventure until: The Sleeper Has Awakened
adventure( my_adventures(), $location[Desert (Ultrahydrated)] );
# Equip wormhooks, use drum machine and then re-equip original weapon.
cli_execute("checkpoint; equip worm hooks; use drum machine; outfit checkpoint");
</syntaxhighlight>}}

[[Category:Automation]]

Modifier Maximizer

2010-06-20T10:16:20Z

Slyz: moved stuff to the Talk page, formating, added useful expressions

{{RFI}}

=Usage=
==General==
The specification of what attributes to maximize is made by a comma-separated list of keywords, each possibly preceded by a numeric weight. Commas can be omitted if the next item starts with a +, -, or digit. Using just a +, or omitting the weight entirely, is equivalent to a weight of 1. Likewise, using just a - is equivalent to a weight of -1. Non-integer weights can be used, but may not be meaningful with all keywords.
==Numeric Modifiers==
The full name of any numeric modifier (as shown by the modref CLI command) is a valid keyword, requesting that its value be maximized. If multiple modifiers are given, their weights specify their relative importance. Negative weights mean that smaller values are more desirable for that modifier.

Shorter forms are allowed for many commonly used modifiers. They can be abbreviated down to just the bold letters:
 mus, mys, mox, mainstat, HP, MP, ML, DA, DR, combat rate, item drop, meat drop, experience, adventures
 Also, resistance (of any type) can be abbreviated as res, and damage can be abbreviated as dmg. all resistance is a shortcut for giving the same weight to all five basic elements. Likewise, elemental dmg is a shortcut for the five elemental damage types.

Note that many modifiers come in pairs: a base value, plus a percentage boost (such as Moxie and Moxie Percent), or a penalty value. In general, you only need to specify the base modifier, and any related modifiers will automatically be taken into account.
==Limits==
Any numeric modifier keyword can be followed by one or both of these special keywords:
 min - The weight specifies the minimum acceptable value for the preceding modifier. If the value is lower, the results will be flagged as a failure.+
 max - The weight specifies the largest useful value for the preceding modifier. Larger values will be ignored in the score calculation, allowing other specified modifiers to be boosted instead.
 Note that the limit keywords won't quite work as expected for a modifier that you're trying to minimize.
 If min or max is specified at the start of the expression, it applies to the total score (the sum of each modifier value times its weight). A global max may allow equipment maximization to finish faster, since no further combinations will be considered once the specified value is reached.+
==Other Modifiers==
Boolean modifiers can also be used as keywords. With positive weight, the modifier is required to be true; with negative weight, it is required to be false. There is one shortcut available: sea requires both Adventure Underwater and Underwater Familiar to be true.

The only bitmap modifiers that currently appear useful for maximization are Clownosity and Raveosity, so they are allowed as a special case. The weight specifies the required minimum value; only one value is actually meaningful for each keyword, so 4 clownosity and 7 raveosity are the only useful forms.

String modifiers are not currently meaningful for maximization.
==Equipment==
Slot names can be used as keywords:
 hat, weapon, offhand, shirt, pants, acc1, acc2, acc3, familiar (stickers and fake hands are not currently planned.)
 With positive weights, only the specified slots will be considered for maximization. With negative weights, all but the specified slots will be considered.
 empty - With positive weight, consider only slots that are currently empty; with negative weight, only those that aren't empty. Either way, +slot and -slot can be used to further refine the selected slots.
 handed - With a weight of 1, only 1-handed weapons will be considered. With a larger weight, only weapons with at least that handedness will be considered.
 melee - With positive weight, only melee weapons will be considered. With negative weight, only ranged weapons will be considered.
 type text - Only weapons with a type containing text are considered; for example, type club if you plan to do some Seal Clubbing.
 shield - With positive weight, only shields will be considered for your off-hand. Implies 1 handed.
 equip item - The specified item is required (positive weight) or forbidden (negative weight). Multiple uses of +equip require all of the items to be equipped.
 outfit name - The specified standard outfit is required or forbidden. If the name is omitted, the currently equipped outfit is used. Multiple uses of +outfit are satisfied by any one of the outfits (since you can't be wearing more than one at a time).
 If both +equip and +outfit are used together, either one will satisfy the condition - all of the items, or one of the outfits. This special case is needed to be able to specify the conditions for adventuring in the Pirate Cove.
 tiebreaker - With negative weight, disables the use of a tiebreaker function that tries to choose equipment with generally beneficial attributes, even if not explicitly requested. There are only a few cases where this would be desirable: maximizing +combat or -combat (since there's usually only one item that can help), adv and/or PvP fights at rollover, and familiar weight when facing the Naughty Sorceress familiars.
==Familiars==
By default, the Modifier Maximizer does not recommend familiars, since there are many possible factors in choosing one beyond those that can be expressed via modifiers. However, you can request that specific familiars be compared with your current one:
 switch familiar - With positive weight, the familiar is added to the list to be considered (unless the player lacks that familiar, or is already using it, in which case there is no effect). With negative weight, the familiar is added to the list only if the player lacks the previously specified familiar. For example, switch hobo monkey, -switch leprechaun will only consider the leprechaun if the player doesn't have the monkey.
==Assumptions==
All suggestions are based on the assumption that you will be adventuring in the currently selected location, with all your current effects, prior to the next rollover (since some things depend on the moon phases). For best results, make sure the proper location is selected before maximizing. This is especially true in The Sea and clan dungeons, which have many location-specific modifiers.

Among effects, stat equalizer potions have a major effect on the suggested boosts, since they change the relative importance of additive and percentage stat boosts. Likewise, elemental phials make certain resistance boosts pointless. If you plan to use an equalizer or phial while adventuring, please use them first so that the suggestions take them into account.
==GUI Use==
If the Max Price field is zero or blank, the limit will be the smaller of your available meat, or your autoBuyPriceLimit (default 20,000). The other options should be self-explanatory.

You can select multiple boosts, and the title of the list will indicate the net effect of applying them all - note that this isn't always just the sum of their individual effects.
==CLI Use==
The Modifier Maximizer can be invoked from the gCLI or a script via maximize expression, and will behave as if you'd selected Equipment: on-hand only, Max Price: don't check, and turned off the Include option. The best equipment will automatically be equipped (unless you invoked the command as maximize? expression), but you'll still need to visit the GUI to apply effect boosts - there are too many factors in choosing between the available boosts for that to be safely automated. An error will be generated if the equipment changes weren't sufficient to fulfill all min keywords in the expression.
==Limitations & Bugs==
This is still a work-in-progress, so don't expect everything to work perfectly at the moment. However, here are some details that are especially broken:
* Items that can be installed at your campground for a bonus (such as Hobopolis bedding) aren't considered.
* Your song limit isn't considered when recommending buffs, nor are any daily casting limits.
* Mutually exclusive effects aren't handled properly.
* Weapon Damage, Ranged Damage, and Spell Damage are calculated assuming 100 points of base damage - in other words, additive and percentage boosts are considered to have exactly equal worth. It's possible that Weapon and Ranged damage might use a better estimate of the base damage in the future, but for Spell Damage, the proper base depends on which spell you end up using.
* Effects which vary in power based on how many turns are left (love songs, Mallowed Out, etc.) are handled poorly. If you don't have the effect, they'll be suggested based on the results you'd get from having a single turn of it. If you have the effect already, extending it to raise the power won't even be considered. Similar problems occur with effects that are based on how full or drunk you currently are.

=Useful Expressions=
'''MP regen''': .5 mp regen max, .5 mp regen min

'''Pirates''': mainstat, +outfit swashbuckling

'''War''': mainstat, +outfit frat warrior

'''Shieldbutting''': muscle, +shield

=More Information=

Here is the expression used as tiebreaker:

:"1 familiar weight, 1 familiar experience, 1 initiative, 5 exp, 1 item, 1 meat, 0.1 DA 1000 max, 1 DR, 0.5 all res, -10 mana cost, 1.0 mus, 0.5 mys, 1.0 mox, 1.5 mainstat, 1 HP, 1 MP, 1 weapon damage, 1 ranged damage, 1 spell damage, 1 cold damage, 1 hot damage, 1 sleaze damage, 1 spooky damage, 1 stench damage, 1 cold spell damage, 1 hot spell damage, 1 sleaze spell damage, 1 spooky spell damage, 1 stench spell damage, 1 critical, -1 fumble, 1 HP regen max, 3 MP regen max, 1 critical hit percent, 0.1 food drop, 0.1 booze drop, 0.1 hat drop, 0.1 weapon drop, 0.1 offhand drop, 0.1 shirt drop, 0.1 pants drop, 0.1 accessory drop, 1 DB combat damage";

See [http://kolmafia.us/showthread.php?4274 this thread] for details.

Talk:Modifier Maximizer

2010-06-20T10:02:12Z

Slyz: Created page with 'I keep getting questions from clannies, especially, on how to use this tool. Unfortunately, I don't know much beyond the basics, myself. So, if someone who DOES know the ins-and-…'

I keep getting questions from clannies, especially, on how to use this tool. Unfortunately, I don't know much beyond the basics, myself. So, if someone who DOES know the ins-and-outs could jot some info down, it would be much appreciated. --[[User:StDoodle|StDoodle (#1059825)]] 22:36, 19 June 2010 (UTC)

The core functionality is to maximize various [[modifiers]] according to certain parameters. A number preceding the modifier determines its weight -- this number (not restricted to integers) can be negative (for discouraged modifiers), zero (to ignore certain modifiers' effect), or positive (duh).

There's something about the +, but I'm not completely sure what it is. I think it's used to force an outfit (e.g. "item drop, +outfit hodg" when boss-killing), but I'm pretty sure there's something else to it. --[[User:Heeheehee|Heeheehee]] 02:33, 20 June 2010 (UTC)

Talk:Helpful Scripts

2010-06-08T02:36:17Z

Slyz: /* To list or not to list */ Forgot to sign earlier

One question -- should relay override scripts be distinguished from those that create entirely new pages, or should we just rename them to "relay browser scripts" (or something like that)? (Asking because I'm not entirely sure where the ZLib variable editor would fall.) --[[User:Heeheehee|Heeheehee]] 22:47, 1 June 2010 (UTC)

* That's a toughie! Dunno. Maybe we should categorize relay overrides based on what they do, rather than the fact that they work with the relay browser. So, my Slime Tubing override would go into Turn-burning while zlib variable editor can go under... I dunno, just tuck it right under zlib and nobody will get too upset about it I guess... --[[User:Bale|Bale]] 07:51, 2 June 2010 (UTC)
** I simply sorted them in function of the kolmafia subforum where they are located, but maybe other categories would be better, like "Quests", "Combat", "Relay Override", "User Interface Script", "Informational", "Libraries" etc... [[User:Slyz|Slyz]] 08:03, 2 June 2010 (UTC)
*** Both suggestions have merit, but I'm leaning a bit closer toward "new category", if not only because the UI scripts need to go in the relay folder, as opposed to the scripts folder. --[[User:Heeheehee|Heeheehee]] 02:15, 3 June 2010 (UTC)
** For everything other than UI scripts, the mafia subforum describes what they do. Even relay override scripts have the common element of modifying the KoL interface. However, the UI scripts do such wildly different things that they break the meaning of the categorization. Perhaps we'll just let UI scripts wander around this list based on their purpose. --[[User:Bale|Bale]] 09:07, 2 June 2010 (UTC)

Also, what format should we make the standard? Already I see two different ones: '''autoBasement''' - ([http://kolmafia.us/showthread.php?3113 download here]) '''Author:''' Rinn and '''ZLib''' by Zarqon ([http://kolmafia.us/showthread.php?2072 download here])

--[[User:Heeheehee|Heeheehee]] 22:51, 1 June 2010 (UTC)

* That was kinda a work in progress. I never intended to leave it with two different formats, I just ran out of time and had to quit half-way. It's settled now. Does it look good? --[[User:Bale|Bale]] 07:51, 2 June 2010 (UTC)
** Yup, looks great! (Also, I guessed that was the case after looking at the revision history a bit more carefully but wasn't entirely sure.) --[[User:Heeheehee|Heeheehee]] 02:15, 3 June 2010 (UTC)

I saw Icon315's edit to add his Daily Info script and thought that maybe script authors shouldn't put their own scripts on this page.
I don't have anything against Daily Info of course, and the original list was very subjective to start with, but I think we should put here other people's scripts that we think would be useful to a large community of Mafia users. Otherwise this page would end up being too big to actually be useful. Any thoughts on this?--[[User:Slyz|Slyz]] 14:08, 4 June 2010 (UTC)

*Sorry about that, i just thought it was really helpful. I won't add any more scripts to this page. Also if you want you can remove it.I do agree though --[[User:Icon315|Icon315]] 20:25, 4 June 2010 (UTC)
**No no, your edit just made me think about what people might start doing, maybe my wording wasn't well chosen. From reading your script's thread, it seems people do like it, and it is useful. I simply wanted to start a talk on how scripts get put here.--[[User:Slyz|Slyz]] 12:23, 5 June 2010 (UTC)
***Can I vouch for "if people other than the author refer to it to solve certain problems or whatever, then it's safe to put it on here"? That'd be at least one of the criteria, I'd hope. Also, for libraries, I guess if they're widely used or used by one of the scripts here? I'm still not sure whether to put my DateLib.ash on here, since it still seems like it'd be too limited in its applications. --[[User:Heeheehee|Heeheehee]] 15:30, 5 June 2010 (UTC)
***Agreed on both counts. A script here should have more than a handful of people that find it helpful. A library script (no matter how clever) shouldn't be listed unless there is more than 1 script on the mafia forum that makes use of it. --[[User:Bale|Bale]] 16:55, 5 June 2010 (UTC)

== To list or not to list ==

potionBuy? Seriously? I wrote the script, but I doubt it is really more than a marginal script of interest to edge cases. I've only been notified by 8 users. Do we want to make the list that complete? Or is it good to list such minor scripts.? --[[User:Bale|Bale]] 16:16, 6 June 2010 (UTC)
*Well hey, hatter.ash only has one notification. To be fair, it also isn't that old. Honestly, though, I don't know. We have examples of most of the other [[Miscellaneous_ASH_Features#Additional_Script_Uses|event-driven scripts]] listed, but those are more widely used and, well, more complex. --[[User:Heeheehee|Heeheehee]] 21:53, 6 June 2010 (UTC)
**By notifications do you mean the whole notify; thing? If so i don't think we should base the scripting on this too much. Mostly because there is a difference between Helpful and Not used. Also i think people remove that command from their scripts alot. My script has had many downloads but only half of that in notifications --[[User:Icon315|Icon315]] 23:08, 6 June 2010 (UTC)
**I would have put potionBuy up here, but I'm not sure it's still useful: doesn't Mafia check mall prices before creating things?--[[User:Slyz|Slyz]] 02:36, 8 June 2010 (UTC)
**Yes. Mafia even started detecting if saucerors would make three of them. potionBuy only exists for the neurotic. I've never really approved of it since it panders to people who believe making potions as a non-sauceror is never right. They're wrong. It's not really any use, except as an example of a buyScript. --[[User:Bale|Bale]] 19:25, 7 June 2010 (UTC)
***[http://kolmafia.us/showthread.php?2815-7760-Start-of-major-concoctions-overhaul-The-mixing-type-in-concoctions.txt-can-..&p=19190&viewfull=1#post19190 This post by JH] suggests otherwise -- if you have all the ingredients already, Mafia won't check prices. I haven't actually looked at the code, but it would make sense for Mafia to check prices for items you don't have at various stages of the process. --[[User:Heeheehee|Heeheehee]] 22:17, 7 June 2010 (UTC)

My 2 cents: there's merit in having an example of each unique type of script (in this case a buyScript), so I'd say even if it isn't what the author considers "top-tier," it's better than nothing. Also, wanted to chime in on the whole "listing one's own scripts" issue (but just haven't had much time lately): if one looks at the list of script authors, and then looks at the list of wiki contributors, one notices a lot of overlap. The list of currently-active KoLmafia enthusiasts is pretty small, and in large part said people contribute both in writing scripts and in editing the wiki. So I wouldn't worry about it, but if anyone reverts an addition, please discuss here before un-reverting. Though, since the list is pretty well fleshed out, it's less of an issue now. --[[User:StDoodle|StDoodle (#1059825)]] 02:09, 8 June 2010 (UTC)

Talk:Helpful Scripts

2010-06-07T14:21:01Z

Slyz: /* To list or not to list */

Talk:Helpful Scripts

2010-06-05T12:23:32Z

Slyz: learning about lists

Talk:Helpful Scripts

2010-06-05T12:23:08Z

Slyz: forgot to sign

Talk:Helpful Scripts

2010-06-05T12:22:30Z

Slyz:

Helpful Scripts

2010-06-04T14:25:22Z

Slyz: added Slime Vial Recipes, added description for hatter.ash and priceAdvisor

{{TOCright}}
This is a list of well written scripts that are currently being maintained for the latest version of KoL and KolMafia. All scripts on this list are free and certified safe for use without any hidden costs or malicious code. If these scripts become outdated for very long or any security risks are found they will be removed from this list, so users should feel free to make use of them.

Of course it is possible that one of these scripts can cause trouble for the user if they are not used properly, so please read the opening post in each thread linked before using that script.

==Turn-Burning Scripts==

'''autoBasement''' - ([http://kolmafia.us/showthread.php?3113 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automates delving into Fernswarthy's Basement.

'''bounty''' - ([http://kolmafia.us/showthread.php?1023-auto-BHH-and-friends&p=15204&viewfull=1#post15204 download here]) '''Author:''' [http://kolmafia.us/member.php?197-izchak izchak], [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automates the bounty gathering quest.
* In conjuction with SmartStasis combat script (below) it will also olfact the monster for the bounty.

'''CounterChecker''' - ([http://kolmafia.us/showthread.php?2519 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Automates semi-rare acquisition, use of dance cards and a few other counter related activities.

'''Dwarven Factory''' - ([http://kolmafia.us/showthread.php?2884 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* Automates the optional Dwarven Factory quest.

'''MacGuffin''' - ([http://kolmafia.us/showthread.php?1965 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Automation for the L11 MacGuffin Quest.

'''One-Click Wossname''' - ([http://kolmafia.us/showthread.php?960 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* A complete script for completing the L12 Island War quest.
* It allows you to chose the medal you are rewarded with, including a Wossname.

'''Rinn's Quest Scripts''' - ([http://kolmafia.us/showthread.php?2584 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]
* Automation for most of the game's quests.

'''Slime Tube Adventuring Script''' - ([http://kolmafia.us/showthread.php?2596 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=alhifar Alhifar]
* Complete automation for the Slime Tube.
* You set up the outfits for maximum ML and minimum ML. The script then switches between them.
* It even allows you to chose to kill or tatter slimes.
* The variety of options allows every type of Slime Tube play, even a slimeling run, to be automated.

==Relay Override Scripts==

'''clan_basement.ash''' - ([http://kolmafia.us/showthread.php?4137 download here]) '''Author:''' Heeheehee
* Sorts dungeon loot by boss, presenting Hobopolis loot before Slime Tube loot.

'''pyramid.ash''' - ([http://kolmafia.us/showthread.php?3922 download here]) '''Author:''' Heeheehee
* Disables potentially harmful links in the Pyramid.

'''shore.ash''' - ([http://kolmafia.us/showthread.php?2813 download here]) '''Author:''' [http://kolmafia.us/member.php?872-lostcalpolydude lostcalpolydude] and [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you take a vacation it reminds you of which shore items you might need for floor 6 of the Sorceress' Tower.
* It uses the telescope to determine the exact item needed if you have a full scope.
* It also keeps you from taking a vacation at level 11 unless you have the forged documents 'cause it sucks to lose those three adventures accidentally.

'''Telescope Information''' - ([http://kolmafia.us/showthread.php?4057 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* When you look through the telescope at your campsite it will explain what monsters you will meet at the lair and the item to defeat them.
* Tells you if you have the items. If you need any items it tells you where to find them.

'''woods.ash''' - ([http://kolmafia.us/showthread.php?4199-Acquire-Continuum-Transfunctioner&p=29908&viewfull=1#post29908 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Gets the Continuum Transfunctioner automatically on your first visit to the woods. You will not need to click anything, it just happens.

===User Interface Scripts===

These scripts are a special type of relay override scripts in that they create pages that do not exist as part of KoL. They are prefixed by "relay_" and must be placed in the user's \relay directory. These scripts are accessed via the "-run script-" dropdown menu in the relay browser.

'''Daily Info''' - ([http://kolmafia.us/showthread.php?4248 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=icon315 Icon315]
*This script shows you the daily information such as:
**The moons' effects on various modifiers
**Current stat day
**Daily Dungeon rooms

'''relay_SlimeTube''' - ([http://kolmafia.us/showthread.php?2596-Slime-Tube-Adventuring-Script&p=29687&viewfull=1#post29687 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
*Adapted from Alhifar's Slime Tube Adventuring Script, this UI script enables the user to configure the Slime Tube script without having to modify the base script.

'''ZLib Variable Editor''' - ([http://kolmafia.us/showthread.php?4081 download here]) '''Author:''' Heeheehee
*This script provides a more user-friendly interface for modifying ZLib variables.

==Custom Combat Scripts==

'''First Things First''' - ([http://kolmafia.us/showthread.php?1255 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Takes care of the first few things needed in a fight: pickpocketing, entangling noodles, olfaction, spooky putty, etc
* Includes quest related events: insulting pirates, throwing flyers, driving away clingy pirates if clingfilm is not needed, etc.

'''SmartStasis''' - ([http://kolmafia.us/showthread.php?1715 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Includes everything from First Things First. (Requires that to be downloaded also.)
* Stasises monsters for a variety of reasons: starfishing, hobo monkey meat.
* Notices when the monkey steals and recognizes if your slimeling or other chargeable starfish is out of juice and stops stasising.
* Quest related stasis: Using molybdenum magnet on the correct gremlin, getting essence in Seaside Megalopolis, learning dance moves Outside the Club.
* Uses disco combos and rave combos when they improve your profit.

==Buff Upkeep Scripts==

'''acquireBuff''' - ([http://kolmafia.us/showthread.php?4048 download here]) '''Author:''' [http://kolmafia.us/member.php?46-Rinn Rinn]

'''Best Between Battle Script Ever''' - ([http://kolmafia.us/showthread.php?1240 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]

'''hatter.ash''' - ([http://kolmafia.us/showthread.php?4262 download here]) '''Author:''' [http://kolmafia.us/member.php?2677-That-FN-Ninja That FN Ninja]
* To get a specific Mad Hatter buff painlessly.

'''Universal Recovery''' - ([http://kolmafia.us/showthread.php?1780 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Improves mafia's automated recovery to make best use of all items in hardcore/ronin or conserve meat if you have mall access.
* Keeps spare mp healing items on-hand in case they are needed in combat.
* Conserves healing items for use against your Shadow.
* Removes poison and keeps some extra antidotes for use in combat.

'''VIP Hopping''' - ([http://kolmafia.us/showthread.php?3620-VIP-Hopping!-Quick-clanhop-to-BAfH-for-all-VIP-room-goodies! download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Automatically hops over the clan Bonus Adventures from Hell to get something (buff, crimbo present, etc) from the VIP Lounge, then it hops back to your regular clan.
* If you don't have a membership in Bonus Adventures from Hell, it will submit a request to join the clan so that you can get access to the fully stocked VIP Lounge.

==Item Handling Scripts==

'''PriceAdvisor''' - ([http://kolmafia.us/showthread.php?3110 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Gives advice on how to maximize profit from an item.

'''Rainbow Gravitation made easy''' - ([http://kolmafia.us/showthread.php?1929 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* In hardcore/ronin it handles automatic wad transmutation to enable easy creation of Rainbow Wads.
* With mall access, it will purchase necessary wads to use daily casts of Rainbow Gravitation.

'''Scripting the birth of a new life''' - ([http://kolmafia.us/showthread.php?2769 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Sets optimal choice adventures based on current class for your ascension. Perfect to run at the beginning of a new life.
* Manages simple tasks that are always run at the beginning of a new life like pulling your VIP Lounge Key and visiting the Toot Oriole.

==Informational Scripts==

'''bumcheekcity's Easy Wiki Snapshot Maker''' - ([http://kolmafia.us/showthread.php?3001 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bumcheekcity bumcheekcity]
* This script will collect information about your character and generate a profile to display on [http://bumcheekcity.com/kol/profile.php bumcheekcity's website].

'''EatDrink.ash: Optimize your daily diet''' - ([http://kolmafia.us/showthread.php?1519 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d]

'''StDoodle's Custom Daily Deeds''' - ([http://kolmafia.us/showthread.php?3443 download here]) '''Author:''' [http://kolmafia.us/member.php?720-StDoodle StDoodle]

'''Slime Vial Recipes''' - ([http://kolmafia.us/showthread.php?3544-Slime-vial-recipes&p=25337&viewfull=1#post25337 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* This script will help you get the [http://kol.coldfront.net/thekolwiki/index.php/Color_Wheel_of_Yuck Color Wheel of Yuck] trophy by using the vials in your inventory to create slime potions you do not know yet.

'''What are you worth?''' - ([http://kolmafia.us/showthread.php?2628-What-are-you-worth-networth.ash-will-tell-you.&p=24990&viewfull=1#post24990 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=dj_d dj_d] and [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* This calculates the current value of all items you own and informs you of what you are worth.

==Script Libraries==
These scripts are libraries of functions that are required components of other scripts. By themselves they do little or nothing. Expect to download them when directed in a script's instructions, or if you want to be a scripter, then study them and learn.

'''HTMLform''' - ([http://kolmafia.us/showthread.php?3842 download here]) '''Author:''' [http://kolmafia.us/member.php?1017-jasonharper jasonharper]
* Library of functions used for creating forms in [[Relay_Override_Scripting#User_Interface_Script|relay interface scripts]].

'''SmashLib''' - ([http://kolmafia.us/showthread.php?3065 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=aqualectrix aqualectrix]
* Determines the results of pulverizing equipment and reports it for use by scripts or aliases.

'''ZLib''' - ([http://kolmafia.us/showthread.php?2072 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=zarqon zarqon]
* Ultimate toolbox of scripting functions for math, string manipulation, version checking, automatic mapfile updating, persistent variables, adventuring, kmailing and so much more. ''Many'' scripts require this.

==Misc==

'''Clan Hopping''' - ([http://kolmafia.us/showthread.php?2071 download here]) '''Author:''' [http://zachbardon.com/mafiatools/details.php?a=bale Bale]
* Hop to a whitelisted clan quickly and easily from the CLI.

Talk:Helpful Scripts

2010-06-04T14:08:21Z

Slyz:

Talk:Helpful Scripts

2010-06-02T08:03:52Z

Slyz:

User:Slyz

2010-06-01T17:23:42Z

Slyz: Created page with '==Turn-Burning Scripts== *'''autoBasement''' by Rinn (http://kolmafia.us/showthread.php?3113) *'''Rinn's Quest Scripts''' by Rinn (http://kolmafia.us/showthread.php?2584) *'''S…'

==Turn-Burning Scripts==

*'''autoBasement''' by Rinn (http://kolmafia.us/showthread.php?3113)
*'''Rinn's Quest Scripts''' by Rinn (http://kolmafia.us/showthread.php?2584)
*'''Slime Tube Adventuring Script''' by Alhifar ( http://kolmafia.us/showthread.php?2596)
*'''One-Click Wossname''' by zarqon (http://kolmafia.us/showthread.php?960)
*'''MacGuffin''' by zarqon (http://kolmafia.us/showthread.php?1965)
*'''CounterChecker''' by Bale (http://kolmafia.us/showthread.php?2519)
*'''Dwarven Factory''' by That FN Ninja (http://kolmafia.us/showthread.php?2884)

==Relay Override Scripts==

*'''Telescope Information''' by Bale (http://kolmafia.us/showthread.php?4057)
*'''shore.ash''' by lostcalpolydude and Bale (http://kolmafia.us/showthread.php?2813)
*'''woods.ash''' by Bale (http://kolmafia.us/showthread.php?4199-Acquire-Continuum-Transfunctioner&p=29908&viewfull=1#post29908)

==Custom Combat Scripts==

*'''First Things First''' by zarqon (http://kolmafia.us/showthread.php?1255)
*'''SmartStasis''' by zarqon (http://kolmafia.us/showthread.php?1715)

==Buff Upkeep Scripts==

*'''Universal Recovery''' by Bale (http://kolmafia.us/showthread.php?1780)
*'''Best Between Battle Script Ever''' by zarqon (http://kolmafia.us/showthread.php?1240)
*'''hatter.ash''' by That FN Ninja (http://kolmafia.us/showthread.php?4262)
*'''acquireBuff''' by Rinn (http://kolmafia.us/showthread.php?4048)

==Item Handling Scripts==

*'''Rainbow Gravitation made easy''' by Bale (http://kolmafia.us/showthread.php?1929)
*'''Scripting the birth of a new life''' by Bale (http://kolmafia.us/showthread.php?2769)
*'''PriceAdvisor''' by aqualectrix (http://kolmafia.us/showthread.php?3110)

==Informational Scripts==

*'''What are you worth?''' by dj_d and zarqon (http://kolmafia.us/showthread.php?2628-What-are-you-worth-networth.ash-will-tell-you.&p=24990&viewfull=1#post24990)
*'''bumcheekcity's Easy Wiki Snapshot Maker''' by bumcheekcity (http://kolmafia.us/showthread.php?3001)
*'''EatDrink.ash: Optimize your daily diet''' by dj_d (http://kolmafia.us/showthread.php?1519)
*'''StDoodle's Custom Daily Deeds''' by StDoodle (http://kolmafia.us/showthread.php?3443)

==Misc==

*'''Clan Hopping''' by Bale (http://kolmafia.us/showthread.php?2071)

Talk:Relay Override Scripting

2010-04-18T08:43:32Z

Slyz:

Icon's edit reminds me; we should note the difference between regular relay override scripts and the brand-new "relay_" scripts. For the former, it should be noted as BAD PRACTICE to completely ignore the unmodified page (as that could really bork things). But for the latter, it's fairly likely you'll be doing the entire page write from your script.--[[User:StDoodle|StDoodle (#1059825)]] 12:56, 12 April 2010 (UTC)

What would be a good name for those? Scripts with Graphical Interfaces? Relay scripts?
--[[User:Slyz|Slyz]] 08:43, 18 April 2010 (UTC)

Talk:ASH Errors

2010-04-18T08:36:08Z

Slyz:

Is this like were things like Script parsing error (X.ash, line Y) are listed?--[[User:Icon315|Icon315]] 22:33, 14 April 2010 (UTC)

:It's where they WILL be listed, once they are listed. --[[User:Bale|Bale]] 22:52, 14 April 2010 (UTC)

What Bale said. Also, I changed that to orange; I kept trying to click on it. :( --[[User:StDoodle|StDoodle (#1059825)]] 00:35, 15 April 2010 (UTC)

Also, if anyone's feeling particularly ambitious, https://kolmafia.svn.sourceforge.net/svnroot/kolmafia/src/net/sourceforge/kolmafia/textui/Parser.java should help. Just look for all the instances of parseException. (Speaking of which, would it be useful if these were presented in the order that they're checked?) --[[User:Heeheehee|Heeheehee]] 00:17, 17 April 2010 (UTC)

I think alphabetical order would be better: this page is going to be excellent for first-time ASH scripters to understand what's wrong with their script. --[[User:Slyz|Slyz]] 10:41, 17 April 2010 (UTC)

Should we add the correct examples? Or are the fixes clear enough?
--[[User:Slyz|Slyz]] 08:36, 18 April 2010 (UTC)

ASH Errors

2010-04-18T08:35:14Z

Slyz: /* Variable is already defined */ Oh my grammar! 'Tis that of a fawning pox-marked flax-wench!

Extract meat

2010-04-17T11:27:29Z

Slyz: removed RFI - no other matches will work

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

FunctionPage|
name={{#var:name}}|
function_category=String Handling Routines|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|text}}|
p1desc={{Pspan|text}} is the string to search|
}}|

function_description=This function searches your supplied {{pspan|text}}, searching for either the phrase "You gain X Meat" or "You lose X Meat" and returns X. For "gain" X will be positive, and for "lose" negative. The number X can be formatted with or without commas. Note that the phrases to search are both case-sensitive (it will not match on "You gain 10 meat"). This function can be used for parsing meat gains and losses from combat and kmails (though additional parsing is necessary for kmail to avoid considering the text of the kmail itself, which could contain the meat gain/loss string).|

needscode=yes|

see_also={{SeeAlso|extract_items}}|
special=This function returns 0 if it does not find a match.
}}

Talk:Extract meat

2010-04-17T11:27:04Z

Slyz: Created page with 'From what I can gather in the mafia source, only "You gain" and "You loose" will result in a match. --~~~~'

From what I can gather in the mafia source, only "You gain" and "You loose" will result in a match.
--[[User:Slyz|Slyz]] 11:27, 17 April 2010 (UTC)

ASH Errors

2010-04-17T10:42:49Z

Slyz:

Talk:ASH Errors

2010-04-17T10:41:33Z

Slyz:

ASH Errors

2010-04-17T10:34:37Z

Slyz: /* Record name is already defined */

ASH Errors

2010-04-17T10:33:50Z

Slyz: /* Invalid field name */

ASH Errors

2010-04-17T10:32:33Z

Slyz: /* Variable is already defined */

ASH Errors

2010-04-17T10:31:53Z

Slyz: /* Variable is already defined */ the problem isn't the name, it's declaring the same variable twice.

ASH Errors

2010-04-16T17:35:53Z

Slyz:

Errors happen.

Also, I don't happen to have this page done, yet.

===Abort===

Whenever a script runs the [[abort|abort()]] function, this error is generated.

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
abort("Aborting script...");
</syntaxhighlight>}}
will stop the execution and print: Aborting script...

===Expected===

This generally indicates a syntax problem (missing ending semi-colon, unmatched braces, unmatched parenthesis etc...).

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int a = 1
print(a);
</syntaxhighlight>}}
will cause this error: Expected ;, found print (test.ash, line 2)

===Missing return value===

The last line of a user-defined function has to be "return <value>;" (although the [[return]] command can be used before too).

{{CodeSample|
description=Example:|
code=
<syntaxhighlight>
int my_function( int a, int b ) {
if ( a > b ) return a ;
else return b ;
}
</syntaxhighlight>}}
will cause this error: Missing return value (test.ash, line 4)

{{RFI|Obviously, a lot more info is needed here.}}

ASH Errors

2010-04-16T17:34:46Z

Slyz: someone might want to check the formatting

Errors happen.

Also, I don't happen to have this page done, yet.

===Abort===

Whenever a script runs the [[abort|abort()]] function, this error is generated.

{{CodeSample|
description=Example|
code=
<syntaxhighlight>
abort("Aborting script...");
</syntaxhighlight>}}
will stop the execution and print: Aborting script...

===Expected===

This generally indicates a syntax problem (missing ending semi-colon, unmatched braces, unmatched parenthesis etc...).

{{CodeSample|
description=Example|
code=
<syntaxhighlight>
int a = 1
print(a);
</syntaxhighlight>}}
will cause this error: Expected ;, found print (test.ash, line 2)

===Missing return value===

The last line of a user-defined function has to be "return <value>;" (although the [[return]] command can be used before too).

{{CodeSample|
description=Example|
code=
<syntaxhighlight>
int my_function( int a, int b ) {
if ( a > b ) return a ;
else return b ;
}
</syntaxhighlight>}}
will cause this error: Missing return value (test.ash, line 4)

{{RFI|Obviously, a lot more info is needed here.}}

Miscellaneous ASH Features

2010-04-14T21:55:11Z

Slyz: added some additional scripts and their associated preferences

{{TOCright}}
==Special Syntax Functions==

'''[[notify]]'''

'''[[import]]'''

==Comments==

Adding '''[[Comments]]''' to your code can make it much easier to maintain, and helps other users understand what's going on.

==Errors==

For help when things go wrong, please see the page on [[ASH Errors]].

==Additional Script Uses==

In addition to regular menu-or-CLI-selectable scripts and relay override scripts, you can also use a script for:
* Login (loginScript)
* Logout (logoutScript)
* Recovery (recoveryScript)
* Between Battle (betweenBattleScript)
* Buy (buyScript)
* Chatbot (chatbotScript)
* Planting (plantingScript)
* Pre Ascension (preAscensionScript)
* Post Ascension (postAscensionScript)
* Counters (counterScript)
* ??
* Profit (profitScript?)

==A little CLI help==

Two CLI commands are of great use to ASH scripters:
* [[ashref]] allows one to get a list of ASH functions
* [[ash (CLI)|ash]] or [[ash (CLI)|ashq]] allows one to run ASH directly on the CLI.

{{RFI|Where are all the other places a script can be used? Help plox.}}

Talk:To upper case

2010-04-14T21:45:00Z

Slyz:

Best code sample EVER!

Now think of what Nigerian princes can achieve with kmails! [[User:Slyz|Slyz]] 21:45, 14 April 2010 (UTC)

To upper case

2010-04-14T21:43:47Z

Slyz: best code sample ever was using to_lower_case()

{{
#vardefine:name|to_upper_case}}{{
#vardefine:return_type|string}}{{

FunctionPage|
name={{#var:name}}|
function_category=String Handling Routines|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|text}}|
p1desc={{Pspan|text}} is the original string|
}}|

function_description=Converts all lower-case alphabetic characters (a-z) found in {{pspan|text}} to their upper-case equivalents (A-Z) and returns the resulting string.|

code1={{CodeSample|
title=Code Sample|
description=Turns "normal" text into "loud" text.|
code=
<syntaxhighlight>
string s = "hi i am a nigerian prince, would you like 1 million us dollar?";
s = to_upper_case(s);
print(s);
</syntaxhighlight>|
moreinfo=
Returns:<pre>HI I AM A NIGERIAN PRINCE, WOULD YOU LIKE 1 MILLION US DOLLAR?</pre>}}|

see_also={{SeeAlso|to_lower_case}}|
}}
{{RFI|Does this have any effect on accented / tilded characters?}}

Get power

2010-04-14T18:54:02Z

Slyz:

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

FunctionPage|
name={{#var:name}}|
function_category=Item Management|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|it}}|
p1desc={{Pspan|it}} is the item to check for.
}}|

function_description=Returns the power of the item {{pspan|it}} or 0 if the item doesn't have a power|

}}

Item Management

2010-04-14T18:53:19Z

Slyz: add get_power()

{{TOCright}}
==Informational==
{{Flink|int|my_meat|desc=Returns the amount of meat you have on hand.}}
{{Flink|int|my_closet_meat|desc=Returns the amount of meat you have in your Colossal Closet.}}
{{Flink|int|pulls_remaining|desc=Returns the number of pulls you can make from storage, or 0 if not applicable.}}
{{Flink|boolean|have_chef|desc=Returns true if you have a chef-boxen at your campground.}}
{{Flink|boolean|have_bartender|desc=Returns true if you have a bartender-boxen at your campground.}}
{{Flink|int [item]|get_campground|desc=Returns a map of your campground items.}}
{{Flink|boolean|have_mushroom_plot|desc=Returns true if and only if you've purchased a mushroom plot this run.}}
{{Flink|int|stills_available|desc=Returns the number of Nash Crosby's Still uses left for the day (0 if not accessible).}}
{{Flink|int|item_amount|item}}
{{Flink|int|closet_amount|item}}
{{Flink|int|display_amount|item}}
{{Flink|int|equipped_amount|item}}
{{Flink|int|shop_amount|item}}
{{Flink|int|stash_amount|item|}}
{{Flink|int|storage_amount|item|desc=These 7 functions return the total number available of a given item in the respective section of your inventory.}}
{{Flink|int|available_amount|item|desc=Returns the total number available of a given item in all inventory sections accessible to your character based on current restrictions.}}
{{Flink|int|creatable_amount|item|desc=Returns the amount of the item that you are capable of creating given your current inventory and skills.}}
{{Flink|int [item]|get_ingredients|item|desc=Returns a map where each key is one of the required ingredients, with the integer value the number required. If you don't have the skills needed to make the item, it will return an empty map.}}
{{Flink|int [item]|get_inventory|desc=Returns a map where each key is an item in your inventory, with the integer value its quantity.}}
{{Flink|int [item]|get_related|item|string|desc=Returns associated items in a zap or fold group (see page for details).}}
{{Flink|boolean|is_tradeable|item|desc=Returns whether the item can be placed in the mall.}}
{{Flink|boolean|is_giftable|item|desc=Returns whether the item can be traded in a gift package.}}
{{Flink|boolean|have_shop|desc=Returns whether you have a mall store.}}
{{Flink|boolean|have_display|desc=Returns whether you have a display case.}}
{{Flink|boolean|is_displayable|item|desc=Returns whether the item can be put in a display case (true for all but quest items).}}
{{Flink|boolean|is_npc_item|item|desc=Returns whether the item can be bought from an NPC store.}}
{{Flink|void|refresh_stash|desc=Takes a new look at the contents of your clan stash, as that section of inventory cannot be internally tracked due to access by others.}}
{{Flink|boolean|mall_price|item|desc=Returns the current (lowest) mall price of the given item.}}
{{Flink|int|autosell_price|item|desc=Returns the autosell price of the item (0 for items that cannot be autosold).}}
{{Flink|int|get_power|item|desc=Returns the power of the item (0 for items that don't have a power).}}
{{Flink|string|to_plural|item|desc=Returns the plural of an item as a string.}}
{{Flink|int|meat_drop|{{opt|monster}}|desc=Returns a certain monster's base meat drop.}}
{{Flink|int [item]|item_drops|{{opt|monster}}|desc=Returns an array of a certain monster's base item drops, keying item to drop rate. Has certain limitations detailed on individual page.}}
{{Flink|record [int]|item_drops_array|{{opt|monster}}|desc=Returns an array of records holding information regarding a certain monster's base item drops.}}

==Moving Items Around==
{{Flink|boolean|put_closet|int|{{opt|item}}}}
{{Flink|boolean|put_display|int|item}}
{{Flink|boolean|put_stash|int|item}}
{{Flink|boolean|take_closet|int|{{opt|item}}}}
{{Flink|boolean|take_display|int|item}}
{{Flink|boolean|take_stash|int|item}}
{{Flink|boolean|take_storage|int|item|desc=Attempts to take or put the specified item in the appropriate section of your inventory, and returns its success. If the item parameter is omitted from put_closet() or take_closet(), meat is transferred instead of an item.}}
{{Flink|boolean|put_shop|int|int|{{opt|int}}|item|desc=Puts items in your store (see page for details).}}

==Acquiring & Using Items==
{{Flink|boolean|retrieve_item|int|item|desc=Uses KoLmafia internal logic to gather items (see page for details).}}
{{Flink|boolean|hermit|int|item|desc=Trades worthless items (adventuring in the sewer if needed) to the hermit for specified items (see page for details).}}
{{Flink|boolean|use|int|item|desc=Attempts to use items as specified and reports success.}}
{{Flink|boolean|eatsilent|int|item}}
{{Flink|boolean|eat|int|item|desc=Attempts to eat items as specified and reports success.}}
{{Flink|boolean|overdrink|int|item}}
{{Flink|boolean|drink|int|item|desc=Attempts to drink items as specified and reports success.}}
{{Flink|boolean|create|int|item|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}
{{Flink|boolean|buy|int|item}}
{{Flink|int|buy|int|item|int|desc=Tries to purchase the specified items (see page for details).}}
{{Flink|boolean|autosell|int|item|desc=Attempts to autosell the given items and reports success.}}
{{Flink|int|craft|string|int|item|item|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}

Get power

2010-04-14T18:51:15Z

Slyz: Created page with '{{ #vardefine:name|get_power}}{{ #vardefine:return_type|int}}{{ FunctionPage| name={{#var:name}}| function_category=Item Management| function1={{Function| name={{#var:name}}| a…'

KoLmafia Guide: Attack Script

2010-04-12T09:21:56Z

Slyz:

Now we are going to fight a foe using a Mafia script instead of our standard method. It is very easy!

1) In the Mafia frame with the Adventure Top Tab active, on the far right there is a pulldown that is labeled 'Action:'. It defaults to 'Attack with Weapon'. Not surprisingly, when auto-combat is activated the script will keep attacking until the combat is over. By clicking this pulldown, you can choose several other options, based on what your character has available. For example, you can have it spam Thrust-Smack, or cast a spell, or whatever.
For now, either stick with weapon-attack, or casting a low MP offensive spell.

You can click in the bar below that lableled 'Special:' to set up any special beginning-of-fight actions. For example, as a Moxie-Class, an option is for Mafia to automatically pickpocket all non-bosses if you win initiative. If you are a moxie-class, pick this option. You can also autocast Noodles (if you don't have the skill, nothing will happen). When selected, a corresponding symbol shows up in the Special Box.

: [[File:Lesson4 actions.png]]

2) In your relay browser, go fight something easy but takes a few rounds to kill. If you use Combat Action Bars, click the 'Script' button. If you don't use action bars, Mafia adds several buttons for easier combat and the 'Script' will be one of them.

3) The script will execute, which will pickpocket if possible (if you are a Moxie class, noodle if Myst,etc.), and then spam the default action until the fight is over. Cool huh? No more clicking the Attack button 6 times every fight! If you run out of mana, it will try to recover mana or default to a weapon attack. (more on this later).

You will notice the fight will go a lot faster too in that it will appear to 'skip rounds'. This is because KoLMafia can send commands and receive results back faster than your browser will refresh. Hence a 12 round fight may only take 3 or 4 refreshes. This speeds up fighting significantly.

BOTTOM LINE: You can save clicks and lag by using the Script button to fight easy battles for you.

Continue to [[KoLmafia Guide: Custom Combat Script|Lesson 5: Custom Combat Script]]

[[Category:KoLmafia Guide]]

Replace string

2010-04-12T08:51:13Z

Slyz: replaced \" with ' in the code sample for easier reading

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

FunctionPage|
name={{#var:name}}|
function_category=String Handling Routines|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|buffer|original}}|
parameter2={{Param|string|find}}|
parameter3={{Param|string|replace}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|original}}|
parameter2={{Param|string|find}}|
parameter3={{Param|string|replace}}|
p1desc={{Pspan|original}} is the starting string or buffer|
p2desc={{Pspan|find}} is the text to find in {{pspan|original}}|
p3desc={{Pspan|replace}} is the text to substitute for {{pspan|find}}|
}}|

function_description=Searches through the supplied {{pspan|original}} text, replacing every instance of {{pspan|find}} with {{pspan|replace}}, and returns the result.|
code1={{CodeSample|
title=Code Sample|
description=Replaces the center image of the Cyrpt (it's blank, don't worry) with some information regarding the noncombats of the zones.|
code=<syntaxhighlight>
void main()
{
buffer results;
results.append(visit_url());

string cyrpt = "<- Muscle     Mys -> <- Mox     All ->";
results.replace_string("<img src='http://images.kingdomofloathing.com/otherimages/cyrpt/cyrpt5.gif'>", cyrpt);

results.write();
}
</syntaxhighlight>}}|

special=Matches are made left-to-right, and once a portion of the supplied {{pspan|original}} is noted as a match, searching continues from the next character after said match.|
}}

Talk:Use familiar

2010-04-10T03:34:09Z

Slyz:

This always seems to return false for me, can anyone confirm? 
--[[User:Slyz|Slyz]] 20:56, 9 April 2010 (UTC)

> ash use_familiar($familiar[sandworm])

Putting Mexicana the Hovering Sombrero back into terrarium... 
Taking Hecho en Mexico the Baby Sandworm out of terrarium... 
Returned: true 
I assume that the ash command should be enough to check return value; correct me if I'm wrong. --[[User:Heeheehee|Heeheehee]] 21:03, 9 April 2010 (UTC)

I'll have to recheck after RO, but here is what I was getting (doing things slightly differently):

> ash print( use_familiar($familiar[slimeling]) )

Putting Dusty the Baby Sandworm back into terrarium... 
Taking Yuk the Slimeling out of terrarium... 
false 
Returned: void 
--[[User:Slyz|Slyz]] 03:33, 10 April 2010 (UTC)

Talk:Use familiar

2010-04-10T03:33:34Z

Slyz:

This always seems to return false for me, can anyone confirm?
--[[User:Slyz|Slyz]] 20:56, 9 April 2010 (UTC)

> ash use_familiar($familiar[sandworm])

Putting Mexicana the Hovering Sombrero back into terrarium... 
Taking Hecho en Mexico the Baby Sandworm out of terrarium... 
Returned: true 
I assume that the ash command should be enough to check return value; correct me if I'm wrong. --[[User:Heeheehee|Heeheehee]] 21:03, 9 April 2010 (UTC)

I'll have to recheck after RO, but here is what I was getting (doing things slightly differently):

> ash print( use_familiar($familiar[slimeling]) )

Putting Dusty the Baby Sandworm back into terrarium...
Taking Yuk the Slimeling out of terrarium...
false
Returned: void
--[[User:Slyz|Slyz]] 03:33, 10 April 2010 (UTC)

Talk:Use familiar

2010-04-10T03:33:07Z

Slyz:

This always seems to return false for me, can anyone confirm? [[User:Slyz|Slyz]] 20:56, 9 April 2010 (UTC)

> ash use_familiar($familiar[sandworm])

Putting Mexicana the Hovering Sombrero back into terrarium... 
Taking Hecho en Mexico the Baby Sandworm out of terrarium... 
Returned: true 
I assume that the ash command should be enough to check return value; correct me if I'm wrong. --[[User:Heeheehee|Heeheehee]] 21:03, 9 April 2010 (UTC)

I'll have to recheck after RO, but here is what I was getting (doing things slightly differently):

> ash print( use_familiar($familiar[slimeling]) )

Putting Dusty the Baby Sandworm back into terrarium...
Taking Yuk the Slimeling out of terrarium...
false
Returned: void[[User:Slyz|Slyz]] 03:33, 10 April 2010 (UTC)

Talk:Use familiar

2010-04-09T20:56:09Z

Slyz: Created page with 'This always seems to return false for me, can anyone confirm? ~~~~'

This always seems to return false for me, can anyone confirm? [[User:Slyz|Slyz]] 20:56, 9 April 2010 (UTC)

Use familiar

2010-04-09T20:55:14Z

Slyz: return value is boolean, not familiar

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

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

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|familiar|buddy}}|
p1desc={{Pspan|buddy}} is the familiar to equip|
}}|

function_description=Switches your current familiar for the the familiar {{pspan|buddy}} specified. Returns true if the specified familiar {{pspan|buddy}} is your current familiar after the function's completion (so it will return true if you try to switch to your current familiar).|

needscode=yes|

see_also={{SeeAlso|have_familiar}}|
cli_equiv=The CLI command "familiar" has the same function when a familiar type is specified as the only parameter.|
}}