python_functions
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
python_functions [2022/05/05 14:02] – g00r00 | python_functions [2023/01/20 01:57] (current) – [Function List A to Z] g00r00 | ||
---|---|---|---|
Line 3: | Line 3: | ||
This page is a work in progress. | This page is a work in progress. | ||
making changes, and be sure to include anchors from the A-Z list at the | making changes, and be sure to include anchors from the A-Z list at the | ||
- | bottom as well as the table at each section. | + | bottom as well as the table at each section. MPL documentation should follow |
+ | a similar format. | ||
- | Optionally maybe these 4 main sections should be their own page I am open | + | If you are looking for documentation for a function from the A-Z function |
- | to suggestion, although I worked hard to come up with a system where all of | + | list at the bottom and it is not yet documented here, do a search at the top |
- | this information could be viewed | + | of the site for the function name. All functions should |
- | single page. | + | the Whats new sections, |
- | MPL documentation should follow this same layout | + | If you have a specific request |
+ | the documentation can be prioritized. If you have a specific request for an | ||
+ | enhancement, | ||
- | 1234567890123456789012345678901234567890123456789012345678901234567890123456789 | + | The examples section, and included example scripts with a new installation of |
+ | Mystic can also be useful when learning the functions. | ||
---- | ---- | ||
Line 158: | Line 162: | ||
---- | ---- | ||
==== Input Functions ==== | ==== Input Functions ==== | ||
+ | |||
+ | ^ Function | ||
+ | | [[python_functions# | ||
+ | | [[python_functions# | ||
+ | | [[python_functions# | ||
=== Function: GETSTR === | === Function: GETSTR === | ||
Line 182: | Line 191: | ||
MaxInput is larger than FieldSize then the input will be | MaxInput is larger than FieldSize then the input will be | ||
scrolled. | scrolled. | ||
+ | | ||
MaxInput defines the total number of bytes allowed in this | MaxInput defines the total number of bytes allowed in this | ||
input field. | input field. | ||
+ | | ||
+ | DefaultText defines the value that will be put into the input | ||
+ | field by default. | ||
| | ||
Example: | Example: | ||
| | ||
input = getstr(11, 40, 120, " | input = getstr(11, 40, 120, " | ||
+ | |||
+ | === Function: KEYPRESSED === | ||
+ | |||
+ | Syntax: keypressed : boolean | ||
+ | | ||
+ | Returns a true if a there is input waiting to be read in from the user | ||
+ | and false if there is no input waiting. | ||
+ | | ||
+ | Example: | ||
+ | | ||
+ | if keypressed is True: | ||
+ | writeln(" | ||
+ | |||
+ | === Function: ONEKEY === | ||
+ | |||
+ | Syntax: onekey (keylist, echo) : string | ||
+ | | ||
+ | This function asks the user to input a character but accepts only input | ||
+ | from the user that matches a character in the keylist. | ||
+ | the function will print the character to the terminal. | ||
+ | | ||
+ | Example: | ||
+ | | ||
+ | ch = onekey(chr(13) + " | ||
+ | | ||
+ | if ch == ' | ||
+ | | ||
+ | | ||
+ | The above example prompts the user to enter one of the keys A, P, Q or | ||
+ | the ENTER key (ASCII #13). Because echo is True, it will prompt the | ||
+ | | ||
+ | |||
+ | User input for this function is not case sensitive. | ||
---- | ---- | ||
Line 247: | Line 292: | ||
* dateu2d | * dateu2d | ||
* delay | * delay | ||
+ | * find_config | ||
+ | * find_display | ||
* fl_close | * fl_close | ||
* fl_found | * fl_found | ||
Line 268: | Line 315: | ||
* getnetaddr | * getnetaddr | ||
* getprompt | * getprompt | ||
- | * getstr | + | * [[python_functions# |
* getuser | * getuser | ||
* getuserid | * getuserid | ||
Line 274: | Line 321: | ||
* gotoxy | * gotoxy | ||
* isuser | * isuser | ||
- | * keypressed | + | * isuserpw |
+ | * isvalidpw | ||
+ | * [[python_functions# | ||
* logerror | * logerror | ||
* mci2str | * mci2str | ||
Line 288: | Line 337: | ||
* msg_seek | * msg_seek | ||
* msg_stats | * msg_stats | ||
- | * onekey | + | * [[python_functions# |
* [[python_functions# | * [[python_functions# | ||
* [[python_functions# | * [[python_functions# | ||
Line 296: | Line 345: | ||
* [[python_functions# | * [[python_functions# | ||
* [[python_functions# | * [[python_functions# | ||
+ | * setlogininfo | ||
* setpinfo | * setpinfo | ||
* setprompt | * setprompt |
python_functions.1651777333.txt.gz · Last modified: 2022/05/05 14:02 by g00r00