AstralTransRocketries/OpenComputers
1
0
Fork 0
mirror of https://github.com/MightyPirates/OpenComputers.git synced 2025-08-03 19:17:27 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated Signals (markdown)

Florian Nücke 2013-12-13 00:15:59 -08:00
parent 919442afb2
commit 801fe5cfe1
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Signals.md

@ -33,14 +33,19 @@ Screen
------
- `screen_resize(screenAddress: string, newWidth: number, newHeight: number)`
This signal is queued by [[screens|Blocks#basic-screen]] when their resolution changes, for example because it is manually set via the [[GPU|Component/GPU]]. The address is the address of the screen the queued the signal.
- `click(screenAddress: string, x: number, y: number, playerName: string)`
- `touch(screenAddress: string, x: number, y: number, playerName: string)`
This signal is queued by screens of [[tier two|Blocks#advanced-screen]] and [[tier three|Blocks#superior-screen]] when they are clicked. This includes left clicks in the GUI (i.e. when a keyboard is attached) or when right-clicking/activating them in the world directly (i.e. when no keyboard is attached). The address is the address of the screen the queued the signal. The x and y coordinates are in "letters" (meaning they map directly to `term.setCursor` or `gpu.set`, for example). The player name is the user name of the player that triggered the event.
Note on the player name: I'll probably add an option to disable this argument in the future, for those who think it's too... unrealistic. It's just quite handy for multi-user programs, so I left it in for now.
**Important**: this signal is *checked*, i.e. it is only queued on a computer if the player that caused it is [[registered as a user|ComputerUsers]] on the computer (or there are no users registered on the computer).
- `drag(screenAddress: string, x: number, y: number, playerName: string)`
This signal is almost equivalent to the `touch` signal. The only difference is the implicit meaning: when this signal is fired, it "belongs" to a `touch` signal that was fired earlier. This can only be triggered by dragging int the GUI.
- `scroll(screenAddress: string, x: number, y: number, direction: number, playerName: string)`
This signal is queued by screens of [[tier two|Blocks#advanced-screen]] and [[tier three|Blocks#superior-screen]] when the player uses the mouse wheel in the GUI. The x and y coordinates are the cursor location when the scroll occurred and are, like the `touch` signal, in "letters". The `direction` indicates which way to scroll, where a positive value usually means "up", whereas a negative value means "down". Note that this may differ based on the client's operating system and/or driver configuration. The player name is the user name of the player that triggered the event.
The same considerations apply to the player name parameter as in `touch`.
- `walk(screenAddress: string, x: number, y: number[, playerName: string])`
This signal is queued by screens of [[tier two|Blocks#advanced-screen]] and [[tier three|Blocks#superior-screen]] when a player or other entity walks on them. The address is the address of the screen the queued the signal. The x and y coordinates are *the coordinates of the sub-block* of the multi-block screen that queued the event. Use `[[gpu.getSize()|Component/GPU]]` to figure out which area of the display that actually represents.
Unlike clicks, this can be triggered for regions of the screen where nothing is displayed based on the current resolution, so keep that in mind.
The same considerations apply to the player name parameter as in `click`.
The same considerations apply to the player name parameter as in `touch`.
Keyboard
--------