MiniScript Wiki - User contributions [en]

Image.pixel

2020-04-01T23:06:41Z

71.226.33.30:

<c>[[Image]].pixel</c> returns the color of a specific pixel in the image.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || horizontal coordinate of the pixel of interest, from 0 to width - 1
|-
| ''y'' || number || 0 || vertical coordinate of the pixel of interest, from 0 to height - 1
|}

== Example ==

<ms>img = file.loadImage("/sys/pics/Dart.png")
// print img.pixel(5, 7)</ms>

[[Category:Mini Micro]]

Image.setPixel

2020-04-01T23:06:22Z

71.226.33.30:

<c>[[Image]].setPixel</c> sets the color of a specific pixel in the image.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || horizontal coordinate of the pixel of interest, from 0 to width - 1
|-
| ''y'' || number || 0 || vertical coordinate of the pixel of interest, from 0 to height - 1
|}

== Example ==

<ms>img = file.loadImage("/sys/pics/Dart.png")
// img.setPixel 5, 7, color.green</ms>

[[Category:Mini Micro]]

Sound.loop

2020-04-01T23:05:51Z

71.226.33.30: Created page with "<c>Sound.loop</c> controls whether a sound will play just once (false) or will repeat indefinitely (true) when played with Sound.play. <ms>s = file.loadSound("/sys/so..."

<c>[[Sound]].loop</c> controls whether a sound will play just once (false) or will
repeat indefinitely (true) when played with [[Sound.play.]]

<ms>s = file.loadSound("/sys/sounds/bonus.wav")
// s.loop = true
// s.play; key.get; s.stop</ms>

[[Category:Mini Micro]]

Sound.mix

2020-04-01T23:03:36Z

71.226.33.30:

<c>[[Sound]].mix</c> mixes another synthesized sound into this one, producing a more
complex sound.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''sound'' || Sound Object || || Other sound (already prepared with sound.init) to mix in
|-
| ''level'' || number || 1 || volume of other mixed-in sound relative to this one
|}

== Example ==

<ms>daDing = new Sound
// daDing.init 0.5, noteFreq(72), [1, 1, 0]
// dd2 = new Sound
// dd2.init 0.5, noteFreq(84), [0]*40 + range(1, 0, -0.01)
// daDing.mix dd2
// daDing.play</ms>

[[Category:Mini Micro]]

Sound.mix

2020-04-01T23:03:28Z

71.226.33.30: Created page with "<c>Sound.mix</c> mixes another synthesized sound into this one, producing a more complex sound. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! De..."

Sound.stop

2020-04-01T23:00:58Z

71.226.33.30: Created page with "<c>Sound.stop</c> stops this sound if it is currently playing. == Example == <ms>s = file.loadSound("/sys/sounds/bonus.wav") s.loop = true s.play; key.get; s.stop</ms> Ca..."

<c>Sound.stop</c> stops this sound if it is currently playing.

== Example ==

<ms>s = file.loadSound("/sys/sounds/bonus.wav")
s.loop = true
s.play; key.get; s.stop</ms>

[[Category:Mini Micro]]

Sound.play

2020-04-01T22:58:32Z

71.226.33.30:

<c>[[Sound]].play</c> plays a sound. Call this on a Sound object initialized either
Sound.init, or loaded via file.loadSound.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''volume'' || number || 1 || volume (0-1) of the sound
|-
| ''pan'' || number || 0 || left (-1) to right (1) stereo pan of the sound
|-
| ''speed'' || number || 1 || speed multiplier (1 == standard speed)
|}

=== Usage Notes ===
the sound will automatically stop if .loop is false, but will repeat until explicitly
stopped if .loop is true.

== Example ==

<ms>s = file.loadSound("/sys/sounds/bonus.wav")
s.play</ms>

[[Category:Mini Micro]]

Sound.play

2020-04-01T22:57:57Z

71.226.33.30: Created page with "<c>Sound.play</c> plays a sound. Call this on a Sound object initialized either Sound.init, or loaded via file.loadSound. === Arguments === {| class="wikitable" |- ! Param..."

