MiniScript Wiki - User contributions [en]

Key.keyNames

2023-10-26T03:01:06Z

Khorne96: /* Example 1 */

<c>[[key]].keyNames</c> returns a list of all the key names available for use with <c>[[key.pressed]]</c>.

=== Usage Notes ===
This can be used to check all possible button-like inputs (keypresses, joystick buttons, etc). For example: if waiting for the user to press anything to continue or while configuring their input preferences.

Though some values may overlap, the values from <c>[[key]].keyNames</c> are not always the same that are received from <c>[[key.get]]</c>. Characters such as upper case letters, arrow keys, etc., as returned from <c>[[key.get]]</c> cannot be used in <c>[[key.pressed]]</c>.

== Example 1 ==

<ms>while true
while true
for n in key.keyNames
if key.pressed(n) then
while key.pressed(n)
end while
print n
end if
end for
end while</ms>

See also: <c>[[key.pressed]]</c>, <c>[[key]]</c>

== Sample Output ==
<div class="toccolours mw-collapsible mw-collapsed">
Windows 10 sample output:
<div class="mw-collapsible-content">
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
1
2
3
4
5
6
7
8
9
0
-
=
[
]
\
,
.
/
;
'
`
f1
f2
f3
f4
f5
f6
f7
f8
f9
f10
f11
f12
f13
f14
f15
up
down
left
right
[1]    // keypad input
[2]    // keypad input
[3]    // keypad input
[4]    // keypad input
[5]    // keypad input
[6]    // keypad input
[7]    // keypad input
[8]    // keypad input
[9]    // keypad input
[0]    // keypad input
[+]    // keypad input
[-]    // keypad input
[*]    // keypad input
[/]    // keypad input
enter
equals
clear
left shift
right shift
left ctrl
right ctrl
left alt
right alt
left cmd
right cmd
backspace
tab
return
escape
space
delete
insert
home
end
page up
page down
mouse 0
mouse 1
mouse 2
mouse 3
mouse 4
mouse 5
mouse 6
joystick button 0
joystick button 1
joystick button 2
joystick button 3
joystick button 4
joystick button 5
joystick button 6
joystick button 7
joystick button 8
joystick button 9
joystick button 10
joystick button 11
joystick button 12
joystick button 13
joystick button 14
joystick button 15
joystick 1 button 0
joystick 1 button 1
joystick 1 button 2
joystick 1 button 3
joystick 1 button 4
joystick 1 button 5
joystick 1 button 6
joystick 1 button 7
joystick 1 button 8
joystick 1 button 9
joystick 1 button 10
joystick 1 button 11
joystick 1 button 12
joystick 1 button 13
joystick 1 button 14
joystick 1 button 15
joystick 2 button 0
joystick 2 button 1
joystick 2 button 2
joystick 2 button 3
joystick 2 button 4
joystick 2 button 5
joystick 2 button 6
joystick 2 button 7
joystick 2 button 8
joystick 2 button 9
joystick 2 button 10
joystick 2 button 11
joystick 2 button 12
joystick 2 button 13
joystick 2 button 14
joystick 2 button 15
joystick 3 button 0
joystick 3 button 1
joystick 3 button 2
joystick 3 button 3
joystick 3 button 4
joystick 3 button 5
joystick 3 button 6
joystick 3 button 7
joystick 3 button 8
joystick 3 button 9
joystick 3 button 10
joystick 3 button 11
joystick 3 button 12
joystick 3 button 13
joystick 3 button 14
joystick 3 button 15
joystick 4 button 0
joystick 4 button 1
joystick 4 button 2
joystick 4 button 3
joystick 4 button 4
joystick 4 button 5
joystick 4 button 6
joystick 4 button 7
joystick 4 button 8
joystick 4 button 9
joystick 4 button 10
joystick 4 button 11
joystick 4 button 12
joystick 4 button 13
joystick 4 button 14
joystick 4 button 15
</div>
</div>

[[Category:Mini Micro]]

Env

2023-08-27T07:32:42Z

Khorne96: /* Windows Version */

<c>env</c> is a built-in map in both [[Mini Micro]] and [[command-line MiniScript]]. It has somewhat different meaning and usage in each environment.

== Mini Micro ==

In [[Mini Micro]], <c>env</c> refers to a map of special values that affect the Mini Micro environment. It contains at least the following keys:

{| class="wikitable"
|-
! Key !! Meaning
|-
| bootOpts || a complete copy of the data in the [[bootOpts.grfon]] file
|-
| curdir || current working directory (same as [[pwd]])
|-
| cmdLine || command line command that was used to launch Mini Micro (where applicable)
|-
| cmdLineArgs || command line arguments (as a [[list]]) used when Mini Micro was launched (where applicable)
|-
| importPaths || [[list]] of directories searched for [[import]] modules
|-
| prompt || [[string]] printed as the command-line prompt
|-
| morePrompt || [[string]] printed as the prompt when more input is needed
|}

== Command-Line MiniScript ==

In [[command-line MiniScript]], <c>env</c> is a copy of the shell environment variables. Assignments to entries of <c>env</c> add or update environment variables. (Deleting environment variables is not possible; you may delete from the <c>env</c> map, but this does not actually affect the environment.)

The exact meaning of environment variables varies with the platform. They have many uses, such as in [http://www.cgi101.com/book/ch3/text.html CGI scripts].

=== Windows Version ===
{| class="wikitable"
|-
! Key !! Default !! Meaning
|-
| MS_EXE_DIR || Launch directory ||Returns the directory ([[String]]) of which the miniscript.exe was launched from
|-
| MS_IMPORT_PATH || "$MS_SCRIPT_DIR/lib:$MS_EXE_DIR/lib" ||directory listings ([[String]]) of where MiniScript files are located allowing [[Import]] to search in those for file import.
|-
| HOMEPATH || User home || Returns the home Directory ([[String]]) of the user that had launched miniscript.exe
|}

=== Linux Version===
{| class="wikitable"
|-
! Key !! Default !! Meaning
|}

== Useful tips ==

=== Adding more import paths (Windows Command Line) ===
To add more folders to [[Import]] from, alter or add the path with a dollar sign ('''$''') to the beginning of $MS_SCRIPT_DIR or $MS_EXE_DIR [[String]] text with a forward slash ('''/''') before the folder name like so: '''$MS_SCRIPT_DIR/sprites'''. To add multiple paths for import simply add a colon (''':''') between the designated paths to indicate multiple directories to import from. Apply the string to the [[Env|env]].MS_IMPORT_PATH like below:

<ms> env.MS_IMPORT_PATH = "$MS_SCRIPT_DIR/sprites" // replaces the default with one folder named sprites
env.MS_IMPORT_PATH = "$MS_SCRIPT_DIR/lib:$MS_EXE_DIR/lib:$MS_SCRIPT_DIR/sprites" // default plus new folder sprites</ms>

[[Category:Mini Micro]]
[[Category:Command-Line MiniScript]]
[[Category:Farmtronics]]

Env

2023-08-27T07:27:24Z

Khorne96: /* Adding more import paths (Windows) */

<c>env</c> is a built-in map in both [[Mini Micro]] and [[command-line MiniScript]]. It has somewhat different meaning and usage in each environment.

== Mini Micro ==

In [[Mini Micro]], <c>env</c> refers to a map of special values that affect the Mini Micro environment. It contains at least the following keys:

{| class="wikitable"
|-
! Key !! Meaning
|-
| bootOpts || a complete copy of the data in the [[bootOpts.grfon]] file
|-
| curdir || current working directory (same as [[pwd]])
|-
| cmdLine || command line command that was used to launch Mini Micro (where applicable)
|-
| cmdLineArgs || command line arguments (as a [[list]]) used when Mini Micro was launched (where applicable)
|-
| importPaths || [[list]] of directories searched for [[import]] modules
|-
| prompt || [[string]] printed as the command-line prompt
|-
| morePrompt || [[string]] printed as the prompt when more input is needed
|}

== Command-Line MiniScript ==

In [[command-line MiniScript]], <c>env</c> is a copy of the shell environment variables. Assignments to entries of <c>env</c> add or update environment variables. (Deleting environment variables is not possible; you may delete from the <c>env</c> map, but this does not actually affect the environment.)

The exact meaning of environment variables varies with the platform. They have many uses, such as in [http://www.cgi101.com/book/ch3/text.html CGI scripts].

=== Windows Version ===
{| class="wikitable"
|-
! Key !! Default !! Meaning
|-
| MS_EXE_DIR || Launch directory ||Returns the directory ([[String]]) of which the miniscript.exe was launched from
|-
| MS_IMPORT_PATH || "$MS_SCRIPT_DIR/lib:$MS_EXE_DIR/lib" ||import paths ([[String]]) listing of where to importable files are located when using [[Import]]
|-
| HOMEPATH || User home || Returns the home Directory ([[String]]) of the user that had launched miniscript.exe
|}

=== Linux Version===
{| class="wikitable"
|-
! Key !! Default !! Meaning
|}

== Useful tips ==

=== Adding more import paths (Windows Command Line) ===
To add more folders to [[Import]] from, alter or add the path with a dollar sign ('''$''') to the beginning of $MS_SCRIPT_DIR or $MS_EXE_DIR [[String]] text with a forward slash ('''/''') before the folder name like so: '''$MS_SCRIPT_DIR/sprites'''. To add multiple paths for import simply add a colon (''':''') between the designated paths to indicate multiple directories to import from. Apply the string to the [[Env|env]].MS_IMPORT_PATH like below:

<ms> env.MS_IMPORT_PATH = "$MS_SCRIPT_DIR/sprites" // replaces the default with one folder named sprites
env.MS_IMPORT_PATH = "$MS_SCRIPT_DIR/lib:$MS_EXE_DIR/lib:$MS_SCRIPT_DIR/sprites" // default plus new folder sprites</ms>

[[Category:Mini Micro]]
[[Category:Command-Line MiniScript]]
[[Category:Farmtronics]]

Env

2023-08-27T07:27:00Z

Khorne96: /* Linux */

<c>env</c> is a built-in map in both [[Mini Micro]] and [[command-line MiniScript]]. It has somewhat different meaning and usage in each environment.

== Mini Micro ==

In [[Mini Micro]], <c>env</c> refers to a map of special values that affect the Mini Micro environment. It contains at least the following keys:

{| class="wikitable"
|-
! Key !! Meaning
|-
| bootOpts || a complete copy of the data in the [[bootOpts.grfon]] file
|-
| curdir || current working directory (same as [[pwd]])
|-
| cmdLine || command line command that was used to launch Mini Micro (where applicable)
|-
| cmdLineArgs || command line arguments (as a [[list]]) used when Mini Micro was launched (where applicable)
|-
| importPaths || [[list]] of directories searched for [[import]] modules
|-
| prompt || [[string]] printed as the command-line prompt
|-
| morePrompt || [[string]] printed as the prompt when more input is needed
|}

== Command-Line MiniScript ==

In [[command-line MiniScript]], <c>env</c> is a copy of the shell environment variables. Assignments to entries of <c>env</c> add or update environment variables. (Deleting environment variables is not possible; you may delete from the <c>env</c> map, but this does not actually affect the environment.)

The exact meaning of environment variables varies with the platform. They have many uses, such as in [http://www.cgi101.com/book/ch3/text.html CGI scripts].

=== Windows Version ===
{| class="wikitable"
|-
! Key !! Default !! Meaning
|-
| MS_EXE_DIR || Launch directory ||Returns the directory ([[String]]) of which the miniscript.exe was launched from
|-
| MS_IMPORT_PATH || "$MS_SCRIPT_DIR/lib:$MS_EXE_DIR/lib" ||import paths ([[String]]) listing of where to importable files are located when using [[Import]]
|-
| HOMEPATH || User home || Returns the home Directory ([[String]]) of the user that had launched miniscript.exe
|}

=== Linux Version===
{| class="wikitable"
|-
! Key !! Default !! Meaning
|}

== Useful tips ==

=== Adding more import paths (Windows) ===
To add more folders to [[Import]] from, alter or add the path with a dollar sign ('''$''') to the beginning of $MS_SCRIPT_DIR or $MS_EXE_DIR [[String]] text with a forward slash ('''/''') before the folder name like so: '''$MS_SCRIPT_DIR/sprites'''. To add multiple paths for import simply add a colon (''':''') between the designated paths to indicate multiple directories to import from. Apply the string to the [[Env|env]].MS_IMPORT_PATH like below:

<ms> env.MS_IMPORT_PATH = "$MS_SCRIPT_DIR/sprites" // replaces the default with one folder named sprites
env.MS_IMPORT_PATH = "$MS_SCRIPT_DIR/lib:$MS_EXE_DIR/lib:$MS_SCRIPT_DIR/sprites" // default plus new folder sprites</ms>

[[Category:Mini Micro]]
[[Category:Command-Line MiniScript]]
[[Category:Farmtronics]]

Env

2023-08-27T07:25:32Z

Khorne96: /* Command-Line MiniScript */

<c>env</c> is a built-in map in both [[Mini Micro]] and [[command-line MiniScript]]. It has somewhat different meaning and usage in each environment.

== Mini Micro ==

In [[Mini Micro]], <c>env</c> refers to a map of special values that affect the Mini Micro environment. It contains at least the following keys:

{| class="wikitable"
|-
! Key !! Meaning
|-
| bootOpts || a complete copy of the data in the [[bootOpts.grfon]] file
|-
| curdir || current working directory (same as [[pwd]])
|-
| cmdLine || command line command that was used to launch Mini Micro (where applicable)
|-
| cmdLineArgs || command line arguments (as a [[list]]) used when Mini Micro was launched (where applicable)
|-
| importPaths || [[list]] of directories searched for [[import]] modules
|-
| prompt || [[string]] printed as the command-line prompt
|-
| morePrompt || [[string]] printed as the prompt when more input is needed
|}

== Command-Line MiniScript ==

In [[command-line MiniScript]], <c>env</c> is a copy of the shell environment variables. Assignments to entries of <c>env</c> add or update environment variables. (Deleting environment variables is not possible; you may delete from the <c>env</c> map, but this does not actually affect the environment.)

The exact meaning of environment variables varies with the platform. They have many uses, such as in [http://www.cgi101.com/book/ch3/text.html CGI scripts].

=== Windows Version ===
{| class="wikitable"
|-
! Key !! Default !! Meaning
|-
| MS_EXE_DIR || Launch directory ||Returns the directory ([[String]]) of which the miniscript.exe was launched from
|-
| MS_IMPORT_PATH || "$MS_SCRIPT_DIR/lib:$MS_EXE_DIR/lib" ||import paths ([[String]]) listing of where to importable files are located when using [[Import]]
|-
| HOMEPATH || User home || Returns the home Directory ([[String]]) of the user that had launched miniscript.exe
|}

=== Linux ===
{| class="wikitable"
|-
! Key !! Default !! Meaning
|}

== Useful tips ==

=== Adding more import paths (Windows) ===
To add more folders to [[Import]] from, alter or add the path with a dollar sign ('''$''') to the beginning of $MS_SCRIPT_DIR or $MS_EXE_DIR [[String]] text with a forward slash ('''/''') before the folder name like so: '''$MS_SCRIPT_DIR/sprites'''. To add multiple paths for import simply add a colon (''':''') between the designated paths to indicate multiple directories to import from. Apply the string to the [[Env|env]].MS_IMPORT_PATH like below:

<ms> env.MS_IMPORT_PATH = "$MS_SCRIPT_DIR/sprites" // replaces the default with one folder named sprites
env.MS_IMPORT_PATH = "$MS_SCRIPT_DIR/lib:$MS_EXE_DIR/lib:$MS_SCRIPT_DIR/sprites" // default plus new folder sprites</ms>

[[Category:Mini Micro]]
[[Category:Command-Line MiniScript]]
[[Category:Farmtronics]]