Link to monitor events from the main monitor page

cc-tweaked · Nov 28, 2024 · fdb65c9 · fdb65c9
1 parent ea670cc
commit fdb65c9
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/doc/events/monitor_resize.md b/doc/events/monitor_resize.md
@@ -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.

diff --git a/doc/events/monitor_touch.md b/doc/events/monitor_touch.md
@@ -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.

diff --git a/...ommon/src/main/java/dan200/computercraft/shared/peripheral/monitor/MonitorPeripheral.java b/...ommon/src/main/java/dan200/computercraft/shared/peripheral/monitor/MonitorPeripheral.java
@@ -21,7 +21,11 @@
  * 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 @@
  * 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;