Skip to content

Client features

Shon edited this page Jul 12, 2024 · 9 revisions

With the CheatBreaker API, you can display Notifications, Waypoints, Cooldown Timers, and more to players who are running the CheatBreaker client.


Table of Contents:


Holograms

The CheatBreaker client allows the server to send holograms. Holograms get cleared whenever the client switches server or world.

Sending Holograms

To send a client a hologram you use CheatBreakerAPI.getInstance().addHologram(Player player, UUID id, Vector position, String[] lines)

Updating a hologram

To update an existing hologram you use CheatBreakerAPI.getInstance().updateHologram(Player player, UUID id, String[] lines)

Removing a hologram

To remove an existing hologram you use CheatBreakerAPI.getInstance().removeHologram(Player player, UUID id)

Notifications

Sending a Notification

To send a notification you use CheatBreakerAPI.getInstance().sendNotification(Player player, CBNotification notification)

Alternatively you can use CheatBreakerAPI.getInstance().sendNotificationOrFallback(Player player, CBNotification notification, Runnable fallback)

Waypoints (currently 1.7 only)

Sending Waypoints

To send a client a server waypoint you use CheatBreakerAPI.getInstance().sendWaypoint(Player player, CBWaypoint waypoint)

Removing Waypoints

To remove a waypoint on the client use CheatBreakerAPI.getInstance().removeWaypoint(Player player, CBWaypoint waypoint)

Minimap (currently 1.7 only)

Please note that the MiniMap is disallowed by default on all servers unless you send the packet that allows it

Allowing the Minimap

To allow the use of the minimap module you use CheatBreakerAPI.getInstance().setMinimapStatus(Player player, MinimapStatus.NEUTRAL)

Disabling the Minimap

To disable the minimap module you use CheatBreakerAPI.getInstance().setMinimapStatus(Player player, MinimapStatus.FORCED_OFF)

Cooldowns

Sending Cooldowns

To send a client a cooldown you use CheatBreakerAPI.getInstance().sendCooldown(Player player, CBCooldown cooldown)

Clearing Cooldowns

To clear a cooldown use CheatBreakerAPI.getInstance().clearCooldown(Player player, CBCooldown cooldown)

Titles and Subtitles

Like in newer Minecraft versions you can send titles and subtitles to users running the CheatBreaker client. Titles appear on the center of a users screen with subtitles below them.

To send a client a title or subtitle you use CheatBreakerAPI.getInstance().sendTitle(Player player, TitleType type, String message, Duration displayTime)

Legacy Combat

Sending this packet allows you to bring a more 1.7 PvP experience to your 1.8 players (legacy combat is off by default)

Enabling legacy combat

To enable legacy combat you use CheatBreakerAPI.getInstance().setLegacyCombat(Player player, true)

Disabling legacy combat

To disable legacy combat you use CheatBreakerAPI.getInstance().setLegacyCombat(Player player, false)