GraphicEntity

While not a literal class in Lua, GraphicEntity is a variant referring to any of the types listed on this page. These types serve to describe the possible special entities that may be attached to the grid.

Blackout

A simple black-to-transparent gradient placed somewhere on the grid.

Constructors

Blackout.new(Rectangle region) Blackout.new(Rectangle region, Movement fade) Rectangle region Blackout.new(Direction fade)
Returns a description of a blackout which covers the given region and, if specified, where the gradient fades towards the given direction or which is a solid black region if no fade is specified or if the fade is specified as NEUTRAL.

Members

Rectangle region
The region covered by the blackout.

Movement fade
The direction in which the blackout fades towards transparency or NEUTRAL if the blackout is solid.

Movement type (read-only)
Always equal to "Blackout"

Background

An opaque background. Used mainly behind mirrors for inputs and outputs.

Constructors

Background.new(Rectangle region)
Returns a description of a background for the specified region.

Members

Rectangle region
The region covered by the background.

Movement type (read-only)
Always equal to "Background"

Mirror

A transposed image of another region of the grid, glowing in partial transparency.

Constructors

Mirror.new(Rectangle source, Rectangle target)
Returns a description of a mirror which displays the contents of the rectangle source transposed to the rectangle target. Note that only target.lesser affects the result; no scaling takes place and the size of the target rectangle is ignored.

Members

Rectangle source
The region which is reflected by the mirror.

Rectangle target
The region in which the mirror displays its contents.

Movement type (read-only)
Always equal to "Mirror"