MiniScript Wiki - User contributions [en]

MathUtil

2025-04-04T20:29:05Z

Duck Mim: degToRad("radians") ----> degToRad(''degrees'')

In [[Mini Micro]], <c>mathUtil</c> is an [[import]] module in the <c>/sys/lib</c> directory. It provides various additional math-related functions and constants.

Like all the modules in <c>/sys/lib</c>, the best documentation for mathUtil is the source code (<c>/sys/lib/mathUtil.ms</c>) itself. But this page summarizes the content in more concise form.

== Constant ==

{| class="wikitable"
|-
! Name !! Value / Purpose
|-
| mathUtil.e || [https://en.wikipedia.org/wiki/E_(mathematical_constant) Euler's number], roughly 2.718; base of natural logarithms
|}

== Methods ==

The following methods are normally accessed via the <c>mathUtil</c> prefix, e.g. <c>mathUtil.radToDeg(pi)</c>.

{| class="wikitable"
|-
! Method !! Returns
|-
| ln(''x'') || natural logarithm of ''x''
|-
| radToDeg(''radians'') || converts ''radians'' into degrees
|-
| degToRad(''degrees'') || converts ''degrees'' into radians
|-
| moveTowards(''num'', ''targetNum'', ''maxChange''=1) || returns a value closer to ''targetNum'' from ''num'', differing from ''num'' by no more than ''maxChange'')
|-
| moveTowardsXY(''mover'', ''target'', ''maxDist''=1) || like <c>moveTowards</c>, but mutates map ''mover'' to approach ''target'', each with ''x'' and ''y'' properties (e.g., a [[Sprite]])
|-
| distance(''p1'', ''p2'') || find the distance between two points; each may be a map containing ''x'' and ''y', or an [''x'', ''y''] list
|-
| lerp(''a'', ''b'', ''t'') || returns a value some portion ''t'' of the way from ''a'' to ''b''
|-
| lerp2d(''p1'', ''p2'', ''t'') || same as <c>lerp</c>, but on 2d points (maps or lists)
|-
| proportionAlongLine(''endA'', ''endB'', ''p'') || returns how far ''p'' is along the line from ''endA'' to ''endB''
|-
| nearestPointOnLine(''endA'', ''endB'', ''p'') || returns closest point to ''p'' on the line from ''endA'' to ''endB'' as an [''x'', ''y''] list
|-
| nearestPointOnLineSegment(''endA'', ''endB'', ''p'') || same as <c>nearestPointOnLine</c>, but limited to not go beyond the range from ''endA'' to ''endB''
|-
| distanceToLine(''endA'', ''endB'', ''p'') || returns distance from ''p'' to the line from ''endA'' to ''endB''
|-
| distanceToLineSegment(''endA'', ''endB'', ''p'') || same as <c>distanceToLine</c>, but limited to not go beyond the range from ''endA'' to ''endB''
|-
| polyPerimeter(''polygon'') || returns total distance around ''polygon'' (given as list of [''x'', ''y'']] points)
|-
| polyArea(''polygon'') || returns area of ''polygon'' (given as list of [''x'', ''y'']] points)
|-
| pointInPoly(''point'', ''polygon'') || returns true if ''point'' (an [''x'', ''y''] point) is contained within ''polygon''; or if ''point'' is a list of ['x'', ''y''] points, returns true if any of those points are within ''polygon''
|-
| offsetPoly(''polygon'', ''delta'') || returns a new polygon by insetting/growing ''polygon'' by the given amount
|-
| shiftPoly(''polygon'', ''dx'', ''dy'') || returns a new polygon by translating ''polygon'' by the given amounts
|-
| rotatePoly(''polygon'', ''degrees'') || returns a new polygon by rotating ''polygon'' by ''degrees'' clockwise
|-
| randNormal(''mean''=0, ''stddev''=1) || returns a [https://en.wikipedia.org/wiki/Normal_distribution normally-distributed] random number
|-
| randRange(''min'', ''max'') || returns a random number between ''min'' and ''max''
|-
| dice(''numberOfDice''=1, ''sides''=6) || roll ''numberOfDice'' dice, each with values from 1 to ''sides'', and return the sum
|-
| clamp(''x'', ''minval''=0, ''maxval'=1) || return ''x'' limited to the range ''minval'' to ''maxval''
|-
| numToStr(''n'', ''precision'') || convert ''n'' to a string, with a specified number of digits past the decimal place, with trailing zeros
|}

== Example ==

The following program creates a sprite, then uses <c>mathUtil.moveTowardsXY</c> to make it chase the mouse.

<ms>import "mathUtil"
s = new Sprite
s.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push s
while true
mathUtil.moveTowardsXY s, mouse, 10
yield
end while</ms>

[[Category:Mini Micro]]
[[Category:Sys Modules]]

TileDisplay

2025-03-28T10:27:41Z

Duck Mim: Added value column and divided into 3 categories

The <c>TileDisplay</c> class in [[Mini Micro]] is a display type that holds and draws a grid of tiles, small images taken from a larger image called a ''tile set''.

No display is configured as a tile display by default. But you can make any display layer a tile display by setting its [[Display.mode|mode]] to <c>displayMode.tile</c>.

== Tile Indexing ==

The tiles within the tile-set are referred to by index.

Note that in contrast to all other Mini Micro coordinates (which originate bottom-left) the tiles in a tile-set file are indexed from '''top-left to bottom-right'''.

The tile with index 0 will refer to the leftmost image in the first row, index 1 to the one to its right, and so on, until the last image in the row. The next index number will refer to the first / leftmost image in the second row, and so on. The last image in the tile set will be the rightmost of the last row.

== Methods and Properties ==

{| class="wikitable"
! Method or Property !! Purpose !! Type
|-
|-|
| colspan=3 style="text-align: center;" | '''Read only'''
|-
| [[TileDisplay.cell]](''x'', ''y'') || get the tile index of cell ''x'', ''y'' || number
|-
| [[TileDisplay.cellTint]](''x'', ''y'') || get the tint color of cell ''x'', ''y'' || string (color)
|-
| [[TileDisplay.cellTransform]](''x'', ''y'') || get the transform (0-7) of cell at ''x'', ''y'' || number
|-

| colspan=3 style="text-align: center;" | '''Edit and read'''
|-
|-
| [[TileDisplay.extent]] ''[columns, rows]'' || display size || pair of numbers
|-
| [[TileDisplay.tileSet]] || [[Image]] containing tiles to draw from || [[Image]]
|-
| [[TileDisplay.tileSetTileSize]] || size of tiles in `tileSet` || number
|-
| [[TileDisplay.cellSize]] || size of tiles on screen || number
|-
| [[TileDisplay.overlap]] || cell overlap, in pixels || number
|-
| [[TileDisplay.oddRowOffset]] || amount to shift odd rows horizontally; use 0.5 for hex rows || number
|-
| [[TileDisplay.oddColOffset]] || amount to shift odd columns vertically; use 0.5 for hex columns || number
|-
| [[TileDisplay.scrollX]] || horizontal scroll amount, in pixels || number
|-
| [[TileDisplay.scrollY]] || vertical scroll amount, in pixels || number
|-

| colspan=3 style="text-align: center;" | '''Run'''
|-
|-
| [[TileDisplay.clear]] ''toIndex'' || set all tiles to null (the default) or the given index
|-
|-
| [[TileDisplay.setCell]] ''x'', ''y'', ''idx'' || set the tile index of cell ''x'', ''y'' to ''idx''
|-
|-
| [[TileDisplay.setCellTint]] ''x'', ''y'', ''c'' || set the tint of cell ''x'', ''y'' to color ''c''
|-
| [[TileDisplay.setCellTransform]] ''x'', ''y'', ''t'' || set the transform of cell ''x'', ''y'' to value ''t''
|}

== Example ==

The following example shows how to set up a TileDisplay, load an initial pattern tiles, and then dynamically change the tiles shown over time. (The main loop cycles through all 64 tiles in the demo tile set, changing the tile shown in the center of the display every 0.1 seconds.)

<ms>// prepare the display
clear
display(5).mode = displayMode.tile
td = display(5)
td.tileSet = file.loadImage("/sys/pics/TileShapes.png")
td.tileSetTileSize = 64 // size of each tile in the image
td.extent = [15, 10] // columns, rows on screen

// set up the initial tile pattern
td.clear 20 // clear to tile 20 (dark blue circle)
for row in range(0, 9)
td.setCell 0, row, 6 // tile 6 is a yellow square
td.setCell 14, row, 6
end for
for col in range(0, 14)
td.setCell col, 0, 1 // tile 1 is a gray square
td.setCell col, 9, 1
end for

// main loop
cellIdx = 0
while true
td.setCell 7, 5, cellIdx
cellIdx = (cellIdx + 1) % 64
wait 0.1
end while</ms>

[[File:TileDisplayExample.png|frameless|center]]

[[Category:Mini Micro]]

PixelDisplay

2025-03-28T10:07:14Z

Duck Mim: Synchronize order with another page

The <c>PixelDisplay</c> class in [[Mini Micro]] is a display type that represents a rectangular pixel buffer, with methods to efficiently draw lines, shapes, images, and text.

By default, [[display]] 5 is configured as a pixel display, and is in fact the pixel display to which the [[gfx]] global refers (unless you change it). But you can make any display layer a pixel display by setting its [[Display.mode|mode]] to <c>displayMode.pixel</c>.

A PixelDisplay is 960 x 640 pixels by default (see [[screen coordinates]]), though this may be changed via the [[PixelDisplay.clear|clear]] method.

== Methods and Properties ==
{| class="wikitable"
! Method or Property !! Purpose !! Type
|-
|-|
| colspan=3 style="text-align: center;" | '''Edit and read'''
|-
|-
| [[PixelDisplay.color]] || get or set the default drawing color, used when color is not otherwise specified || string (color)
|-
| [[PixelDisplay.scale]] || scaling factor used to magnify (or shrink) the pixel display on screen || number
|-
| [[PixelDisplay.scrollX]] || get or set a horizontal shift applied to the entire display || number
|-
| [[PixelDisplay.scrollY]] || get or set a vertical shift applied to the entire display || number
|-
| colspan=3 style="text-align: center;" | '''Read only'''
|-
| [[PixelDisplay.width]] || number of columns in the the pixel buffer || number
|-
| [[PixelDisplay.height]] || number of rows in the the pixel buffer || number
|-
| [[PixelDisplay.pixel]] ''x '', ''y'' || get the color of a particular pixel || string (color)
|-
| [[PixelDisplay.getImage]](''left'', ''bottom'', ''width'', ''height'') || get a portion of the pixel buffer as an [[Image]] || [[Image]]
|-
|-|
| colspan=3 style="text-align: center;"| '''Run'''
|-
|-
| [[PixelDisplay.clear]] ''[color]'', ''[width]'', ''[height]'' || clear/reset the pixel buffer width: number; height: number
|-
| [[PixelDisplay.setPixel]] ''x'', ''y'', ''[color]'' || set the color of a particular pixel
|-
| [[PixelDisplay.line]] ''x1'', ''y1'', ''x2'', ''y2'', ''[color]'', ''[penSize]'' || draw a line
|-
| [[PixelDisplay.drawRect]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'', ''[penSize]'' || draw a rectangle outline
|-
| [[PixelDisplay.fillRect]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled rectangle
|-
| [[PixelDisplay.drawEllipse]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'', ''[penSize]'' || draw an ellipse outline
|-
| [[PixelDisplay.fillEllipse]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled ellipse
|-
| [[PixelDisplay.drawPoly]] ''points'', ''[color]'', ''[penSize]'' || draw a polygon outline
|-
| [[PixelDisplay.fillPoly]] ''points'', ''[color]'' || draw a filled polygon
|-
| [[PixelDisplay.drawImage]] ''img'', ''left'', ''bottom'', ''[width]'', ''[height]'', ''[srcLeft]'', ''[srcBottom]'', ''[srcWidth]'', ''[srcHeight]'' || draw an [[Image]] (or portion thereof)
|-
| [[PixelDisplay.print]] ''str'', ''x'', ''y'', ''[color]'', ''[font]'' || draw a string
|}

== Implementation Note ==

For performance reasons, a PixelDisplay under the hood is made up of 256x256 pixel tiles. These are initialized to the color passed to [[PixelDisplay.clear]]. As a result, if your width or height is not an even multiple of 256, then this initial clear color will extend beyond the usable area. As an example, try:

<ms>gfx.clear color.red, 200,200
gfx.fillRect 0,0,gfx.width,gfx.height, color.blue</ms>

This displays a 200x200 blue square (the official size of the pixel display) with an additional red area extending 256x256 (one full tile) in size.

[[Category:Mini Micro]]

Sprite

2025-01-29T17:19:18Z

Duck Mim: Fixing

<c>Sprite</c> is a built-in class in the [[Mini Micro]] API. It represents an image which can be added to a [[SpriteDisplay]], enabling it to be drawn to the screen very efficiently while also being scaled, rotated, or tinted, and layered consistently with other sprites and the surrounding displays.

== Methods and properties used with Sprite objects ==

Use these methods on Sprite instances, created with <c>[[new]] Sprite</c>.
{| class="wikitable"
|-
! Method or Property !! Purpose !! Type
|-
| colspan=3 style="text-align: center;" | '''Edit and read'''
|-
| [[Sprite.image]] || image displayed by the sprite || [[Image]]
|-
| [[Sprite.x]] || horizontal position of the sprite || number
|-
| [[Sprite.y]] || vertical position of the sprite || number
|-
| [[Sprite.scale]] || sprite scale (default 1.0) || number
|-
| [[Sprite.rotation]] || sprite rotation (degrees counter-clockwise) || number
|-
| [[Sprite.tint]] || tint color (defaults to white) || string (color)
|-
| [[Sprite.localBounds]] || stores the local bounds of the sprite || [[Bounds]]
|-
| colspan=3 style="text-align: center;" | '''Read only'''
|-
|-
| [[Sprite.worldBounds]] || computes world bounds from local bounds and current position || pare of numbers
|-
| [[Sprite.contains]](''x'', ''y'') || return whether the sprite contains the given world point || bool
|-
| [[Sprite.overlaps]](''other'') || return whether this sprite is touching another sprite or [[Bounds]] || bool
|-
| [[Sprite.corners]] || return <c>[x,y]</c> screen positions of the four corners of this sprite, counter-clockwise from bottom left || 4 pares of numbers
|-
| colspan=3 style="text-align: center;"| '''Run'''
|-
|-
| [[Sprite.setCorners]] ''corners''|| set new screen positions for the four sprite corners (counter-clockwise from bottom left)
|-
|}

== Usage Notes (Soda) ==

In [[Soda]] there is currently only one, implicit, [[Display]]. So to add sprites to this display, push them onto a global list called <c>sprites</c>.

[[Soda]] does not currently support [[Sprite.corners]] or [[Sprite.setCorners]].

== Example ==

This example creates a sprite, loads it into display 4 (which by default is a [[SpriteDisplay]]), and rotates it through 360 degrees.

<ms>spr = new Sprite
spr.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push spr
spr.x = 480
spr.y = 320
for r in range(0,360)
spr.rotation = r
yield
end for</ms>

== See also ==

* [[How to move a sprite forward]]
* [[How to detect a click on a sprite]]
* [[How to move a sprite with directional inputs]]
* [[How to load a sprite from the web]]
* [[How to make a sprite translucent]]
* [[How to move a sprite towards a target]]
* [[How to point a sprite at a target]]

[[Category: Mini Micro]]
[[Category: Soda]]

Sprite

2025-01-29T17:18:48Z

Duck Mim: /* Methods and properties used with Sprite objects */ Better look

<c>Sprite</c> is a built-in class in the [[Mini Micro]] API. It represents an image which can be added to a [[SpriteDisplay]], enabling it to be drawn to the screen very efficiently while also being scaled, rotated, or tinted, and layered consistently with other sprites and the surrounding displays.

== Methods and properties used with Sprite objects ==

Use these methods on Sprite instances, created with <c>[[new]] Sprite</c>.
{| class="wikitable"
|-
! Method or Property !! Purpose !! Type
|-
| colspan=3 style="text-align: center;" | '''Edit and read'''
|-
| [[Sprite.image]] || image displayed by the sprite || [[Image]]
|-
| [[Sprite.x]] || horizontal position of the sprite || number
|-
| [[Sprite.y]] || vertical position of the sprite || number
|-
| [[Sprite.scale]] || sprite scale (default 1.0) || number
|-
| [[Sprite.rotation]] || sprite rotation (degrees counter-clockwise) || number
|-
| [[Sprite.tint]] || tint color (defaults to white) || string (color)
|-
| [[Sprite.localBounds]] || stores the local bounds of the sprite || [[Bounds]]
|-
| colspan=3 style="text-align: center;" | '''Read only'''
|-
|-
| [[Sprite.worldBounds]] || computes world bounds from local bounds and current position || pare of numbers
|-
| [[Sprite.contains]](''x'', ''y'') || return whether the sprite contains the given world point || bool
|-
| [[Sprite.overlaps]](''other'') || return whether this sprite is touching another sprite or [[Bounds]] || bool
|-
| [[Sprite.corners]] || return <c>[x,y]</c> screen positions of the four corners of this sprite, counter-clockwise from bottom left || 4 pares of numbers
|-
| colspan=3 style="text-align: center;"| '''Run'''
|-
! Method or Property !! Purpose
|-
| [[Sprite.setCorners]] ''corners''|| set new screen positions for the four sprite corners (counter-clockwise from bottom left)
|-
|}

== Usage Notes (Soda) ==

In [[Soda]] there is currently only one, implicit, [[Display]]. So to add sprites to this display, push them onto a global list called <c>sprites</c>.

[[Soda]] does not currently support [[Sprite.corners]] or [[Sprite.setCorners]].

== Example ==

This example creates a sprite, loads it into display 4 (which by default is a [[SpriteDisplay]]), and rotates it through 360 degrees.

<ms>spr = new Sprite
spr.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push spr
spr.x = 480
spr.y = 320
for r in range(0,360)
spr.rotation = r
yield
end for</ms>

== See also ==

* [[How to move a sprite forward]]
* [[How to detect a click on a sprite]]
* [[How to move a sprite with directional inputs]]
* [[How to load a sprite from the web]]
* [[How to make a sprite translucent]]
* [[How to move a sprite towards a target]]
* [[How to point a sprite at a target]]

[[Category: Mini Micro]]
[[Category: Soda]]

PixelDisplay

2025-01-29T16:45:06Z

Duck Mim: /* Methods and Properties */ Better looking

The <c>PixelDisplay</c> class in [[Mini Micro]] is a display type that represents a rectangular pixel buffer, with methods to efficiently draw lines, shapes, images, and text.

By default, [[display]] 5 is configured as a pixel display, and is in fact the pixel display to which the [[gfx]] global refers (unless you change it). But you can make any display layer a pixel display by setting its [[Display.mode|mode]] to <c>displayMode.pixel</c>.

A PixelDisplay is 960 x 640 pixels by default (see [[screen coordinates]]), though this may be changed via the [[PixelDisplay.clear|clear]] method.

== Methods and Properties ==
{| class="wikitable"
! Method or Property !! Purpose !! Type
|-
| colspan=3 style="text-align: center;" | '''Read only'''
|-
| [[PixelDisplay.width]] || number of columns in the the pixel buffer || number
|-
| [[PixelDisplay.height]] || number of rows in the the pixel buffer || number
|-
| [[PixelDisplay.pixel]] ''x '', ''y'' || get the color of a particular pixel || string (color)
|-
| [[PixelDisplay.getImage]](''left'', ''bottom'', ''width'', ''height'') || get a portion of the pixel buffer as an [[Image]] || [[Image]]
|-
|-|
| colspan=3 style="text-align: center;" | '''Edit and read'''
|-
|-
| [[PixelDisplay.color]] || get or set the default drawing color, used when color is not otherwise specified || string (color)
|-
| [[PixelDisplay.scale]] || scaling factor used to magnify (or shrink) the pixel display on screen || number
|-
| [[PixelDisplay.scrollX]] || get or set a horizontal shift applied to the entire display || number
|-
| [[PixelDisplay.scrollY]] || get or set a vertical shift applied to the entire display || number
|-
|-|
| colspan=3 style="text-align: center;"| '''Run'''
|-
|-
| [[PixelDisplay.clear]] ''[color]'', ''[width]'', ''[height]'' || clear/reset the pixel buffer width: number; height: number
|-
| [[PixelDisplay.setPixel]] ''x'', ''y'', ''[color]'' || set the color of a particular pixel
|-
| [[PixelDisplay.line]] ''x1'', ''y1'', ''x2'', ''y2'', ''[color]'', ''[penSize]'' || draw a line
|-
| [[PixelDisplay.drawRect]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'', ''[penSize]'' || draw a filled rectangle
|-
| [[PixelDisplay.fillRect]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled rectangle
|-
| [[PixelDisplay.drawEllipse]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'', ''[penSize]'' || draw an ellipse outline
|-
| [[PixelDisplay.fillEllipse]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled ellipse
|-
| [[PixelDisplay.drawPoly]] ''points'', ''[color]'', ''[penSize]'' || draw a polygon outline
|-
| [[PixelDisplay.fillPoly]] ''points'', ''[color]'' || draw a filled polygon
|-
| [[PixelDisplay.drawImage]] ''img'', ''left'', ''bottom'', ''[width]'', ''[height]'', ''[srcLeft]'', ''[srcBottom]'', ''[srcWidth]'', ''[srcHeight]'' || draw an [[Image]] (or portion thereof)
|-
| [[PixelDisplay.print]] ''str'', ''x'', ''y'', ''[color]'', ''[font]'' || draw a string
|}

== Implementation Note ==

For performance reasons, a PixelDisplay under the hood is made up of 256x256 pixel tiles. These are initialized to the color passed to [[PixelDisplay.clear]]. As a result, if your width or height is not an even multiple of 256, then this initial clear color will extend beyond the usable area. As an example, try:

<ms>gfx.clear color.red, 200,200
gfx.fillRect 0,0,gfx.width,gfx.height, color.blue</ms>

This displays a 200x200 blue square (the official size of the pixel display) with an additional red area extending 256x256 (one full tile) in size.

[[Category:Mini Micro]]

Sprite

2025-01-29T16:13:33Z

Duck Mim: /* Methods and properties used with Sprite objects */ Add feedback features

<c>Sprite</c> is a built-in class in the [[Mini Micro]] API. It represents an image which can be added to a [[SpriteDisplay]], enabling it to be drawn to the screen very efficiently while also being scaled, rotated, or tinted, and layered consistently with other sprites and the surrounding displays.

== Methods and properties used with Sprite objects ==

Use these methods on Sprite instances, created with <c>[[new]] Sprite</c>.

=== Edit and Read ===
{| class="wikitable"
|-
! Method or Property !! Purpose !! Type
|-
| [[Sprite.image]] || image displayed by the sprite || [[Image]]
|-
| [[Sprite.x]] || horizontal position of the sprite || Number
|-
| [[Sprite.y]] || vertical position of the sprite || Number
|-
| [[Sprite.scale]] || sprite scale (default 1.0) || Number
|-
| [[Sprite.rotation]] || sprite rotation (degrees counter-clockwise) || Number
|-
| [[Sprite.tint]] || tint color (defaults to white) || String (color)
|-
| [[Sprite.localBounds]] || stores the local bounds of the sprite || [[Bounds]]
|-
|}
=== Read only ===
{| class="wikitable"
|-
! Method or Property !! Purpose !! Type
|-
| [[Sprite.worldBounds]] || computes world bounds from local bounds and current position || Pare of numbers
|-
| [[Sprite.contains]](''x'', ''y'') || return whether the sprite contains the given world point || Bool
|-
| [[Sprite.overlaps]](''other'') || return whether this sprite is touching another sprite or [[Bounds]] || Bool
|-
| [[Sprite.corners]] || return <c>[x,y]</c> screen positions of the four corners of this sprite, counter-clockwise from bottom left || 4 pares of numbers
|-
|}
=== Run ===
{| class="wikitable"
|-
! Method or Property !! Purpose
|-
| [[Sprite.setCorners]] ''corners''|| set new screen positions for the four sprite corners (counter-clockwise from bottom left)
|-
|}

== Usage Notes (Soda) ==

In [[Soda]] there is currently only one, implicit, [[Display]]. So to add sprites to this display, push them onto a global list called <c>sprites</c>.

[[Soda]] does not currently support [[Sprite.corners]] or [[Sprite.setCorners]].

== Example ==

This example creates a sprite, loads it into display 4 (which by default is a [[SpriteDisplay]]), and rotates it through 360 degrees.

<ms>spr = new Sprite
spr.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push spr
spr.x = 480
spr.y = 320
for r in range(0,360)
spr.rotation = r
yield
end for</ms>

== See also ==

* [[How to move a sprite forward]]
* [[How to detect a click on a sprite]]
* [[How to move a sprite with directional inputs]]
* [[How to load a sprite from the web]]
* [[How to make a sprite translucent]]
* [[How to move a sprite towards a target]]
* [[How to point a sprite at a target]]

[[Category: Mini Micro]]
[[Category: Soda]]

PixelDisplay

2025-01-29T16:07:30Z

Duck Mim: /* Methods and Properties */ Add feedback features

The <c>PixelDisplay</c> class in [[Mini Micro]] is a display type that represents a rectangular pixel buffer, with methods to efficiently draw lines, shapes, images, and text.

By default, [[display]] 5 is configured as a pixel display, and is in fact the pixel display to which the [[gfx]] global refers (unless you change it). But you can make any display layer a pixel display by setting its [[Display.mode|mode]] to <c>displayMode.pixel</c>.

A PixelDisplay is 960 x 640 pixels by default (see [[screen coordinates]]), though this may be changed via the [[PixelDisplay.clear|clear]] method.

== Methods and Properties ==

=== Read only ===
{| class="wikitable"
|-
! Method or Property !! Purpose !! Type
|-
| [[PixelDisplay.width]] || number of columns in the the pixel buffer || Number
|-
| [[PixelDisplay.height]] || number of rows in the the pixel buffer || Number
|-
| [[PixelDisplay.pixel]] ''x '', ''y'' || get the color of a particular pixel || String (color)
|-
| [[PixelDisplay.getImage]](''left'', ''bottom'', ''width'', ''height'') || get a portion of the pixel buffer as an [[Image]] || [[Image]]
|-
|}

=== Edit and read ===
{| class="wikitable"
|-
! Method or Property !! Purpose !! Value
|-
| [[PixelDisplay.color]] || get or set the default drawing color, used when color is not otherwise specified || String (color)
|-
| [[PixelDisplay.scale]] || scaling factor used to magnify (or shrink) the pixel display on screen || Number
|-
| [[PixelDisplay.scrollX]] || get or set a horizontal shift applied to the entire display || Number
|-
| [[PixelDisplay.scrollY]] || get or set a vertical shift applied to the entire display || Number
|-
|}
=== Run ===
{| class="wikitable"
|-
! Method or Property !! Purpose
|-
| [[PixelDisplay.clear]] ''[color]'', ''[width]'', ''[height]'' || clear/reset the pixel buffer
width: number; height: number
|-
| [[PixelDisplay.setPixel]] ''x'', ''y'', ''[color]'' || set the color of a particular pixel
|-
| [[PixelDisplay.line]] ''x1'', ''y1'', ''x2'', ''y2'', ''[color]'', ''[penSize]'' || draw a line
|-
| [[PixelDisplay.drawRect]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'', ''[penSize]'' || draw a filled rectangle
|-
| [[PixelDisplay.fillRect]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled rectangle
|-
| [[PixelDisplay.drawEllipse]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'', ''[penSize]'' || draw an ellipse outline
|-
| [[PixelDisplay.fillEllipse]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled ellipse
|-
| [[PixelDisplay.drawPoly]] ''points'', ''[color]'', ''[penSize]'' || draw a polygon outline
|-
| [[PixelDisplay.fillPoly]] ''points'', ''[color]'' || draw a filled polygon
|-
| [[PixelDisplay.drawImage]] ''img'', ''left'', ''bottom'', ''[width]'', ''[height]'', ''[srcLeft]'', ''[srcBottom]'', ''[srcWidth]'', ''[srcHeight]'' || draw an [[Image]] (or portion thereof)
|-
| [[PixelDisplay.print]] ''str'', ''x'', ''y'', ''[color]'', ''[font]'' || draw a string
|}

== Implementation Note ==

For performance reasons, a PixelDisplay under the hood is made up of 256x256 pixel tiles. These are initialized to the color passed to [[PixelDisplay.clear]]. As a result, if your width or height is not an even multiple of 256, then this initial clear color will extend beyond the usable area. As an example, try:

<ms>gfx.clear color.red, 200,200
gfx.fillRect 0,0,gfx.width,gfx.height, color.blue</ms>

This displays a 200x200 blue square (the official size of the pixel display) with an additional red area extending 256x256 (one full tile) in size.

[[Category:Mini Micro]]

Sprite

2025-01-29T11:26:22Z

Duck Mim: /* Methods and properties used with Sprite objects */

<c>Sprite</c> is a built-in class in the [[Mini Micro]] API. It represents an image which can be added to a [[SpriteDisplay]], enabling it to be drawn to the screen very efficiently while also being scaled, rotated, or tinted, and layered consistently with other sprites and the surrounding displays.

== Methods and properties used with Sprite objects ==

Use these methods on Sprite instances, created with <c>[[new]] Sprite</c>.

=== Edit and Read ===
{| class="wikitable"
|-
! Method or Property !! Purpose !! Value
|-
| [[Sprite.image]] || image displayed by the sprite || Input: image
Output: image
|-
| [[Sprite.x]] || horizontal position of the sprite || Input: number
Output: number
|-
| [[Sprite.y]] || vertical position of the sprite || Input: number
Output: number
|-
| [[Sprite.scale]] || sprite scale (default 1.0) || Input: number
Output: number

|-
| [[Sprite.rotation]] || sprite rotation (degrees counter-clockwise) || Input: number
Output: number
|-
| [[Sprite.tint]] || tint color (defaults to white) || Input: color
Output: color
|-
| [[Sprite.localBounds]] || stores the local bounds of the sprite || Input: [[Bounds]]
Output: [[Bounds]]
|-
|}
=== Read only ===
{| class="wikitable"
|-
! Method or Property !! Purpose !! Value
|-
| [[Sprite.worldBounds]] || computes world bounds from local bounds and current position || Input: NULL
Output: pare of numbers
|-
| [[Sprite.contains]](''x'', ''y'') || return whether the sprite contains the given world point || Input: x: number; y: number
Output: true/false
|-
| [[Sprite.overlaps]](''other'') || return whether this sprite is touching another sprite or [[Bounds]] || Input: [[Sprite]]
Output: true/false
|-
| [[Sprite.corners]] || return <c>[x,y]</c> screen positions of the four corners of this sprite, counter-clockwise from bottom left || Input: NULL
Output: 4 pares of numbers
|-
|}
=== Run ===
{| class="wikitable"
|-
! Method or Property !! Purpose !! Value
|-
| [[Sprite.setCorners]] ''corners''|| set new screen positions for the four sprite corners (counter-clockwise from bottom left) || Input: 4 pares of numbers
|-
|}

== Usage Notes (Soda) ==

In [[Soda]] there is currently only one, implicit, [[Display]]. So to add sprites to this display, push them onto a global list called <c>sprites</c>.

[[Soda]] does not currently support [[Sprite.corners]] or [[Sprite.setCorners]].

== Example ==

This example creates a sprite, loads it into display 4 (which by default is a [[SpriteDisplay]]), and rotates it through 360 degrees.

<ms>spr = new Sprite
spr.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push spr
spr.x = 480
spr.y = 320
for r in range(0,360)
spr.rotation = r
yield
end for</ms>

== See also ==

* [[How to move a sprite forward]]
* [[How to detect a click on a sprite]]
* [[How to move a sprite with directional inputs]]
* [[How to load a sprite from the web]]
* [[How to make a sprite translucent]]
* [[How to move a sprite towards a target]]
* [[How to point a sprite at a target]]

[[Category: Mini Micro]]
[[Category: Soda]]

PixelDisplay

2025-01-29T10:06:11Z

Duck Mim: /* Methods and Properties */ added value column and divided into 3 categories

The <c>PixelDisplay</c> class in [[Mini Micro]] is a display type that represents a rectangular pixel buffer, with methods to efficiently draw lines, shapes, images, and text.

By default, [[display]] 5 is configured as a pixel display, and is in fact the pixel display to which the [[gfx]] global refers (unless you change it). But you can make any display layer a pixel display by setting its [[Display.mode|mode]] to <c>displayMode.pixel</c>.

A PixelDisplay is 960 x 640 pixels by default (see [[screen coordinates]]), though this may be changed via the [[PixelDisplay.clear|clear]] method.

== Methods and Properties ==

=== Read only ===
{| class="wikitable"
|-
! Method or Property !! Purpose !! Value
|-
| [[PixelDisplay.width]] || number of columns in the the pixel buffer || Input: NULL
Output: number
|-
| [[PixelDisplay.height]] || number of rows in the the pixel buffer || Input: NULL
Output: number
|-
| [[PixelDisplay.pixel]] ''x '', ''y'' || get the color of a particular pixel || Input: x: number; y: number
Output: color
|-
| [[PixelDisplay.getImage]](''left'', ''bottom'', ''width'', ''height'') || get a portion of the pixel buffer as an [[Image]] || Input: left: number; bottom: number; width: number; height: number
Output: image
|-
|}

=== Edit and read ===
{| class="wikitable"
|-
! Method or Property !! Purpose !! Value
|-
| [[PixelDisplay.color]] || get or set the default drawing color, used when color is not otherwise specified || Input: color
Output: color
|-
| [[PixelDisplay.scale]] || scaling factor used to magnify (or shrink) the pixel display on screen || Input: number
Output: number
|-
| [[PixelDisplay.scrollX]] || get or set a horizontal shift applied to the entire display || Input: number
Output: number
|-
| [[PixelDisplay.scrollY]] || get or set a vertical shift applied to the entire display || Input: number
Output: number
|-
|}
=== Run ===
{| class="wikitable"
|-
! Method or Property !! Purpose !! Value
|-
| [[PixelDisplay.clear]] ''[color]'', ''[width]'', ''[height]'' || clear/reset the pixel buffer || Input: color: color
width: number; height: number
|-
| [[PixelDisplay.setPixel]] ''x'', ''y'', ''[color]'' || set the color of a particular pixel || Input: x: number; y: number; color: color
|-
| [[PixelDisplay.line]] ''x1'', ''y1'', ''x2'', ''y2'', ''[color]'', ''[penSize]'' || draw a line || Input: x1: number; y1: number; x2: number; x2: number; color: color; penSize: num
|-
| [[PixelDisplay.drawRect]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'', ''[penSize]'' || draw a rectangle outline || Input: left: number; bottom: number; width: number; height: number; color: color; penSize: num
|-
| [[PixelDisplay.fillRect]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled rectangle ||
Input: left: number; bottom: number; width: number; height: number; color: color
|-
| [[PixelDisplay.drawEllipse]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'', ''[penSize]'' || draw an ellipse outline || Input: left: number; bottom: number; width: number; height: number; color: color; penSize: num
|-
| [[PixelDisplay.fillEllipse]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled ellipse || Input: left: number; bottom: number; width: number; height: number; color: color
|-
| [[PixelDisplay.drawPoly]] ''points'', ''[color]'', ''[penSize]'' || draw a polygon outline || Input: points: list of pare of nums; color: color; penSize: num
|-
| [[PixelDisplay.fillPoly]] ''points'', ''[color]'' || draw a filled polygon || Input: points: list of pare of nums; color: color
|-
| [[PixelDisplay.drawImage]] ''img'', ''left'', ''bottom'', ''[width]'', ''[height]'', ''[srcLeft]'', ''[srcBottom]'', ''[srcWidth]'', ''[srcHeight]'' || draw an [[Image]] (or portion thereof) || Input: img: image; left: number; bottom: number; width: number; height: number; scrWidth: number; scrHeight
|-
| [[PixelDisplay.print]] ''str'', ''x'', ''y'', ''[color]'', ''[font]'' || draw a string || Input: str: string; x: number; y: number; color: color; font: font
|}

== Implementation Note ==

For performance reasons, a PixelDisplay under the hood is made up of 256x256 pixel tiles. These are initialized to the color passed to [[PixelDisplay.clear]]. As a result, if your width or height is not an even multiple of 256, then this initial clear color will extend beyond the usable area. As an example, try:

<ms>gfx.clear color.red, 200,200
gfx.fillRect 0,0,gfx.width,gfx.height, color.blue</ms>

This displays a 200x200 blue square (the official size of the pixel display) with an additional red area extending 256x256 (one full tile) in size.

[[Category:Mini Micro]]

PixelDisplay.clear

2025-01-28T19:01:56Z

Duck Mim: Add "Examples"

<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 || 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. If you wish to clear only the color without resetting scale and scroll, use something like:

<ms>gfx.fillRect 0, 0, gfx.width, gfx.height, myColor</ms>

=== Examples ===
<ms>clear

gfx.fillRect 10,10,700,600,"#aaaaaa" // Draw rect

wait 1

gfx.clear "#556677", 100, 100 // Clear window and set window size 100x100
gfx.fillRect 10,10,700,600,"#aaaaaa" // Draw same rect on resize window </ms>

[[Category:Mini Micro]]

Gfx

2025-01-28T11:56:25Z

Duck Mim: Fixed the bottom link

In [[Mini Micro]], <c>gfx</c> is a global reference to a [[PixelDisplay]]. It is assigned <c>[[display]](5)</c> by the <c>[[clear]]</c> command. Users may reassign it as desired.

Note that unlike <c>[[text]]</c>, <c>gfx</c> has no special significance to the Mini Micro runtime. It is provided only as a convenience to the user, and to facilitate sharing of small scripts that do pixel drawing.

[[Category:Mini Micro]]