<c>Sound.play</c> plays a sound. Call this on a Sound object initialized either
Sound.init, or loaded via file.loadSound.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''volume'' || number || 1 || volume (0-1) of the sound
|-
| ''pan'' || number || 0 || left (-1) to right (1) stereo pan of the sound
|-
| ''speed'' || number || 1 || speed multiplier (1 == standard speed)
|}

=== Usage Notes ===
the sound will automatically stop if .loop is false, but will repeat until explicitly
stopped if .loop is true.

== Example ==

<ms>s = file.loadSound("/sys/sounds/bonus.wav")
s.play</ms>

[[Category:Mini Micro]]

Sound.stopAll

2020-04-01T22:49:25Z

71.226.33.30:

<c>[[Sound]].stopAll</c> stops all currently playing sounds.

[[Category:Mini Micro]]

Sound.init

2020-04-01T22:48:35Z

71.226.33.30: Created page with "<c>Sound.init</c> synthesizes a sound from various parameters, including look-up tables that represent one cycle of the waveform and the volume envelope. === Usage Notes..."

<c>[[Sound]].init</c> synthesizes a sound from various parameters, including look-up tables
that represent one cycle of the waveform and the volume envelope.

=== Usage Notes ===
Call this on a new Sound object, or to reset a previous one.
duration (number, default 1): length of the sound, in seconds
freq (number, default 440): number of repeats of the waveform per second
envelope (list): volume (0 to 1) over the duration of the sound
waveform (list): wave value (-1 to 1) over one cycle

== Example ==

<ms>pew = new Sound
pew.init 0.3, [8000,100], [1,0]
pew.play
Example 2:
hitSnd = new Sound
hitSnd.init 1, 100, [1,0], Sound.noiseWave
hitSnd.play</ms>

[[Category:Mini Micro]]

Sound.stopAll

2020-04-01T22:45:50Z

71.226.33.30: Created page with "<c>Sound.stopAll</c> stops all currently playing sounds. Category:Mini Micro"

<c>Sound.stopAll</c> stops all currently playing sounds.

[[Category:Mini Micro]]

Sound.noiseWave

2020-04-01T22:43:06Z

71.226.33.30: Created page with "<c>Sound.noiseWave</c> returns a collection of random values. === Usage Notes === For use with the ''waveform'' parameter of Sound.init. This produces a slightly buzz..."

<c>[[Sound]].noiseWave</c> returns a collection of random values.

=== Usage Notes ===
For use with the ''waveform'' parameter of [[Sound.init]].
This produces a slightly buzzy, retro tone.

[[Category:Mini Micro]]

Sound.sawtoothWave

2020-04-01T22:42:02Z

71.226.33.30: Created page with "<c>Sound.sawtoothWave</c> returns a 128-element list approximating a sawtooth wave. === Usage Notes === For use with the ''waveform'' parameter of Sound.init. This pr..."

<c>[[Sound]].sawtoothWave</c> returns a 128-element list approximating a sawtooth wave.

=== Usage Notes ===
For use with the ''waveform'' parameter of [[Sound.init]].
This produces a slightly buzzy, retro tone.

[[Category:Mini Micro]]

Sound.triangleWave

2020-04-01T22:41:06Z

71.226.33.30:

<c>[[Sound]].triangleWave</c> returns a 128-element list approximating a triangle wave.

=== Usage Notes ===
For use with the ''waveform'' parameter of [[Sound.init]].
This produces a clean sound, almost like a sine wave.
[[Category:Mini Micro]]

Sound.triangleWave

2020-04-01T22:40:55Z

71.226.33.30: Created page with "<c>Sound.triangleWave</c> returns a 128-element list approximating a triangle wave. === Usage Notes === For use with the ''waveform'' parameter of Sound.init. This produc..."

<c>Sound.triangleWave</c> returns a 128-element list approximating a triangle wave.

=== Usage Notes ===
For use with the ''waveform'' parameter of [[Sound.init]].
This produces a clean sound, almost like a sine wave.
[[Category:Mini Micro]]

