A lot of GOOD API DOCUMENTATION

This commit is contained in:
Kam committed 2026-03-09 16:20:07 -04:00
1 parent a6c55ca331
commit 319e774518
131 files changed
+3363 -175

No files matched your search

+22 -8
View File
@@ -19,46 +19,55 @@ public interface ITelegraphInstance {
/**
* Get the unique instance ID.
* @return the unique instance identifier
*/
String getInstanceId();
// ═══════════════════════════════════════════════════════════════════════════
// ==========================================================================
// POSITION
// ═══════════════════════════════════════════════════════════════════════════
// ==========================================================================
/**
* Get the current X position.
* @return the current X coordinate
*/
double getX();
/**
* Get the current Y position.
* @return the current Y coordinate
*/
double getY();
/**
* Get the current Z position.
* @return the current Z coordinate
*/
double getZ();
/**
* Get the rotation yaw.
* @return the rotation yaw in degrees
*/
float getYaw();
/**
* Set the position.
* Note: Only works for static telegraphs (not following an entity).
* @param x X coordinate
* @param y Y coordinate
* @param z Z coordinate
*/
void setPosition(double x, double y, double z);
// ═══════════════════════════════════════════════════════════════════════════
// ==========================================================================
// ENTITY FOLLOWING
// ═══════════════════════════════════════════════════════════════════════════
// ==========================================================================
/**
* Make this telegraph follow an entity.
* The telegraph position will update each tick to match the entity.
* @param entity the entity to follow
*/
void followEntity(IEntity entity);
@@ -69,36 +78,41 @@ public interface ITelegraphInstance {
/**
* Check if this telegraph is following an entity.
* @return true if currently following an entity
*/
boolean isFollowing();
// ═══════════════════════════════════════════════════════════════════════════
// ==========================================================================
// TIMING
// ═══════════════════════════════════════════════════════════════════════════
// ==========================================================================
/**
* Get the remaining ticks before the telegraph expires.
* @return remaining ticks before expiration
*/
int getRemainingTicks();
/**
* Get the total duration ticks.
* @return the total duration in ticks
*/
int getTotalTicks();
/**
* Get the progress from 0.0 (just started) to 1.0 (finished).
* @return progress from 0.0 (just started) to 1.0 (finished)
*/
float getProgress();
/**
* Check if the telegraph is in the warning phase.
* @return true if in the warning phase
*/
boolean isWarning();
// ═══════════════════════════════════════════════════════════════════════════
// ==========================================================================
// CONTROL
// ═══════════════════════════════════════════════════════════════════════════
// ==========================================================================
/**
* Remove this telegraph immediately.