love module reference

love module reference

LÖVE graphics.

This module implements basic graphics using the love2d game engine.

running

In order to use this module, the copilot has to be started in a specific way:

$ love bin/alv-love <session.alv>

usage

The love/draw ops can be used to draw one or more love/shapes in a fixed stacking order. love/shapes can be created using love/rectangle etc, and positioned and styled using the modifier ops like love/translate, love/color and so on. All modifier ops take the shape as the last input and output a modified shape, and can be used comfortably with the thread-last macro ->>:

(import* love math)
(draw (->>
  (rectangle 'fill' 100 100)
  (color 1 0 0)
  (rotate (/ pi 4))
  (translate 150 150)))

index

• circle (opdef):  – create a circle shape.
• color (opdef):  – set color of a shape.
• draw (opdef):  – draw one or more love/shape shapes.
• ellipse (opdef):  – create a ellipse shape.
• font (opdef):  – create a font.
• key-down? (opdef):  – checks whether a key is down.
• key-presses (opdef):  – outputs key press events.
• key-releases (opdef):  – outputs key release events.
• line-width (opdef):  – set line-width of a shape.
• mouse-delta (opdef):  – outputs mouse move events.
• mouse-down? (opdef):  – checks whether a mouse button is down.
• mouse-pos (opdef):  – outputs current mouse position.
• mouse-presses (opdef):  – outputs mouse press events.
• mouse-releases (opdef):  – outputs mouse release events.
• no-shape (love/shape):  – invisible null shape.
• rectangle (opdef):  – create a rectangle shape.
• rotate (opdef):  – rotate a shape.
• scale (opdef):  – scale a shape.
• shear (opdef):  – shear a shape.
• text (opdef):  – create a text shape.
• translate (opdef):  – translate a shape.
• wheel-delta (opdef):  – outputs mouse wheel move events.

details

• circle (opdef):  – create a circle shape.

  (love/circle mode radius [segments])

• color (opdef):  – set color of a shape.

  (love/color color shape) (love/color r g b [a] shape)

• draw (opdef):  – draw one or more love/shape shapes.

  (love/draw shape1 …) (love/draw shapes)

• ellipse (opdef):  – create a ellipse shape.

  (love/ellipse mode size [segments]) (love/ellipse mode rx ry [segments])

• font (opdef):  – create a font.

  (love/font [filename] size)

• key-down? (opdef):  – checks whether a key is down.

  (love/key-down? key)

  checks whether key is down and returns a bool ~-stream.

  key should be a str~ stream.

• key-presses (opdef):  – outputs key press events.

  (love/key-presses) (love/key-presses key)

  With no arguments, outputs a str! stream of key names.

  If key is passed, outputs a bang! stream.

• key-releases (opdef):  – outputs key release events.

  (love/key-releases) (love/key-releases key)

  With no arguments, outputs a str! stream of key names.

  If key is passed, outputs a bang! stream.

• line-width (opdef):  – set line-width of a shape.

  (love/line-width width shape)

• mouse-delta (opdef):  – outputs mouse move events.

  (love/mouse-delta)

  vec2! stream of mouse movements.

• mouse-down? (opdef):  – checks whether a mouse button is down.

  (love/mouse-down? [button])

  checks whether button is down and returns a bool ~-stream.

  button should be a num~ stream and defaults to 1 (the left mouse button).

• mouse-pos (opdef):  – outputs current mouse position.

  (love/mouse-pos)

  vec2~ stream of mouse position.

• mouse-presses (opdef):  – outputs mouse press events.

  (love/mouse-presses) (love/mouse-presses button)

  With no arguments, outputs a !-stream of press events with the following keys:

  • pos (vec2): x/y position of mouse
  • button (num): mouse button number

  If button is passed, outputs a vec2! stream.

• mouse-releases (opdef):  – outputs mouse release events.

  (love/mouse-releases) (love/mouse-releases button)

  With no arguments, outputs a !-stream of release events with the following keys:

  • pos (vec2): x/y position of mouse
  • button (num): mouse button number

  If button is passed, outputs a vec2! stream.

• no-shape (love/shape):  – invisible null shape.
• rectangle (opdef):  – create a rectangle shape.

  (love/rectangle mode size) (love/rectangle mode w h)

• rotate (opdef):  – rotate a shape.

  (love/rotate angle shape)

• scale (opdef):  – scale a shape.

  (love/scale scale shape) (love/scale sx [sy] shape)

• shear (opdef):  – shear a shape.

  (love/shear x y shape)

• text (opdef):  – create a text shape.

  (love/text str [align] [font])

  Create a shape that draws the text str with font font (or the default font). align should be on of the following strings:

  • center (the default)
  • left
  • right
• translate (opdef):  – translate a shape.

  (love/translate [delta] shape) (love/translate x y shape)

• wheel-delta (opdef):  – outputs mouse wheel move events.

  (love/wheel-delta)

  vec2! stream of mouse wheel movements.