Kolmafia - User contributions [en]

KoLmafia Properties

2017-09-10T18:45:43Z

Theo: /* User-defined variables */

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

==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
| false
|
|-
| autoSatisfyWithCoinmasters
| false
|
|-
| autoSatisfyWithMall
| false
|
|-
| autoSatisfyWithNPCs
| false
|
|-
| autoSatisfyWithStash
| false
|
|-
| autoSatisfyWithStorage
| true
|
|-
| 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
|
|-
| checkJackassHardcore
| true
|
|-
| checkJackassSoftcore
| true
|
|-
| cloverProtectActive
| true
|
|-
| coinMasterIndex
| 1
|
|-
| combatHotkey0
|
|
|-
| combatHotkey1
|
|
|-
| combatHotkey2
|
|
|-
| combatHotkey3
|
|
|-
| combatHotkey4
|
|
|-
| combatHotkey5
|
|
|-
| combatHotkey6
|
|
|-
| combatHotkey7
|
|
|-
| combatHotkey8
|
|
|-
| combatHotkey9
|
|
|-
| commandLineNamespace
|
|
|-
| connectViaAddress
| false
|
|-
| cookies.inventory
|
|
|-
| copyAsHTML
| false
|
|-
| customizedTabs
| false
|
|-
| dailyDeedsOptions
| Breakfast,Daily Dungeon,Submit Spading Data,Chips,Library Card,Telescope,Ball Pit,Styx Pixie,VIP Pool,Swimming Pool,April Shower,Bag o' Tricks,Legendary Beat,Outrageous Sombrero,Feast,Friars,Skate Park,Concert,Demon Summoning,Rage Gland,Free Rests,Hot Tub,Nuns,Oscus' Soda,Express Card,Flush Mojo,Pudding,Hatter,Melange,Ultra Mega Sour Ball,Stills,Photocopy,Putty,Camera,Banished Monsters,Romantic Arrow,Avatar of Jarlberg Staves,Bonus Adventures,Familiar Drops,Free Fights,Free Runaways,Defective Token
|
|-
| dailyDeedsVersion
| 8
|
|-
| debugBuy
| false
|
|-
| debugConsequences
| false
|
|-
| debugFoxtrotRemoval
| false
|
|-
| debugPathnames
| true
|
|-
| defaultBorderColor
| blue
|
|-
| defaultDropdown1
| 0
|
|-
| defaultDropdown2
| 1
|
|-
| defaultDropdownSplit
| 0
|
|-
| defaultLimit
| 5
|
|-
| defaultLoginServer
| 1
|
|-
| displayName
|
|
|-
| externalEditor
|
|
|-
| fixedThreadPoolSize
| 0
|
|-
| gapProtection
| false
|
|-
| 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
|
|
|-
| https.proxyHost
|
|
|-
| https.proxyPassword
|
|
|-
| https.proxyPort
|
|
|-
| https.proxyUser
|
|
|-
| initialDesktop
| AdventureFrame,CommandDisplayFrame,<br />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
|
|-
| logChatRequests
| false
|
|-
| logCleanedHTML
| false
|
|-
| logDecoratedResponses
| false
|
|-
| logFamiliarActions
| true
|
|-
| logGainMessages
| true
|
|-
| logReadableHTML
| false
|
|-
| loginRecoveryHardcore
| false
|
|-
| loginRecoverySoftcore
| true
|
|-
| loginScript
|
|
|-
| loginServerName
|
|
|-
| loginWindowLogo
| lantern.jpg
|
|-
| logMonsterHealth
| false
|
|-
| logoutScript
|
|
|-
| logReverseOrder
| false
|
|-
| logStatGains
| true
|
|-
| logStatusEffects
| true
|
|-
| logStatusOnLogin
| false
|
|-
| macroDebug
| false
|
|-
| macroLens
| false
|
|-
| mementoListActive
| false
|
|-
| mergeHobopolisChat
| false
|
|-
| outerChatColor
| #b4460f
|
|-
| outerTabColor
| #0f46b4
|
|-
| pathedSummonsHardcore
| true
|
|-
| pathedSummonsSoftcore
| false
|
|-
| preferredWebBrowser
|
|
|-
| previousNotifyList
| <>
|
|-
| previousUpdateVersion
|
|
|-
| previousUpdateRevision
| 0
|
|-
| protectAgainstOverdrink
| true
|
|-
| proxySet
| false
|
|-
| readManualHardcore
| true
|
|-
| readManualSoftcore
| true
|
|-
| relayAddsCustomCombat
| true
|
|-
| relayAddsDiscoHelper
| false
|
|-
| relayAddsGraphicalCLI
| false
|
|-
| relayAddsQuickScripts
| false
|
|-
| relayAddsRestoreLinks
| true
|
|-
| relayAddsUpArrowLinks
| true
|
|-
| relayAddsUseLinks
| true
|
|-
| relayAddsWikiLinks
| false
|
|-
| relayAllowRemoteAccess
| false
|
|-
| relayBrowserOnly
| false
|
|-
| relayFormatsChatText
| true
|
|-
| relayHidesJunkMallItems
| false
|
|-
| relayMaintainsEffects
| false
|
|-
| relayMaintainsHealth
| false
|
|-
| relayMaintainsMana
| false
|
|-
| relayOverridesImages
| false
|
|-
| relayRunsAfterAdventureScript
| false
|
|-
| relayRunsBeforeBattleScript
| false
|
|-
| relayRunsBeforePVPScript
| false
|
|-
| relayScriptButtonFirst
| false
|
|-
| relaySkillButtonCount
| 5
|
|-
| relayTextualizesEffects
| false
|
|-
| relayTrimsZapList
| false
|
|-
| relayUsesInlineLinks
| true
|
|-
| relayUsesIntegratedChat
| false
|
|-
| relayViewsCustomItems
| false
|
|-
| relayWarnOnRecoverFailure
| true
|
|-
| removeMalignantEffects
| false
|
|-
| saveSettingsOnSet
| true
|
|-
| saveState
|
|
|-
| saveStateActive
|
|
|-
| scriptButtonPosition
| 0
|
|-
| scriptList
| restore hp | restore mp
|
|-
| sharePriceData
| false
|
|-
| showAllRequests
| false
|
|-
| showAnnouncements
| true
| Display special KoL announcements from the login page
|-
| showExceptionalRequests
| false
|
|-
| simpleSvnUpdate
| true
|
|-
| statusDropdown
| 0
|
|-
| stealthLogin
| true
|
|-
| svnInstallDependencies
| true
|
|-
| svnShowCommitMessages
| false
|
|-
| svnUpdateOnLogin
| false
|
|-
| swingLookAndFeel
|
|
|-
| switchEquipmentForBuffs
| false
|
|-
| syncAfterSvnUpdate
| false
|
|-
| tomeSkillsHardcore
| Summon Snowcone
|
|-
| tomeSkillsSoftcore
| all
|
|-
| toolbarPosition
| 1
|
|-
| useChatToolbar
| true
|
|-
| useContactsFrame
| true
|
|-
| useCrimboToysHardcore
| false
|
|-
| useCrimboToysSoftcore
| true
|
|-
| useDecoratedTabs
|
|
|-
| useDevProxyServer
| false
|
|-
| useDockIconBadge
| false
|
|-
| useImageCache
| true
|
|-
| useLastUserAgent
| false
|
|-
| useNaiveSecureLogin
| false
|
|-
| useSecureLogin
| false
|
|-
| useShinyTabbedChat
| true
|
|-
| useSystemTrayIcon
| false
|
|-
| useTabbedChatFrame
| true
|
|-
| useToolbars
| true
|
|-
| useZoneComboBox
| false
|
|-
| userAgent
|
|
|-
| verboseSpeakeasy
| false
|
|-
| visitLoungeHardcore
| true
|
|-
| visitLoungeSoftcore
| true
|
|-
| visitRumpusHardcore
| true
|
|-
| visitRumpusSoftcore
| true
|
|}

