MiniScript Wiki - User contributions [en]

PixelDisplay.print

2020-05-01T03:34:11Z

ZachStrout: Created page with "<c>PixelDisplay.print</c> draws some text to the pixel display. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! Default Value !! Meaning |- | ''str..."

<c>[[PixelDisplay]].print</c> draws some text to the pixel display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''str'' || string || "" || string to draw
|-
| ''x'' || number || 0 || horizontal position at which to start drawing
|-
| ''y'' || number || 0 || vertical position of bottom of string drawn
|}

=== Usage Notes ===
By default this method uses the same font seen in a [[TextDisplay]],
but you may get a larger or smaller font using the ''fontName'' parameter.

== Example ==

[[Category:Mini Micro]]

PixelDisplay.getImage

2020-05-01T03:32:03Z

ZachStrout:

<c>[[PixelDisplay]].getImage</c> returns a portion of the pixel display as an [[Image]].

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''left'' || number || 0 || left side of display area to get
|-
| ''bottom'' || number || 0 || bottom side of display area to get
|-
| ''width'' || number || 960 || width side of display area to get
|-
| ''height'' || number || 640 || height side of display area to get
|}

=== Usage Notes ===
Note that this works even for a display that is not visible (because it is covered by another
display, or has been turned [[DisplayMode|off]]. This allows you to use
a PixelDisplay as an area to create images at runtime, using any combination
of drawing methods, and then capture the result for use as a [[Sprite]], or
to [[File.saveImage|save]] to disk, etc.

[[Category:Mini Micro]]

PixelDisplay.getImage

2020-05-01T03:29:55Z

ZachStrout: Created page with "<c>PixelDisplay.getImage</c> returns a portion of the pixel display as an Image. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! Default Value !! M..."

<c>PixelDisplay.getImage</c> returns a portion of the pixel display as an [[Image]].

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''left'' || number || 0 || left side of display area to get
|-
| ''bottom'' || number || 0 || bottom side of display area to get
|-
| ''width'' || number || 960 || width side of display area to get
|-
| ''height'' || number || 640 || height side of display area to get
|}

=== Usage Notes ===
Note that this works even for a display that is not visible (because it is covered by another
display, or has been turned [[DisplayMode|off]]. This allows you to use
a PixelDisplay as an area to create images at runtime, using any combination
of drawing methods, and then capture the result for use as a [[Sprite]], or
to [[File.saveImage|save]] to disk, etc.

[[Category:Mini Micro]]

PixelDisplay.drawImage

2020-05-01T03:27:37Z

ZachStrout: Created page with "<c>PixelDisplay.drawImage</c> draws an Image, or a portion of an Image, to the pixel display. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! D..."

<c>[[PixelDisplay]].drawImage</c> draws an [[Image]], or a portion of an Image, to the pixel display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''image'' || image || 0 || picture to draw
|-
| ''left'' || number || 0 || left side of destination area in the display
|-
| ''bottom'' || number || 0 || bottom of destination area in the display
|-
| ''width'' || number || 0 || width of destination area in the display
|-
| ''height'' || number || 0 || height side of destination area in the display
|-
| ''srcLeft'' || number || 0 || left side of source area in the image
|-
| ''srcBottom'' || number || 0 || bottom side of source area in the image
|-
| ''srcWidth'' || number || 0 || width of source area in the image
|-
| ''srcHeight'' || number || 0 || height side of source area in the image
|}

=== Usage Notes ===
To draw the entire image, specify only the image, and the bottom-left
corner of where you want it to appear on the display (and optionally the
desired width and height you want it to appear). To draw just a portion
of an image, add the four additional parameters specifying the rectangular
area in the source image that you want to draw.

Note that this should not be used for animation, as it is substantially
slower than using a [[SpriteDisplay]]. But it is more efficient if you
only need to draw something occasionally.

[[Category:Mini Micro]]

PixelDisplay.setPixel

2020-05-01T03:19:54Z

ZachStrout: Created page with "<c>PixelDisplay.setPixel</c> sets the color of a specific pixel within the display. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! Default Value !..."