Sound.squareWave

2020-04-01T22:39:20Z

71.226.33.30: Created page with "<c>Sound.squareWave</c> returns a 128-element list approximating a square wave. === Usage Notes === For use with the ''waveform'' parameter of Sound.init. This produc..."

<c>[[Sound]].squareWave</c> returns a 128-element list approximating a square wave.

=== Usage Notes ===
For use with the ''waveform'' parameter of [[Sound.init]].
This produces a buzzy, old-school "chip tone" sound.

[[Category:Mini Micro]]

Sound.sineWave

2020-04-01T22:38:10Z

71.226.33.30:

<c>[[Sound]].sineWave</c> returns a 128-element list approximating a sine wave.

=== Usage Notes ===
<c>[[Sound]].sineWave</c> produces a smooth, pure tone.

[[Category:Mini Micro]]

Sound.sineWave

2020-04-01T22:37:47Z

71.226.33.30: Created page with "<c>Sound.sineWave</c> returns a 128-element list approximating a sine wave. === Usage Notes === <c>Sound.sineWave</c> produces a smooth, pure tone. Category:Mini M..."

<c>[[Sound.sineWave]]</c> returns a 128-element list approximating a sine wave.

=== Usage Notes ===
<c>[[Sound.sineWave]]</c> produces a smooth, pure tone.

[[Category:Mini Micro]]

Image.getImage

2020-04-01T22:35:14Z

71.226.33.30:

<c>Image.getImage</c> returns a rectangular portion of the image as a new image.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''left'' || number || 0 || leftmost horizontal coordinate of the portion to get
|-
| ''bottom'' || number || 0 || lowest vertical coordinate of the portion to get
|-
| ''width'' || number || image.width || width (in pixels) of portion to get
|-
| ''height'' || number || image.height || height (in pixels) of portion to get)
|}

== Example ==

<ms>img = file.loadImage("/sys/pics/Wumpus.png")
// eyes = img.getImage(35, 59, 60, 48)
// view eyes</ms>

[[Category:Mini Micro]]

Image.getImage

2020-04-01T22:35:03Z

71.226.33.30: Created page with "<c>Image.getImage</c> returns a rectangular portion of the image as a new image. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! Default Value !! Mean..."

Image.setPixel

2020-04-01T22:30:55Z

71.226.33.30: Created page with "<c>Image.setPixel</c> sets the color of a specific pixel in the image. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! Default Value !! Meaning |- | '..."

<c>Image.setPixel</c> sets the color of a specific pixel in the image.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || horizontal coordinate of the pixel of interest, from 0 to width - 1
|-
| ''y'' || number || 0 || vertical coordinate of the pixel of interest, from 0 to height - 1
|}

== Example ==

<ms>img = file.loadImage("/sys/pics/Dart.png")
// img.setPixel 5, 7, color.green</ms>

[[Category:Mini Micro]]

Image.pixel

2020-04-01T22:29:18Z

71.226.33.30: Created page with "<c>Image.pixel</c> returns the color of a specific pixel in the image. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! Default Value !! Meaning |- | ''..."

<c>Image.pixel</c> returns the color of a specific pixel in the image.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || horizontal coordinate of the pixel of interest, from 0 to width - 1
|-
| ''y'' || number || 0 || vertical coordinate of the pixel of interest, from 0 to height - 1
|}

== Example ==

<ms>img = file.loadImage("/sys/pics/Dart.png")
// print img.pixel(5, 7)</ms>

[[Category:Mini Micro]]

Image.width

2020-04-01T22:24:35Z

71.226.33.30: Created page with "<c>Image.width</c> returns the width of the image, in pixels. (Read-only.) == Example == <ms>img = file.loadImage("/sys/pics/Dart.png")</ms> Category:Mini Micro"

<c>Image.width</c> returns the width of the image, in pixels. (Read-only.)

== Example ==

<ms>img = file.loadImage("/sys/pics/Dart.png")</ms>

[[Category:Mini Micro]]

TextDisplay.print

2020-04-01T22:18:04Z

