Documentation to Square Telegraph

This commit is contained in:
Kam committed 2026-03-09 17:50:46 -04:00
1 parent c7ef60136c
commit efce1a99b7
2 files changed
+10 -3

No files matched your search

+2 -2
View File
@@ -33,14 +33,14 @@ public interface ITelegraph {
/**
* Get the telegraph type.
*
* @return Type name: "CIRCLE", "RING", "LINE", "CONE", or "POINT"
* @return Type name: "CIRCLE", "RING", "LINE", "CONE", "SQUARE", or "POINT"
*/
String getType();
/**
* Set the telegraph type.
*
* @param type Type name: "circle", "ring", "line", "cone", or "point" (case insensitive)
* @param type Type name: "circle", "ring", "line", "cone", "square", or "point" (case insensitive)
*/
void setType(String type);
@@ -68,6 +68,13 @@ public interface ITelegraphHandler {
*/
ITelegraph createCone(float length, float angle);
/**
* Create a square telegraph.
* The square is axis-aligned by default and can be rotated with yaw when spawned.
*
* @param radius The half-size of the square (distance from center to edge)
* @return A new telegraph configuration
*/
ITelegraph createSquare(float radius);
/**
@@ -80,7 +87,7 @@ public interface ITelegraphHandler {
/**
* Create a telegraph by type name.
*
* @param type Type name: "circle", "ring", "line", "cone", "point" (case insensitive)
* @param type Type name: "circle", "ring", "line", "cone", "square", "point" (case insensitive)
* @return A new telegraph configuration, or null if type is invalid
*/
ITelegraph create(String type);