<c>[[PixelDisplay]].setPixel</c> sets the color of a specific pixel within the display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || horizontal coordinate of pixel to set
|-
| ''y'' || number || 0 || vertical coordinate of pixel to set
|-
| color || color || self.color || color to set that pixel to
|}

[[Category:Mini Micro]]

PixelDisplay.pixel

2020-05-01T02:48:25Z

ZachStrout:

<c>[[PixelDisplay]].pixel</c> returns the color of a specific pixel within the display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || horizontal coordinate of pixel to get
|-
| ''y'' || number || 0 || vertical coordinate of pixel to get
|}

=== Usage Notes ===
Note that the color is always returned with the alpha channel included.
So even if you draw in color "#00FF00" (solid green, with alpha implied),
the pixel color will be returned as "#00FF00FF" (also solid grean, but
with the alpha explicit as the final FF).

[[Category:Mini Micro]]

PixelDisplay.pixel

2020-05-01T02:48:15Z

ZachStrout: Created page with "<c>PixelDisplay.pixel</c> returns the color of a specific pixel within the display. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! Default Value..."

PixelDisplay.fillEllipse

2020-05-01T02:45:26Z

ZachStrout:

<c>[[PixelDisplay]].fillEllipse</c> fills an ellipse defined by an axis-aligned rectangle on the pixel display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''left'' || number || 0 || left side of ellipse
|-
| ''bottom'' || number || 0 || bottom side of ellipse
|-
| ''width'' || number || 100 || ellipse width
|-
| ''height'' || number || 100 || ellipse height
|-
| ''color'' || color || self.color || color to draw
|}

== Example ==

<ms>gfx.fillEllipse 100, 200, 400, 150</ms>

[[Category:Mini Micro]]

PixelDisplay.fillEllipse

2020-05-01T02:45:12Z

ZachStrout: Created page with "<c>PixelDisplay.fillEllipse</c> fills an ellipse defined by an axis-aligned rectangle on the pixel display. === Arguments === {| class="wikitable" |- ! Parameter Name !! Ty..."

<c>PixelDisplay.fillEllipse</c> fills an ellipse defined by an axis-aligned rectangle on the pixel display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''left'' || number || 0 || left side of ellipse
|-
| ''bottom'' || number || 0 || bottom side of ellipse
|-
| ''width'' || number || 100 || ellipse width
|-
| ''height'' || number || 100 || ellipse height
|-
| ''color'' || color || self.color || color to draw
|}

== Example ==

<ms>gfx.fillEllipse 100, 200, 400, 150</ms>

[[Category:Mini Micro]]

PixelDisplay.drawEllipse

2020-05-01T02:42:00Z

ZachStrout: Created page with "<c>PixelDisplay.drawEllipse</c> draws (outlines) an ellipse defined by an axis-aligned rectangle on the pixel display. === Arguments === {| class="wikitable" |- ! Parame..."

<c>[[PixelDisplay]].drawEllipse</c> draws (outlines) an ellipse defined by an axis-aligned rectangle on the pixel display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''left'' || number || 0 || left side of ellipse
|-
| ''bottom'' || number || 0 || bottom side of ellipse
|-
| ''width'' || number || 100 || ellipse width
|-
| ''height'' || number || 100 || ellipse height
|-
| ''color'' || color || self.color || color to draw
|-
| ''penSize'' || number || 1 || width of line to draw
|}

== Example ==

<ms>gfx.drawEllipse 100, 200, 400, 150</ms>

[[Category:Mini Micro]]

PixelDisplay.fillRect

2020-05-01T02:36:46Z

ZachStrout: Created page with "<c>PixelDisplay.fillRect</c> fills an axis-aligned rectangle on the pixel display. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! Default Value !!..."

<c>[[PixelDisplay]].fillRect</c> fills an axis-aligned rectangle on the pixel display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''left'' || number || 0 || left side of rectangle
|-
| ''bottom'' || number || 0 || bottom side of rectangle
|-
| ''width'' || number || 100 || rectangle width
|-
| ''height'' || number || 100 || rectangle height
|-
| ''color'' || color || self.color || color to draw
|}

