1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-01-23 07:26:58 +00:00

Link to monitor events from the main monitor page

This commit is contained in:
Jonathan Coates 2024-11-28 10:31:36 +00:00
parent ea670cc358
commit fdb65c9368
No known key found for this signature in database
GPG Key ID: B9E431FF07C98D06
3 changed files with 10 additions and 3 deletions

View File

@ -8,7 +8,7 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
SPDX-License-Identifier: MPL-2.0
-->
The [`monitor_resize`] event is fired when an adjacent or networked monitor's size is changed.
The [`monitor_resize`] event is fired when an adjacent or networked [monitor's][`monitor`] size is changed.
## Return Values
1. [`string`]: The event name.

View File

@ -8,7 +8,7 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
SPDX-License-Identifier: MPL-2.0
-->
The [`monitor_touch`] event is fired when an adjacent or networked Advanced Monitor is right-clicked.
The [`monitor_touch`] event is fired when an adjacent or networked [Advanced Monitor][`monitor`] is right-clicked.
## Return Values
1. [`string`]: The event name.

View File

@ -21,7 +21,11 @@ import javax.annotation.Nullable;
* Monitors act as [terminal redirects][`term.Redirect`] and so expose the same methods, as well as several additional
* ones, which are documented below.
* <p>
* Like computers, monitors come in both normal (no colour) and advanced (colour) varieties.
* If the monitor is resized (by adding new blocks to the monitor, or by calling {@link setTextScale}), then a
* [`monitor_resize`] event will be queued.
* <p>
* Like computers, monitors come in both normal (no colour) and advanced (colour) varieties. Advanced monitors be right
* clicked, which will trigger a [`monitor_touch`] event.
* <p>
* ## Recipes
* <div class="recipe-container">
@ -37,6 +41,9 @@ import javax.annotation.Nullable;
* monitor.setCursorPos(1, 1)
* monitor.write("Hello, world!")
* }</pre>
*
* @cc.see monitor_resize Queued when a monitor is resized.
* @cc.see monitor_touch Queued when an advanced monitor is clicked.
*/
public class MonitorPeripheral extends TermMethods implements IPeripheral {
private final MonitorBlockEntity monitor;