MiniScript Wiki - User contributions [en]

If

2025-02-17T15:37:38Z

Turtlezero: added link to orphaned "end if" page

<c>if</c> is the [[:Category:Keywords|keyword]] that begins an ''if block''. Use an <c>if…then</c> statement to specify some condition under which the following statements should be executed. Use "[[end if]]" to end the if-block. The basic syntax is:

:'''if''' ''condition'' '''then'''
:…
:'''end if'''

When the condition is not true, MiniScript will jump directly to the <c>end if</c> statement.

<ms>if x == 42 then
print "I have found the Ultimate Answer!"
end if</ms>

The whole set of lines, from <c>if…then</c> to <c>end if</c>, is known as an ''if block''.
Sometimes you want to do something else when the specified condition is not true. You can
specify this with an ''else block'' before the <c>end if</c>.

<ms>if x == 42 then
print "I have found the Ultimate Answer!"
else
print "I am still searching."
end if</ms>

Finally, you can check for additional conditions by adding ''else-if blocks'' as needed. Here's a
slightly more practical example that converts a number to words.

<ms>if apples == 0 then
print "You have no apples."
else if apples == 1 then
print "You have one apple."
else if apples > 10 then
print "You have a lot of apples!"
else
print "You have " + apples + " apples."
end if</ms>

In this case, the first condition that matches will execute its block of lines. If none of the
conditions match, then the <c>else</c> block will run instead.

Note that for all these forms, the <c>if</c>, <c>else if</c>, <c>else</c>, and <c>end if</c> statements must each be
on its own line. However, there is also a "short form" <c>if</c> statement that allows you to write
an <c>if</c> or <c>if/else</c> on a single line, provided you have only a single statement for the then
block, and a single statement for the <c>else</c> block (if you have an <c>else</c> block at all). A shortform
if looks like this:

<ms>if x == null then x = 1</ms>

…while a short-form if/else looks like this:

<ms>if x >= 0 then print "positive" else print "negative"</ms>

Notice that <c>end if</c> is not used with a short-form <c>if</c> or <c>if/else</c>. Moreover, there is no
way to put more than one statement into the <c>then</c> or <c>else</c> block. If you need more than
one statement, then use the standard multi-line form.

[[Category:Language]]
[[Category:Keywords]]

Import

2025-02-17T15:32:37Z

Turtlezero: Fixed Further Reading placement

<c>import</c> is a function in [[Mini Micro]], [[Farmtronics]], [[command-line MiniScript]], and [[Soda]] that loads a MiniScript file from the current
directory, '''/sys/lib''', '''/usr/lib''', or some path defined in
[[env]].importPaths. <c>import</c> looks for a file with the module name plus ".ms".
Any values defined by that code then become available in a map of the same name.

== Usage Notes ==

<c>import</c> imports the named module into the current local variable space. Simple (and typical) usage is to do this at the top of your main program, where [[locals]] and [[globals]] are the same thing, which makes the imported module globally available.

However, if you have a large, complex project composed of many interdependent modules, '''and''' you want those various modules to be testable on their own, then those modules are likely to be importing other modules, in what can rapidly become a tangle of imports that leads to several problems:

# A recursive cycle of imports (e.g. A imports B which imports A) can result in an infinite loop.
# Importing a large module several times wastes time and makes your program take longer to load than necessary.
# If the module has any internal state, then you now have multiple separate copies of that internal state, which can lead to hard-to-find bugs.

The solution to all these problems is to make a function like the following:

<ms>// ensureImport: check whether the given module has been imported already
// (or is in the process of being imported). If so, return immediately.
// If not, then import that module into the global namespace.
globals.ensureImport = function(moduleName)
if globals.hasIndex(moduleName) then return
globals[moduleName] = "PENDING" // (module is being imported now)
import moduleName
globals[moduleName] = locals[moduleName]
end function</ms>

Put this in some tiny, stand-alone script that can be safely imported from anywhere. Import this with <c>import</c>, but then load all other modules with the <c>ensureImport</c> function it provides. For example, if the above function is in a script called "coreUtils":

<ms>import "coreUtils"
ensureImport "someModule"
ensureImport "someOtherOne"</ms>

This will ensure that no matter how your various files depend on each other, each one is only loaded once.

'''Note:''' This <c>ensureImport</c> function is available in the /sys/lib/importUtil standard library in Mini Micro.

== Alternate Return Value ==