== Example ==

<ms>gfx.fillRect 100, 200, 400, 150</ms>

[[Category:Mini Micro]]

PixelDisplay.drawRect

2020-04-29T00:16:39Z

ZachStrout:

<c>[[PixelDisplay]].drawRect</c> draws (outlines) an axis-aligned rectangle on the pixel display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''left'' || number || 0 || left side of rectangle
|-
| ''bottom'' || number || 0 || bottom side of rectangle
|-
| ''width'' || number || 100 || rectangle width
|-
| ''height'' || number || 100 || rectangle height
|-
| ''color'' || color || self.color || color to draw
|-
| ''penSize'' || number || 1 || width of line to draw
|}

== Example ==

<ms>gfx.drawRect 100, 200, 400, 150</ms>

[[Category:Mini Micro]]

PixelDisplay.drawRect

2020-04-29T00:16:25Z

ZachStrout:

<c>[[Pixeldisplay]].drawRect</c> draws (outlines) an axis-aligned rectangle on the pixel display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''left'' || number || 0 || left side of rectangle
|-
| ''bottom'' || number || 0 || bottom side of rectangle
|-
| ''width'' || number || 100 || rectangle width
|-
| ''height'' || number || 100 || rectangle height
|-
| ''color'' || color || self.color || color to draw
|-
| ''penSize'' || number || 1 || width of line to draw
|}

== Example ==

<ms>gfx.drawRect 100, 200, 400, 150</ms>

[[Category:Mini Micro]]

PixelDisplay.drawRect

2020-04-29T00:16:13Z

ZachStrout: Created page with "<c>Pixeldisplay.drawRect</c> draws (outlines) an axis-aligned rectangle on the pixel display. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! Default V..."

<c>Pixeldisplay.drawRect</c> draws (outlines) an axis-aligned rectangle on the pixel display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''left'' || number || 0 || left side of rectangle
|-
| ''bottom'' || number || 0 || bottom side of rectangle
|-
| ''width'' || number || 100 || rectangle width
|-
| ''height'' || number || 100 || rectangle height
|-
| ''color'' || color || self.color || color to draw
|-
| ''penSize'' || number || 1 || width of line to draw
|}

== Example ==

<ms>gfx.drawRect 100, 200, 400, 150</ms>

[[Category:Mini Micro]]

PixelDisplay.fillPoly

2020-04-29T00:11:03Z

ZachStrout:

<c>[[PixelDisplay]].fillPoly</c> fills a polygon on the pixel display. The ''points'' argument can
be either a list of maps containing "x" and "y" values, or a list of 2-element
lists interpreted as [''x'', ''y''].

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''points'' || list || default value || list of three or more points
|-
| ''color'' || color || self.color || color to draw
|}

=== Usage Notes ===
The polygon is automatically closed; there is no need to repeat the first point at the end of the list.

== Example ==

<ms>gfx.fillPoly [[10,100], [200,500], [390,100]] // fills a triangle</ms>

[[Category:Mini Micro]]

PixelDisplay.fillPoly

2020-04-29T00:09:59Z

ZachStrout: Created page with "<c>PixelDisplay.fillPoly</c> fills a polygon on the pixel display. The ''points'' argument can be either a list of maps containing "x" and "y" values, or a list of 2-elem..."

<c>[[PixelDisplay.]]fillPoly</c> fills a polygon on the pixel display. The ''points'' argument can
be either a list of maps containing "x" and "y" values, or a list of 2-element
lists interpreted as [''x'', ''y''].

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''points'' || list || default value || list of three or more points
|-
| ''color'' || color || self.color || color to draw
|}

=== Usage Notes ===
The polygon is automatically closed; there is no need to repeat the first point at the end of the list.

== Example ==

<ms>gfx.fillPoly [[10,100], [200,500], [390,100]] // fills a triangle</ms>

[[Category:Mini Micro]]

PixelDisplay.drawPoly

2020-04-29T00:06:57Z

ZachStrout:

