shado

• Index

Contents

• Functions

Modules

• shado
• lib.blocks
• lib.frames
• lib.manager
• lib.masks
• lib.renderers
• lib.types

Examples

• 8x8.lua
• counter.lua
• nugget.lua
• pyramids.lua
• square.lua

Module lib.frames

Frames: stacks of shado objects (including sub-frames).

Functions

it transparent).

<code>(x, y)</code>.

Functions

Frame:new ()

Create a new, empty frame.

Frame:add (item, x, y)

Add an item to a frame, at the top. Calls can be cascaded, thus:

frame:add(item1, x1, y1):add(item2, x2, y2)

Note: an item should not be added to a frame more than once. If
you want to do that, put the item into its own frame each time add
that to the main frame. (At some point we will test for duplicate
addition and throw an error.)

Parameters:

• item the shado object to add
• x the horizontal location, 1 being the origin
• y the vertical location, 1 being the origin

Returns:

the frame

Frame:remove (item)

Remove a shado object from the frame.

Raises an error if the item isn't present.
*TODO* Calls to <a href="../modules/lib.frames.html#Frame:remove">remove</a> should chain.

Parameters:

• item the shado object to remove

Frame:top (item)

Bring a shado object to the top of a frame.

Raises an error if the item isn't present.
*TODO* Calls to <a href="../modules/lib.frames.html#Frame:top">top</a> should chain.

Parameters:

• item the shado object to raise

Frame:bottom (item)

Drop a shado object to the bottom of a frame.

Raises an error if the item isn't present.
*TODO* Calls to <a href="../modules/lib.frames.html#Frame:bottom">bottom</a> should chain.

Parameters:

• item the shado object to lower

Frame:hide (item)

Hide a shado object in a frame (effectively, make

it transparent).  This does not affect its response
to button presses.

Parameters:

• item the object to hide

Frame:show (item)

Show a shado object in a frame. This does

not affect its response to button presses.

Parameters:

• item the object to show

Frame:moveTo (item, x, y)

Move an object in a frame to a new location.

Origin is <code>(1, 1).</code>
Returns the frame, for chaining.

Parameters:

• item the object to move
• x the new X location
• y the new Y location

Returns:

the frame

Frame:get (i)

Retrieve an object from a frame. The topmost

object is at index <code>1</code>. Throws an error if
the index is less than <code>1</code> or greater than the
number of objects present.

Parameters:

• i the index of the desired object

Returns:

the object

Frame:getLamp (x, y)

Get the computed "lamp" value for a frame at location

<code>(x, y)</code>.  If the frame is empty, or the coordinates <code>(x, y)</code> are
outside any objects in the frame, the result will be
<code>types.LampState.THRU</code>.

Parameters:

• x the X location to examine
• y the Y location to examine

Returns:

the lamp value

See also:

Frame:press (x, y, how)

The default handler for button press events. It returns

<code>false</code>, which will cause press events to be passed into
the frame's component objects. Override to handle buttons
in the frame itself, rather than its components.

Parameters:

• x the X location of the press
• y the Y location of the press
• how the kind of button event: 1 for press, 0 for release.

Returns:

false

Frame:routePress00 (x, y)

Internal function for routing press-on events. Returns a RouteResult

object so that the corresponding press-off can be handled properly.

If the frame itself does not handle the press, then the constituent
objects are interrogated from top to bottom, until one does handle
it (by returning a result from its <a href="../modules/lib.frames.html#Frame:routePress00">routePress00</a> method). If there is
no result, then the frame as a whole has not handled the press, so
return <code>nil</code>.

Parameters:

• x TODO
• y if we care: what if stack content changes as a result of press() calls? (We should dup.)