Index
All Classes and Interfaces|All Packages
A
- at(Location, String) - Static method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
A point at a location, with height.
C
- compass() - Method in interface io.github.nacvark.hudengine.api.HudEngine
-
Where a plugin publishes points for compasses to point at.
- CompassPoint(String, double, double, double, String, double) - Constructor for record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
Creates an instance of a
CompassPointrecord class.
E
- equals(Object) - Method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.nacvark.hudengine.api.HudEngine.ReloadResult
-
Indicates whether some other object is "equal to" this one.
F
- find() - Static method in class io.github.nacvark.hudengine.api.HudEngineProvider
-
The running engine, or empty if it is not installed or failed to start.
- flat(String, double, double, String) - Static method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
A point with no height, which is always measured on the flat.
G
- get() - Static method in class io.github.nacvark.hudengine.api.HudEngineProvider
-
The running engine.
- getHandlerList() - Static method in class io.github.nacvark.hudengine.api.event.HudsReloadedEvent
- getHandlers() - Method in class io.github.nacvark.hudengine.api.event.HudsReloadedEvent
H
- hashCode() - Method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.nacvark.hudengine.api.HudEngine.ReloadResult
-
Returns a hash code value for this object.
- hasHeight() - Method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
Whether this point carries a height at all.
- hasHud(String) - Method in interface io.github.nacvark.hudengine.api.HudEngine
-
Whether a HUD with this key was compiled.
- hide(String) - Method in interface io.github.nacvark.hudengine.api.PlayerHuds
-
Removes a HUD from this player's set.
- HudCompass - Interface in io.github.nacvark.hudengine.api
-
Where a plugin publishes points for compasses to point at.
- HudCompass.CompassPoint - Record Class in io.github.nacvark.hudengine.api
-
Somewhere a compass can point.
- HudCompass.Provider - Interface in io.github.nacvark.hudengine.api
-
Supplies points for one player.
- HudEngine - Interface in io.github.nacvark.hudengine.api
-
Entry point for plugins building on HUDEngine.
- HudEngine.ReloadResult - Record Class in io.github.nacvark.hudengine.api
-
The outcome of a reload.
- HudEngineProvider - Class in io.github.nacvark.hudengine.api
-
Resolves the running
HudEngine. - HudMetrics - Interface in io.github.nacvark.hudengine.api
-
Pixel measurement against a HUD's real fonts.
- huds() - Method in class io.github.nacvark.hudengine.api.event.HudsReloadedEvent
-
The HUDs the new model compiled, in compile order.
- huds() - Method in interface io.github.nacvark.hudengine.api.HudEngine
-
Every compiled HUD, in the order the configuration defined them.
- HudsReloadedEvent - Class in io.github.nacvark.hudengine.api.event
-
Fired after the configuration has been recompiled and the new model is live.
- HudsReloadedEvent(List<String>) - Constructor for class io.github.nacvark.hudengine.api.event.HudsReloadedEvent
- HudValues - Interface in io.github.nacvark.hudengine.api
-
Where a plugin publishes values for HUD patterns.
I
- icon() - Method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
Returns the value of the
iconrecord component. - io.github.nacvark.hudengine.api - package io.github.nacvark.hudengine.api
- io.github.nacvark.hudengine.api.event - package io.github.nacvark.hudengine.api.event
- isRegistered(String) - Method in interface io.github.nacvark.hudengine.api.HudCompass
- isRegistered(String) - Method in interface io.github.nacvark.hudengine.api.HudValues
-
Whether anything is registered under this key.
- isRunning() - Method in interface io.github.nacvark.hudengine.api.HudEngine
-
Whether the engine compiled successfully and is currently rendering.
- isVisible() - Method in interface io.github.nacvark.hudengine.api.PlayerHuds
-
Whether the player is currently being shown a HUD at all.
M
- messages() - Method in record class io.github.nacvark.hudengine.api.HudEngine.ReloadResult
-
Returns the value of the
messagesrecord component. - metrics() - Method in interface io.github.nacvark.hudengine.api.HudEngine
-
Pixel measurement against a HUD's real fonts.
P
- player(Player) - Method in interface io.github.nacvark.hudengine.api.HudEngine
-
What one player currently sees, and how to change it.
- PlayerHuds - Interface in io.github.nacvark.hudengine.api
-
One player's view of the HUD.
- points(Player) - Method in interface io.github.nacvark.hudengine.api.HudCompass.Provider
R
- radius() - Method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
Returns the value of the
radiusrecord component. - refresh() - Method in interface io.github.nacvark.hudengine.api.PlayerHuds
-
Recomputes and sends now instead of waiting for the next tick.
- register(String, HudCompass.Provider) - Method in interface io.github.nacvark.hudengine.api.HudCompass
-
Registers a source of moving points.
- register(String, Function<Player, String>) - Method in interface io.github.nacvark.hudengine.api.HudValues
-
Publishes a value.
- reload() - Method in interface io.github.nacvark.hudengine.api.HudEngine
-
Recompiles the configuration and swaps the model in.
- ReloadResult(boolean, List<String>) - Constructor for record class io.github.nacvark.hudengine.api.HudEngine.ReloadResult
-
Creates an instance of a
ReloadResultrecord class. - reset() - Method in interface io.github.nacvark.hudengine.api.PlayerHuds
-
Returns the player to the configured default set.
S
- setVisible(boolean) - Method in interface io.github.nacvark.hudengine.api.PlayerHuds
-
The master switch.
- show(String) - Method in interface io.github.nacvark.hudengine.api.PlayerHuds
-
Adds a HUD to this player's set, including one outside the configured defaults.
- showFor(String, int) - Method in interface io.github.nacvark.hudengine.api.PlayerHuds
-
Shows a HUD for a fixed number of ticks, then hides it again.
- success() - Method in record class io.github.nacvark.hudengine.api.HudEngine.ReloadResult
-
Returns the value of the
successrecord component.
T
- toggle() - Method in interface io.github.nacvark.hudengine.api.PlayerHuds
-
Flips the master switch.
- toString() - Method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.nacvark.hudengine.api.HudEngine.ReloadResult
-
Returns a string representation of this record class.
U
- unregister(String) - Method in interface io.github.nacvark.hudengine.api.HudCompass
- unregister(String) - Method in interface io.github.nacvark.hudengine.api.HudValues
-
Withdraws a value.
V
- values() - Method in interface io.github.nacvark.hudengine.api.HudEngine
-
Where a plugin publishes values for HUD patterns to draw.
- visible() - Method in interface io.github.nacvark.hudengine.api.PlayerHuds
-
This player's HUDs, in compile order.
W
- width(String, String, String) - Method in interface io.github.nacvark.hudengine.api.HudMetrics
-
Width of a string in HUD pixels.
- within(Location, String, double) - Static method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
A point at a location that only appears within
radiusblocks. - world() - Method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
Returns the value of the
worldrecord component. - wrap(String, String, String, int) - Method in interface io.github.nacvark.hudengine.api.HudMetrics
-
Wraps text to a pixel width.
X
- x() - Method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
Returns the value of the
xrecord component.
Y
- y() - Method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
Returns the value of the
yrecord component.
Z
- z() - Method in record class io.github.nacvark.hudengine.api.HudCompass.CompassPoint
-
Returns the value of the
zrecord component.
All Classes and Interfaces|All Packages