Difference between pages "Npc price" and "Help:To Do List"

From Kolmafia
(Difference between pages)
Jump to navigation Jump to search
imported>Theraze
(Created page with "{{ #vardefine:name|npc_price}}{{ #vardefine:return_type|int}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate}}| return...")
 
imported>Bale
(more PvP stuff. We seriously need a PvP page for all the commands and so forth.)
 
Line 1: Line 1:
−
{{
+
{{TOCright}}
−
#vardefine:name|npc_price}}{{
 
−
#vardefine:return_type|int}}{{
 
  
−
FunctionPage|
+
== "To Do" List ==
−
name={{#var:name}}|
 
  
−
function1={{Function|
+
This is a list of stuff that is missing from the wiki or else needs major work. Please help!
−
name={{#var:name}}|
 
−
aggregate={{#var:aggregate}}|
 
−
return_type={{#var:return_type}}|
 
−
return_also={{#var:return_also}}|
 
−
parameter1={{Param|item|shop_for}}|
 
−
p1desc={{Pspan|shop_for}} is the item to inquire on the npc price and availability of.|
 
−
}}|
 
  
−
function_description=Returns the current price of the given item from NPC shops, given availability to the player. This function runs a new check each time it is called, so if you call this function and then unlock a new NPC store, calling this function again will return the new availability state of the item.|
 
  
−
see_also={{SeeAlso|historical_price|buy|mall_price|retrieve_item}}|
+
If you need tips for editing the wiki, find that here: [[Help:Editing]].
−
special=Items not currently available will return 0. When not logged in, this function returns 0 for all items, as none of them are available to you at the time.|
 
−
}}
 
  
−
[[Category:Item Management]]
+
*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 ==
 +
10078: ash function format_dtg
 +
10081: ash function format_dtg renamed to be
 +
string '''format_date_time(inFormat, dtg, outFormat)'''
 +
more info: http://kolmafia.us/showthread.php?8451-time_to_string()-with-parameter&p=64058&viewfull=1#post64058
 +
 
 +
Modify examples on proxy record page because of:
 +
10122: Add the boolean "fancy" and "candy" fields to item '''proxy records'''.
 +
10147: Initial support for "Crimbo 2011" coinmaster: trade candy for Candy Credits
 +
10412: Add $skill '''proxy records''': .dailylimit and .timescast
 +
10879: Add a boolean "boss" field to $monster[]
 +
 
 +
10227: Add the <s>"'''closet empty'''" CLI command, and</s> the '''empty_closet()''' ASH function.
 +
 
 +
r9181, 9183, 9184 & r9190: '''moods''' per slyz's summary here: http://kolmafia.us/showthread.php?8852-Composable-Moods
 +
 
 +
r10344 Add '''tavern( string goal )''' ASH function.
 +
goal can be "faucet", "baron", or  "explore" (to explore all remaining unexplored squares).
 +
r10345 Add ASH '''tavern( "fight" )''' to explore cellar until the Baron's mansion is found
 +
and then go in to fight him.
 +
 
 +
r10753-6 '''get_goals()''' returns a string[int] containing all the conditions that KoLmafia will
 +
try to satisfy. Add g'''oal_exists()''' where you can pass in a goal type (choiceadv, autostop,
 +
meat, health, mana, item) and KoLmafia will tell you if there are any goals that match.
 +
 
 +
'''static''' scope is added!
 +
r10765: Add a "final" scope type to ASH which allows data/commands to be executed only
 +
once per session.
 +
r10772: A final declaration can either take a block, surrounded by {}, or a single
 +
command or declaration.
 +
r10774: ASH: "final" -> "static"
 +
 
 +
10922: Add '''get_player_id()''' method to ASH
 +
 
 +
10937: Add '''minstrel_quest()''' boolean function,
 +
which returns true when Clancy has a new quest for you.
 +
 
 +
10971: Added boolean '''hippy_stone_broken()''' function
 +
 
 +
11008: Add the ASH function int[effect] '''my_effects()''', which returns an array of
 +
the character's current effects and their duration. Intrinsic effects have a duration of -1.
 +
 
 +
11023: Make the CLI "attack" command work again. Make "pvp" equivalent to "steal" instead
 +
of "attack". Added "swagger" as equivalent to "flowers".
 +
 
 +
11055: Added a 2-parameter version of '''to_string()''', where the first parameter can
 +
currently be an int or float (other types are possible, but didn't seem
 +
useful), and the second is a format string as defined by the Java
 +
String.format() method (which in turn is based on C printf() format strings).
 +
For example, "%.2f" will output a float with exactly two digits after the
 +
(localized) decimal point.
 +
 
 +
11110: Add ASH function: '''pvp_attacks_left()'''. This is guaranteed accurate only if you
 +
have recently looked at the Fight! page. Tracking of PVP fights gained via
 +
consumption or familiar action and initialization at login will come later -
 +
after api.php is updated to include the figure.
 +
 +
Add '''beforePVPScript''' setting which contains a script to be executed before a PVP
 +
attack. At the moment, this is only called from the Relay Browser - and only if
 +
relayRunsBeforePVPScript is true
 +
 +
11112: Call beforePVPScript, if present, during automated PVP via the "flowers" command
 +
 
 +
11112: Change ASH '''have_outfit()''' to work with custom outfits, as well as normal outfit
 +
Add ASH '''is_wearing_outfit()''' to return TRUE if you are currently wearing the
 +
specified custom or normal outfit.
 +
 
 +
11119: overloaded signature for user_confirm:
 +
boolean '''user_confirm( String message, int timeOutMillis, boolean defaultValue)'''
 +
 +
message - the message displayed in the dialog
 +
timeOutMillis - the time (in ms) for the dialog to be displayed before it is closed and returns defaultValue
 +
defaultValue - the default value if the user does not choose yes/no before timeOut elapses
 +
 
 +
11125: Soup up "steal" command:
 +
 +
'''steal''' [attacks] (flowers|fame|loot) [(muscle|mysticality|moxie|ballyhoo)]
 +
 +
You can optionally specify the number of attacks (default is all remaining) to
 +
get flowers, fame, or loot, using either the specified stance or your best stat,
 +
if no stance is specified.
 +
 +
When calculating the "best" stat, do it after your beforePVPScript has executed.
 +
 
 +
'''attack''' <player>, <player>, ...
 +
Attack specific players using "best" stat for fame (in-run) or loot (in aftercore)
 +
 +
'''steal''' [<count>] <mission> [<stance>]
 +
'''pvp''' - synonym for steal
 +
Attack <count> random players for the mission of your choice using whatever stance you choose
 +
(or your "best" stat if none chosen)
 +
 
 +
'''flowers'''
 +
Use all of your remaining pvp attacks to get flowers from random players using your "best" stat
 +
 +
If you don't specify how many PvP fights to use (when using pvp or swagger commands),
 +
use all of them
 +
 
 +
== 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
 +
 
 +
r10025: Added '''choice''' CLI command, to resolve manual or unsupported choiceadventures
 +
Added "choice" CLI command, to resolve manual or unsupported choice
 +
adventures without having to visit the relay browser - which might be
 +
inconvenient if you're already in the CLI, and don't need to see the full
 +
adventure text to decide which option you want. With no parameter, "choice"
 +
just lists the options. With a numeric parameter, it picks that option.
 +
With any other parameter, it picks the first option containing that text (in
 +
either the actual button text, or mafia's spoiler text).
 +
 
 +
== 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]]

Revision as of 20:03, 12 June 2012

"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

10078: ash function format_dtg
10081: ash function format_dtg renamed to be
string format_date_time(inFormat, dtg, outFormat)
more info: http://kolmafia.us/showthread.php?8451-time_to_string()-with-parameter&p=64058&viewfull=1#post64058

Modify examples on proxy record page because of:
10122: Add the boolean "fancy" and "candy" fields to item proxy records.
10147: Initial support for "Crimbo 2011" coinmaster: trade candy for Candy Credits
10412: Add $skill proxy records: .dailylimit and .timescast
10879: Add a boolean "boss" field to $monster[]

10227: Add the "closet empty" CLI command, and the empty_closet() ASH function.

r9181, 9183, 9184 & r9190: moods per slyz's summary here: http://kolmafia.us/showthread.php?8852-Composable-Moods

r10344 Add tavern( string goal ) ASH function. 
goal can be "faucet", "baron", or  "explore" (to explore all remaining unexplored squares). 
r10345 Add ASH tavern( "fight" ) to explore cellar until the Baron's mansion is found 
and then go in to fight him.

r10753-6 get_goals() returns a string[int] containing all the conditions that KoLmafia will 
try to satisfy. Add goal_exists() where you can pass in a goal type (choiceadv, autostop, 
meat, health, mana, item) and KoLmafia will tell you if there are any goals that match.

static scope is added!
r10765: Add a "final" scope type to ASH which allows data/commands to be executed only 
once per session.
r10772: A final declaration can either take a block, surrounded by {}, or a single
command or declaration.
r10774: ASH: "final" -> "static"

10922: Add get_player_id() method to ASH

10937: Add minstrel_quest() boolean function,
which returns true when Clancy has a new quest for you.

10971: Added boolean hippy_stone_broken() function

11008: Add the ASH function int[effect] my_effects(), which returns an array of 
the character's current effects and their duration. Intrinsic effects have a duration of -1.

11023: Make the CLI "attack" command work again. Make "pvp" equivalent to "steal" instead 
of "attack". Added "swagger" as equivalent to "flowers".

11055: Added a 2-parameter version of to_string(), where the first parameter can
currently be an int or float (other types are possible, but didn't seem
useful), and the second is a format string as defined by the Java
String.format() method (which in turn is based on C printf() format strings).
For example, "%.2f" will output a float with exactly two digits after the
(localized) decimal point.

11110: Add ASH function: pvp_attacks_left(). This is guaranteed accurate only if you 
have recently looked at the Fight! page. Tracking of PVP fights gained via
consumption or familiar action and initialization at login will come later -
after api.php is updated to include the figure.

Add beforePVPScript setting which contains a script to be executed before a PVP
attack. At the moment, this is only called from the Relay Browser - and only if
relayRunsBeforePVPScript is true

11112: Call beforePVPScript, if present, during automated PVP via the "flowers" command

11112: Change ASH have_outfit() to work with custom outfits, as well as normal outfit 
Add ASH is_wearing_outfit() to return TRUE if you are currently wearing the
specified custom or normal outfit.

11119: overloaded signature for user_confirm: 
boolean user_confirm( String message, int timeOutMillis, boolean defaultValue)

message - the message displayed in the dialog
timeOutMillis - the time (in ms) for the dialog to be displayed before it is closed and returns defaultValue
defaultValue - the default value if the user does not choose yes/no before timeOut elapses

11125: Soup up "steal" command:

steal [attacks] (flowers|fame|loot) [(muscle|mysticality|moxie|ballyhoo)]

You can optionally specify the number of attacks (default is all remaining) to
get flowers, fame, or loot, using either the specified stance or your best stat,
if no stance is specified.

When calculating the "best" stat, do it after your beforePVPScript has executed.

attack <player>, <player>, ...
Attack specific players using "best" stat for fame (in-run) or loot (in aftercore)

steal [<count>] <mission> [<stance>]
pvp - synonym for steal
Attack <count> random players for the mission of your choice using whatever stance you choose
(or your "best" stat if none chosen)

flowers
Use all of your remaining pvp attacks to get flowers from random players using your "best" stat

If you don't specify how many PvP fights to use (when using pvp or swagger commands), 
use all of them

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

r10025: Added choice CLI command, to resolve manual or unsupported choiceadventures 
Added "choice" CLI command, to resolve manual or unsupported choice
adventures without having to visit the relay browser - which might be
inconvenient if you're already in the CLI, and don't need to see the full
adventure text to decide which option you want. With no parameter, "choice"
just lists the options. With a numeric parameter, it picks that option. 
With any other parameter, it picks the first option containing that text (in
either the actual button text, or mafia's spoiler text).

Needs Code Samples

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

Information on how to create a code sample: Template:CodeSample

Retrieved from "https://wiki.kolmafia.us/index.php?title=Npc_price&oldid=7597"