Ashita Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== Misc Namespace =====

The misc namespace contains various functions that do not qualify to be in another namespace or warrant their own namespace at this time.

You can access these functions via:
<sxh lua>ashita.misc.</sxh>

----
==== ashita.misc.open_url ====

Opens an url using the systems default browser.
<sxh lua>void ashita.misc.open_url(url);</sxh>
  * **Parameters**
    * url - (string) The url of the site to open.
  * **Returns**
    * //Function does not return a value.//

----
==== ashita.misc.play_sound ====

Plays a sound file.
<sxh lua>void ashita.misc.play_sound(file);</sxh>
  * **Parameters**
    * file - (string) The sound file to play.
  * **Returns**
    * //Function does not return a value.//

----
==== ashita.misc.get_clipboard ====

Obtains the clipboard text of the system.
<sxh lua>string ashita.misc.get_clipboard();</sxh>
  * **Parameters**
    * //Function does not have any parameters.//
  * **Returns**
    * string - The clipboard text, nil on error.

----
==== ashita.misc.set_clipboard ====

Sets the clipboard text.
<sxh lua>bool ashita.misc.set_clipboard(text);</sxh>
  * **Parameters**
    * text - (string) The text to set the clipboard to.
  * **Returns**
    * bool - True on success, false otherwise.

----
==== ashita.misc.execute ====

Executes an application via ShellExecute.
<sxh lua>void ashita.misc.execute(path, args, mode);</sxh>
  * **Parameters**
    * path - (string) The path to the file to execute.
    * args - (string) The arguments to pass to the file when it launches.
    * mode - (number) The mode to pass to the application when it launches. (Optional, default is SW_SHOWMINNOACTIVE.)
  * **Returns**
    * //Function does not return a value.//

----
==== ashita.misc.hide_console ====

Hides the console window of the process, if present. (Useful for hiding private server boot loaders.)
<sxh lua>void ashita.misc.hide_console();</sxh>
  * **Parameters**
    * //Function does not have any parameters.//
  * **Returns**
    * //Function does not return a value.//

----
==== ashita.misc.show_console ====

Shows the console window of the process, if present. (Useful for showing private server boot loaders.)
<sxh lua>void ashita.misc.hide_console();</sxh>
  * **Parameters**
    * //Function does not have any parameters.//
  * **Returns**
    * //Function does not return a value.//

//If a console window has not been created for the process yet, a new one will be created by calling this function.//
Ashita Documentation

User Tools

Site Tools

Page Tools