<c>[[PixelDisplay]].drawPoly</c> draws (outlines) a polygon on the pixel display. The ''points'' argument can be either a list of maps containing "x" and "y" values, or a list of 2-element
lists interpreted as [''x'', ''y''].

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''points'' || list || || list of three or more points
|-
| ''color'' || type || self.color || color to draw
|-
| ''penSize'' || number || 1 || width of line to draw
|}

=== Usage Notes ===
The polygon is automatically closed; there is no need to repeat the first point
at the end of the list.

== Example ==

<ms>gfx.drawPoly [[10,100], [200,500], [390,100]] // draws a triangle</ms>

[[Category:Mini Micro]]

PixelDisplay.drawPoly

2020-04-29T00:06:46Z

ZachStrout: Created page with "<c>PixelDisplay.drawPoly</c> draws (outlines) a polygon on the pixel display. The ''points'' argument can be either a list of maps containing "x" and "y" values, or a list of..."

<c>PixelDisplay.drawPoly</c> draws (outlines) a polygon on the pixel display. The ''points'' argument can be either a list of maps containing "x" and "y" values, or a list of 2-element
lists interpreted as [''x'', ''y''].

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''points'' || list || || list of three or more points
|-
| ''color'' || type || self.color || color to draw
|-
| ''penSize'' || number || 1 || width of line to draw
|}

=== Usage Notes ===
The polygon is automatically closed; there is no need to repeat the first point
at the end of the list.

== Example ==

<ms>gfx.drawPoly [[10,100], [200,500], [390,100]] // draws a triangle</ms>

[[Category:Mini Micro]]

PixelDisplay.line

2020-04-29T00:03:22Z

ZachStrout: Created page with "<c>PixelDisplay.line</c> draws a line on the pixel display. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! Default Value !! Meaning |- | ''x1'' ||..."

<c>[[PixelDisplay]].line</c> draws a line on the pixel display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x1'' || number || 0 || horizontal position of one end of the line
|-
| ''y1'' || number || 0 || vertical position of one end of the line
|-
| ''x2'' || number || 960 || horizontal position of other end of the line
|-
| ''y2'' || number || 640 || vertical position of other end of the line
|-
| ''color'' || color || self.color || color to draw
|-
| ''penSize'' || number || 640 || width of line to draw
|}

== Example ==

<ms>gfx.line 100,200, 500,200</ms>

[[Category:Mini Micro]]

PixelDisplay.clear

2020-04-28T23:56:45Z

ZachStrout: Created page with "<c>PixelDisplay.clear</c> clears, resets, and resizes this pixel display. === Arguments === {| class="wikitable" |- ! Parameter Name !! Type !! Default Value !! Meaning..."

<c>[[PixelDisplay]].clear</c> clears, resets, and resizes this pixel display.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''color'' || color || color.clear || color to fill the display with
|-
| ''width'' || number || 960 || new display width
|-
| ''height'' || number || default 640 || new display height
|}

=== Usage Notes ===
In addition to clearing the color and setting the size, this method
also resets the scale to 1, and scrollX and scrollY to 0.

[[Category:Mini Micro]]

PixelDisplay.scrollY

2020-04-28T23:50:25Z

ZachStrout: Created page with "<c>PixelDisplay.scrollY</c> This is an offset, in screen pixels, which makes the pixel display appear shifted down on screen (or up with negative values). == Example ==..."

<c>[[PixelDisplay]].scrollY</c> This is an offset, in screen pixels, which makes the pixel display appear shifted down on screen (or up with negative values).

== Example ==

<ms>gfx.scrollY = 100 // shifts the display 100 pixels down</ms>

[[Category:Mini Micro]]

PixelDisplay.scrollX

2020-04-28T23:48:45Z

ZachStrout: Created page with "<c>PixelDisplay.scrollX</c> is an offset, in screen pixels, which makes the pixel display appear shifted to the left on screen (or to the right with negative values). == Exam..."

<c>PixelDisplay.scrollX</c> is an offset, in screen pixels, which makes the pixel display appear shifted to the left on screen (or to the right with negative values).