71.226.33.30:

<c>TextDisplay.print</c> prints a given string to this text display, followed by whatever
[[TextDisplay.delimiter]] contains.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''s'' || string || "" || string to print
|}

=== Usage Notes ===
For the default text display,
this is equivalent to [[print]] by itself, so calling this as a
TextDisplay method is mainly useful when you have set up multiple
text displays.

== Example ==

<ms>text.print "Hello World!"</ms>

[[Category:Mini Micro]]

TextDisplay.print

2020-04-01T22:17:58Z

71.226.33.30: Created page with "<c>TextDisplay.print</c> prints a given string to this text display, followed by whatever TextDisplay.delimiter contains. === Arguments === {| class="wikitable" |- ! Pa..."

TextDisplay.setCellBackColor

2020-04-01T22:14:24Z

71.226.33.30: Created page with "<c>TextDisplay.setCellBackColor</c> changes the background color of the given cell. See also: TextDisplay.cellBackColor === Arguments === {| class="wikitable" |- ! Para..."

<c>TextDisplay.setCellBackColor</c> changes the background color of the given cell.

See also: [[TextDisplay.cellBackColor]]

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || column of interest
|-
| ''y'' || number || 0 || row of interest
|}

=== Usage Notes ===
<c>TextDisplay.setCellBackColor</c> may appear as either the text color or the surrounding color, depending
on whether the given cell is in inverse mode.

== Example ==

<ms>text.setCellBackColor 0, 10, color.blue</ms>

[[Category:Mini Micro]]

TextDisplay.cellBackColor

2020-04-01T22:11:55Z

71.226.33.30: Created page with "<c>TextDisplay.cellBackColor</c> returns the background color of the given cell. See also: TextDisplay.setCellBackColor === Arguments === {| class="wikitable" |- ! Par..."

<c>TextDisplay.cellBackColor</c> returns the background color of the given cell.

See also: [[TextDisplay.setCellBackColor]]

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || column of interest
|-
| ''y'' || number || 0 || row of interest
|}

=== Usage Notes ===
<c>TextDisplay.cellBackColor</c> may appear as either the text color or the surrounding color, depending
on whether the given cell is in inverse mode.

== Example ==

<ms>print text.cellBackColor 0, 10</ms>

[[Category:Mini Micro]]

TextDisplay.setCellColor

2020-04-01T22:09:24Z

71.226.33.30:

<c>TextDisplay.setCellColor</c> changes the foreground color of the given cell.

See also: [[TextDisplay.cellColor]]

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || column of interest
|-
| ''y'' || number || 0 || row of interest
|-
| ''color'' || string || #FFFFFF || color to apply
|}

=== Usage Notes ===
This may appear as either the text color or the surrounding color, depending
on whether the given cell is in inverse mode.

== Example ==

<ms>text.setCellColor 0, 10, color.red</ms>

[[Category:Mini Micro]]

TextDisplay.setCellColor

2020-04-01T22:09:00Z

71.226.33.30: Created page with "<c>TextDisplay.setCellColor</c> changes the foreground color of the given cell. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! Default Value !! Meani..."

<c>TextDisplay.setCellColor</c> changes the foreground color of the given cell.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || column of interest
|-
| ''y'' || number || 0 || row of interest
|-
| ''color'' || string || #FFFFFF || color to apply
|}

=== Usage Notes ===
This may appear as either the text color or the surrounding color, depending
on whether the given cell is in inverse mode.

== Example ==

<ms>text.setCellColor 0, 10, color.red</ms>

[[Category:Mini Micro]]

TextDisplay.cellColor

2020-04-01T22:06:29Z

71.226.33.30: Created page with "<c>TextDisplay.cellColor</c> returns the foreground color of the given cell. See also: TextDisplay.setCellColor === Arguments === {| class="wikitable" |- ! Parameter Na..."

<c>TextDisplay.cellColor</c> returns the foreground color of the given cell.

See also: [[TextDisplay.setCellColor]]

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || column of interest
|-
| ''y'' || number || 0 || row of interest
|}