Normally, all the file-scope variables (what would be <c>[[globals]]</c> if the module were loaded and run by itself) are gathered into the map referenced by the name of the module itself. However, it is possible to change this by executing a <c>[[return]]</c> statement inside the module. In this case, the name of the module will refer to whatever value you return. See [https://luminaryapps.com/blog/advanced-import/index.html this blog post] for more detail.

== Examples ==
The following example loads a script called "mathUtil.ms" (normally found in '''/sys/lib'''), and makes it available as a map called <c>mathUtil</c>.

<ms>import "mathUtil"
print mathUtil.radToDeg(2*pi) // prints 360</ms>

Some modules, like [[listUtil]], [[stringUtil]], and [[mapUtil]], extend these
built-in types with new methods. For example, the built-in [[list]]
type does not have a .reverse method, but it does once you import
"listUtil":

<ms>import "listUtil"
print [1,2,3].reverse // prints [3, 2, 1]</ms>

== Further Reading ==

* [https://luminaryapps.com/blog/advanced-import/index.html Advanced Tricks with Import] (blog post)

== See Also ==

{| class="wikitable"
|-
! Module name !! Contents
|-
| [[bmfFonts]] || BMF (bitmapped font) utilities
|-
| [[json]] || JSON utilities
|-
| [[qa]] || Quality assurance (unit testing) utilities
|-
| [[listUtil]] || List utilities
|-
| [[mapUtil]] || Map (aka dictionary, hash table) utilities
|-
| [[mathUtil]] || Math utilities
|-
| [[stringUtil]] || String utilities
|-}

[[Category:Modules]]
[[Category:Mini Micro]]
[[Category:Farmtronics]]

Import

2025-02-17T15:28:24Z

Turtlezero: /* Examples */ Added See Also section linking to the modules mentioned in the text, inclding MathUtil (orphaned) and qa (missing)

<c>import</c> is a function in [[Mini Micro]], [[Farmtronics]], [[command-line MiniScript]], and [[Soda]] that loads a MiniScript file from the current
directory, '''/sys/lib''', '''/usr/lib''', or some path defined in
[[env]].importPaths. <c>import</c> looks for a file with the module name plus ".ms".
Any values defined by that code then become available in a map of the same name.

== Usage Notes ==

<c>import</c> imports the named module into the current local variable space. Simple (and typical) usage is to do this at the top of your main program, where [[locals]] and [[globals]] are the same thing, which makes the imported module globally available.

However, if you have a large, complex project composed of many interdependent modules, '''and''' you want those various modules to be testable on their own, then those modules are likely to be importing other modules, in what can rapidly become a tangle of imports that leads to several problems:

# A recursive cycle of imports (e.g. A imports B which imports A) can result in an infinite loop.
# Importing a large module several times wastes time and makes your program take longer to load than necessary.
# If the module has any internal state, then you now have multiple separate copies of that internal state, which can lead to hard-to-find bugs.

The solution to all these problems is to make a function like the following:

<ms>// ensureImport: check whether the given module has been imported already
// (or is in the process of being imported). If so, return immediately.
// If not, then import that module into the global namespace.
globals.ensureImport = function(moduleName)
if globals.hasIndex(moduleName) then return
globals[moduleName] = "PENDING" // (module is being imported now)
import moduleName
globals[moduleName] = locals[moduleName]
end function</ms>

Put this in some tiny, stand-alone script that can be safely imported from anywhere. Import this with <c>import</c>, but then load all other modules with the <c>ensureImport</c> function it provides. For example, if the above function is in a script called "coreUtils":

<ms>import "coreUtils"
ensureImport "someModule"
ensureImport "someOtherOne"</ms>

This will ensure that no matter how your various files depend on each other, each one is only loaded once.

'''Note:''' This <c>ensureImport</c> function is available in the /sys/lib/importUtil standard library in Mini Micro.

== Alternate Return Value ==

Normally, all the file-scope variables (what would be <c>[[globals]]</c> if the module were loaded and run by itself) are gathered into the map referenced by the name of the module itself. However, it is possible to change this by executing a <c>[[return]]</c> statement inside the module. In this case, the name of the module will refer to whatever value you return. See [https://luminaryapps.com/blog/advanced-import/index.html this blog post] for more detail.

== Examples ==
The following example loads a script called "mathUtil.ms" (normally found in '''/sys/lib'''), and makes it available as a map called <c>mathUtil</c>.

<ms>import "mathUtil"
print mathUtil.radToDeg(2*pi) // prints 360</ms>

Some modules, like [[listUtil]], [[stringUtil]], and [[mapUtil]], extend these
built-in types with new methods. For example, the built-in [[list]]
type does not have a .reverse method, but it does once you import
"listUtil":

<ms>import "listUtil"
print [1,2,3].reverse // prints [3, 2, 1]</ms>

== See Also ==
{| class="wikitable"
|-
! Module name !! Contents
|-
| [[bmfFonts]] || BMF (bitmapped font) utilities
|-
| [[json]] || JSON utilities
|-
| [[qa]] || Quality assurance (unit testing) utilities
|-
| [[listUtil]] || List utilities
|-
| [[mapUtil || Map (aka dictionary, hash table) utilities
|-
| [[mathUtil || Math utilities
|-
| [[stringUtil]] || String utilities
|-}

[[Category:Modules]]
[[Category:Mini Micro]]
[[Category:Farmtronics]]

== Further Reading ==

* [https://luminaryapps.com/blog/advanced-import/index.html Advanced Tricks with Import] (blog post)

Sprite

2025-02-17T14:44:13Z

Turtlezero: /* See also */ Added a link to orphaned "sprite sheet" page.

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

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