Kolmafia - User contributions [en]

Help:To Do List

2017-05-24T01:14:33Z

Bale: /* Missing Stuff */ r18040

{{TOCright}}

== "To Do" List ==

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

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

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

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

== Missing Stuff ==

'''test CLI commands:'''

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

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

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

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

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

r15606: Add "test encounter URL" command.

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

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

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

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

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

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

r16508: Add "test numberology adventureDelta spleenDelta"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

equip [2268] will equip an item by number.

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

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

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

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

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

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

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

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

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

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

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

r15937: Add mayosoak command

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

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

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

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

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

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

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

'''int monster_factoids_available( monster )'''

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

'''string monster_manuel_text( monster )'''

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

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

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

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

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

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

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

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

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

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

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

r17909: Add ASH function: string numberology_prize( number )

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

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

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

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

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

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

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

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

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

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

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

r17284: Allow pranking with timespinner

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

r17290: Add traceprint( string) ASH function

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

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

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

r17817: Added CLI command "absorb"

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

r17845: Add my_absorbs() ash function

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

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

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

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

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

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

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

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

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

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

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

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

== Needs Major Work ==

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

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

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

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

== Needs Code Samples ==

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

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

Help:To Do List

2017-04-30T07:41:09Z

Bale: /* Missing Stuff */ my_session_meat()

{{TOCright}}

== "To Do" List ==

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

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

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

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

== Missing Stuff ==

'''test CLI commands:'''

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

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

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

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

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

r15606: Add "test encounter URL" command.

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

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

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

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

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

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

r16508: Add "test numberology adventureDelta spleenDelta"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

equip [2268] will equip an item by number.

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

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

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

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

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

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

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

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

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

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

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

r15937: Add mayosoak command

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

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

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

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

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

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

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

'''int monster_factoids_available( monster )'''

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

'''string monster_manuel_text( monster )'''

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

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

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

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

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

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

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

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

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

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

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

r17909: Add ASH function: string numberology_prize( number )

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

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

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

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

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

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

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

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

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

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

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

r17284: Allow pranking with timespinner

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

r17290: Add traceprint( string) ASH function

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

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

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

r17817: Added CLI command "absorb"

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

r17845: Add my_absorbs() ash function

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

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

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

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

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

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

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

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

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

== Needs Major Work ==

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

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

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

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

== Needs Code Samples ==

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

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

Reporting a Bug/Requesting a Feature

2017-04-15T20:46:32Z

Bale:

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

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

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

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

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

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

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

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

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

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

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

For both Feature and New Content

*Implemented means that KoLmafia has been changed in response.

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

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

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

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

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

Help:To Do List

2017-04-09T01:48:39Z

Bale: /* Missing Stuff */ "spacegate" command.

{{TOCright}}

== "To Do" List ==

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

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

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

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

== Missing Stuff ==

'''test CLI commands:'''

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

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

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

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

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

r15606: Add "test encounter URL" command.

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

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

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

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

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

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

r16508: Add "test numberology adventureDelta spleenDelta"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

equip [2268] will equip an item by number.

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

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

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

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

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

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

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

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

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

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

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

r15937: Add mayosoak command

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

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

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

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

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

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

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

'''int monster_factoids_available( monster )'''

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

'''string monster_manuel_text( monster )'''

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

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

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

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

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

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

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

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

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

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

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

r17909: Add ASH function: string numberology_prize( number )

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

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

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

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

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

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

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

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

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

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

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

r17284: Allow pranking with timespinner

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

r17290: Add traceprint( string) ASH function

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

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

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

r17817: Added CLI command "absorb"

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

r17845: Add my_absorbs() ash function

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

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

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

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

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

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

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

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

== Needs Major Work ==

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

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

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

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

== Needs Code Samples ==

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

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

Help:To Do List

2017-04-04T05:28:01Z

Bale: /* Missing Stuff */ mood_execute() and available_choice_options()

{{TOCright}}

== "To Do" List ==

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

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

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

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

== Missing Stuff ==

'''test CLI commands:'''

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

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

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

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

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

r15606: Add "test encounter URL" command.

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

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

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

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

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

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

r16508: Add "test numberology adventureDelta spleenDelta"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

equip [2268] will equip an item by number.

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

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

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

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

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

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

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

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

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

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

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

r15937: Add mayosoak command

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

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

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

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

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

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

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

'''int monster_factoids_available( monster )'''

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

'''string monster_manuel_text( monster )'''

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

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

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

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

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

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

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

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

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

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

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

r17909: Add ASH function: string numberology_prize( number )

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

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

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

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

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

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

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

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

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

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

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

r17284: Allow pranking with timespinner

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

r17290: Add traceprint( string) ASH function

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

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

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

r17817: Added CLI command "absorb"

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

r17845: Add my_absorbs() ash function

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

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

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

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

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

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

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

== Needs Major Work ==

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

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

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

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

== Needs Code Samples ==

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

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

Help:To Do List

2017-04-02T16:55:47Z

Bale: /* Missing Stuff */ r17921: Add ASH get_closet() and get_storage() commands:

{{TOCright}}

== "To Do" List ==

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

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

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

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

== Missing Stuff ==

'''test CLI commands:'''

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

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

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

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

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

r15606: Add "test encounter URL" command.

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

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

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

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

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

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

r16508: Add "test numberology adventureDelta spleenDelta"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

equip [2268] will equip an item by number.

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

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

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

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

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

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

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

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

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

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

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

r15937: Add mayosoak command

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

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

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

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

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

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

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

'''int monster_factoids_available( monster )'''

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

'''string monster_manuel_text( monster )'''

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

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

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

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

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

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

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

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

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

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

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

r17909: Add ASH function: string numberology_prize( number )

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

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

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

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

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

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

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

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

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

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

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

r17284: Allow pranking with timespinner

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

r17290: Add traceprint( string) ASH function

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

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

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

r17817: Added CLI command "absorb"

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

r17845: Add my_absorbs() ash function

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

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

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

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

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

== Needs Major Work ==

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

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

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

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

== Needs Code Samples ==

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

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

Help:To Do List

2017-03-23T23:36:58Z

Bale: /* Missing Stuff */ r17911 & r17912

{{TOCright}}

== "To Do" List ==

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

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

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

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

== Missing Stuff ==

'''test CLI commands:'''

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

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

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

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

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

r15606: Add "test encounter URL" command.

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

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

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

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

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

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

r16508: Add "test numberology adventureDelta spleenDelta"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

equip [2268] will equip an item by number.

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

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

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

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

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

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

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

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

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

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

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

r15937: Add mayosoak command

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

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

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

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

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

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

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

'''int monster_factoids_available( monster )'''

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

'''string monster_manuel_text( monster )'''

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

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

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

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

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

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

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

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

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

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

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

r17909: Add ASH function: string numberology_prize( number )

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

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

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

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

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

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

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

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

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

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

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

r17284: Allow pranking with timespinner

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

r17290: Add traceprint( string) ASH function

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

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

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

r17817: Added CLI command "absorb"

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

r17845: Add my_absorbs() ash function

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

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

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

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

== Needs Major Work ==

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

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

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

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

== Needs Code Samples ==

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

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

Miscellaneous Functions

2017-03-22T23:33:40Z

Bale:

