This shows you the differences between two versions of the page.
addons:functions:misc [2017/04/22 00:40] atom0s created |
addons:functions:misc [2017/04/22 01:14] (current) atom0s |
||
---|---|---|---|
Line 18: | Line 18: | ||
---- | ---- | ||
==== ashita.misc.play_sound ==== | ==== 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 ==== | ==== 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 ==== | ==== 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 ==== | ==== 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 ==== | ==== 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 ==== | ==== 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.// |