== Example ==

<ms>gfx.scrollX = 100 // shifts the display 100 pixels to the left</ms>

[[Category:Mini Micro]]

PixelDisplay.scale

2020-04-28T23:46:53Z

ZachStrout:

<c>[[PixelDisplay]].scale</c> is a scaling factor controlling how this pixel display is rendered on
screen. The default value of 1 means that one pixel in the display
draws as 1 pixel on screen; 2 double the scale, making each pixel
appear twice the normal width and height.

=== Usage Notes ===
You may assign either a simple number to scale the same way in width
and height, or a list <c>[''x scale'', ''y scale'']</c> to scale differently
in X and Y.

== Example ==

<ms>gfx.scale = 5 // makes every gfx pixel 5 times bigger in X and Y</ms>

[[Category:Mini Micro]]

PixelDisplay.scale

2020-04-28T23:43:57Z

ZachStrout:

<c>[[PixelDisplay]].clear</c> is a scaling factor controlling how this pixel display is rendered on
screen. The default value of 1 means that one pixel in the display
draws as 1 pixel on screen; 2 double the scale, making each pixel
appear twice the normal width and height.

=== Usage Notes ===
You may assign either a simple number to scale the same way in width
and height, or a list <c>[''x scale'', ''y scale'']</c> to scale differently
in X and Y.

== Example ==

<ms>gfx.scale = 5 // makes every gfx pixel 5 times bigger in X and Y</ms>

[[Category:Mini Micro]]

PixelDisplay.scale

2020-04-28T23:43:00Z

ZachStrout:

<c>[[PixelDisplay.clear]]</c> is a scaling factor controlling how this pixel display is rendered on
screen. The default value of 1 means that one pixel in the display
draws as 1 pixel on screen; 2 double the scale, making each pixel
appear twice the normal width and height.

=== Usage Notes ===
You may assign either a simple number to scale the same way in width
and height, or a list <c>[''x scale'', ''y scale'']</c> to scale differently
in X and Y.

== Example ==

<ms>gfx.scale = 5 // makes every gfx pixel 5 times bigger in X and Y</ms>

[[Category:Mini Micro]]

PixelDisplay.scale

2020-04-28T23:42:50Z

ZachStrout: Created page with "<c>PixelDisplay.clear</c> is a scaling factor controlling how this pixel display is rendered on screen. The default value of 1 means that one pixel in the display draws as 1..."

<c>PixelDisplay.clear</c> is a scaling factor controlling how this pixel display is rendered on
screen. The default value of 1 means that one pixel in the display
draws as 1 pixel on screen; 2 double the scale, making each pixel
appear twice the normal width and height.

=== Usage Notes ===
You may assign either a simple number to scale the same way in width
and height, or a list <c>[''x scale'', ''y scale'']</c> to scale differently
in X and Y.

== Example ==

<ms>gfx.scale = 5 // makes every gfx pixel 5 times bigger in X and Y</ms>

[[Category:Mini Micro]]

PixelDisplay.height

2020-04-28T23:40:39Z

ZachStrout: Created page with "<c>PixelDisplay.height</c> is the number of pixel rows in the display. This is a read-only value; to change the width and height of the display, use [[PixelDisplay.clear]..."

<c>[[PixelDisplay.height]]</c> is the number of pixel rows in the display.

This is a read-only value; to change the width and height of the display,
use [[PixelDisplay.clear]].

== Example ==

<ms>print gfx.height // prints 640 in the default state</ms>

[[Category:Mini Micro]]

PixelDisplay.width

2020-04-28T23:38:03Z

ZachStrout:

<c>PixelDisplay.width</c> is the number of pixel columns in the display.

=== Usage Notes ===
This is a read-only value; to change the width and height of the display,
use [[PixelDisplay.clear]].

== Example ==

print gfx.width // prints 960 in the default state

[[Category:Mini Micro]]

PixelDisplay.width

2020-04-28T23:37:38Z

ZachStrout: Created page with "<c>PixelDisplay.width</c> is the number of pixel columns in the display. === Usage Notes === This is a read-only value; to change the width and height of the display, use P..."