=== Usage Notes ===
This may appear as either the text color or the surrounding color, depending
on whether the given cell is in inverse mode.

== Example ==

<ms>print text.cellColor 0, 10</ms>

[[Category:Mini Micro]]

TextDisplay.setCell

2020-04-01T22:04:08Z

71.226.33.30: Created page with "<c>TextDisplay.setCell</c> Directly sets a character into a given row and column of the text display. This does not use (or change) the cursor position, nor does it apply the..."

<c>TextDisplay.setCell</c> Directly sets a character into a given row and column of the text
display. This does not use (or change) the cursor position, nor
does it apply the current text colors or inverse mode; it only change
the character displayed.

See also: [[TextDisplay.cell]]

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || column of cell to change
|-
| ''y'' || number || 0 || row of cell to change
|-
| ''character'' || string || "" || character to store in the given cell
|}

== Example ==

<ms>text.setCell 0, 10, "@"</ms>

[[Category:Mini Micro]]

TextDisplay.cell

2020-04-01T21:59:55Z

71.226.33.30: Created page with "<c>TextDisplay.cell</c> returns the character stored at a given row and column of the text display. See also: TextDisplay.setCell === Arguments === {| class="wikitable"..."

<c>TextDisplay.cell</c> returns the character stored at a given row and column
of the text display.

See also: [[TextDisplay.setCell]]

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || column of interest
|-
| ''y'' || number || 0 || row of interest
|}

== Example ==

<ms>print text.cell(0,25) // print character in top-left corner</ms>

[[Category:Mini Micro]]

TextDisplay.delimiter

2020-04-01T21:57:15Z

71.226.33.30: Created page with "<c>TextDisplay.delimiter</c>: This value is a string which is printed after every print output. === Usage Notes === Its default value is char(13), which is a carriage ret..."

<c>TextDisplay.delimiter</c>: This value is a string which is printed after every [[print]] output.

=== Usage Notes ===
Its default value is char(13), which is a carriage return (moves the
cursor to the start of the next line). You may set it to "" (empty
string) if you want no delimiter, allowing you to print several things
in a row all on the same line. Note that TextDisplay.clear does not
reset this value; you will need to manually reassign char(13) to it
to restore normal behavior.

== Example ==

<ms>text.delimiter = ""
// print "one"
// print "two"
// text.delimiter = char(13)</ms>

[[Category:Mini Micro]]

TextDisplay.inverse

2020-04-01T21:55:11Z

71.226.33.30:

<c>TextDisplay.inverse</c> gets or sets whether subsequent printing should be done in "inverse" mode,
where the foreground and background colors are swapped.

=== Usage Notes ===
This mode may also be controlled by printing two special characters:
char(134) sets inverse to true, and char(135) sets inverse to false.)

== Example ==

<ms>text.inverse = true; print " BLOCKY "; text.inverse = false</ms>

[[Category:Mini Micro]]

TextDisplay.inverse

2020-04-01T21:54:58Z

71.226.33.30: Created page with "<c>TextDisplay.inverse</c> gets or sets whether subsequent printing should be done in "inverse" mode, where the foreground and background colors are swapped. === Usage Notes..."

<c>TextDisplay.inverse</c> gets or sets whether subsequent printing should be done in "inverse" mode,
where the foreground and background colors are swapped.

=== Usage Notes ===
this mode may also be controlled by printing two special characters:
char(134) sets inverse to true, and char(135) sets inverse to false.)

== Example ==

<ms>text.inverse = true; print " BLOCKY "; text.inverse = false</ms>

[[Category:Mini Micro]]

TextDisplay.row

2020-04-01T21:53:29Z

71.226.33.30: Created page with "<c>TextDisplay.row</c> gets or sets the row of the text cursor, where subsequent printing will begin. Row values range from 0 at the bottom of the screen, to 25 at the top...."

<c>TextDisplay.row</c> gets or sets the row of the text cursor, where subsequent printing will
begin. Row values range from 0 at the bottom of the screen, to 25 at the top.

== Example ==

<ms>text.row = 25; print "At the top!"</ms>

