MiniScript Wiki - User contributions [en]

Qa.assert

2025-09-20T13:06:32Z

Shellrider:

You can use this function if you want to make sure that a specific fact is true at a certain point of your program. The function takes an condition and an optional description as parameters. This is often useful when writing tests or to check inputs to functions. In case the condition is not met this function uses [[qa.abort|abort(errMsg)]] to halt script execution and print a stack trace.

=== Example ===
<ms>
import "qa"

createPerson = function (age)
qa.assert age >= 0, "age can not be negative"
noob = {}
noob.age = age
return noob
end function
</ms>

Qa.assert

2025-09-20T13:06:00Z

Shellrider: Created page with "You can use this function if you want to make sure that a specific fact is true at a certain point of your program. The function takes an condition and an optional description..."

You can use this function if you want to make sure that a specific fact is true at a certain point of your program. The function takes an condition and an optional description as parameters. This is often useful when writing tests or to check inputs to functions. In case the condition is not met this function uses [[qa.abort|abort(errMsg)]] to halt script execution and print a stack trace.

=== Example ===
<ms>
import "qa"

createPerson = function (age)
qa.assert(age >= 0, "age can not be negative)
noob = {}
noob.age = age
return noob
end function
</ms>

Sprite

2025-07-04T09:36:52Z

Shellrider: Change pare to pair. Either it was a mistake before, or it was less accessible language. Pair is more easily understood.

<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 || pair 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 pairs 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]]
* [[How to use a sprite sheet]]

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

Color.lerp

2021-07-09T11:39:20Z

Shellrider: Initial write up of color.lerp

<c>color.lerp</c> is a method that implements linear interpolation between two colors. It is commonly used for changing colors over time or painting gradients.

== Parameters ==

The method has this signature: <c>color.lerp c1, c2, t</c>

{| class="wikitable"
|-
! Parameter !! Description
|-
| c1|| First color in hexcolor format
|-
| c2|| Second color in hexcolor format
|-
| t|| Variable for how far to interpolate between the two colors (t <= 0 retunrs c1, t >= 0 returns c2, 0 < t < 1 returns color inbetween)
|}

== Example ==

<ms>
color.lerp color.red, color.blue, 0
#FF0000FF
color.lerp color.red, color.blue, 1
#0000FFFF
color.lerp color.red, color.blue, 0.5
#7F007FFF
color.lerp color.red, color.blue, 0.25
#BF003FFF
</ms>

See also [[Color]]

[[Category:Mini Micro]]

TileDisplay.cellTint

2021-07-08T08:49:19Z

Shellrider: Initial write up of page.

<c>TileDisplay.cellTint</c> is a method to get the tint colour of a specific cell in the [[TileDisplay]].

== Example usage ==

<c>display(4).cellTint(1,1)</c> returns the tint colour of cell 1,1.

To set the tint colour of a cell use [[TileDisplay.setCellTint]]

See also: [[TileDisplay.tileSet]], [[TileDisplay]], [[TileDisplay.setCellTint]]

[[Category:Mini Micro]]

TileDisplay.cellSize

2021-07-08T08:37:14Z

Shellrider: Initial write up of page analogous to TileDisplay.tileSetTileSize

The <c>TileDisplay.cellSize</c> property defines the size (in pixels) of the tiles drawn to the screen by a [[TileDisplay]].

The value may be either:
* a simple [[number]], used as both the width and the height of square tiles; or
* a <c>[width, height]</c> list (i.e. a 2-element list of numbers), defining the tile width and height separately.

To set the size of the tiles in the source image, use [[TileDisplay.tileSetTileSize]]

See also: [[TileDisplay.tileSet]], [[TileDisplay.setCell]], [[TileDisplay.tileSetTileSize]]

[[Category:Mini Micro]]