Sprite.tint

2020-04-12T23:08:39Z

ZachStrout: Created page with "<c>Sprite.tint:</c> Tint color to apply to the sprite image. A tint of <c>color.red</c>, for example, will make white pixels in the sprite image appear red; other colors..."

<c>Sprite.tint:</c> Tint [[color]] to apply to the sprite image. A tint of <c>color.red</c>,
for example, will make white pixels in the sprite image appear red; other
colors will be mixed with (technically, multiplied by) red.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''paramnamd1'' || type || default value || description
|}

=== Usage Notes ===
Assigning a tint color with an alpha less than 255 (FF) will make the
sprite semi-transparent. In the extreme, setting a tint of <c>color.clear</c>
will make the sprite invisible (though this is not as efficient as simply
removing the sprite from the display [[SpriteDisplay.sprites|sprites]] list).

== Example ==

<ms>sp = new Sprite
sp.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push sp
sp.tint = "#00FF0088" // semi-transparent green</ms>

[[Category:Mini Micro]]

Sprite.rotation

2020-04-12T23:07:14Z

ZachStrout:

<c>Sprite.rotation</c>: Rotation of the sprite, in degrees counter-clockwise.

== Example ==

<ms>sp = new Sprite
sp.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push sp
sp.rotation = 45</ms>

[[Category:Mini Micro]]

Sprite.overlaps

2020-04-12T22:04:22Z

ZachStrout: Created page with "<c> Sprite.overlaps</c> checks whether this sprite overlaps (touches) another one, by comparing their bounds. === Arguments === {| class="wikitable" |- ! Parameter Name !!..."

<c> Sprite.overlaps</c> checks whether this sprite overlaps (touches) another one, by
comparing their bounds.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Meaning
|-
| ''other'' || Sprite or Bounds || object to check for overlap with
|}

=== Usage Notes ===
Use of this requires first defining the [[Sprite.localBounds|localBounds]]
of each sprite.

[[Category:Mini Micro]]

Sprite.contains

2020-04-12T22:02:19Z

ZachStrout: Created page with "<c>Sprite.contains</c> returns whether the sprite's world bounds contains the given x,y point (given in world coordinates). === Arguments === {| class="wikitable" |- ! Para..."

<c>Sprite.contains</c> returns whether the sprite's world bounds contains the given x,y point
(given in world coordinates).

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Type !! Default Value !! Meaning
|-
| ''x'' || number || 0 || horizontal position of point of interest
|-
| ''y'' || number || 0 || vertical position of point of interest
|}

=== Usage Notes ===
This is just a shortcut for <c>[[Sprite.worldBounds|worldBounds]].contains</c>.
Use of this requires first defining the [[Sprite.localBounds|localBounds]].

[[Category:Mini Micro]]

Sprite.worldBounds

2020-04-12T21:58:56Z

ZachStrout: ZachStrout moved page Sprite.worldbounds to Sprite.worldBounds

<c>Sprite.worldbounds</c> returns the current bounds of the sprite in world coordinates. This
is calculated by applying the sprite's current [[Sprite.x|x]],
[[Sprite.y|y]], [[Sprite.rotation|rotation]], and [[Sprite.scale|scale]]
values to the sprite's [[Sprite.localBounds|localBounds]].

See also: [[How to detect a click on a sprite]]

=== Usage Notes ===
Use of this requires first defining the [[Sprite.localBounds|localBounds]].

[[Category:Mini Micro]]

Sprite.worldbounds

2020-04-12T21:58:56Z

ZachStrout: ZachStrout moved page Sprite.worldbounds to Sprite.worldBounds

#REDIRECT [[Sprite.worldBounds]]

Sprite.localBounds

2020-04-12T21:58:25Z

ZachStrout: ZachStrout moved page Sprite.localbounds to Sprite.localBounds

<c>sprite.localBounds</c> assigns a [[Bounds]] object to this property to define the sprite
bounds in "local" coordinates. That means the bounds the sprite would
have if it were positioned at x=0, y=0, with no rotation and scale=1.
[[Mini Micro]] will automatically compute the [[Sprite.worldBounds|worldBounds]]
from this local bounds as the sprite moves, rotates, and scales.