[[Category:Mini Micro]]

TextDisplay.column

2020-04-01T21:52:28Z

71.226.33.30: Created page with "<c>TextDisplay.column</c> gets or sets the column of the text cursor, where subsequent printing will begin. Column values range from 0 on the left to 67 on the right. == Exa..."

<c>TextDisplay.column</c> gets or sets the column of the text cursor, where subsequent printing
will begin. Column values range from 0 on the left to 67 on the right.

== Example ==

<ms>text.column = 60; print "HEY!"</ms>

[[Category:Mini Micro]]

TextDisplay.backColor

2020-04-01T21:51:13Z

71.226.33.30: Created page with "<c>TextDisplay.backColor</c> gets or sets the background color used on any future printing to this text display. This is the surrounding color for normal text, or the text co..."

<c>TextDisplay.backColor</c> gets or sets the background color used on any future printing to this
text display. This is the surrounding color for normal text, or the
text color for inverse-mode text.

= Example ==

<ms>text.backColor = color.navy</ms>

[[Category:Mini Micro]]

TextDisplay.color

2020-04-01T21:50:04Z

71.226.33.30: Created page with "<c>TextDisplay.color</c> gets or sets the foreground color used on any future printing to this text display. This is the text color for normal text, or the surrounding color..."

<c>TextDisplay.color</c> gets or sets the foreground color used on any future printing to this
text display. This is the text color for normal text, or the surrounding
color for inverse-mode text.

== Example ==

<ms>text.color = color.aqua</ms>

[[Category:Mini Micro]]

TextDisplay.clear

2020-04-01T21:48:14Z

71.226.33.30: Created page with "<c>TextDisplay.clear</c> clears the text display, setting all cells to " " (space), with inverse turned off and all cell colors set to the match the display properties. === U..."

<c>TextDisplay.clear</c> clears the text display, setting all cells to " " (space), with
inverse turned off and all cell colors set to the match the display
properties.

=== Usage Notes ===
This method does **not** change the cursor
position, nor does it reset TextDisplay.delimiter.

== Example ==

<ms>text.clear // clears the default text display</ms>

[[Category:Mini Micro]]

SolidColorDisplay.color

2020-04-01T21:46:20Z

71.226.33.30: Created page with "<c>SolidColorDisplay.color</c> gets or sets the color shown by this display. The alpha channel is functional, so you can make such a display semi-transparent. == Example ==..."

<c>SolidColorDisplay.color</c> gets or sets the color shown by this display. The alpha channel is functional, so you can make such a display semi-transparent.

== Example ==

<ms>display(0).mode = displayMode.solidColor
display(0).color = "#0000FF88" // semi-transparent blue</ms>

[[Category:Mini Micro]]

Display.mode

2020-04-01T21:44:41Z

71.226.33.30: Created page with "<c>Display.mode</c> this property gives (or allows you to change) the mode of a Display instance. See also: displayMode === Usage Notes === When you assign a different m..."

<c>Display.mode</c> this property gives (or allows you to change) the mode of a
Display instance.

See also: [[displayMode]]

=== Usage Notes ===
When you assign a different mode,
Mini Micro actually removes the Display instance from the
display list, and inserts a new one of the correct Display
subclass. You may hang onto (and work with, off-screen) a
previous reference to the removed Display. If you want a
reference to the new Display, be sure to assign it *after*
assigning to the mode.

== Example ==

<ms>display(4).mode = displayMode.pixel // set display 4 to pixel mode
// g = display(4) // grab a reference to it as g</ms>

[[Category:Mini Micro]]

Mouse.visible

2020-03-24T15:42:00Z

71.226.33.30: Created page with "<c>mouse.visible</c> controls whether the mouse cursor is currently visible. Assign false (0) to this to hide the mouse cursor, and true (1) to show it again. == Example ==..."

<c>mouse.visible</c> controls whether the mouse cursor is currently visible. Assign false (0) to this to hide the mouse cursor, and true (1) to show it again.

== Example ==

<ms>mouse.visible = false // hides the mouse cursor</ms>

