Module wonderful.std.event.signal

Some common signals.

Classes and inheritance

Signal The base signal class.
ComponentAdded The "component_added" signal.
ComponentRemoved The "component_removed" signal.
ComponentAvailable The "component_available" signal.
ComponentUnavailable The "component_unavailable" signal.
Touch The "touch" signal.
Drag The "drag" signal.
Drop The "drop" signal.
Scroll The "scroll" signal.
KeyDown The "key_down" signal.
KeyUp The "key_up" signal.
Clipboard The "clipboard" signal.

Tables

SCREEN_SIGNALS The screen signals.
KEYBOARD_SIGNALS The keyboard signals.

Fields

Interrupt The "interrupted" signal.

Class ComponentAdded

ComponentAdded:__new__(address, componentType) Construct a new instance.

Class ComponentRemoved

ComponentRemoved:__new__(address, componentType) Construct a new instance.

Class ComponentAvailable

ComponentAvailable:__new__(componentType) Construct a new instance.

Class ComponentUnavailable

ComponentUnavailable:__new__(componentType) Construct a new instance.

Class Touch

Touch:__new__(screen, x, y, button, playerName) Construct a new instance.

Class Drag

Drag:__new__(screen, x, y, button, playerName) Construct a new instance.

Class Drop

Drop:__new__(screen, x, y, button, playerName) Construct a new instance.

Class Scroll

Scroll:__new__(screen, x, y, direction, playerName) Construct a new instance.

Class KeyDown

KeyDown:__new__(keyboard, char, code, playerName) Construct a new instance.

Class KeyUp

KeyUp:__new__(keyboard, char, code, playerName) Construct a new instance.

Class Clipboard

Clipboard:__new__(keyboard, value, playerName) Construct a new instance.


Classes and inheritance

Signal
The base signal class.

Parent classes:

ComponentAdded
The "component_added" signal.

Parent classes:

ComponentRemoved
The "component_removed" signal.

Parent classes:

ComponentAvailable
The "component_available" signal.

Parent classes:

ComponentUnavailable
The "component_unavailable" signal.

Parent classes:

Touch
The "touch" signal.

Parent classes:

Drag
The "drag" signal.

Parent classes:

Drop
The "drop" signal.

Parent classes:

Scroll
The "scroll" signal.

Parent classes:

KeyDown
The "key_down" signal.

Parent classes:

KeyUp
The "key_up" signal.

Parent classes:

Clipboard
The "clipboard" signal.

Parent classes:

Tables

SCREEN_SIGNALS
The screen signals. They are only sent to documents that are displayed on the screen that issued them. Additionally, Wonderful:hit is used to dispatch them.

Fields:

  • [touch]
  • [drag]
  • [drop]
  • [scroll]
KEYBOARD_SIGNALS
The keyboard signals. They are only sent to document that listen on the keyboard that issues them.

Fields:

  • [key_down]
  • [key_up]
  • [clipboard]

Fields

Interrupt
The "interrupted" signal.

Class ComponentAdded

ComponentAdded:__new__(address, componentType)
Construct a new instance.

Parameters:

  • address string a component address
  • componentType string a component type

Class ComponentRemoved

ComponentRemoved:__new__(address, componentType)
Construct a new instance.

Parameters:

  • address string a component address
  • componentType string a component type

Class ComponentAvailable

ComponentAvailable:__new__(componentType)
Construct a new instance.

Parameters:

  • componentType string a component type

Class ComponentUnavailable

ComponentUnavailable:__new__(componentType)
Construct a new instance.

Parameters:

  • componentType string a component type

Class Touch

Touch:__new__(screen, x, y, button, playerName)
Construct a new instance.

Parameters:

  • screen string a screen address
  • x number a column number
  • y number a row number
  • button int a button number
  • playerName optional string a player name

Class Drag

Drag:__new__(screen, x, y, button, playerName)
Construct a new instance.

Parameters:

  • screen string a screen address
  • x number a column number
  • y number a row number
  • button int a button number
  • playerName optional string a player name

Class Drop

Drop:__new__(screen, x, y, button, playerName)
Construct a new instance.

Parameters:

  • screen string a screen address
  • x number a column number
  • y number a row number
  • button int a button number
  • playerName optional string a player name

Class Scroll

Scroll:__new__(screen, x, y, direction, playerName)
Construct a new instance.

Parameters:

  • screen string a screen address
  • x number a column number
  • y number a row number
  • direction int a direction of scrolling
  • playerName optional string a player name

Class KeyDown

KeyDown:__new__(keyboard, char, code, playerName)
Construct a new instance.

Parameters:

  • keyboard string a keyboard address
  • char int a character Unicode codepoint
  • code int a key code
  • playerName optional string a player name

Class KeyUp

KeyUp:__new__(keyboard, char, code, playerName)
Construct a new instance.

Parameters:

  • keyboard string a keyboard address
  • char int a character Unicode codepoint
  • code int a key code
  • playerName optional string a player name

Class Clipboard

Clipboard:__new__(keyboard, value, playerName)
Construct a new instance.

Parameters:

  • keyboard string a keyboard address
  • value string an inserted string
  • playerName string a player name
generated by LDoc 1.4.6 Last updated 2019-07-27 21:32:05