Ashref: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
mNo edit summary
imported>Bale
mNo edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{#customtitle:ashref}}
{{DISPLAYTITLE:ashref (CLI)}}


Technically, "ashref" is a CLI command, but it's one of particular use for ASH scripting.  
Technically, "ashref" is a CLI command, but it's one of particular use for ASH scripting.  
Line 6: Line 6:


Entering "ashref [string]" with a partial command name in place of "[string]" will display all commands matching the partial command name entered.
Entering "ashref [string]" with a partial command name in place of "[string]" will display all commands matching the partial command name entered.
Note that calling ashref with a datatype as your parameter will return functions taking that datatype as a parameter, but the return type is ignored. For example, "ashref string" would list the function [[user_confirm|user_confirm( string )]] (which returns a boolean), but not the function [[to_url|to_url( location )]] (which returns a string).
[[Category:CLI Commands]][[Category:Scripting]]

Latest revision as of 22:31, 10 November 2010


Technically, "ashref" is a CLI command, but it's one of particular use for ASH scripting.

Entering "ashref" into the CLI with no parameters will display a list of all available ASH scripting functions.

Entering "ashref [string]" with a partial command name in place of "[string]" will display all commands matching the partial command name entered.

Note that calling ashref with a datatype as your parameter will return functions taking that datatype as a parameter, but the return type is ignored. For example, "ashref string" would list the function user_confirm( string ) (which returns a boolean), but not the function to_url( location ) (which returns a string).