==Per-Account Variables==
Several categories of Per-Account preferences ([[Daily Variables]], [[Choice Adventures]], and [[Quest Tracking Preferences]]) have their own pages and are not listed here.

===Daily Variables===
See page [[Daily Variables]].

===Choice Adventures===
See page [[Choice Adventures]].

===Quest Tracking===
See page [[Quest Tracking Preferences]].

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

{| class="wikitable" border="1"
|-
! Variable Name
! scope="col" width="300" | Default Value
! Notes
|-
| addingScrolls
| -1
|
|-
| afterAdventureScript
|
|
|-
| arcadeGameHints
| false
|
|-
| 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
|-
| autoCraft
| true
| Automatically spend 10 meat to create a badass belt or Bonerdagon necklace if the components are available
|-
| autoQuest
| true
|
|-
| autoEntangle
| false
| Use Entangling Noodles at the beginning of combat
|-
| autoGarish
| false
| If true, when attempting to eat lasagna, will attempt to automatically acquire and use a {{kolwiki|potion of the field gar}}
|-
| 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
|-
| autoTuxedo
| false
| If true, when drinking a martini, automatically attempts to equip a {{kolwiki|tuxedo shirt}} first
|-
| availableCandyCredits
| 0
|
|-
| availableDimes
| 0
|
|-
| availableQuarters
| 0
|
|-
| availableStoreCredits
| 0
|
|-
| availableSwagger
| 0
|
|-
| ballpitBonus
| 1
|
|-
| banishedMonsters
|
|
|-
| banishingShoutMonsters
|
|
|-
| bankedKarma
| 0
|
|-
| barrelGoal
| 1
|
|-
| bartenderTurnsUsed
| 0
|
|-
| basementMallPrices
| 1
|
|-
| battleAction
| attack with weapon
|
|-
| beeCounter
| 0
|
|-
| beforePVPScript
|
|
|-
| betweenBattleScript
|
|
|-
| bigBrotherRescued
| false
|
|-
| birdformCold
| 0
|
|-
| birdformHot
| 0
|
|-
| birdformRoc
| 0
|
|-
| birdformSleaze
| 0
|
|-
| birdformSpooky
| 0
|
|-
| birdformStench
| 0
|
|-
| blackBartsBootyAvailable
| true
|
|-
| blackPuddingsDefeated
| 0
|
|-
| blackForestProgress
| 0
|
|-
| blankOutUsed
| 0
| Tracks current amount of active Blank-out
|-
| boneAbacusVictories
| 0
|
|-
| booPeakProgress
| 100
|
|-
| borisPoints
| 0
|
|-
| breakableHandling
| 1
|
|-
| breakableHandling1964
| 2
|
|-
| brodenBacteria
| 0
|
|-
| brodenSprinkles
| 0
|
|-
| buffBotCasting
|
|
|-
| buffBotMessageDisposal
| 0
|
|-
| buffBotPhilanthropyType
| 1
|
|-
| buffJimmyIngredients
| 0
|
|-
| burnoutsDefeated
| 0
|
|-
| buyScript
|
|
|-
| cameraMonster
|
|
|-
| camerasUsed
| 0
|
|-
| carboLoading
| 0
|
|-
| cellarLayout
| 0
|
|-
| charitableDonations
| 0
|
|-
| chasmBridgeProgress
| 0
|
|-
| chatbotScript
|
|
|-
| chatbotScriptExecuted
| false
|
|-
| chatLiterate
| false
|
|-
| chatServesUpdates
| false
|
|-
| chefTurnsUsed
| 0
|
|-
| chessboardsCleared
| 0
| Number of queen cookies acquired from chessboards (max 50)
|-
| chosenTrip
|
|
|-
| cinderellaMinutesToMidnight
| 0
| Time left while doing the stepmother section of the {{kolwiki|grimstone mask}} content
|-
| cinderellaScore
| 0
| Current score while doing the stepmother section of the {{kolwiki|grimstone mask}} content
|-
| grimstoneMaskPath
|
|
|-
| clanAttacksEnabled
| false
|
|-
| coldAirportAlways
| false
| Set to true if you use an {{kolwiki|airplane charter: The Glaciest}}
|-
| considerShadowNoodles
| false
|
|-
| counterScript
|
|
|-
| corralUnlocked
| false
|
|-
| crappyCameraMonster
|
|
|-
| crimboTreeDays
| 7
|
|-
| crudeMonster
|
|
|-
| currentEasyBountyItem
|
|
|-
| currentExtremity
| 0
|
|-
| currentHardBountyItem
|
|
|-
| currentHippyStore
| none
|
|-
| currentJunkyardTool
|
|
|-
| currentJunkyardLocation
|
|
|-
| currentMood
| default
|
|-
| currentNunneryMeat
| 0
|
|-
| currentSpecialBountyItem
|
|
|-
| customCombatScript
| default
|
|-
| cyrptAlcoveEvilness
| 0
|
|-
| cyrptCrannyEvilness
| 0
|
|-
| cyrptNicheEvilness
| 0
|
|-
| cyrptNookEvilness
| 0
|
|-
| cyrptTotalEvilness
| 0
|
|-
| dampOldBootPurchased
| false
|
|-
| dbNemesisSkill1
| 0
|
|-
| dbNemesisSkill2
| 0
|
|-
| dbNemesisSkill3
| 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
|-
| demonName10
|
| Name of demon that gives Pleasures of the Flesh
|-
| demonName11
|
| Name of demon that gives Infernal Thirst
|-
| demonName12
|
| Name of demon from obtained from Intergnat
|-
| desertExploration
| 0
|
|-
| desktopHeight
| 600
|
|-
| desktopWidth
| 800
|
|-
| dnaSyringe
|
|
|-
| dolphinItem
|
|
|-
| envyfishMonster
|
|
|-
| 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
|
|-
| gameProBossSpecialPower
| Unknown
|
|-
| ghostPencil1
| false
|
|-
| ghostPencil2
| false
|
|-
| ghostPencil3
| false
|
|-
| ghostPencil4
| false
|
|-
| ghostPencil5
| false
|
|-
| ghostPencil6
| false
|
|-
| ghostPencil7
| false
|
|-
| ghostPencil8
| false
|
|-
| ghostPencil9
| false
|
|-
| goldenMrAccessories
| 0
|
|-
| gongPath
| 0
|
|-
| gourdItemCount
| 5
|
|-
| grimstoneCharge
| 0
| Track combat turns with Grimstone Golem
|-
| 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
|
|-
| hardcorePVPWarning
| false
| If true, will warn you if you click on the Prism with a broken Hippy Stone and PVP fights remaining
|-
| heavyRainsStartingThunder
| 0
|
|-
| heavyRainsStartingRain
| 0
|
|-
| heavyRainsStartingLightning
| 0
|
|-
| heroDonationBoris
| 0
| Meat donated to Boris
|-
| heroDonationJarlsberg
| 0
| Meat donated to Jarlsberg
|-
| heroDonationSneakyPete
| 0
| Meat donated to Sneaky Pete
|-
| hippiesDefeated
| 0
|
|-
| hotAirportAlways
| false
| Set to true if you use an {{kolwiki|airplane charter: That 70s Volcano}}
|-
| hpAutoRecovery
| -0.05
|
|-
| hpAutoRecoveryItems
| cannelloni cocoon;scroll of drastic healing;tongue of the walrus;lasagna bandages;doc galaktik's ailment ointment
|
|-
| hpAutoRecoveryTarget
| 1.0
|
|-
| iceSculptureMonster
|
|
|-
| invalidBuffMessage
| You sent an amount which does not correspond to a valid buff amount.
|
|-
| jarlsbergPoints
| 0
| Number of bonus skill points earned by doing {{kolwiki|Avatar of Jarlsberg}} ascensions
|-
| jungCharge
| 0
|
|-
| kingLiberated
| false
|
|-
| kingLiberatedScript
|
|
|-
| knownAscensions
| -1
|
|-
| kolhsTotalSchoolSpirited
| 0
|
|-
| lassoTraining
|
| Records your current {{kolwiki|sea lasso}} adjective.
|-
| lastAdventure
|
|
|-
| lastAnticheeseDay
| -5
|
|-
| lastArcadeAscension
| -1
|
|-
| lastBadMoonReset
| -1
|
|-
| lastBangPotion819
|
|
|-
| lastBangPotion820
|
|
|-
| lastBangPotion821
|
|
|-
| lastBangPotion822
|
|
|-
| lastBangPotion823
|
|
|-
| lastBangPotion824
|
|
|-
| lastBangPotion825
|
|
|-
| lastBangPotion826
|
|
|-
| lastBangPotion827
|
|
|-
| lastBangPotionReset
| -1
|
|-
| lastBattlefieldReset
| -1
|
|-
| lastBreakfast
| -1
|
|-
| lastCastleGroundUnlock
| -1
|
|-
| lastCastleTopUnlock
| -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
|-
| lastChessboard
|
|
|-
| lastChasmReset
| -1
|
|-
| lastCouncilVisit
| 0
|
|-
| lastCounterDay
| -1
|
|-
| lastDesertUnlock
| -1
|
|-
| lastDispensaryOpen
| -1
|
|-
| lastDoorCodeReset
| -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
|
|-
| lastEasterEggBalloon
| -1
|
|-
| lastEmptiedStorage
| -1
| Number of the last ascension that Hangk's storage was emptied.
|-
| lastEncounter
|
|
|-
| lastFilthClearance
| -1
|
|-
| lastGoofballBuy
| -1
|
|-
| lastGuildStoreOpen
| -1
|
|-
| lastGuyMadeOfBeesReset
| -1
|
|-
| lastHiddenCityAscension
| 0
|
|-
| lastHippyCall
| -1
|
|-
| lastKingLiberation
| -1
|
|-
| lastLightsOutTurn
| -1
|
|-
| lastMushroomPlot
| -1
|
|-
| lastMessageId
|
|
|-
| lastMiningReset
| -1
|
|-
| lastPaperStripReset
| -1
|
|-
| lastPaperStrip3144
|
|
|-
| lastPaperStrip4138
|
|
|-
| lastPaperStrip4139
|
|
|-
| lastPaperStrip4140
|
|
|-
| lastPaperStrip4141
|
|
|-
| lastPaperStrip4142
|
|
|-
| lastPaperStrip4143
|
|
|-
| lastPaperStrip4144
|
|
|-
| lastPirateEphemera
|
|
|-
| lastPirateEphemeraReset
| -1
|
|-
| lastPirateInsult1
| false
|
|-
| lastPirateInsult2
| false
|
|-
| lastPirateInsult3
| false
|
|-
| lastPirateInsult4
| false
|
|-
| lastPirateInsult5
| false
|
|-
| lastPirateInsult6
| false
|
|-
| lastPirateInsult7
| false
|
|-
| lastPirateInsult8
| false
|
|-
| lastPirateInsultReset
| -1
|
|-
| lastPlusSignUnlock
| -1
|
|-
| lastPorkoBoard
|
|
|-
| lastPorkoPayouts
|
|
|-
| lastPorkoExpected
|
|
|-
| lastQuartetAscension
| -1
|
|-
| lastQuartetRequest
| 0
|
|-
| lastSecondFloorUnlock
| -1
|
|-
| lastSemirareReset
| -1
|
|-
| lastTavernAscension
| 0
|
|-
| lastTavernSquare
| 0
|
|-
| lastTelescopeReset
| -1
|
|-
| lastTowerClimb
| -1
|
|-
| lastVioletFogMap
| 0
|
|-
| lastWartDinseyDefeated
| -1
| Tracks defeat of {{kolwiki|Wart Dinsey}}
|-
| lastZapperWand
| 0
|
|-
| lightsOutAutomation
| 1
| Highlights/automatically selects correct option during {{kolwiki|Lights Out Quest}} noncombats
|-
| louvreDesiredGoal
| 7
|
|-
| louvreGoal
| 0
|
|-
| louvreOverride
|
|
|-
| makeFriendsMonster
|
|
|-
| manaBurnSummonThreshold
| 10
|
|-
| manaBurningThreshold
| -0.05
|
|-
| maximizerMRUSize
| 5
|
|-
| maximizerCombinationLimit
| 0
|
|-
| maxManaBurn
| 1000
|
|-
| mayflyExperience
| 0
| Uses of mayfly bait necklace. Reset each ascension.
|-
| meansuckerPrice
| 400
|
|-
| meatDropSpading
| false
|
|-
| mineLayout1
|
|
|-
| mineLayout2
|
|
|-
| mineLayout3
|
| Stores the results of each twinkly rock mined in {{kolwiki|Anemone Mine (Mining)}}. This is used by the relay browser to display the results in-game.
|-
| mineLayout4
|
|
|-
| miniAdvClass
| 0
|
|-
| mmgAutoConfirmBets
| false
|
|-
| mmgDisabled
| false
|
|-
| mmgSearchMinimum
|
|
|-
| mmgSearchMaximum
|
|
|-
| 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
|
|-
| nextAdventure
|
|
|-
| nextSpookyravenElizabethRoom
| The Haunted Storage Room
|
|-
| nextSpookyravenStephenRoom
| The Haunted Bedroom
|
|-
| nosyNoseMonster
|
|
|-
| oceanAction
| savecontinue
|
|-
| oceanDestination
| manual
|
|-
| olfactedMonster
| unknown
|
|-
| parasolUsed
| 0
|
|-
| pastaThrall1
|
|
|-
| pastaThrall2
|
|
|-
| pastaThrall3
|
|
|-
| pastaThrall4
|
|
|-
| pastaThrall5
|
|
|-
| pastaThrall6
|
|
|-
| pastaThrall7
|
|
|-
| pastaThrall8
|
|
|-
| pendingMapReflections
| 0
|
|-
| peteMotorbikeTires
|
|
|-
| peteMotorbikeGasTank
|
|
|-
| peteMotorbikeHeadlight
|
|
|-
| peteMotorbikeCowling
|
|
|-
| peteMotorbikeMuffler
|
|
|-
| peteMotorbikeSeat
|
|
|-
| photocopyMonster
|
|
|-
| pieStuffing
|
|
|-
| pirateSwagger
| 0
|
|-
| plantingDate
|
|
|-
| plantingDay
| -1
|
|-
| plantingLength
|
|
|-
| plantingScript
|
|
|-
| poolSharkCount
| 0
| Number of times "Rack 'em up" was selected at {{kolwiki|A Shark's Chum}}
|-
| postAscensionScript
|
|
|-
| preAscensionScript
|
|
|-
| preBlackbirdFamiliar
|
|
|-
| promptAboutCrafting
| 1
| Prompt when crafting would spend an adventure. (0=never, 1=one-time confirmation, 2=always)
|-
| pyramidPosition
| 1
|
|-
| pyramidBombUsed
| false
|
|-
| rainDohMonster
|
|
|-
| raveCombo1
|
| Rave Concentration
|-
| raveCombo2
|
| Rave Nirvana
|-
| raveCombo3
|
| Rave Knockout
|-
| raveCombo4
|
| Rave Bleeding
|-
| raveCombo5
|
| Rave Steal
|-
| raveCombo6
|
| Rave Substats
|-
| reanimatorArms
| 0
|
|-
| reanimatorLegs
| 0
|
|-
| reanimatorSkulls
| 0
|
|-
| reanimatorWeirdParts
| 0
|
|-
| reanimatorWings
| 0
|
|-
| recentLocations
| 5
|
|-
| recoveryScript
|
|
|-
| relayCounters
|
|
|-
| relayShowSpoilers
| false
|
|-
| relayShowWarnings
| true
|
|-
| relocatePygmyJanitor
| -1
|
|-
| relocatePygmyLawyer
| -1
|
|-
| rememberDesktopSize
| false
|
|-
| requireBoxServants
| false
|
|-
| requireSewerTestItems
| false
|
|-
| retrieveContacts
| true
|
|-
| rumpelstiltskinTurnsUsed
| 0
|
|-
| rumpelstiltskinKidsRescued
| 0
|
|-
| safePickpocket
| true
|
|-
| scriptMRULength
| 0
|
|-
| scriptMRUList
|
|
|-
| seahorseName
|
|
|-
| semirareCounter
| 0
|
|-
| semirareLocation
|
|
|-
| serverAddsCustomCombat
| false
|
|-
| sexChanges
| 0
|
|-
| showGainsPerUnit
| false
|
|-
| showNoSummonOnly
| false
|
|-
| showTurnFreeOnly
| false
|
|-
| sideDefeated
| neither
|
|-
| sidequestArenaCompleted
| none
|
|-
| sidequestFarmCompleted
| none
|
|-
| sidequestJunkyardCompleted
| none
|
|-
| sidequestLighthouseCompleted
| none
|
|-
| sidequestNunsCompleted
| none
|
|-
| sidequestOrchardCompleted
| none
|
|-
| singleFamiliarRun
| 0
|
|-
| skateParkStatus
| war
|
|-
| skillLevel46
| 2
|
|-
| skillLevel47
| 1
|
|-
| skillLevel48
| 2
|
|-
| sleazeAirportAlways
| false
| Set to true if you use an {{kolwiki|airplane charter: Spring Break Beach}}
|-
| slimelingFullness
| 0.0
|
|-
| slimelingStacksDropped
| 0
|
|-
| slimelingStacksDue
| 0
|
|-
| sneakyPetePoints
| 0
| Number of bonus skill points earned by doing {{kolwiki|Avatar of Sneaky Pete}} ascensions
|-
| sortByRoom
| true
|
|-
| spadingData
|
|
|-
| spookyAirportAlways
| false
| Set to true if you use an {{kolwiki|airplane charter: Conspiracy Island}}
|-
| spookyPuttyMonster
|
|
|-
| stationaryButton1
|
|
|-
| stationaryButton2
|
|
|-
| stationaryButton3
|
|
|-
| stationaryButton4
|
|
|-
| stationaryButton5
|
|
|-
| stenchAirportAlways
| false
| Set to true if you use an {{kolwiki|airplane charter: Dinseylandfill}}
|-
| suppressInappropriateNags
| false
| Facilitates end-user suppression of inappropriate nags.
|-
| suppressPotentialMalware
| false
| If true, prevents the relay browser from connecting to known malware attack vectors.
|-
| tacoDanCocktailSauce
| 0
|
|-
| tacoDanFishMeat
| 0
|
|-
| [[tavernLayout]]
| 0000000000000000000000000
|
|-
| telescope1
|
|
|-
| telescope2
|
|
|-
| telescope3
|
|
|-
| telescope4
|
|
|-
| telescope5
|
|
|-
| telescope6
|
|
|-
| telescope7
|
|
|-
| telescopeLookedHigh
| false
|
|-
| telescopeUpgrades
| 0
|
|-
| testudinalTeachings
|
|
|-
| thanksMessage
| Thank you for the donation!
|
|-
| timeTowerAvailable
| false
|
|-
| trackLightsOut
| false
| Track {{kolwiki|Lights Out Quest}}. Can be set with "spookyraven" CLI command.
|-
| trapperOre
| chrome ore
|
|-
| turtleBlessingTurns
| 0
|
|-
| uneffectWithHotTub
| true
| If true, during HC/ronin KoLmafia will spend a {{kolwiki|hot tub}} use to remove a negative effect instead of a {{kolwiki|soft green echo eyedrop antidote}}. Does not change casual/aftercore behavior.
|-
| usable1HWeapons
| 3
|
|-
| usable1xAccs
| 1
|
|-
| usable2HWeapons
| 1
|
|-
| usable3HWeapons
| 1
|
|-
| usableAccessories
| 3
|
|-
| usableHats
| 2
|
|-
| usableOffhands
| 1
|
|-
| usableOther
| 1
|
|-
| usablePants
| 1
|
|-
| usableShirts
| 1
|
|-
| valueOfAdventure
| 500
|
|-
| valueOfInventory
| 1.8
|
|-
| valueOfStill
| 0
|
|-
| valueOfTome
| 0
|
|-
| verboseMaximizer
| false
|
|-
| violetFogGoal
| 0
|
|-
| violetFogLayout
|
|
|-
| warProgress
| unstarted
|
|-
| waxMonster
|
|
|-
| welcomeBackAdv
| 0
|
|-
| workteaClue
|
|
|-
| unknownRecipe3542
| true
|
|-
| unknownRecipe3543
| true
|
|-
| unknownRecipe3544
| true
|
|-
| unknownRecipe3545
| true
|
|-
| unknownRecipe3546
| true
|
|-
| unknownRecipe3547
| true
|
|-
| unknownRecipe3548
| true
|
|-
| unknownRecipe3749
| true
|
|-
| unknownRecipe3751
| true
|
|-
| unknownRecipe4172
| true
|
|-
| unknownRecipe4173
| true
|
|-
| unknownRecipe4174
| true
|
|-
| yearbookCameraAscensions
| 0
|
|-
| yearbookCameraPending
| false
|
|-
| yearbookCameraTarget
|
|
|-
| yearbookCameraUpgrades
| 0
|
|-
| zeppelinProtestors
| 0
| Counts protesters removed from {{kolwiki|A Mob of Zeppelin Protesters}}
|-
| zombiePoints
| 0
|
|}

{{SeeAlso|get_property|set_property}}

{{PropertyNav}}

[[Category:Scripting]]

Item Management

2016-05-29T11:02:29Z

Theo: /* Acquiring & Using Items */

{{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|my_storage_meat|desc=Returns the amount of meat you have in Hagnk's Ancestral Mini-Storage.}}
{{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|item|get_dwelling|desc=Returns the item corresponding with your dwelling.}}
{{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|string|item_type|item|desc=Returns the type of item specified.}}
{{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 [item]|get_shop|desc=Returns entire contents of shop and quantity of each 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|string|craft_type|item|desc=Returns a string identifying how an item is crafted and any other requirements for creating it.}}
{{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).}}
[[File:Item category.png|frame|You can categorize items in KoL using [[is tradeable|is_tradeable()]], [[is giftable|is_giftable()]], and [[is displayable|is_displayable()]].]]
{{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|is_displayable|item|desc=Returns whether the item can be put in a display case (true for all but quest items).}}
{{Flink|boolean|is_discardable|item|desc=Returns whether the item can be discarded or autosold.}}
{{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_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|void|refresh_shop|desc=Takes a new look at the contents of your mall store, as that section of inventory cannot be internally tracked due to access by others.}}
{{Flink|int|shop_price|item|desc=Returns the current price for the given item if it is present in your mall store.}}
{{Flink|int|mall_price|item|desc=Returns the current (lowest) mall price of the given item.}}
{{Flink|int|npc_price|item|desc=Returns the current price of the given item if it can currently be bought from an NPC store.}}
{{Flink|int|historical_price|item|desc=Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().}}
{{Flink|float|historical_age|item|desc=Returns the age of the most recently checked price for an item in days. This allows you to decide if you want to use historical_price() or mall_price().}}
{{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|empty_closet|desc=Remove every item from the closet in a single server hit.}}
{{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.<br />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}}
{{Flink|boolean|take_shop|{{opt|int}}|item|desc=Adds or removes items in your store and returns success.}}

==Acquiring & Using Items==
{{Flink|boolean|autosell|int|item|desc=Attempts to autosell the given items and reports success.}}
{{Flink|boolean|buy|{{opt|coinmaster}}|int|item}}
{{Flink|int|buy|int|item|int|desc=Tries to purchase the specified items.}}
{{Flink|boolean|buy_using_storage|int|item}}
{{Flink|int|buy_using_storage|int|item|int|desc=Tries to purchase the specified items using meat in Hangks.}}
{{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|drink|int|item|desc=Attempts to drink items as specified and reports success.}}
{{Flink|boolean|eat|int|item|desc=Attempts to eat items as specified and reports success.}}
{{Flink|boolean|eatsilent|int|item|desc=Attempts to eat items as specified.}}
{{Flink|boolean|chew|int|item|desc=Attempts to chew spleen items as specified and reports success.}}
{{Flink|boolean|hermit|int|item|desc=Trades worthless items (buying and using chewing gum 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|overdrink|int|item}}
{{Flink|boolean|retrieve_item|int|item|desc=Uses KoLmafia internal logic to gather items (see page for details).}}
{{Flink|int|craft|string|int|item|item|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}
{{Flink|string|last_item_message|desc=Returns message that KoL reports in the event of error.}}

==Coinmaster Control==
Some items can be bought from or sold to various "coinmasters" which are like shops that deal in a currency other than meat. These coinmasters include the Dimemaster and Quartermaster during the Island War, the Hermit, the Mr. Store and many others. Some relevant information can be found in [[proxy records]] for the item and coinmaster data types. The rest is controlled by the following functions.

===Inquiries===
{{Flink|coinmaster|to_coinmaster|string|desc=Converts a string to a valid coinmaster.}}
{{Flink|boolean|is_coinmaster_item|item|desc=Is a given item acquirable from a coinmster.}}
{{Flink|boolean|buys_item|coinmaster|item|desc=Is a specific item acquirable from the named coinmster.}}
{{Flink|int|buy_price|coinmaster|item|desc=What is the coinmaster's purchase price for an item.}}
{{Flink|boolean|sells_item|coinmaster|item|desc=Is a specific item sellable to the named coinmster.}}
{{Flink|int|sell_price|coinmaster|item|desc=What is the coinmaster's selling price for an item.}}

===Coinmaster transactions===
{{Flink|boolean|is_accessible|coinmaster|desc=Is a given coinmaster currently accessible.}}
{{Flink|string|inaccessible_reason|coinmaster|desc=The reason a given coinmaster is currently inaccessible.}}
{{Flink|boolean|visit|coinmaster|desc=Refreshes information at a coinmaster.}}
{{Flink|boolean|buy|coinmaster|int|item|desc=Buys an item from a coinmaster.}}
{{Flink|boolean|sell|coinmaster|int|item|desc=Sells an item to a coinmaster.}}

[[Category:Scripting]]

Miscellaneous ASH Features

2016-05-19T22:54:16Z

Theo: /* Additional Script Uses */ added familiarScript

{{TOCright}}
==Special Features of ASH Scripting==
These features are not exactly ASH commands, but they are used to improve script usage.

===Special Syntax Functions===

'''[[script]]'''

Defines a script's proper name. Mostly for use by a subsequent notify command in case the user saves the script with a custom name.

'''[[notify]]'''

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

'''[[since]]'''

Used to inform KoLmafia of the minimum build necessary to support the script's functionality so it can abort execution with a meaningful error message.

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

There are a wide variety of error messages. For help when things go wrong, please see the page on [[ASH Errors]].

==Relay Override Scripts==
A relay override script is a script that modifies a web page in the relay browser. It is only in the relay browser that the effects of this scripts can be seen. The purpose of this is to alter a KoL page to improve functionality or appearance.

Detailed information is at [[Relay_Override_Scripting#Relay_Script|Relay Override Script]].

==User Interface Script==
A User Interface script is a script that creates a web page viewable in the relay browser. It is only in the relay browser that this special page can be seen. The purpose of this is to extend KoLmafia abilities or present information to the user.

Detailed information is at [[Relay_Override_Scripting#User_Interface_Script|User Interface Script]].

==Consult Scripts==
Consult scripts are used to script combat. They can be used in automated adventuring or in the relay browser.

Detailed information is at [[Custom_Combat_Script#Consult_Scripts|Consult Scripts]].

==Additional Script Uses==

In addition to regular scripts, override scripts, UI 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).

=== After Adventure (afterAdventureScript) ===

*Executed just after mafia has finished an adventure.
*The afterAdventureScript 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.
*By default this only works for automated adventuring. If you wish it to fire when you're using the relay browser then turn it on in General -> Preferences -> - Relay Browser or set the property relayRunsAfterAdventureScript to true.

=== Before Adventure (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.
*By default this only works for automated adventuring. If you wish it to fire when you're using the relay browser then turn it on in General -> Preferences -> - Relay Browser or set the property relayRunsBeforeBattleScript to true.
*Example: Zarqon's [http://kolmafia.us/showthread.php?t=1240 Best Between Battle]

=== Before PvP Script (beforePVPScript) ===
* This will be executed before every PvP attack initiated through the relay browser or CLI command.
* If you want buffs maintained during PvP (and nothing else) you can do that with:
*: <pre>set beforePVPScript = mood execute</pre>

=== Breaking the Prism (kingLiberatedScript) ===

: This will be executed after you break the Prism at the top of the Naughty Sorceress' Lair. This trigger is designed so that a character can be automatically prepared for aftercore. The kingLiberatedScript 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.

=== 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 or an event is received
**When an event is received the message is stripped of HTML, the channel is "Events" and the sender is an empty string.
*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, "Events" for chat notifications (e.g. "New message received from Bale."), 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 {{f|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]

=== Familiar (familiarScript) ===
*Executed after changing familiars but before automatically changing familiar equipment.
*Requires a special main() declaration: boolean main(). Returning true will cause normal familiar equipment switching to be skipped, while false will lead to it running after the script returns.

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