[[Category:Mini Micro]]

Sprite.localbounds

2020-04-12T21:58:25Z

ZachStrout: ZachStrout moved page Sprite.localbounds to Sprite.localBounds

#REDIRECT [[Sprite.localBounds]]

Sprite.worldBounds

2020-04-12T21:55:10Z

ZachStrout: Created page with "<c>Sprite.worldbounds</c> returns the current bounds of the sprite in world coordinates. This is calculated by applying the sprite's current x, y, [..."

Sprite.localBounds

2020-04-12T21:53:33Z

ZachStrout: Created page with "<c>sprite.localBounds</c> assigns a Bounds object to this property to define the sprite bounds in "local" coordinates. That means the bounds the sprite would have if it w..."

Sprite.rotation

2020-04-12T21:52:18Z

ZachStrout: Created page with "<c>Sprite.rotation</c>: Tint color to apply to the sprite image. A tint of <c>color.red</c>, for example, will make white pixels in the sprite image appear red; other col..."

<c>Sprite.rotation</c>: Tint [[color]] to apply to the sprite image. A tint of <c>color.red</c>,
for example, will make white pixels in the sprite image appear red; other
colors will be mixed with (technically, multiplied by) red.

=== Usage Notes ===
Assigning a tint color with an alpha less than 255 (FF) will make the
sprite semi-transparent. In the extreme, setting a tint of <c>color.clear</c>
will make the sprite invisible (though this is not as efficient as simply
removing the sprite from the display [[SpriteDisplay.sprites|sprites]] list)
== Example ==

<ms>sp = new Sprite
sp.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push sp
sp.tint = "#00FF0088" // semi-transparent green</ms>

[[Category:Mini Micro]]

Sprite.scale

2020-04-12T21:49:52Z

ZachStrout: Created page with "<c>Sprite.scale</c> is the scale factor of the sprite. A scale of 1 means that one pixel in the image appears as one pixel on screen. Setting scale=2 makes..."

<c>Sprite.scale</c> is the scale factor of the sprite. A scale of 1 means that one pixel in
the [[Sprite.image|image]] appears as one pixel on screen. Setting
scale=2 makes the sprite appear twice as big; scale=0.5 makes it appear
half its standard size.

=== Usage Notes ===
You may also scale a sprite differently in
x and y by assigning a list of two numbers; the first is the x scale,
and the second is the y scale, as in the example below.

== Example ==

<ms>sp = new Sprite
sp.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push sp
sp.scale = [2,1] // double the width, but leave height alone</ms>

[[Category:Mini Micro]]

Sprite.y

2020-04-12T21:48:03Z

ZachStrout: Created page with "<c>Sprite.y</c> is the vertical position of the sprite, in Screen coordinates (adjusted by SpriteDisplay.scrollY. == Example == <ms>sp = new Sprite sp.image = file.l..."

