Difference between revisions of "Ashref"

From Kolmafia
Jump to navigation Jump to search
(Undo revision 4657 by 78.46.197.81 (Talk))
imported>Bale
m
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[ashref]]
+
{{DISPLAYTITLE:ashref (CLI)}}
  
AshRef is not an actual ash function, it is a cli function.  
+
Technically, "ashref" is a CLI command, but it's one of particular use for ASH scripting.  
  
Enter "ashref" into the Graphical cli with no parameters will display a list of all available ASH scripting functions.
+
Entering "ashref" into the CLI with no parameters will display a list of all available ASH scripting functions.
  
Entering "ashref " and a partial command name 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).