[[Category:Mini Micro]]

Mouse.x

2020-03-24T15:37:45Z

71.226.33.30:

<c>mouse.x</c> returns the current distance (in pixels) of the mouse cursor from the left edge of the screen.

See also: [[mouse.y]]; [[Screen coordinates]]

== Example ==

<ms>print mouse.x</ms>

[[Category:Mini Micro]]

Mouse.y

2020-03-24T15:37:13Z

71.226.33.30: Created page with "<c>mouse.y</c> returns the current distance (in pixels) of the mouse cursor from the bottom edge of the screen. See also: mouse.x; Screen coordinates == Example ==..."

<c>mouse.y</c> returns the current distance (in pixels) of the mouse cursor from the bottom edge of the screen.

See also: [[mouse.x]]; [[Screen coordinates]]

== Example ==

<ms>print mouse.x</ms>

[[Category:Mini Micro]]

Mouse.x

2020-03-24T15:35:30Z

71.226.33.30: Created page with "<c>mouse.x</c> returns the current distance (in pixels) of the mouse cursor from the left edge of the screen. == Example == <ms>print mouse.x</ms> Category:Mini Micro"

<c>mouse.x</c> returns the current distance (in pixels) of the mouse cursor from the left edge of the screen.

== Example ==

<ms>print mouse.x</ms>

[[Category:Mini Micro]]

Key.keyNames

2020-03-24T15:33:58Z

71.226.33.30:

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

See also: [[key.pressed]]

=== Usage Notes ===
This can be used, for example, to check all possible inputs, if waiting for the user to press anything to continue, or while configuring their
input preferences.

== Example ==

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

[[Category:Mini Micro]]

Key.keyNames

2020-03-24T15:33:43Z

71.226.33.30: Created page with "<c>key.keyNames</c> returns a list of all the key names available for use with key.pressed. See also: key.pressed === Usage Notes === This can be used, for example, to..."

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

See also: [[key.pressed]]

=== Usage Notes ===
This can be used, for example, to check all possible inputs, if waiting for the user to press anything to continue, or while configuring their
input preferences.

== Example ==

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

[[Category:Mini Micro]]

Key.axis

2020-03-24T15:25:47Z

71.226.33.30: Created page with "<c>key.axis</c> returns the numeric value (from -1 to 1) of an input axis. See also: key.pressed === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! D..."

<c>key.axis</c> returns the numeric value (from -1 to 1) of an input axis.

See also: [[key.pressed]]

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''axisName'' || string || Horizontal || name of axis to get
|}

=== Usage Notes ===
Available axis names are "Horizontal" and "Vertical", which can be activated
by both WASD and arrow keys as well as any joystick or gamepad;
"JoyAxis1" through "JoyAxis29" which detect axis inputs from any joystick or gamepad, and "Joy1Axis1" through "Joy8Axis29" which detect
axis inputs from specific joystick/gamepad 1 through 8.

== Example ==

<ms>print key.axis("Vertical")</ms>

[[Category:Mini Micro]]

Key.pressed

2020-03-24T00:31:30Z

71.226.33.30: Created page with "<c>key.pressed</c> detects whether a specific key or button input is currently pressed. See also: key.keyNames; key.axis === Arguments === {| class="wikitable" |-..."

<c>key.pressed</c> detects whether a specific key or button input is currently pressed.

See also: [[key.keyNames]]; [[key.axis]]

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Default Value !! Meaning
|-
| ''keyName'' || string, default "space" || key/button to press
|}

=== Usage Notes ===
These include modifier keys (e.g. "left shift", "right alt") as
well as mouse buttons (e.g. "mouse 0") and joystick/gamepad buttons
("joystick 1 button 0", etc.). With regard to joystick buttons,
if you don't specify a number (e.g. "joystick button 0"), then
it will detect a press of button 0 on *any* joystick.
See [[key.keyNames]] for all the possible names to use with this method.

== Example ==

<ms>while not key.pressed("left"); end while // waits until left arrow pressed</ms>

[[Category:Mini Micro]]