<c>Sprite.y</c> is the vertical position of the sprite, in [[Screen coordinates]]
(adjusted by [[SpriteDisplay.scrollY]].

== Example ==

<ms>sp = new Sprite
sp.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push sp
sp.y = 320</ms>

[[Category:Mini Micro]]

Sprite.image

2020-04-12T21:47:12Z

ZachStrout:

<c>Sprite.image</c>: [[Image]] displayed by the sprite.

See also: [[file.loadImage]]

== Example ==

<ms>sp = new Sprite
sp.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push sp</ms>

[[Category:Mini Micro]]

Sprite.x

2020-04-12T21:45:05Z

ZachStrout: Created page with "<c>Sprite.x</c> Horizontal position of the sprite, in Screen coordinates (adjusted by SpriteDisplay.scrollX. == Example == <ms>sp = new Sprite sp.image = file.loadIm..."

<c>Sprite.x</c> Horizontal position of the sprite, in [[Screen coordinates]]
(adjusted by [[SpriteDisplay.scrollX]].

== Example ==

<ms>sp = new Sprite
sp.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push sp
sp.x = 480</ms>

[[Category:Mini Micro]]

Sprite.image

2020-04-12T21:44:04Z

ZachStrout: Created page with "<c>Sprite.image</c>: Image displayed by the sprite. == Example == <ms>sp = new Sprite sp.image = file.loadImage("/sys/pics/Wumpus.png") display(4).sprites.push sp</ms>..."

<c>Sprite.image</c>: [[Image]] displayed by the sprite.

== Example ==

<ms>sp = new Sprite
sp.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push sp</ms>

[[Category:Mini Micro]]

SpriteDisplay.sprites

2020-04-12T21:38:51Z

ZachStrout: Created page with "<c>SpriteDisplay.sprites</c> is the list that contains all sprites in the display. Sprites are layered according to their order in this list, with sprites[0] at the back, an..."

<c>SpriteDisplay.sprites</c> is the list that contains all sprites in the display. Sprites are
layered according to their order in this list, with sprites[0] at the
back, and the last sprite in the list drawn on top. To add a sprite to
the display, simply add it to this list; remove it from the list to remove
the sprite from the display. You may reorder
sprites in this list at any time to change the layering.

== Example ==

<ms>sp = new Sprite
sp.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push sp // add a sprite to the display
key.get // wait for a keypress
display(4).sprites.remove display(4).sprites.indexOf sp // remove it</ms>

[[Category:Mini Micro]]

SpriteDisplay.clear

2020-04-12T21:37:05Z

ZachStrout:

<c>SpriteDisplay.clear</c> clears all sprites from the display (resetting [[SpriteDisplay.sprites|.sprites]]
to an empty list). It also resets [[SpriteDisplay.scrollX|.scrollX]] and
[[SpriteDisplay.scrollY|.scrollY]] to zero.

== Example ==

<ms>display(4).mode = displayMode.sprite
disp = display(4)
disp.clear</ms>

[[Category:Mini Micro]]

SpriteDisplay.clear

2020-04-12T21:36:55Z

ZachStrout: Created page with "<c>SpriteDisplay.clear</c> Clears all sprites from the display (resetting .sprites to an empty list). It also resets SpriteDisplay.scrollX|.scroll..."

<c>SpriteDisplay.clear</c> Clears all sprites from the display (resetting [[SpriteDisplay.sprites|.sprites]]
to an empty list). It also resets [[SpriteDisplay.scrollX|.scrollX]] and
[[SpriteDisplay.scrollY|.scrollY]] to zero.

== Example ==

<ms>display(4).mode = displayMode.sprite
disp = display(4)
disp.clear</ms>

[[Category:Mini Micro]]

SpriteDisplay.scrollX

2020-04-12T21:35:46Z

ZachStrout:

<c>SpriteDisplay.scrollX</c>: Horizontal scroll amount subtracted from the position of all
sprites on the display. This is the standard way of making it
appear that the world is scrolling past.

See also: [[SpriteDisplay.scrollY]]; [[PixelDisplay.ScrollX]]; [[TileDisplay.ScrollX]]

== Example ==

<ms>sp = new Sprite
sp.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push sp
for i in range(0,500,10)
display(4).scrollX = -i
wait 0.2
end for</ms>

[[Category:Mini Micro]]

SpriteDisplay.scrollY

2020-04-12T21:34:53Z

ZachStrout: Created page with "<c>SpriteDisplay.scrollY</c>: Vertical scroll amount subtracted from the position of all sprites on the display. This is the standard way of making it appear that the world i..."

<c>SpriteDisplay.scrollY</c>: Vertical scroll amount subtracted from the position of all
sprites on the display. This is the standard way of making it
appear that the world is scrolling past.

See also: [[SpriteDisplay.scrollX]]; [[PixelDisplay.ScrollY]]; [[TileDisplay.ScrollY]]

== Example ==

<ms>sp = new Sprite
sp.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push sp
for i in range(0,500,10)
display(4).scrollY = -i
wait 0.2
end for</ms>

[[Category:Mini Micro]]