{{TOCright}}
== Chat Functions ==
{{Flink|void|chat_clan|string}}
{{Flink|void|chat_clan|string|string|desc=Sends a message to clan chat.}}
{{Flink|void|chat_macro|string|desc=Submits a chat macro to KoL.}}
{{Flink|void|chat_notify|string|string|desc=Sends a notification to the player's own chat.}}
{{Flink|void|chat_private|string|string|desc=Sends a private message to another player.}}
{{Flink|boolean|is_online|string|desc=Check to see if a player is online.}}
{{Flink|boolean [string]|who_clan|desc=Returns a list of whom is in your clan and if they are in chat.}}
{{Flink|boolean|can_faxbot|monster|desc=Check to see if a monster can be faxed.}}
{{Flink|boolean|faxbot|monster|desc=Attempts to receive a fax of a given monster.}}

== Debugging Functions ==
{{Flink|void|disable|string|desc=Disables the specified function.}}
{{Flink|void|enable|string|desc=Enables the specified function.}}
{{Flink|buffer|load_html|string|desc=Works like visit_url(), but for debugging.}}
{{Flink|string|make_url|string|boolean|boolean|desc=Crafts the URL to visit.}}

== Map Management Functions ==
''Note: Information about maps (including creating, assigning, and removing keys, can be found at [[Data Structures#Maps|Map Data Structures]].''

{{Flink|boolean|file_to_map|string|aggregate|desc=Loads a map from a tab-delimited text file.}}
{{Flink|boolean|map_to_file|aggregate|string|desc=Saves a map to a tab-delimited text file.}}
{{Flink|int|count|aggregate|desc=Returns the number of defined keys for the specified aggregate.}}
{{Flink|void|clear|aggregate|desc=Removes all keys from the specified aggregate.}}

== Time Functions ==
{{Flink|string|format_date_time|string|string|string|desc=Reformats dates.}}
{{Flink|int|gameday_to_int|desc=Returns the current KoL date as an integer.}}
{{Flink|string|gameday_to_string|desc=Returns the current KoL date as a string.}}
{{Flink|int|gametime_to_int|desc=Returns the current KoL time in ms as an integer.}}
{{Flink|string|now_to_string|string|desc=Returns current local time/date in SimpleDateFormat format.}}
{{Flink|string|time_to_string|desc=Returns the current local time in HH:mm:ss z format.}}
{{Flink|string|today_to_string|desc=Returns the current local day in ISO format.}}

== SVN Functions ==
''There is much additional information in the [[SVN Primer]]''.
{{Flink|boolean|svn_exists|string|desc=Returns true if a valid working copy named projectname exists in the svn/ folder.}}
{{Flink|boolean|svn_at_head|string|desc=Returns true if projectname exists, is a valid working copy, and is currently at the same revision number as the repository.}}
{{Flink|record|svn_info|string|desc=Returns a record containing additional information about the given projectname: svnurl, last author, last revision, last change date.}}

== User Interaction ==
{{Flink|void|print|string|{{opt|string}}|desc=Prints to CLI and status line of Adventuring window, optionally in a specified color.}}
{{Flink|void|print_html|string|desc=Prints to CLI, parsing any included html.}}
{{Flink|void|logprint|string|desc=Prints to the session log.}}
{{Flink|void|wait|int}}
{{Flink|void|waitq|int|desc=Sleeps for the specified number of seconds.}}
{{Flink|boolean|user_confirm|string|desc=Allows user input in Y/N format.}}

== Property Functions ==

{{Flink|boolean [string]|get_all_properties|string|boolean|desc=Returns a map of all user or global properties.}}
{{Flink|boolean|property_exists|string}}
{{Flink|boolean|property_exists|string|boolean|desc=Returns true if the named property exists.}}
{{Flink|boolean|property_has_default|string name|desc=Returns true if the named property in has a default value.}}
{{Flink|string|property_default_value|string name|desc=Returns the default value for a built-in property.}}
{{Flink|string|get_property|string}}
{{Flink|string|get_property|string|boolean|desc=Gets a global or user preference as appropriate.}}
{{Flink|void|set_property|string|string|desc=Sets a global or user preference as appropriate.}}
{{Flink|void|remove_property|string}}
{{Flink|void|remove_property|string|boolean|desc=Removes property or resets it to default.}}
{{Flink|boolean|rename_property|string|string|desc=Changes name of a property.}}

== Other Functions ==
{{Flink|void|abort|{{opt|string}}|desc=Aborts the current script with an optional message.}}
{{Flink|boolean|cli_execute|string|desc=Executes the given command as if it were entered into the CLI.}}
{{Flink|void|batch_open|desc=Used to mark the beginning of a block of functions to operate in batch mode (see page for {{f|batch_close}} for details).}}
{{Flink|boolean|batch_close|desc=Used to mark the end of a block of functions to operate in batch mode (see page for details).}}
{{Flink|int|get_revision|desc=Returns the current KoLmafia revision number.}}
{{Flink|string|get_version|desc=Returns the most recent KoLmafia version.}}
{{Flink|string|get_player_id|string|desc=Returns the user id number of a given player.}}
{{Flink|string|to_json|aggregate|desc=Converts a simple aggregate into JSON.}}

Additional functions that are considered not really to be ash functions are available in [[Miscellaneous ASH Features#Special Syntax Functions|Misc ASH Features]]

[[Category:Scripting]]

Template:Flink

2017-03-22T23:33:08Z

Bale: fix spacing issue

<includeonly>{{
#vardefine:par|no}}{{
#vardefine:par|{{
#if: {{{3|}}}|yes|no}}}}{{{1}}}{{
#ifeq: {{#var:par}}|yes| {{lnkstart}}{{{2}}}{{!}}{{{2}}}({{
#if: {{{3|}}}| {{{3}}}}}{{
#if: {{{4|}}}|, {{{4}}}}}{{
#if: {{{5|}}}|, {{{5}}}}}{{
#if: {{{6|}}}|, {{{6}}}}}{{
#if: {{{7|}}}|, {{{7}}}}}{{
#if: {{{8|}}}|, {{{8}}}}}{{
#if: {{{9|}}}|, {{{9}}}}} ){{lnkend}}}}{{
#ifeq: {{#var:par}}|no| [[{{{2}}}|{{{2}}}()]]}}{{
#if: {{{desc|}}}|<div style="margin-left: 2em; display: block;">{{{desc}}}</div>}}</includeonly>
<noinclude>
This template styles a function call so that it can be displayed as a link in (pseudo) Category pages.
This template requires ''at least'' two (unnamed) parameters to be passed; the first is the datatype returned by the function; the second is the name of the function (''without'' parenthesis).
All additional unnamed parameters will be parsed as datatypes, in order, of the usable parameters. (Up to 8 can be supplied.)
An optional named parameter ''desc'' can be used to include a brief description of the what the function does, which will automatically be included in its display.
Optional parameters can be displayed by wrapping them in the [[Template:Opt|Opt Template]].
 
<pre>
{{Flink|int|some_function}}
</pre>
Returns:
{{Flink|int|some_function}}
<pre>
{{Flink|string|other_function|{{opt|float}}|desc=This is what this bad boy does; blah de freakin' blah}}
</pre>
Returns:
{{Flink|string|other_function|{{opt|float}}|desc=This is what this bad boy does; blah de freakin' blah}}
[[Category:Basic Templates]]
</noinclude>

Template:Flink

2017-03-22T23:32:42Z

Bale:

<includeonly>{{
#vardefine:par|no}}{{
#vardefine:par|{{
#if: {{{3|}}}|yes|no}}}}{{{1}}}{{
#ifeq: {{#var:par}}|yes|,{{lnkstart}}{{{2}}}{{!}}{{{2}}}({{
#if: {{{3|}}}| {{{3}}}}}{{
#if: {{{4|}}}|, {{{4}}}}}{{
#if: {{{5|}}}|, {{{5}}}}}{{
#if: {{{6|}}}|, {{{6}}}}}{{
#if: {{{7|}}}|, {{{7}}}}}{{
#if: {{{8|}}}|, {{{8}}}}}{{
#if: {{{9|}}}|, {{{9}}}}} ){{lnkend}}}}{{
#ifeq: {{#var:par}}|no| [[{{{2}}}|{{{2}}}()]]}}{{
#if: {{{desc|}}}|<div style="margin-left: 2em; display: block;">{{{desc}}}</div>}}</includeonly>
<noinclude>
This template styles a function call so that it can be displayed as a link in (pseudo) Category pages.
This template requires ''at least'' two (unnamed) parameters to be passed; the first is the datatype returned by the function; the second is the name of the function (''without'' parenthesis).
All additional unnamed parameters will be parsed as datatypes, in order, of the usable parameters. (Up to 8 can be supplied.)
An optional named parameter ''desc'' can be used to include a brief description of the what the function does, which will automatically be included in its display.
Optional parameters can be displayed by wrapping them in the [[Template:Opt|Opt Template]].
 
<pre>
{{Flink|int|some_function}}
</pre>
Returns:
{{Flink|int|some_function}}
<pre>
{{Flink|string|other_function|{{opt|float}}|desc=This is what this bad boy does; blah de freakin' blah}}
</pre>
Returns:
{{Flink|string|other_function|{{opt|float}}|desc=This is what this bad boy does; blah de freakin' blah}}
[[Category:Basic Templates]]
</noinclude>

Template:Flink

2017-03-22T23:31:41Z

Bale:

<includeonly>{{
#vardefine:par|no}}{{
#vardefine:par|{{
#if: {{{3|}}}|yes|no}}}}{{{1}}}{{
#ifeq: {{#var:par}}|yes|{{lnkstart}}{{{2}}}{{!}}{{{2}}}({{
#if: {{{3|}}}| {{{3}}}}}{{
#if: {{{4|}}}|, {{{4}}}}}{{
#if: {{{5|}}}|, {{{5}}}}}{{
#if: {{{6|}}}|, {{{6}}}}}{{
#if: {{{7|}}}|, {{{7}}}}}{{
#if: {{{8|}}}|, {{{8}}}}}{{
#if: {{{9|}}}|, {{{9}}}}} ){{lnkend}}}}{{
#ifeq: {{#var:par}}|no| ,[[{{{2}}}|{{{2}}}()]]}}{{
#if: {{{desc|}}}|<div style="margin-left: 2em; display: block;">{{{desc}}}</div>}}</includeonly>
<noinclude>
This template styles a function call so that it can be displayed as a link in (pseudo) Category pages.
This template requires ''at least'' two (unnamed) parameters to be passed; the first is the datatype returned by the function; the second is the name of the function (''without'' parenthesis).
All additional unnamed parameters will be parsed as datatypes, in order, of the usable parameters. (Up to 8 can be supplied.)
An optional named parameter ''desc'' can be used to include a brief description of the what the function does, which will automatically be included in its display.
Optional parameters can be displayed by wrapping them in the [[Template:Opt|Opt Template]].
 
<pre>
{{Flink|int|some_function}}
</pre>
Returns:
{{Flink|int|some_function}}
<pre>
{{Flink|string|other_function|{{opt|float}}|desc=This is what this bad boy does; blah de freakin' blah}}
</pre>
Returns:
{{Flink|string|other_function|{{opt|float}}|desc=This is what this bad boy does; blah de freakin' blah}}
[[Category:Basic Templates]]
</noinclude>

Template:Flink

2017-03-22T23:30:32Z

Bale:

<includeonly>{{
#vardefine:par|no}}{{
#vardefine:par|{{
#if: {{{3|}}}|yes|no}}}}{{{1}}}{{
#ifeq: {{#var:par}}|yes|{{lnkstart}}{{{2}}}{{!}}{{{2}}}({{
#if: {{{3|}}}| {{{3}}}}}{{
#if: {{{4|}}}|, {{{4}}}}}{{
#if: {{{5|}}}|, {{{5}}}}}{{
#if: {{{6|}}}|, {{{6}}}}}{{
#if: {{{7|}}}|, {{{7}}}}}{{
#if: {{{8|}}}|, {{{8}}}}}{{
#if: {{{9|}}}|, {{{9}}}}} ){{lnkend}}}}{{
#ifeq: {{#var:par}}|no| [[{{{2}}}|{{{2}}}()]]}}{{
#if: {{{desc|}}}|, <div style="margin-left: 2em; display: block;">{{{desc}}}</div>}}</includeonly>
<noinclude>
This template styles a function call so that it can be displayed as a link in (pseudo) Category pages.
This template requires ''at least'' two (unnamed) parameters to be passed; the first is the datatype returned by the function; the second is the name of the function (''without'' parenthesis).
All additional unnamed parameters will be parsed as datatypes, in order, of the usable parameters. (Up to 8 can be supplied.)
An optional named parameter ''desc'' can be used to include a brief description of the what the function does, which will automatically be included in its display.
Optional parameters can be displayed by wrapping them in the [[Template:Opt|Opt Template]].
 
<pre>
{{Flink|int|some_function}}
</pre>
Returns:
{{Flink|int|some_function}}
<pre>
{{Flink|string|other_function|{{opt|float}}|desc=This is what this bad boy does; blah de freakin' blah}}
</pre>
Returns:
{{Flink|string|other_function|{{opt|float}}|desc=This is what this bad boy does; blah de freakin' blah}}
[[Category:Basic Templates]]
</noinclude>

Help:To Do List

2017-03-22T22:09:07Z

Bale: /* Missing Stuff */ 17909: Add ASH function: string numberology_prize( number )

{{TOCright}}

== "To Do" List ==

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

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

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

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

== Missing Stuff ==

'''test CLI commands:'''

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

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

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

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

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

r15606: Add "test encounter URL" command.

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

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

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

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

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

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

r16508: Add "test numberology adventureDelta spleenDelta"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

equip [2268] will equip an item by number.

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

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

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

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

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

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

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

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

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

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

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

r15937: Add mayosoak command

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

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

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

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

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

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

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

'''int monster_factoids_available( monster )'''

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

'''string monster_manuel_text( monster )'''

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

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

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

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

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

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

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

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

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

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

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

r17909: Add ASH function: string numberology_prize( number )

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

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

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

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

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

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

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

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

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

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

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

r17284: Allow pranking with timespinner

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

r17290: Add traceprint( string) ASH function

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

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

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

r17817: Added CLI command "absorb"

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

r17845: Add my_absorbs() ash function

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

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

== Needs Major Work ==

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

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

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

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

== Needs Code Samples ==

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

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

Adventuring

2017-03-13T07:50:28Z

Bale:

{{Flink|boolean| adventure|int|location|desc=Visits the desired location the the desired number of times.}}
{{Flink|boolean| adventure|int|location|string|desc=Visits the desired location a specified number of times, using a combat filter function defined elsewhere in your script.}}
{{Flink|boolean| adv1|location|int|string|desc=Adventure exactly once in the specified location (even if it uses no turns). Chained choice adventures '''are''' followed. Int overrides default settings, and string is a filter, same as in [[adventure|adventure()]]}}
{{Flink|buffer| visit_url}}
{{Flink|buffer| visit_url|string}}
{{Flink|buffer| visit_url|string|boolean}}
{{Flink|buffer| visit_url|string|boolean|boolean|desc=Visits the specified address and returns the page source.}}
{{Flink|void| remove_item_condition|int|item|desc=Removes adventuring conditions.}}
{{Flink|void| add_item_condition|int|item|desc=Specifies adventuring conditions. With these in place, [[adventure|adventure()]] will successfully complete once the conditions are met.}}
{{Flink|boolean| is_goal|item|desc=Checks if a given item is a goal.}}
{{Flink|boolean|goal_exists|string|desc=Checks if there is currently a given type of goal.}}
{{Flink|string [int]|get_goals|desc=Lists all current goals.}}
{{Flink|string|get_counters|string|int|int|desc=Determine if a counter will expire in a specified
period of time.}}
{{Flink|void|council|desc=Visits the Council of Loathing.}}
{{Flink|item|guardians|desc=Climbs the Naughty Sorceress' Tower and passes the challenges it can, returning the first item needed to pass a failed stage.}}
{{Flink|int|tavern|desc=Attempt to complete the tavern, and returns the number of squares visited}}
{{Flink|boolean|entryway}}
{{Flink|boolean|hedgemaze}}
{{Flink|boolean|chamber|desc=These three functions attempt to perform the associated tasks. The return value indicates the success.}}
{{Flink|location|my_location|desc=Returns the location where you last adventured.}}
{{Flink|void|set_location|location|desc=Changes the value returned by my_location().}}
{{Flink|void|refresh_status|desc=Refreshes the side-pane character info (health, effects, etc.).}}
{{Flink|buffer|run_combat|desc=Uses the current KoLmafia settings to run a combat (for use with [[visit_url|visit_url()]]).}}
{{Flink|buffer|run_choice|desc=Chooses an option in the current choice adventure.}}
{{Flink|buffer|run_turn|descwork as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.}}
{{Flink|boolean|change_mcd|int|desc=Tries to set your +ML device to a specified setting and reports on success.}}
{{Flink|boolean|hermit|int|item|desc=Trades worthless items (adventuring in the sewer if needed) to the hermit for specified items.}}

==About Monsters==
For all of the below functions that accept an optional monster parameter, the default value is your most recently-encountered monster (that means your current monster if you're in combat).

{{flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}|desc=Returns the chance of successfully getting the jump against the monster or in the location.}}
{{Flink|monster|last_monster|desc=Returns last monster encountered.}}
{{Flink|monster [int]|get_monsters|location|desc=Returns a map of potential monsters at a given location.}}
{{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}|desc=Returns a map of the expected frequency of each monster at the specified location.}}
{{Flink|int|monster_attack|{{opt|monster}}|desc=Returns the starting/current attack value of the specified monster.}}
{{Flink|int|monster_defense|{{opt|monster}}|desc=Returns the starting/current defense value of the specified monster.}}
{{Flink|int|monster_hp|{{opt|monster}}|desc=Returns the starting/current HP of the specified monster.}}
{{Flink|int|monster_initiative|{{opt|monster}}|desc=Returns the starting/current initiative of the specified monster.}}
{{Flink|phylum|monster_phylum|{{opt|monster}}|desc=Returns the phylum of the specified monster.}}
{{Flink|int|expected_damage|{{opt|monster}}|desc=Returns the amount of damage you are expected to take each round from the specified monster.}}
{{Flink|element|monster_element|{{opt|monster}}|desc=Returns the elemental alignment of the specified monster.}}
{{Flink|monster|image_to_monster|string|desc=Looks up monster by image name.}}
{{Flink|boolean|is_banished|monster|desc=Returns true if the specified monster is banished}}

==Misc.==
{{Flink|int|get_auto_attack|desc=Returns your current auto-attack setting.}}
{{Flink|void|set_auto_attack|int|desc=Sets your auto-attack setting.}}
[[Category:Scripting]]

Retrieve item

2017-03-13T07:50:16Z

Bale:

{{
#vardefine:name|retrieve_item}}{{
#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|qty}}|
parameter2={{Param|item|get}}|
p1desc={{Pspan|qty}} is the quantity to acquire|
p2desc={{Pspan|get}} is the item to acquire|
}}|

function_description=Uses KoLmafia's internal logic to gather the items in the least destructive manner. Returns true if items are acquired as specified and false if not.|

code1={{CodeSample|
title=Code Sample|
description=This is an example of a very simple aftercore logout script.|
code=<syntaxhighlight>
item nightcap = $item[ Mon Tiki ];
while (my_inebriety() <= inebriety_limit())
{
if ( !retrieve_item( 1 , nightcap ) )
abort( "Could not make/buy a " + nightcap + " for a nightcap." );
else
overdrink( 1 , nightcap );
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|buy}}|
cli_equiv=The CLI command "acquire" works similarly.|
special=Unlike a few other ASH commands, retrieve_item() will still return false on attempts to acquire items that are not possible to get (such as a sparkly engagement ring).|
more_info=For information on order of operations, see [[Retrieval order]].|
special=This function and it's CLI equivalent "acquire" will not purchase items from the mall that can not be discarded. This is because many of those items are surprisingly expensive. Such items can be detected by checking to see if their {{f|autosell_price}} is 0. There are a few hard-coded exceptions to this rule: clovers, phials, divine favors, love songs and white rice can all be purchased with this command despite not being discardable.|
}}
{{RFI|Are there exceptions to the info listed under Special?}}

[[Category:Item Management]]

Adventuring

2017-03-13T07:47:33Z

Bale: r15235: run_choice() and run_turn()

{{Flink|boolean|adventure|int|location|desc=Visits the desired location the the desired number of times.}}
{{Flink|boolean|adventure|int|location|string|desc=Visits the desired location a specified number of times, using a combat filter function defined elsewhere in your script.}}
{{Flink|boolean|adv1|location|int|string|desc=Adventure exactly once in the specified location (even if it uses no turns). Chained choice adventures '''are''' followed. Int overrides default settings, and string is a filter, same as in [[adventure|adventure()]]}}
{{Flink|buffer|visit_url}}
{{Flink|buffer|visit_url|string}}
{{Flink|buffer|visit_url|string|boolean}}
{{Flink|buffer|visit_url|string|boolean|boolean|desc=Visits the specified address and returns the page source.}}
{{Flink|void|remove_item_condition|int|item|desc=Removes adventuring conditions.}}
{{Flink|void|add_item_condition|int|item|desc=Specifies adventuring conditions. With these in place, [[adventure|adventure()]] will successfully complete once the conditions are met.}}
{{Flink|boolean|is_goal|item|desc=Checks if a given item is a goal.}}
{{Flink|boolean|goal_exists|string|desc=Checks if there is currently a given type of goal.}}
{{Flink|string [int]|get_goals|desc=Lists all current goals.}}
{{Flink|string|get_counters|string|int|int|desc=Determine if a counter will expire in a specified
period of time.}}
{{Flink|void|council|desc=Visits the Council of Loathing.}}
{{Flink|item|guardians|desc=Climbs the Naughty Sorceress' Tower and passes the challenges it can, returning the first item needed to pass a failed stage.}}
{{Flink|int|tavern|desc=Attempt to complete the tavern, and returns the number of squares visited}}
{{Flink|boolean|entryway}}
{{Flink|boolean|hedgemaze}}
{{Flink|boolean|chamber|desc=These three functions attempt to perform the associated tasks. The return value indicates the success.}}
{{Flink|location|my_location|desc=Returns the location where you last adventured.}}
{{Flink|void|set_location|location|desc=Changes the value returned by my_location().}}
{{Flink|void|refresh_status|desc=Refreshes the side-pane character info (health, effects, etc.).}}
{{Flink|buffer|run_combat|desc=Uses the current KoLmafia settings to run a combat (for use with [[visit_url|visit_url()]]).}}
{{Flink|buffer|run_choice|desc=Chooses an option in the current choice adventure.}}
{{Flink|buffer|run_turn|descwork as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.}}
{{Flink|boolean|retrieve_item|int|item|desc=Uses KoLmafia internal logic to gather items.}}
{{Flink|boolean|change_mcd|int|desc=Tries to set your +ML device to a specified setting and reports on success.}}
{{Flink|boolean|hermit|int|item|desc=Trades worthless items (adventuring in the sewer if needed) to the hermit for specified items.}}

==About Monsters==
For all of the below functions that accept an optional monster parameter, the default value is your most recently-encountered monster (that means your current monster if you're in combat).

{{flink|int|jump_chance|{{opt|monster}}|{{opt|int}}|{{opt|int}}}}
{{flink|int|jump_chance|location|{{opt|int}}|{{opt|int}}|desc=Returns the chance of successfully getting the jump against the monster or in the location.}}
{{Flink|monster|last_monster|desc=Returns last monster encountered.}}
{{Flink|monster [int]|get_monsters|location|desc=Returns a map of potential monsters at a given location.}}
{{Flink|float [monster]|appearance_rates|location|{{opt|boolean}}|desc=Returns a map of the expected frequency of each monster at the specified location.}}
{{Flink|int|monster_attack|{{opt|monster}}|desc=Returns the starting/current attack value of the specified monster.}}
{{Flink|int|monster_defense|{{opt|monster}}|desc=Returns the starting/current defense value of the specified monster.}}
{{Flink|int|monster_hp|{{opt|monster}}|desc=Returns the starting/current HP of the specified monster.}}
{{Flink|int|monster_initiative|{{opt|monster}}|desc=Returns the starting/current initiative of the specified monster.}}
{{Flink|phylum|monster_phylum|{{opt|monster}}|desc=Returns the phylum of the specified monster.}}
{{Flink|int|expected_damage|{{opt|monster}}|desc=Returns the amount of damage you are expected to take each round from the specified monster.}}
{{Flink|element|monster_element|{{opt|monster}}|desc=Returns the elemental alignment of the specified monster.}}
{{Flink|monster|image_to_monster|string|desc=Looks up monster by image name.}}
{{Flink|boolean|is_banished|monster|desc=Returns true if the specified monster is banished}}

==Misc.==
{{Flink|int|get_auto_attack|desc=Returns your current auto-attack setting.}}
{{Flink|void|set_auto_attack|int|desc=Sets your auto-attack setting.}}
[[Category:Scripting]]

Miscellaneous Functions

2017-03-12T21:22:30Z

Bale: r17892 add a whole lot of property functions!

{{TOCright}}
== Chat Functions ==
{{Flink|void|chat_clan|string}}
{{Flink|void|chat_clan|string|string|desc=Sends a message to clan chat.}}
{{Flink|void|chat_macro|string|desc=Submits a chat macro to KoL.}}
{{Flink|void|chat_notify|string|string|desc=Sends a notification to the player's own chat.}}
{{Flink|void|chat_private|string|string|desc=Sends a private message to another player.}}
{{Flink|boolean|is_online|string|desc=Check to see if a player is online.}}
{{Flink|boolean [string]|who_clan|desc=Returns a list of whom is in your clan and if they are in chat.}}
{{Flink|boolean|can_faxbot|monster|desc=Check to see if a monster can be faxed.}}
{{Flink|boolean|faxbot|monster|desc=Attempts to receive a fax of a given monster.}}

== Debugging Functions ==
{{Flink|void|disable|string|desc=Disables the specified function.}}
{{Flink|void|enable|string|desc=Enables the specified function.}}
{{Flink|buffer|load_html|string|desc=Works like visit_url(), but for debugging.}}
{{Flink|string|make_url|string|boolean|boolean|desc=Crafts the URL to visit.}}

== Map Management Functions ==
''Note: Information about maps (including creating, assigning, and removing keys, can be found at [[Data Structures#Maps|Map Data Structures]].''

{{Flink|boolean|file_to_map|string|aggregate|desc=Loads a map from a tab-delimited text file.}}
{{Flink|boolean|map_to_file|aggregate|string|desc=Saves a map to a tab-delimited text file.}}
{{Flink|int|count|aggregate|desc=Returns the number of defined keys for the specified aggregate.}}
{{Flink|void|clear|aggregate|desc=Removes all keys from the specified aggregate.}}

== Time Functions ==
{{Flink|string|format_date_time|string|string|string|desc=Reformats dates.}}
{{Flink|int|gameday_to_int|desc=Returns the current KoL date as an integer.}}
{{Flink|string|gameday_to_string|desc=Returns the current KoL date as a string.}}
{{Flink|int|gametime_to_int|desc=Returns the current KoL time in ms as an integer.}}
{{Flink|string|now_to_string|string|desc=Returns current local time/date in SimpleDateFormat format.}}
{{Flink|string|time_to_string|desc=Returns the current local time in HH:mm:ss z format.}}
{{Flink|string|today_to_string|desc=Returns the current local day in ISO format.}}

== SVN Functions ==
''There is much additional information in the [[SVN Primer]]''.
{{Flink|boolean|svn_exists|string|desc=Returns true if a valid working copy named projectname exists in the svn/ folder.}}
{{Flink|boolean|svn_at_head|string|desc=Returns true if projectname exists, is a valid working copy, and is currently at the same revision number as the repository.}}
{{Flink|record|svn_info|string|desc=Returns a record containing additional information about the given projectname: svnurl, last author, last revision, last change date.}}

== User Interaction ==
{{Flink|void|print|string|{{opt|string}}|desc=Prints to CLI and status line of Adventuring window, optionally in a specified color.}}
{{Flink|void|print_html|string|desc=Prints to CLI, parsing any included html.}}
{{Flink|void|logprint|string|desc=Prints to the session log.}}
{{Flink|void|wait|int}}
{{Flink|void|waitq|int|desc=Sleeps for the specified number of seconds.}}
{{Flink|boolean|user_confirm|string|desc=Allows user input in Y/N format.}}

== Property Functions ==

{{Flink|boolean [string]| get_all_properties|string|boolean|desc=Returns a map of all user or global properties.}}
{{Flink|boolean| property_exists|string}}
{{Flink|boolean| property_exists|string|boolean|desc=Returns true if the named property exists.}}
{{Flink|boolean| property_has_default|string name|desc=Returns true if the named property in has a default value.}}
{{Flink|string| property_default_value|string name|desc=Returns the default value for a built-in property.}}
{{Flink|string| get_property|string}}
{{Flink|string| get_property|string|boolean|desc=Gets a global or user preference as appropriate.}}
{{Flink|void| set_property|string|string|desc=Sets a global or user preference as appropriate.}}
{{Flink|string| remove_property|string}}
{{Flink|string| remove_property|string|boolean|desc=Removes property or resets it to default.}}
{{Flink|boolean| rename_property|string|string|desc=Changes name of a property.}}

== Other Functions ==
{{Flink|void|abort|{{opt|string}}|desc=Aborts the current script with an optional message.}}
{{Flink|boolean|cli_execute|string|desc=Executes the given command as if it were entered into the CLI.}}
{{Flink|void|batch_open|desc=Used to mark the beginning of a block of functions to operate in batch mode (see page for {{f|batch_close}} for details).}}
{{Flink|boolean|batch_close|desc=Used to mark the end of a block of functions to operate in batch mode (see page for details).}}
{{Flink|int|get_revision|desc=Returns the current KoLmafia revision number.}}
{{Flink|string|get_version|desc=Returns the most recent KoLmafia version.}}
{{Flink|string|get_player_id|string|desc=Returns the user id number of a given player.}}
{{Flink|string|to_json|aggregate|desc=Converts a simple aggregate into JSON.}}

Additional functions that are considered not really to be ash functions are available in [[Miscellaneous ASH Features#Special Syntax Functions|Misc ASH Features]]

[[Category:Scripting]]

Help:To Do List

2017-03-12T20:57:14Z

Bale: /* Missing Stuff */ r17892: Add a bunch of ASH support for doing interesting things with properties

{{TOCright}}

== "To Do" List ==

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

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

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

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

== Missing Stuff ==

'''test CLI commands:'''

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

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

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

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

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

r15606: Add "test encounter URL" command.

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

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

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

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

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

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

r16508: Add "test numberology adventureDelta spleenDelta"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

equip [2268] will equip an item by number.

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

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

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

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

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

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

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

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

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

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

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

r15937: Add mayosoak command

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

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

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

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

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

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

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

'''int monster_factoids_available( monster )'''

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

'''string monster_manuel_text( monster )'''

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17644: To automatically select pairs of candy, add some ASH functions:
item [int] sweet_synthesis_pair( effect )
item [int] sweet_synthesis_pair( effect, flags )

For the desired effect, pick a suitable pair of candies.
If you are in-run, it will use only "available" candy and will prefer candies that you have more of.
If you are post-run, it will consider all candies and will choose the pair with the lowest total mall price.
If you want to force "available" candies post-run, use flags = 1.

boolean sweet_synthesis( effect )
boolean sweet_synthesis( effect, flags )

The same, but it will actually perform Sweet Synthesis to get the effect.

http://kolmafia.us/showthread.php?21144-Rethinking-Candy&p=139996&viewfull=1#post139996

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

r17673: Add "shop reprice" command and reprice_shop() ash function

r17677: edpiece? command tells you the effects of the various decorations, as well as telling you which one is currently equipped.

r17817: Added CLI command "absorb"

r17819: Add ASH function to interface to KoL's /count chat command:
int slash_count( item it )

r17845: Add my_absorbs() ash function

r17892: Add a bunch of ASH support for doing interesting things with properties:
http://kolmafia.us/showthread.php?21570-Properties&p=141625&viewfull=1#post141625
http://kolmafia.us/showthread.php?21570-Properties&p=141629&viewfull=1#post141629

boolean [string] get_all_properties( string filter, boolean global )
boolean property_exists( string name )
boolean property_exists( string name, boolean global )
boolean property_has_default( string name )
string property_default_value( string name )
string get_property( string name, boolean global )
string remove_property( string name )
string remove_property( string name, boolean global )
boolean rename_property( string old_name, string new_name )

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2017-02-22T21:19:49Z

Bale: /* Missing Stuff */ r17845: Add my_absorbs() ash function

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r17658: http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=140128#post140128

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17644: To automatically select pairs of candy, add some ASH functions:
item [int] sweet_synthesis_pair( effect )
item [int] sweet_synthesis_pair( effect, flags )

For the desired effect, pick a suitable pair of candies.
If you are in-run, it will use only "available" candy and will prefer candies that you have more of.
If you are post-run, it will consider all candies and will choose the pair with the lowest total mall price.
If you want to force "available" candies post-run, use flags = 1.

boolean sweet_synthesis( effect )
boolean sweet_synthesis( effect, flags )

The same, but it will actually perform Sweet Synthesis to get the effect.

http://kolmafia.us/showthread.php?21144-Rethinking-Candy&p=139996&viewfull=1#post139996

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

r17673: Add "shop reprice" command and reprice_shop() ash function

r17677: edpiece? command tells you the effects of the various decorations, as well as telling you which one is currently equipped.

r17817: Added CLI command "absorb"

r17819: Add ASH function to interface to KoL's /count chat command:
int slash_count( item it )

r17845: Add my_absorbs() ash function

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2017-02-16T05:21:53Z

Bale: /* Missing Stuff */ r17819: int slash_count( item it )

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r17658: http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=140128#post140128

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17644: To automatically select pairs of candy, add some ASH functions:
item [int] sweet_synthesis_pair( effect )
item [int] sweet_synthesis_pair( effect, flags )

For the desired effect, pick a suitable pair of candies.
If you are in-run, it will use only "available" candy and will prefer candies that you have more of.
If you are post-run, it will consider all candies and will choose the pair with the lowest total mall price.
If you want to force "available" candies post-run, use flags = 1.

boolean sweet_synthesis( effect )
boolean sweet_synthesis( effect, flags )

The same, but it will actually perform Sweet Synthesis to get the effect.

http://kolmafia.us/showthread.php?21144-Rethinking-Candy&p=139996&viewfull=1#post139996

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

r17673: Add "shop reprice" command and reprice_shop() ash function

r17677: edpiece? command tells you the effects of the various decorations, as well as telling you which one is currently equipped.

r17817: Added CLI command "absorb"

r17819: Add ASH function to interface to KoL's /count chat command:
int slash_count( item it )

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2017-02-16T04:36:16Z

Bale: /* Missing Stuff */ r17817: Added CLI command "absorb"

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r17658: http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=140128#post140128

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17644: To automatically select pairs of candy, add some ASH functions:
item [int] sweet_synthesis_pair( effect )
item [int] sweet_synthesis_pair( effect, flags )

For the desired effect, pick a suitable pair of candies.
If you are in-run, it will use only "available" candy and will prefer candies that you have more of.
If you are post-run, it will consider all candies and will choose the pair with the lowest total mall price.
If you want to force "available" candies post-run, use flags = 1.

boolean sweet_synthesis( effect )
boolean sweet_synthesis( effect, flags )

The same, but it will actually perform Sweet Synthesis to get the effect.

http://kolmafia.us/showthread.php?21144-Rethinking-Candy&p=139996&viewfull=1#post139996

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

r17673: Add "shop reprice" command and reprice_shop() ash function

r17677: edpiece? command tells you the effects of the various decorations, as well as telling you which one is currently equipped.

r17817: Added CLI command "absorb"

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2017-01-17T23:39:08Z

Bale: /* Missing Stuff */ r17673: Add "shop reprice" command & r17677: edpiece?

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r17658: http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=140128#post140128

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17644: To automatically select pairs of candy, add some ASH functions:
item [int] sweet_synthesis_pair( effect )
item [int] sweet_synthesis_pair( effect, flags )

For the desired effect, pick a suitable pair of candies.
If you are in-run, it will use only "available" candy and will prefer candies that you have more of.
If you are post-run, it will consider all candies and will choose the pair with the lowest total mall price.
If you want to force "available" candies post-run, use flags = 1.

boolean sweet_synthesis( effect )
boolean sweet_synthesis( effect, flags )

The same, but it will actually perform Sweet Synthesis to get the effect.

http://kolmafia.us/showthread.php?21144-Rethinking-Candy&p=139996&viewfull=1#post139996

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

r17673: Add "shop reprice" command and reprice_shop() ash function

r17677: edpiece? command tells you the effects of the various decorations, as well as telling you which one is currently equipped.

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2017-01-13T09:38:53Z

Bale: /* Missing Stuff */

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r17658: http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=140128#post140128

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17644: To automatically select pairs of candy, add some ASH functions:
item [int] sweet_synthesis_pair( effect )
item [int] sweet_synthesis_pair( effect, flags )

For the desired effect, pick a suitable pair of candies.
If you are in-run, it will use only "available" candy and will prefer candies that you have more of.
If you are post-run, it will consider all candies and will choose the pair with the lowest total mall price.
If you want to force "available" candies post-run, use flags = 1.

boolean sweet_synthesis( effect )
boolean sweet_synthesis( effect, flags )

The same, but it will actually perform Sweet Synthesis to get the effect.

http://kolmafia.us/showthread.php?21144-Rethinking-Candy&p=139996&viewfull=1#post139996

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Item Management

2017-01-08T22:12:35Z

Bale: All Sweet Synthesis skills as of r17644

{{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|int [item]|get_clan_lounge|desc=Returns a map of your Clan VIP Lounge 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. 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.}}

===Sweet Synthesis===
{{Flink|item [int]|candy_for_tier|int|{{opt|int}}|desc=Returns all the candy to create a given tier of effect.}}
{{Flink|item [int]|sweet_synthesis_pairing|effect|item|{{opt|int}}|desc=Find a second candy to synthesize.}}
{{Flink|item [int]|sweet_synthesis_pair|effect|{{opt|int}}|desc=Picks a pair of candies to synthesize for an effect.}}
{{Flink|effect|sweet_synthesis_result|item|item|desc=Show result of synthesis.}}
{{Flink|boolean|sweet_synthesis|item|item|desc=Synthesize specified candies.}}
{{Flink|boolean|sweet_synthesis|effect|{{opt|int}}|desc=Picks a pair of candies and synthesizes them for the effect.}}

[[Category:Scripting]]

Help:To Do List

2017-01-08T21:56:23Z

Bale: /* Missing Stuff */

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17644: To automatically select pairs of candy, add some ASH functions:
item [int] sweet_synthesis_pair( effect )
item [int] sweet_synthesis_pair( effect, flags )

For the desired effect, pick a suitable pair of candies.
If you are in-run, it will use only "available" candy and will prefer candies that you have more of.
If you are post-run, it will consider all candies and will choose the pair with the lowest total mall price.
If you want to force "available" candies post-run, use flags = 1.

boolean sweet_synthesis( effect )
boolean sweet_synthesis( effect, flags )

The same, but it will actually perform Sweet Synthesis to get the effect.

http://kolmafia.us/showthread.php?21144-Rethinking-Candy&p=139996&viewfull=1#post139996

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2017-01-08T20:43:44Z

Bale: /* Missing Stuff */ r17644: To automatically select pairs of candy, add some ASH functions

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

r17644: To automatically select pairs of candy, add some ASH functions:
item [int] sweet_synthesis_pair( effect )
item [int] sweet_synthesis_pair( effect, flags )
boolean sweet_synthesis( effect )
boolean sweet_synthesis( effect, flags )

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2017-01-08T20:38:21Z

Bale: /* Missing Stuff */ r17645 synthesize(?) EFFECT

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

r17645: Add CLI commands:
synthesize EFFECT
synthesize? EFFECT

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2017-01-08T06:22:25Z

Bale: /* Missing Stuff */ r17637: Add "synthesize" command

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

r17637: Add "synthesize" command: synthesize CANDY1, CANDY2 - combines candies to get an effect
synthesize? CANDY1, CANDY2 - tells you about the candies and the effect

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2017-01-06T22:16:40Z

Bale: /* Missing Stuff */ r16790: int [int] reverse_numberology()

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16790: Add ASH function int [int] reverse_numberology([int adv_delta, int spleen_delta]).
The return value is a map from result IDs to input seeds that generate said results.
adv_delta and spleen_delta, which both default to 0, allow one to obtain forecasts on upcoming options.
http://kolmafia.us/showthread.php?19664-ASH-command(s)-for-Numberology&p=133467&viewfull=1#post133467

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2017-01-05T02:42:21Z

Bale: /* Missing Stuff */ r17629: overload candy_for_tier() and sweet_synthesis_pairing()

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

r17629: Add candy_for_tier() and sweet_synthesis_pairing() ASH functions that have a "flags" argument,
in which you can specify filtering. 0 = no filtering, 1 = available, 2 = allowed, 3 = available and allowed.

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2017-01-02T02:50:10Z

Bale: /* Missing Stuff */ r17612 & r17613: Sweet Synthesis stuff

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

r17612: ASH has a function to return all the candy in a given tier:
item [int] '''candy_for_tier'''( int tier )
The "'''checkcandy'''" command will list all unspaded candy or will tell you the candy type of each of its arguments.

r17613: More Sweet Synthesis stuff: ASH functions:
boolean '''sweet_synthesis'''( item candy1, item candy2 )
effect '''sweet_synthesis_result'''( item candy1, item candy2 )
item [int] '''sweet_synthesis_pairings'''( effect result, item candy1 )

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

SVN Primer

2016-12-19T21:40:05Z

Bale: re-order

{{TOCright}}

== Introduction ==

Subversion (svn) is a centralized version control system. A repository (repo) exists online — this repo contains a scripting project. KoLmafia can download scripts from an online SVN repo and automatically install them for the user. It can even automatically update scripts to the latest version without any effort from the user.

== Non-Technical FAQ ==
'''Q. What is this "SVN" thinggy?''' 
A. It's a better way for users to install scripts.

'''Q. What do I have to know about SVN to use this feature?''' 
A. Absolutely nothing! There's a Script Manger under the Scripts menu. You can select scripts you want to install, right-click and select "install script." Then the magic happens. It's really simple.
:[[File:Script_Manager_Abridged.png]]

'''Q. At the top of the page you said "automatically update scripts." None of my scripts have updated themselves so how does that work?''' 
A. There's a preference you have to set to enable it which is off by default. Go to Preferences -> SVN -> Check "Update installed SVN projects on login." That will cause all your SVN installed scripts to be updated once a day.
:[[File:Preferences_SVN.png]]

'''Q. Why is SVN good for KoLmafia scripts?''' 
A. There are a whole bunch of reasons. I'll enumerate:
# It makes finding the script you want easy. Just read down the list checking the description for each.
# It makes script installation easier. The user doesn't have to ensure that the script is downloaded into the correct directory or fret about putting multiple files into multiple directories.
# It makes script updating easier. All scripts can be updated automatically at first run of the day, or the user can type <code> svn update </code> to manually update all scripts.
# It is easier for the scripter to publish his scripts and keep them up to date.
# When you recommend a script in chat, you can tell them its name in the Script Manager without their having to go download something from the KoLmafia forum.

'''Q. Why was this added to mafia?''' 
A. We understand that a lot of people don't use scripts, even scripts that will help them a lot. This is because they find it troublesome to find and install scripts. The intention is to make it easy to install scripts. Even a script like Character Info Toolbox which contains more than 30 files is easy to install now. Just install it from Mafia's Script Manager and every single file will be placed in the correct directory. If you don't like it, you can use the Script Manager to delete it and all those files are removed.

'''Q. Wait! Does this mean I don't have to find the correct thread on the KoLmafia forum and login there to install a script?''' 
A. Yup. It's incomprehensible to most of us, but we've noticed that people hate reading our forum. Now you won't have to do that.

'''Q. This sounds like black magic!''' 
A. Please state your problem in the form of a question. 
Q. How does that work? 
A. Black magic. Not really, but it is very impressive and you don't really need to know the mechanics. Just trust that it works.

== Revision Merging ==
There is another even more impressive ability of the KoLmafia's svn update: Revision Merging! This is only helpful to people who know how to modify someone's script, but you only need to understand a few lines of any script to make this worth reading.

The ''real'' awesome here is aimed at people who sometimes like to make small modifications to their scripts. People like you with a little bit of scripting ability. I suspect you've sometimes made a tiny tweak to a script to make it more perfect for your specific needs. Then the original author updates his script and you're stuck trying to decide if it is worth your trouble to copy all your modifications to the new version of his script. If not, you might just refuse to update it. With SVN if you know what you are doing, you can update your cake and eat it too! When svn updates your script it will automatically keep your modifications, producing a blend of your modifications and the author's update. Now I'll tell you how to do this.

# Acquire the most recent version using <code> svn update </code>
# Open the script's working copy in the project's /svn directory, and make your edits. Always make sure the project in /svn has your changes
# Use the command <code> svn sync </code> to push your modifications in the working copy to the local copy in the /scripts or /relay directory
# If you ever want to modify your changes or add to them, just repeat steps 2 and 3.

That's it! Now you can update from svn as usual. You can use <code> svn update bale-ocd </code> to update just that script, or <code> svn update </code> to update all your scripts or just check the box in SVN preferences to make it happen automatically once a day. Whenever the script is updated SVN will magically merge your changes into the working copy in the /svn folder and then push those changes into the local copy. This is magic! This will happen every single time you use svn to update the script without requiring your intervention. The CLI will display a "G" for merGing the script instead of a "U" for Updating it when this happens.

=== Revision Conflicts ===
If an update to a script changes it so severely that it cannot be merGed with your modifications, it will show "C" for Conflict and produce several files in the working copy to help you solve the problem:
* myfile - will have some inline markup at the location of the conflict ( look for <<<<<< and >>>>> markup) showing you both what your text was and what the repo's text was.
* myfile.mine - Your version before the update.
* myfile.rOld - The pristine repo versions from before the update.
* myfile.rNew - The pristine repo versions from after the update.

With all of these files, you can pretty easily figure out where the problem line(s) are, and how to fix them. Sometimes you'll just want to use rNew and discard your local changes, sometimes you'll want to do something else. Copy/pasting between the different files is straightforward. You will need to delete the extra files when you're done resolving the conflict, and make sure that the remaining file has the same name as the original file.

== Information for Scripters ==
The SVN repo contains your project. It not only contains the files for your project, but every previous version of those files that's ever existed. Think of old versions like hitting ctrl-z on a Word document — you can revert changes all the way back to the start, or anywhere in between.

It is more than just a place to save files though. There is something called a Working Copy, which is a local version of a remote repository, plus any local changes you may have made. The process of creating this Working Copy is referred to as "checking out" the repo, or "checkout." You have probably also heard the term "commit" which is simply taking some/all local changes in a working copy and syncing them with the repo. Then other users sync their working copies with the repo, and voila!

=== How to Set Up a Repo ===
A working copy contains a hidden folder, .svn, that contains all of the metadata needed to know how your local version differs from the repository's version. This is created for you when you checkout the project. You don't really need to know any of these details, really, for the most part using svn does not require knowing how it works under the hood. What you may be interested in is how to create your own repo.

I'll go over the easiest method under Windows - using TortoiseSVN. Under *nix you should probably just be using the command line "svn" client, though I imagine there are a million different graphical alternatives. There are alternatives in windows as well, I just prefer TortoiseSVN for its file system integration.

First, get a [https://sourceforge.net/ sourceforge] account. Make a new project there. Download [http://tortoisesvn.net/downloads.html TortoiseSVN] and install it. Make a new folder somewhere on your computer. Right-click, and choose SVN Checkout... from the context menu. You will want to give it the address that you see on your new sourceforge project code page - for now just grab the http:// address, it's easier. Ignore the commands in front of the address and after it, those are for command-line svn tools.

The rest of the default options are okay. Click OK and you should get a new working copy of your repo! Cool. Open it up and let's add some stuff. Add a new directory called scripts/, and within scripts/ put a new text file. Now navigate back up to the root of your working copy, right click on the folder, and choose SVN commit... Tick all the files/folders (tick the "show unversioned files" box if it's not ticked), give it a quick commit comment up top. You should have to enter your sourceforge user information, save it if you want. If you've done everything correctly, your new project should have been committed.

Optional: to really play around with this, checkout a second working copy somewhere in another folder on your computer. Try committing changes from one working copy to the repo, then doing right-click SVN Update on the other working copy. Notice how TortoiseSVN helpfully changes the little file/folder icons for you when you make modifications to things. Hopefully you're starting to see how this whole thing works.

=== What it Can Do ===
Svn is a very mature tool by now, so there's an absolute ton of stuff that I won't cover. You may for example notice that mafia itself has a "Latest SVN Changes" forum, which has .diffs of all the changes to files within mafia. There's also creating patches, merging repos, yada yada... Won't talk about it.

I'm more interested in talking about how mafia svn integration works. Doing <code> svn checkout <repo> </code> creates a working copy of the repo in your svn/ folder. Then, mafia "pushes" the contents of that working copy to the appropriate subfolders. For example, if a repo has a scripts/dostuff.ash file, that file gets copied to your scripts/ folder.

svn update goes through all your working copies and performs an update. There are other operations that can happen here. With a checkout, you can only be adding ("A") new files to a working copy. With an update you can update ("U"), merge ("G"), delete ("D") or also add ("A") files. Here, we warn the user whenever a file is added, due to security concerns. Note that "U"pdating '''only happens if the "pushed" local file still exists in the user's directory'''. I am bolding this because I'm sure it will confuse some people. This feature is a safeguard against svn re-installing scripts over and over that the user just wants to have deleted.

If you installed TortoiseSVN above and browse to the svn/ folder, you may notice something: the working copies checked out with svn checkout are fully-featured working copies, just like you checked out using TortoiseSVN. This means that you can make changes directly to this folder and commit them to the repo using TortoiseSVN - if you have repo commit permissions, of course.

=== Specifications ===
At the base level of the SVN link there are only several legal folders which may contain scripts:
* ccs/
* data/
* images/
* planting/
* relay/
* scripts/
Additionally there is only one legal file:
* dependencies.txt
If there are any other folders or files at the base level of the SVN repository, it will fail to be checked out by KoLmafia. This is a security feature. Within the stated folders you can nest any additional folders and files you desire.

When the SVN repo is committed, the scripts in the folders will be pushed to local copies in corresponding folders in the KoLmafia directory. If there is a file of the same name in any of those folder, or a sub-folder of those folders, then the file will be copied to that location. This allows the user to move the files to new locations or sub-folders and still know that KoLmafia will keep it up to date.

The file <code>'''dependencies.txt'''</code> contains a list of other SVN repositories that this script will automatically install. This is done so that the script can install other scripts it depends on. If there is a <code>'''dependencies.txt'''</code> file at the root directory of the repo, it will not be pushed along with the files in the various folders. It only exists to serve this purpose. Each line in the file provides a url to another SVN project. Here is an example of what a dependencies.txt file may look like:
<nowiki> https://svn.code.sf.net/p/zlib/code
https://svn.code.sf.net/p/smartstasis/code
https://svn.code.sf.net/p/therazekolmafia/canadv/code/</nowiki>

== How to Command SVN ==
KoLmafia has both ASH and CLI commands to interact with SVN repos.
=== CLI Commands ===
SVN Repositories can be checked out, updated or deleted from the CLI with the following commands:
* <code>svn checkout <svnurl></code>
: This checks out an svn repository and adds the files from the working copy to the appropriate locations. <svnurl> must be a <nowiki>svn://, http://, or https://</nowiki> link to a valid svn repo.
* <code>svn list</code>
: This lists installed projects.
* <code>svn update </code>
* <code>svn update <projectname></code>
* <code>svn update <SVNURL></code>
: This updates your installed projects and pushes any changes to the appropriate locations. If the parameter is blank it will update everything.
* <code>svn delete <projectname></code>
: This deletes an installed project and the corresponding files that it pushed. <projectname> fuzzy matches the script names from svn list.
* <code>svn increment <projectname></code>
* <code>svn decrement <projectname></code>
: These two commands move an installed svn project up/down one revision, respectively.
* <code>svn inc <projectname></code>
* <code>svn dec <projectname></code>
: The same as the previous two commands. Because typing stuff is hard.
* <code>svn sync</code>
: This looks through your working copies for modifications, then checks if that file differs from the local copy. If it differs, the working copy file is copied over the local copy one. Note that this is very different from "svn update" and does not contact the repository server at all.

=== ASH Commands ===
There are a few additional functions that ASH possesses to check up on an SVN repo.
* {{Flink|boolean|svn_exists|string|desc=Returns true if a valid working copy named projectname exists in the /svn folder.}}
* {{Flink|boolean|svn_at_head|string|desc=Returns true if projectname exists, is a valid working copy, and is currently at the same revision number as the repository.}}
* {{Flink|record|svn_info|string|desc=Returns a record containing additional information about the given projectname: svnurl, last author, last revision, last change date.}}

[[Category:New User Help]][[Category:Scripting]][[Category:Tech Support]]

SVN Primer

2016-12-19T21:35:55Z

Bale: /* Revision Merging */

{{TOCright}}

== Introduction ==

Subversion (svn) is a centralized version control system. A repository (repo) exists online — this repo contains a scripting project. KoLmafia can download scripts from an online SVN repo and automatically install them for the user. It can even automatically update scripts to the latest version without any effort from the user.

== Non-Technical FAQ ==
'''Q. What is this "SVN" thinggy?''' 
A. It's a better way for users to install scripts.

'''Q. What do I have to know about SVN to use this feature?''' 
A. Absolutely nothing! There's a Script Manger under the Scripts menu. You can select scripts you want to install, right-click and select "install script." Then the magic happens. It's really simple.
:[[File:Script_Manager_Abridged.png]]

'''Q. At the top of the page you said "automatically update scripts." None of my scripts have updated themselves so how does that work?''' 
A. There's a preference you have to set to enable it which is off by default. Go to Preferences -> SVN -> Check "Update installed SVN projects on login." That will cause all your SVN installed scripts to be updated once a day.
:[[File:Preferences_SVN.png]]

'''Q. Why is SVN good for KoLmafia scripts?''' 
A. There are a whole bunch of reasons. I'll enumerate:
# It makes finding the script you want easy. Just read down the list checking the description for each.
# It makes script installation easier. The user doesn't have to ensure that the script is downloaded into the correct directory or fret about putting multiple files into multiple directories.
# It makes script updating easier. All scripts can be updated automatically at first run of the day, or the user can type <code> svn update </code> to manually update all scripts.
# It is easier for the scripter to publish his scripts and keep them up to date.
# When you recommend a script in chat, you can tell them its name in the Script Manager without their having to go download something from the KoLmafia forum.

'''Q. Why was this added to mafia?''' 
A. We understand that a lot of people don't use scripts, even scripts that will help them a lot. This is because they find it troublesome to find and install scripts. The intention is to make it easy to install scripts. Even a script like Character Info Toolbox which contains more than 30 files is easy to install now. Just install it from Mafia's Script Manager and every single file will be placed in the correct directory. If you don't like it, you can use the Script Manager to delete it and all those files are removed.

'''Q. Wait! Does this mean I don't have to find the correct thread on the KoLmafia forum and login there to install a script?''' 
A. Yup. It's incomprehensible to most of us, but we've noticed that people hate reading our forum. Now you won't have to do that.

'''Q. This sounds like black magic!''' 
A. Please state your problem in the form of a question. 
Q. How does that work? 
A. Black magic. Not really, but it is very impressive and you don't really need to know the mechanics. Just trust that it works.

== Information for Scripters ==
The SVN repo contains your project. It not only contains the files for your project, but every previous version of those files that's ever existed. Think of old versions like hitting ctrl-z on a Word document — you can revert changes all the way back to the start, or anywhere in between.

It is more than just a place to save files though. There is something called a Working Copy, which is a local version of a remote repository, plus any local changes you may have made. The process of creating this Working Copy is referred to as "checking out" the repo, or "checkout." You have probably also heard the term "commit" which is simply taking some/all local changes in a working copy and syncing them with the repo. Then other users sync their working copies with the repo, and voila!

=== How to Set Up a Repo ===
A working copy contains a hidden folder, .svn, that contains all of the metadata needed to know how your local version differs from the repository's version. This is created for you when you checkout the project. You don't really need to know any of these details, really, for the most part using svn does not require knowing how it works under the hood. What you may be interested in is how to create your own repo.

I'll go over the easiest method under Windows - using TortoiseSVN. Under *nix you should probably just be using the command line "svn" client, though I imagine there are a million different graphical alternatives. There are alternatives in windows as well, I just prefer TortoiseSVN for its file system integration.

First, get a [https://sourceforge.net/ sourceforge] account. Make a new project there. Download [http://tortoisesvn.net/downloads.html TortoiseSVN] and install it. Make a new folder somewhere on your computer. Right-click, and choose SVN Checkout... from the context menu. You will want to give it the address that you see on your new sourceforge project code page - for now just grab the http:// address, it's easier. Ignore the commands in front of the address and after it, those are for command-line svn tools.

The rest of the default options are okay. Click OK and you should get a new working copy of your repo! Cool. Open it up and let's add some stuff. Add a new directory called scripts/, and within scripts/ put a new text file. Now navigate back up to the root of your working copy, right click on the folder, and choose SVN commit... Tick all the files/folders (tick the "show unversioned files" box if it's not ticked), give it a quick commit comment up top. You should have to enter your sourceforge user information, save it if you want. If you've done everything correctly, your new project should have been committed.

Optional: to really play around with this, checkout a second working copy somewhere in another folder on your computer. Try committing changes from one working copy to the repo, then doing right-click SVN Update on the other working copy. Notice how TortoiseSVN helpfully changes the little file/folder icons for you when you make modifications to things. Hopefully you're starting to see how this whole thing works.

=== What it Can Do ===
Svn is a very mature tool by now, so there's an absolute ton of stuff that I won't cover. You may for example notice that mafia itself has a "Latest SVN Changes" forum, which has .diffs of all the changes to files within mafia. There's also creating patches, merging repos, yada yada... Won't talk about it.

I'm more interested in talking about how mafia svn integration works. Doing <code> svn checkout <repo> </code> creates a working copy of the repo in your svn/ folder. Then, mafia "pushes" the contents of that working copy to the appropriate subfolders. For example, if a repo has a scripts/dostuff.ash file, that file gets copied to your scripts/ folder.

svn update goes through all your working copies and performs an update. There are other operations that can happen here. With a checkout, you can only be adding ("A") new files to a working copy. With an update you can update ("U"), merge ("G"), delete ("D") or also add ("A") files. Here, we warn the user whenever a file is added, due to security concerns. Note that "U"pdating '''only happens if the "pushed" local file still exists in the user's directory'''. I am bolding this because I'm sure it will confuse some people. This feature is a safeguard against svn re-installing scripts over and over that the user just wants to have deleted.

If you installed TortoiseSVN above and browse to the svn/ folder, you may notice something: the working copies checked out with svn checkout are fully-featured working copies, just like you checked out using TortoiseSVN. This means that you can make changes directly to this folder and commit them to the repo using TortoiseSVN - if you have repo commit permissions, of course.

=== Specifications ===
At the base level of the SVN link there are only several legal folders which may contain scripts:
* ccs/
* data/
* images/
* planting/
* relay/
* scripts/
Additionally there is only one legal file:
* dependencies.txt
If there are any other folders or files at the base level of the SVN repository, it will fail to be checked out by KoLmafia. This is a security feature. Within the stated folders you can nest any additional folders and files you desire.

When the SVN repo is committed, the scripts in the folders will be pushed to local copies in corresponding folders in the KoLmafia directory. If there is a file of the same name in any of those folder, or a sub-folder of those folders, then the file will be copied to that location. This allows the user to move the files to new locations or sub-folders and still know that KoLmafia will keep it up to date.

The file <code>'''dependencies.txt'''</code> contains a list of other SVN repositories that this script will automatically install. This is done so that the script can install other scripts it depends on. If there is a <code>'''dependencies.txt'''</code> file at the root directory of the repo, it will not be pushed along with the files in the various folders. It only exists to serve this purpose. Each line in the file provides a url to another SVN project. Here is an example of what a dependencies.txt file may look like:
<nowiki> https://svn.code.sf.net/p/zlib/code
https://svn.code.sf.net/p/smartstasis/code
https://svn.code.sf.net/p/therazekolmafia/canadv/code/</nowiki>

== How to Command SVN ==
KoLmafia has both ASH and CLI commands to interact with SVN repos.
=== CLI Commands ===
SVN Repositories can be checked out, updated or deleted from the CLI with the following commands:
* <code>svn checkout <svnurl></code>
: This checks out an svn repository and adds the files from the working copy to the appropriate locations. <svnurl> must be a <nowiki>svn://, http://, or https://</nowiki> link to a valid svn repo.
* <code>svn list</code>
: This lists installed projects.
* <code>svn update </code>
* <code>svn update <projectname></code>
* <code>svn update <SVNURL></code>
: This updates your installed projects and pushes any changes to the appropriate locations. If the parameter is blank it will update everything.
* <code>svn delete <projectname></code>
: This deletes an installed project and the corresponding files that it pushed. <projectname> fuzzy matches the script names from svn list.
* <code>svn increment <projectname></code>
* <code>svn decrement <projectname></code>
: These two commands move an installed svn project up/down one revision, respectively.
* <code>svn inc <projectname></code>
* <code>svn dec <projectname></code>
: The same as the previous two commands. Because typing stuff is hard.
* <code>svn sync</code>
: This looks through your working copies for modifications, then checks if that file differs from the local copy. If it differs, the working copy file is copied over the local copy one. Note that this is very different from "svn update" and does not contact the repository server at all.

=== ASH Commands ===
There are a few additional functions that ASH possesses to check up on an SVN repo.
* {{Flink|boolean|svn_exists|string|desc=Returns true if a valid working copy named projectname exists in the /svn folder.}}
* {{Flink|boolean|svn_at_head|string|desc=Returns true if projectname exists, is a valid working copy, and is currently at the same revision number as the repository.}}
* {{Flink|record|svn_info|string|desc=Returns a record containing additional information about the given projectname: svnurl, last author, last revision, last change date.}}

== Revision Merging ==
There is another even more impressive ability of the KoLmafia's svn update: Revision Merging! This is only helpful to people who know how to modify someone's script so if you cannot understand a single line of any script you might as well skip this part.

The ''real'' awesome here is aimed at people who sometimes like to make small modifications to their scripts. People like you with a little bit of scripting ability. I suspect you've sometimes made a tiny tweak to a script to make it more perfect for your specific needs. Then the original author updates his script and you're stuck trying to decide if it is worth your trouble to copy all your modifications to the new version of his script. If not, you might just refuse to update it. With SVN if you know what you are doing, you can update your cake and eat it too! When svn updates your script it will automatically keep your modifications, producing a blend of your modifications and the author's update. Now I'll tell you how to do this.

# Acquire the most recent version using <code> svn update </code>
# Open the script's working copy in the project's /svn directory, and make your edits. Always make sure the project in /svn has your changes
# Use the command <code> svn sync </code> to push your modifications in the working copy to the local copy in the /scripts or /relay directory
# If you ever want to modify your changes or add to them, just repeat steps 2 and 3.

That's it! Now you can update from svn as usual. You can use <code> svn update bale-ocd </code> to update just that script, or <code> svn update </code> to update all your scripts or just check the box in SVN preferences to make it happen automatically once a day. Whenever the script is updated SVN will magically merge your changes into the working copy in the /svn folder and then push those changes into the local copy. This is magic! This will happen every single time you use svn to update the script without requiring your intervention. The CLI will display a "G" for merGing the script instead of a "U" for Updating it when this happens.

=== Revision Conflicts ===
If an update to a script changes it so severely that it cannot be merGed with your modifications, it will show "C" for Conflict and produce several files in the working copy to help you solve the problem:
* myfile - will have some inline markup at the location of the conflict ( look for <<<<<< and >>>>> markup) showing you both what your text was and what the repo's text was.
* myfile.mine - Your version before the update.
* myfile.rOld - The pristine repo versions from before the update.
* myfile.rNew - The pristine repo versions from after the update.

With all of these files, you can pretty easily figure out where the problem line(s) are, and how to fix them. Sometimes you'll just want to use rNew and discard your local changes, sometimes you'll want to do something else. Copy/pasting between the different files is straightforward. You will need to delete the extra files when you're done resolving the conflict, and make sure that the remaining file has the same name as the original file.

[[Category:New User Help]][[Category:Scripting]][[Category:Tech Support]]

Help:To Do List

2016-12-13T01:26:42Z

Bale: /* Missing Stuff */ r17520

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r17520 does the same for effects:
> test effectids Got Milk
Got Milk has 1 effectid: 211
> test effectids A Little Bit Evil
A Little Bit Evil has 6 effectids: 597, 598, 599, 600, 601, 602

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2016-12-12T00:05:55Z

Bale: /* Missing Stuff */ r17507

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r17507: Experimental: ItemDatabase keeps a set of all item ids for each item name.
> test itemids seal tooth
seal tooth has 1 itemid: 2
> test itemids Staff of Ed
Staff of Ed has 2 itemids: 2325, 7961
> test itemids ancient amulet
ancient amulet has 2 itemids: 2180, 7963

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Set auto attack

2016-12-08T20:44:50Z

Bale: r17491 adds version with a string parameter

{{
#vardefine:name|set_auto_attack}}{{
#vardefine:return_type|void}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|setting}}|
p1desc={{Pspan|setting}} is the KoL attack code: 0 for disabled, 1 for attack with weapon, a [http://kol.coldfront.net/thekolwiki/index.php/Skills_by_number skillID] number, or a macroID number preceeded by 99.|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|setting}}|
p1desc={{Pspan|setting}} is the attack expressed as a string: "attack", "steal", "pickpocket", "pick pockey" or the name of a skill.|
}}|

function_description=Sets your auto-attack to the {{Pspan|setting}}. |

needscode=yes|
see_also={{SeeAlso|get_auto_attack}}|
cli_equiv=The CLI command "autoattack" functions similarly.|
}}
{{RFI|Does the CLI command allow macro setting?}}
[[Category:Adventuring]]

Help:To Do List

2016-12-07T06:27:20Z

Bale: /* Missing Stuff */ r17477: can_still_steal()

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

r17477: Add boolean '''can_still_steal()''' function to ASH, which calls the same function
that Stationary Buttons use do decide whether to enable or disable the "steal" button

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Get ccs action

2016-12-06T10:00:38Z

Bale:

{{
#vardefine:name|get_ccs_action}}{{
#vardefine:return_type|string}}{{

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|round}}|
p1desc={{pspan|round}} is the current round of combat|
}}|

function_description=This function will read a line from the active [[Custom Combat Script|CCS]] for a given round and return that round's command as a string. This will only return a value from the section of the [[Custom Combat Script|CCS]] for the monster that is currently being fought. Note that this command is only useful in consult scripts or combat filters. See {{f|adventure}} for more details.|

code1={{CodeSample|
title=Code Sample|
description=This incredibly basic combat filter will simply do exactly what the CCS instructs.|
code=
<syntaxhighlight>
string run_combat(int round, monster opp, string text) {
return get_ccs_action(round);
}
</syntaxhighlight>}}
{{CodeSample|
description=This is a function designed for use in a combat consult script that has parameters contained in a note field of the CCS. (A note is just a comment that contains information.)|
code=
<syntaxhighlight>
string get_parameter() {
for i from 0 upto 30 {
ccs_line = get_ccs_action(i).to_lower_case();
if(ccs_line.substring(0, 5) == "note ")
return get_ccs_action(i).to_lower_case();
}
}
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|run_combat}}|
}}

[[Category:In-combat Consulting]]

Help:To Do List

2016-12-05T19:56:43Z

Bale: /* Missing Stuff */ r17446 test crop, r17454 increment and decrement, r17460 java style for loop

{{TOCright}}

== "To Do" List ==

This is a list of stuff that is missing from the wiki or else needs major work. Please help!

If you need tips for editing the wiki, find that here: [[Help:Editing]].

*CLI Commands are usually only added to the [[CLI Reference]]. Only very complicated commands require their own page.

*ASH commands need to be listed on their category page as well as on the [[Ash Functions]] list.
**It is not necessary to always create a code sample, although it is preferred.
**If you don't add a code sample, please remember to add '''needscode=yes|''' to the page.

== Missing Stuff ==

'''test CLI commands:'''

r14764: add "test xpath" to, well, test xpath expressions
r14767: Expose an xpath function that relay scripts can use after they've invoked visit_url().
http://kolmafia.us/showthread.php?16722-the-DOM-regex-scalability-and-other-jargony-words
http://kolmafia.us/showthread.php?16764-xpath-primer

r14967: Add "test mchat" command which can be used after "test load JSONFILE"

This is how test newitem is used!
http://kolmafia.us/showthread.php?17365-When-detecting-new-items-detect-new-outfits-too&p=119368&viewfull=1#post119368
r15741, Now "test newitem descId" no longer requires itemId.

r15176: Add "test adventure URL" CLI command to see how we translate the given URL

r15239: Add "test dump_disabled_skills" to the gCLI to aid upcoming debugging

r15606: Add "test encounter URL" command.

r15874: Add "test leet NAME" command to check if KoL monster names get translated successfully from their 1337 versions.

r15883: "test load HTMLFILE" followed by "test aagain" will print the Adventure Again URL from that page.

r16275: "test visit-choice" now prints the various choice options available on the loaded HTML text.

r16309: Add "test manuel" command which will process a loaded HTML file as if it were the response to a visit to Monster Manuel.
http://kolmafia.us/showthread.php?19094-shrine-to-the-Barrel-god-(Sept-2015-IotM)&p=128256&viewfull=1#post128256

r15928: Add "test monster" command to parse the monster out of the saved HTML and save
it where ASH's last_monster() function will fetch it.

r16496: Add "test spleen X" to set your current spleen use to X (as far as KoLmafia knows; obviously it does not actually change KoL's value).

r16508: Add "test numberology adventureDelta spleenDelta"

r16519: Add "test stats X" to set all three stat values to X substats (if X > 0).

r17296: Add "test cookies" command to see values of the "special" cookies we track.

r17446: Soup up "test crop" command to allow specifying current crop and test crop.
Fix crop "is better than" test to only include count when comparing identical crop type

r15148: Track Xiblaxian holo-wrist-puter drops in '''_holoWristDrops''', and progress toward the next drop in '''_holoWristProgress'''.

r15177: Track which keys have been used on the Sorceress Tower door in a setting: '''nsTowerDoorKeysUsed'''
It is a comma separated list.

r15235: Add buffer '''run_choice( int )''' command. When in a choice adventure, use this to submit the selected option.
With -1 as imput, it will automate the rest of the choice using existing settings.

Also add '''run_turn()''', which will work as run_combat() or run_choice( -1 ) depending on whether you are in combat or in a choice.

r15238: Provide '''limit_mode()''' function that returns (currently) null or spelunky.

r15354: Move "equip all familiars" function from the FamiliarTrainingFrame to a new
module: FamiliarManager. Let ASH use it via boolean '''equip_all_familiars()'''

r15440: Add "'''servants'''" command to list Ed's servants, "'''servant'''" to list status of your current servant,
and "'''servant TYPE'''" to switch to the servant of the specified type.

r15441 adds the $servant data type to ASH and the following functions to manipulate them:

int '''to_servant'''( servant )
servant to_servant( int )
servant to_servant( string )
servant '''my_servant'''()
boolean '''have_servant'''( servant )
boolean '''use_servant'''( servant )

Additionally, it has the following proxy fields:
int id
string name
int level
int experience
string image,
string level1_ability
string level7_ability
string level14_ability
string level21_ability

r15466: Add '''chew'''(INT,ITEM) to ASH for cnsuming spleen toxins

equip [2268] will equip an item by number.

r15475: Add '''prefref''' as a built-in gCLI command

r15590: '''Add run_combat( string filter )'''.

r15676: Make built-in Sorceress Tower scripts available to scripts.

CLI: '''maze''' [arg]
CLI: '''door'''

'''hedge_maze( string )'''
'''tower_door()'''

The string argument for the maze can be one of:
traps - 4 turns, all traps
gopher or duck - 7 turns gopher and duck
chihuahua or kiwi - 7 turns chihuahua and kiwi
nugglets - 10 turns, all nugglets

r15791: The "pvp" command with no arguments will list available stances and their
associated option number. You now can now specify a stance by either name or
number. The "pvp" command now requires you to choose a stance, since it can
no longer choose a reaosnable default based on your stats.

r15796: Add ASH function: '''int [string] current_pvp_stances()'''

r15840: Provide ASH '''string leetify( string )''' function to garble strings.

r15847: Add "Random Monster Attributes" modifier as provided by dice items and the
Curse of Randomness status effect. Add random_attributes proxy field to ASH
$monster type. Munge random attributes from monster names is the Random Monster
Attribute modifier is > 0, not only if current path is One Crazy Random Summer.

r15922: Add Familiar Script. This script will run after changing familiars, before
automatically changing familiar equipment. The script should have a boolean main() function.
Returning true will cause normal familiar equipiment switching to be skipped,
while false will lead to it running after the script returns.

r15937: Add mayosoak command

r15959: Add knowledge of familiar drop counters to FamiliarData,
New ASH proxy fields for $familiar data type:
drop_name = short name of the thing that drops
drop_item = if it is a single item, the $item. Otherwise, $item[none]
drops_today = how many things this familiar has dropped so far today
drops_limit = the maximum number of available drops from this familiar today

CLI: wumpus status - Display status of last wumpus cave.
r16014: Add "wumpus replay FILE" command to process the session log of a wumpus exploration and make deductions, etc.
r16015: Add "wumpus reset" CLI command to clear in-memory Wumpus cave state

r16044:The "cheat" command is a synonym for the "play" command. options:
play random - play a random card (1 draw)
cheat phylum PHYLUM - cheat (5 draws) a fight with specified phylum
cheat stat STAT - cheat (5 draws) 500 substats of specified stat
cheat buff BUFF - cheat (5 draws) 20 turns of the specified buff, either by name
or by effect: muscle, mysticality, moxie, item drop (or items), initiative
cheat CARD - cheat (5 draws) the specified card name.
PHYLUM, STAT, BUFF, and CARD all use fuzzy matching.

r16047: Track Armorer quest (Madness Bakery) as questM25Armorer.

r16060: Make fixed list of modifier maximizer strings configurable
set maximizerList. Default value is:
mainstat | mus | mys | mox | familiar weight | HP | MP | ML | DA | DR | +combat -tie | -combat -tie | initiative | exp | meat drop | item drop | 2.0 meat, 1.0 item | item, sea | weapon dmg | ranged dmg | elemental dmg | spell dmg | adv | pvp fights | hot res | cold res | spooky res | stench res | sleaze res | all res | mp regen | ML, 0.001 slime res | 4 clownosity, -tie | 7 raveosity, -tie | surgeonosity | +four songs

r16163: For all monsters where our name differs from Manuel's, add a new attribute: Manuel: "MANUEL NAME"
Add .manuelName proxy field for ASH $monster data type

Add "'''checkmanuel'''" command which will look up all of you

'''int monster_factoids_available( monster )'''

returns number of factoids currently retained in memory. Note that this
can be more than the currently logged in character knows, since we don't
flush the factoids from a previous login if you know all three factoids.

'''string monster_manuel_text( monster )'''

returns the full HTML of the monster manuel entry for the given
monster. As above, this could have been retained from the previous
character; otherwise, it will fetch and cache the text.

r16166: Add ASH function: '''boolean [monster] all_monsters_with_id()'''

returns a map of all monsters that have a non-zero monster ID. It builds this
afresh every time you call it, since new monsters can be (temporarily) added

r16169: Add MonsterManuelManager.flushCache()and expose it to ASH via flush_'''monster_manuel_cache()''' function.
Add a second parameter to MonsterManuelManager.getFactoidsAvailable: boolean
cachedOnly says "don't look on the page if the monster is not in the cache,
because we have already looked at the page and the monster wasn't there."
Expose this to ASH by changing '''monster_factoids_available()''' parameters: monster, boolean

r16171: Add ASH function: '''boolean[monster] get_location_monsters(location)'''
This has the same info as get_monsters, but returns a (perhaps) more useful aggregate value

r16200: '''Mayominder''' CLi command. Sets (buying if needed) Mayo Minder to a particular Mayo.
Can specify Mayo name or use a description (adv, stat, food, drunk or bmc).

r16218: Add ASH function '''get_stash()''' to retrieve cached view of clan stash

r16391: Add ASH '''skill_modifier'''(object, modifiername) (currently only useful for "Skill")
to interpret the specified modifier of an item as a skill object.

r16396, r16398 & r16399 : '''Numberology''' command:
numberology - lists all the currently possible seeds and what they give you
numberology? N - N is the desired (numeric) result you want. Tell you if it is currently available.
numberology N - Attempts to get the desired result.
For both of these, if it is not currently available, tells you in how many turns it will be available.

16481: Add $vykea type to ASH
vykea my_vykea_companion( )
int to_int( vykea )
vykea to_vykea( strict_string )

r16800: Add multi-line string support to ASH. In order to specify a multi-line string,
you must explicitly escape the end-of-line by placing a backslash (\) at the end of the line.

Note that as a consequence of how the parser is written, it will trim all
leading and trailing whitespace for each of these lines via Java's
String.trim() method. Previously, this was irrelevant in the context of ASH
strings, but now that ASH strings can span multiple lines, it is worth
mentioning. If you want to have whitespace at the beginning of the line,
just escape the first character of the line.

r16866: Add aggregate literals to ASH.
http://kolmafia.us/showthread.php?20103-16866-Add-aggregate-literals-to-ASH-The-main-use-of-these-is-likely-for-initializa
http://kolmafia.us/showthread.php?10685-Map-literals-in-ASH-(potential-feature)&p=134150#post134150

r16886: Add '''witchess''' command to get Puzzle Champ. This only works if you have solved all puzzles.

r16978: Eudora CLI command now returns current correspondent with no argument.
Add ash string eudora() command which returns current correspondent.
Add ash boolean eudora(string) command which takes "penpal", "game" or "xi" and attempts to set that correspondent.

r17023: Add terminal gCLI command

r17136: Track furniture in the Clan Rumpus Room, accessible with '''get_clan_rumpus()'''. Extra Adventures and PvP Fights from furniture are tracked.
If your clan has a ball pit, the last entry in get_clan_rumpus() will indicate how many balls are in it.

r17471: get_clan_rumpus() now returns int [string] map of furniture names.
http://kolmafia.us/showthread.php?21006-Improve-return-value-of-get_clan_rumpus()

r17151: Add ASH and CLI support for stocking mall stores from Hagnk's.
boolean '''put_shop_using_storage(int price, int limit, item it)'''
boolean '''put_shop_using_storage(int price, int limit, int qty, item it)'''

and extends the CLI commands mallsell and shop.
put_shop() works by batching requests for "shop put". Similarly, buy_using_storage() puts together requests via "buy using storage".

r17283: Add "timespinner" command courtesy of lost.
Add "timespinner" command courtesy of lost.
timespinner list food -> list available foods
timespinner eat FOOD -> Spin and Munch on the specified food

r17284: Allow pranking with timespinner

r17286: Add "timespinner list monsters [filter]". This will show all monsters that should be available in the Time-Spinner, optionally filtered (case-insensitive).

r17290: Add traceprint( string) ASH function

r17454: Experimental ASH feature: allow X++, X--, ++X, and --X with their normal meanings: post-increment, post-decrement, pre-increment, and pre-decrement.

r17460: Add Java-style "for" loop:
for (INIT [, INIT]* ; CONDITION ; ITERATE [, ITERATE]* ) BODY
You can have 0 or more INIT statements, which can be of the form
X = EXP (where X is declared already) or
TYPE X = EXP (whre X of type TYPE will be declared for use in the BODY scope).

You can have 0 or more ITERATE statements, which can be of the form
X++ or X--
++X or -- X
X OPER EXP (where OPER can be =, +=, -=, etc.

BODY can be a single statement ending with a ; or a block enclosed in {}, with no ; at the end, just like and other loop.

break, continue, return, or exit are allowed within BODY, just like any loop.

== Needs Major Work ==

[[Proxy Records]] is only slightly better than a placeholder.

In r10047, the adventure tab interface was altered. Fix SinginSally's guide on pages...

http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Attack_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Custom_Combat_Script
http://wiki.kolmafia.us/index.php?title=KoLmafia_Guide:_Goal-Oriented_Adventuring

Information on moods calling other moods: http://kolmafia.us/showthread.php?8852-Composable-Moods&p=66468&viewfull=1#post66468

== Needs Code Samples ==

There is a list of all pages that require code samples: [[:Category:Needs_Code_Sample|Category:Needs Code Sample]]

Information on how to create a code sample: [[Template:CodeSample]]
[[Category:Contributing]]

Help:To Do List

2016-12-05T03:32:08Z

Bale: /* Missing Stuff */ r17471: get_clan_rumpus() now returns int [string] map of furniture names.

Storage amount

2016-12-04T01:11:09Z

Bale: Changed in r17441

{{
#vardefine:name|storage_amount}}{{
#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|it}}|
p1desc={{Pspan|it}} is the item to check|
}}|

function_description=Returns the amount of the given item that are in storage at Hagnk's.|

code1={{CodeSample|
title=Code Sample|
description=The following code will check a pull list loaded from a text file.|
code=
<syntaxhighlight>
int day = 2;
int [int, item] static_pulls; //Items that are always included in a pull list.
file_to_map( "static_pulls.txt" , static_pulls );

//Validate your pull list before you begin the day
foreach it, req_num in static_pulls[ day ]
{
if ( storage_amount( it ) < req_num )
print( "Uh-oh! You don't have enough of " + it + " to pull." , "red" );
else
print( "You have enough " + it );
}
</syntaxhighlight>
|moreinfo=Note that [[take_storage]]() returns a boolean value indicating whether an attempt at pulling was successful.
}}|

see_also={{SeeAlso|closet_amount|display_amount|equipped_amount|item_amount|shop_amount|stash_amount}}|
more_info=Information on handling free pulls is at [[Tips, Tricks and Workarounds#Free Pulls|Tips, Tricks and Workarounds]].|
}}

[[Category:Item Management]]

Adv1

2016-12-03T21:13:59Z

Bale: see also run_combat()

{{
#vardefine:name|adv1}}{{
#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|location|place}}|
parameter2={{Param|int|turnsUsed}}|
parameter3={{Param|string|filterFunc}}|
p1desc={{Pspan|place}} is the adventuring location.|
p2desc={{Pspan|turnsUsed}} overrides the normal number of adventures that are expected to be consumed at this location, or -1 can be passed to use the default. Specifically, 0 will prevent any counters from triggering - of course, if an adventure actually is consumed, any counters that you kept from triggering will be lost.|
p3desc={{Pspan|filterFunc}} is a macro or the name of a combat filter function defined elsewhere in your script, with the same behavior as in the 3-paramater version of [[adventure]](). An empty string can be passed to use your battle action or CCS as normal.}}|

function_description=This will adventure exactly once in the specified {{pspan|place}} (even if it took no turns), although it will follow chained choice adventures for as long as you have preset options.

If {{Pspan|filter}} contains a semicolon it will use {{Pspan|filter}} as a macro.
This function does not have to make use of its return value, but if you wish to do so, it will return true if all adventures were used, and false if it is unable to do so for any reason (not enough adventures, location unavailable, etc.).|

code1={{CodeSample|
title=Code Sample|
description=Adventures 1 time at the Slime Tube. If an adventure takes no turns, possibly because the Gall Bladder was already squeezed, that adventure will still count. Counters will trigger as normal.|
code=
<syntaxhighlight>
adv1($location[slime tube], -1, "");
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|run_combat}}|
cli_equiv=None - "adv" will always try adventuring again if an adventure took no turns.|
}}

[[Category:Adventuring]]

Adventure

2016-12-03T21:13:36Z

Bale: see also run_combat()

{{
#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, monster opp, string text) {
if(opp != $monster[Goth Giant])
return get_ccs_action(round);
if(round == 1 && have_effect($effect[On the Trail]) < 1)
return "skill transcendent olfaction";
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, monster opp, string text) {
if (opp == $monster[frog] || opp == $monster[newt]
|| opp == $monster[salamander]) {
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, monster 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|run_combat}}|
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]]

Run combat

2016-12-03T21:13:03Z

Bale: two parameter version

{{
#vardefine:name|run_combat}}{{
#vardefine:return_type|buffer}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|string|filter}}|
p1desc={{Pspan|filter}} is a macro or the name of a combat filter function defined elsewhere in your script, with the same behavior as in the 3-paramater version of adventure(). An empty string can be passed to use your battle action or CCS as normal. Essentially, this allows the scripter to put a CCS or macro into a script.|
}}|

function_description=Proceeds to run a combat using your current KoLmafia settings. This function returns the HTML from the final round of combat (not just what is displayed, but all markup). Most commonly used to finish up combats started via [[visit_url|visit_url()]].

Another handy use for this function is to finish up combats that were started in the relay browser, or were interrupted (causing mafia to pop up the minibrowser). Typing "ashq run_combat()" into the CLI will finish up the combat for you using your current CCS/battle action. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire combat results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This is a personalized version of adv1() that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, run_combat() is used.|
code=
<syntaxhighlight>
int run_adv(location place) {
string page_text = to_url(place).visit_url();
string choiceAdventure = "-1";
matcher m_choice = create_matcher("whichchoice value=(\\d+)", page_text);
while(page_text.contains_text("choice.php")) {
m_choice.reset(page_text);
m_choice.find();
choiceAdventure = m_choice.group(1);
string choice_num = get_property("choiceAdventure"+ choiceAdventure);

if(choice_num == "0") abort("Manual Control for "+ choiceAdventure);
if(choice_num == "") abort("Unsupported Choice Adventure!");

page_text = visit_url("choice.php?pwd&whichchoice="+ choiceAdventure +"&option="+ choice_num);
}
if(page_text.contains_text("Combat"))
run_combat();
return choiceAdventure.to_int();
}
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url}}|

special=Will return the text of the last combat encounter when called independently of a fight page.|
}}

[[Category:Adventuring]]

Adventure

2016-11-29T22:43:31Z

Bale: r17447

{{
#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, monster opp, string text) {
if(opp != $monster[Goth Giant])
return get_ccs_action(round);
if(round == 1 && have_effect($effect[On the Trail]) < 1)
return "skill transcendent olfaction";
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, monster opp, string text) {
if (opp == $monster[frog] || opp == $monster[newt]
|| opp == $monster[salamander]) {
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, monster 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]]

Get ccs action

2016-11-29T22:41:48Z

Bale: r17447

Custom Combat Script

2016-11-29T22:39:27Z

Bale: /* Consult Scripts */ small clarification

{{TOCright}}
== Basic CCS ==
A Custom Combat Script (CCS) is a way of instructing mafia how to handle combat, round by round. For example, a simple CCS would be to tell mafia to pickpocket on round 1, then cast entangling noodles on round 2 and finally on rounds 3+ to use shieldbutt. If it is unable to carry out one of those steps, then that step will be skipped. For instance, if the character failed to get initiative, then pickpocket will be skipped and the character will go straight to entangling noodles. That CCS would look like this:

<div style="border: solid 1px black; padding: 1em; margin:0px 20px;">
[ default ] 
try to steal an item 
skill entangling noodles 
skill shieldbutt 
</div>

If you wanted to treat different monsters differently, that can be accommodated also. For instance, the following CCS will attempt to cast Transcendent Olfaction upon Black Knights while treating all other monsters differently. If the character currently has "On the Trail" then that line will be skipped.

<div style="border: solid 1px black; padding: 1em; margin:0px 20px;">
[ Black Knight ] 
try to steal an item 
skill transcendent olfaction 
skill entangling noodles 
skill shieldbutt 

[ default ] 
try to steal an item 
skill entangling noodles 
skill shieldbutt 
</div>

Note that when you use a CCS, your CLI will report "character executes a macro!" because the CCS is converted into a macro to save on page loads

=== Available Commands ===
* attack
* skill
* item, use
* try to steal an item, pickpocket
* summon pastamancer ghost
* jiggle chefstaff
* combo {followed by one of the following}
** Disco Concentration, Disco Nirvana, Disco Inferno, Disco Bleeding, Disco Blindness
** Rave Knockout, Rave Bleeding, Rave Concentration, Rave Steal, Rave Nirvana, Rave Stats
** [http://kolmafia.us/showthread.php?5709-Add-rave-combo-learning-to-quot-special-action-quot&p=42107&viewfull=1#post42107 random rave]
* abort
* abort after
* section [section name]
* special
* delevel
* skip
* note
* twiddle

=== Using ASH Constants in CCS ===
Certain ASH constants can be used in CCS as section headers.
* '''$phylum[ ]''' refers to the 22 {{kolwiki|Monster Types|Monster Phylumn}}.
* '''$element[ ]''' refers to either the attack or the defense element. As long as one matches, this check will be satisfied.
* '''$item[ ]''' refers to an item that the monster drops. If there are multiple monsters that drop the item (such as SGEEA) it will match any of those monsters.

You may specify more than one of these, but unless everything matches, it won't match. So if you specify an impossible combination, that CCS section will not run.

<div style="border: solid 1px black; padding: 1em; margin:0px 20px;">
[ $element[ spooky ] $item[ hobo nickel ] ] 
skill entangling noodles 
skill weapon of the pastalord 

[ bathroom $element[ spooky ] ] 
attack 

[ $phylum[ beast ] ] 
skill stomp 
attack 
</div>

== Macros in CCS ==
Macros may be used in a Custom Combat Script in addition to the basic commands. Any line in quotes and any macro command used in a CCS will be made into part of the macro which KoLmafia is passing to KoL. You can find an primer on all KoL's macros at {{kolwiki|Combat Macros}}.

Also there is a section in the CCS called "global prefix" which will be part of every combat macro KoLmafia generates, regardless of the monster encountered.

=== Example of CCS Macro ===
Here's an example of a CCS that generates a macro which will cause KoL to wait for a hobo monkey to steal meat from your enemy before launching attacks.
<div style="border: solid 1px black; padding: 1em; margin:0px 20px;">
[ default ] 
sub monkey_stasis 
:while !match "climbs up and sits on your shoulder" && !pastround 20 && !hppercentbelow 20
::call stasis_item
:endwhile
endsub 
call monkey_stasis 
attack

[ global prefix ] 
scrollwhendone 
"abort missed 5" 
"abort pastround 27" 
sub stasis_item 
:if hascombatitem facsimile dictionary
::item facsimile dictionary
::goto _endstasisitem
:endif
:if hascombatitem seal tooth
::item seal tooth
::goto _endstasisitem
:endif
:if hascombatitem spices
::item spices
::goto _endstasisitem
:endif
:if hascombatitem spectre scepter
::item spectre scepter
::goto _endstasisitem
:endif
:if hascombatitem dictionary
::item dictionary
::goto _endstasisitem
:endif
:"abort "No infinite use items detected!" "
:mark _endstasisitem
endsub 
sub stasis 
:while !pastround 20 && !hppercentbelow 20 && mppercentbelow 99
::call stasis_item
:endwhile
endsub
</div>

=== Concerns for macros in CCS ===
*A macro's abort command needs to be encased in quotes because abort is also a legal CCS command. That's why all aborts in the previous example were quoted.

*If a comment is the last line in a CCS, that will be used as your finishing attack even though it does nothing. Never conclude a CCS with a macro comment or it will abort to the mini-browser with a warning from KoL that you executed 37 commands in a row without taking an action.

== Consult Scripts ==
While a CCS may seem reasonably flexible, sometimes you will want to do something too complicated to express in that format. For instance if you want your character to take different actions based on your characters current stats or current monster level, a consult script can automatically figure it out. There are few limits to what a consult script can enable. The downside to using a consult script is that KoLmafia will not be able to generate a combat macro to pass to KoL. As a result multi-round combat will take somewhat longer.

A consult script is called by using the "consult" command in your CCS, as follows:

<div style="border: solid 1px black; padding: 1em; margin:0px 20px;">
[ default ] 
consult myscript.ash 
attack 
</div>

The main() function in the ASH script being consulted must accept three parameters:

void main(int round, monster mob, string page_text)

These values will be supplied by mafia when the consult script is called.

=== Example of a Consult Script ===
This example will attempt to maximize use of a Sauceror's spells as a Sauceror by making use of sauce splash effects when they can be used.
<div style="margin-bottom: 1em; border: dashed 1px green; padding: 1em; margin:0px 20px;"><syntaxhighlight>
// Save this as SauceSplash.ash
boolean sauceSplash() {
if(!my_class() == $class[Sauceror])
return false;
int normal = numeric_modifier("spell damage");
if(normal >= 25)
return true;
int cold = numeric_modifier("cold spell damage");
int hot = numeric_modifier("hot spell damage");

#deal with monsters weak to cold
if(((((monster_element() == $element[stench]) || (monster_element() == $element[sleaze]))
&& have_skill($skill[Immaculate Seasoning]))
|| have_equipped($item[Gazpacho's Glacial Grimoire]))
&& cold + normal >= 25)
return true;
#deal with monsters weak to hot
else if((((((monster_element() == $element[cold]) || (monster_element() == $element[spooky]))
&& have_skill($skill[Immaculate Seasoning]))
|| have_equipped($item[Codex of Capsaicin Conjuration])
|| have_equipped($item[Ol' Scratch's manacles])
|| have_equipped($item[Ol' Scratch's ash can]))
&& hot + normal >= 25)
#deal with monsters weak to neither (hot/non-aligned)
else if(have_skill($skill[Immaculate Seasoning])
&& cold != hot && max(cold, hot) + normal >= 25)
return true;
else return false;
}

void main(int initround, monster foe, string page) {
if(have_effect($effect[Burning Soul]) || have_effect($effect[Soul Freeze]) || !sauceSplash())
use_skill($skill[Saucegeyser]);
else
use_skill($skill[Wave of Sauce]);
}
</syntaxhighlight></div>

This consult script can then be integrated into a CCS like this:
<div style="border: solid 1px black; padding: 1em; margin:0px 20px;">
[ default ] 
consult SauceSplash.ash 
attack 
</div>

=== Parts of a Combat Consultation Script ===
As you can see in the above example, a consultation script is called with three parameters.
*The first parameter is the round of combat that the script is called. Sometimes it is important to keep track of the round. This is particularly important to keep from losing the fight by going over 30 rounds.
*The second parameter is the monster that you are fighting. This is important because it enables you to take different actions for different monsters.
*The third parameter is the text of the page. This is important because it enables you to examine every detail of the fight as it is taking place. It can be analyzed for potential actions, damage that you deal to a monster and all other events.

All possible actions you can take in a round of combat are listed under [[In-combat Consulting]].

=== Resolution of a Combat Consultation Script ===
The consult script can automate as many, or as few rounds of combat as desired to achieve its goal. When it finishes executing, if the monster is not yet dead, then the CCS will continue combat from the current round. Note that the current round is not always the next line in a script. For instance, if the consult script is called at round 1 and executes three actions, then it will return to the CCS at round 4. This is why most CCSs containing consult script prefer to have only a line after the consult script, usually a simple method of killing a monster.

=== Macros in Consult Scripts ===
It is possible for a consult script to submit a macro. As a simple example, if your consult script wants to submit a macro that simply attacks the monster until the combat ends...

<div style="margin-bottom: 1em; border: dashed 1px green; padding: 1em; margin:0px 20px;"><syntaxhighlight>
string macro = "attack; repeat"
visit_url("fight.php?action=macro&macrotext=" + url_encode(macro) ,true,true);
</syntaxhighlight></div>

Between macro commands you need to insert either /n or a semi-colon as in the above example. Your submitted macro can be as complicated as you wish.

[[Category:Scripting]]

Help:To Do List

2016-10-22T20:14:03Z

Bale: /* Missing Stuff */ r17296: Add "test cookies" command

Help:To Do List

2016-10-18T16:50:43Z

Bale: /* Missing Stuff */ r17290: Add traceprint()

Help:To Do List

2016-10-15T18:20:47Z

Bale: /* Missing Stuff */