Index (datmoddingapi 1.20.1-1.7.0 API)

A C D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ACTIONBAR - Enum constant in enum class com.datdeveloper.datmoddingapi.util.ENotificationType: A message above the player's hotbar
addEvent(IDelayedEvent) - Static method in class com.datdeveloper.datmoddingapi.delayedEvents.DelayedEventsHandler: Add a DelayedEvent to the Delay Queue
addLocalisation(String, String) - Method in class com.datdeveloper.datmoddingapi.localisation.DatLocalisation: Add a localisation to the available translations.
AgeUtil - Class in com.datdeveloper.datmoddingapi.util: A utility class to help display time scales
AWAY - Static variable in class com.datdeveloper.datmoddingapi.util.DatChatFormatting.PlayerColour

C

callConcurrentTask(Callable<T>) - Static method in class com.datdeveloper.datmoddingapi.concurrentTask.ConcurrentHandler: Queue a concurrent task with a return value
canExecute() - Method in interface com.datdeveloper.datmoddingapi.delayedEvents.IDelayedEvent: The check to ensure the conditions are correct for the Delayed Event to execute
canExecute() - Method in class com.datdeveloper.datmoddingapi.delayedEvents.TimeDelayedEvent
CHAT - Enum constant in enum class com.datdeveloper.datmoddingapi.util.ENotificationType: A message in chat (Only visible to the player)
chatNotification(ServerPlayer, Component) - Static method in class com.datdeveloper.datmoddingapi.util.NotificationHelper: Display a notification for the given player in their chat
This is just a wrapper around ServerPlayer.sendSystemMessage(Component)
ChatParseException - Exception in com.datdeveloper.datmoddingapi.util.exceptions
ChatParseException(String, String, int) - Constructor for exception com.datdeveloper.datmoddingapi.util.exceptions.ChatParseException
CHUNKPOS - Static variable in class com.datdeveloper.datmoddingapi.util.DatCodec: A Codec for handling ChunkPos
This converts the chunkpos into an intstream, similar to BlockPos
clearTranslations() - Method in class com.datdeveloper.datmoddingapi.localisation.DatLocalisation: Clear all the translations
Warning, this clears ALL the translations, from all mods that have registered up until this point.
com.datdeveloper.datmoddingapi - package com.datdeveloper.datmoddingapi
com.datdeveloper.datmoddingapi.collections - package com.datdeveloper.datmoddingapi.collections
com.datdeveloper.datmoddingapi.command.util - package com.datdeveloper.datmoddingapi.command.util
com.datdeveloper.datmoddingapi.concurrentTask - package com.datdeveloper.datmoddingapi.concurrentTask
com.datdeveloper.datmoddingapi.delayedEvents - package com.datdeveloper.datmoddingapi.delayedEvents
com.datdeveloper.datmoddingapi.localisation - package com.datdeveloper.datmoddingapi.localisation
com.datdeveloper.datmoddingapi.permissions - package com.datdeveloper.datmoddingapi.permissions
com.datdeveloper.datmoddingapi.util - package com.datdeveloper.datmoddingapi.util
com.datdeveloper.datmoddingapi.util.exceptions - package com.datdeveloper.datmoddingapi.util.exceptions
COMMAND - Static variable in class com.datdeveloper.datmoddingapi.util.DatChatFormatting.TextColour
ConcurrentHandler - Class in com.datdeveloper.datmoddingapi.concurrentTask: A system for running tasks concurrently in another thread, optionally with a delay
ConcurrentHandler() - Constructor for class com.datdeveloper.datmoddingapi.concurrentTask.ConcurrentHandler

D

DatChatFormatting - Class in com.datdeveloper.datmoddingapi.util: A utility class containing standardised colours
DatChatFormatting.PlayerColour - Class in com.datdeveloper.datmoddingapi.util: Colours for player states
DatChatFormatting.TextColour - Class in com.datdeveloper.datmoddingapi.util: Colours for chat messages
DatCodec - Class in com.datdeveloper.datmoddingapi.util: A utility class containing various useful codecs
DatCodec() - Constructor for class com.datdeveloper.datmoddingapi.util.DatCodec
DatConfig - Class in com.datdeveloper.datmoddingapi
DatLocalisation - Class in com.datdeveloper.datmoddingapi.localisation: A utility for serverside localisation
Does not yet support providing arguments
DatMessageFormatter - Class in com.datdeveloper.datmoddingapi.util: A class for formatting
DatMessageFormatter(String, Object...) - Constructor for class com.datdeveloper.datmoddingapi.util.DatMessageFormatter
Datmoddingapi - Class in com.datdeveloper.datmoddingapi
Datmoddingapi() - Constructor for class com.datdeveloper.datmoddingapi.Datmoddingapi
DatPermissions - Class in com.datdeveloper.datmoddingapi.permissions: A utility class for checking permissions
DatPermissions() - Constructor for class com.datdeveloper.datmoddingapi.permissions.DatPermissions
DatTeleporter - Class in com.datdeveloper.datmoddingapi.util: A simple teleporter that just teleports a player to a location in a level Does not produce a portal and does not produce a sound
DatTeleporter(BlockPos) - Constructor for class com.datdeveloper.datmoddingapi.util.DatTeleporter
DelayedEventsHandler - Class in com.datdeveloper.datmoddingapi.delayedEvents: A system for delaying the execution of events until a condition is met
DelayedEventsHandler() - Constructor for class com.datdeveloper.datmoddingapi.delayedEvents.DelayedEventsHandler
DelayedTeleportEvent - Class in com.datdeveloper.datmoddingapi.delayedEvents: A Delayed Event to teleport the player to a specific location after a set amount of time Cancels if the player moves
DelayedTeleportEvent(BlockPos, ResourceKey<Level>, ServerPlayer, int) - Constructor for class com.datdeveloper.datmoddingapi.delayedEvents.DelayedTeleportEvent
destinationPos - Variable in class com.datdeveloper.datmoddingapi.delayedEvents.DelayedTeleportEvent: The position the player will teleport to
destinationWorld - Variable in class com.datdeveloper.datmoddingapi.delayedEvents.DelayedTeleportEvent: The level the player will teleport to
DISABLED - Enum constant in enum class com.datdeveloper.datmoddingapi.util.ENotificationType: No notification will be sent

E

ENotificationType - Enum Class in com.datdeveloper.datmoddingapi.util: An enum representing different ways to notify a player
ERROR - Static variable in class com.datdeveloper.datmoddingapi.util.DatChatFormatting.TextColour
execute() - Method in class com.datdeveloper.datmoddingapi.delayedEvents.DelayedTeleportEvent
execute() - Method in interface com.datdeveloper.datmoddingapi.delayedEvents.IDelayedEvent: The code that will execute when the delay has passed
exeTime - Variable in class com.datdeveloper.datmoddingapi.delayedEvents.TimeDelayedEvent: The time after which the event can be executed

F

formatChatString(String, Object...) - Static method in class com.datdeveloper.datmoddingapi.util.DatMessageFormatter: Format the given chat string into a chat component using objects passed as arguments
A shortcut function for DatMessageFormatter
When an error is encountered in the DatMessageFormatter Then it is caught and dumped in the chat message.

G

getAllTranslations() - Method in class com.datdeveloper.datmoddingapi.localisation.DatLocalisation
getDelayedEventsPerTick() - Static method in class com.datdeveloper.datmoddingapi.DatConfig
getEnumCodec(Class<E>) - Static method in class com.datdeveloper.datmoddingapi.util.DatCodec: A helper function to create a Codec that handles the given enum class
The resulting codec will convert the enum into a string for storage
getFooter(int) - Method in class com.datdeveloper.datmoddingapi.command.util.Pager
getFormatMessage() - Method in exception com.datdeveloper.datmoddingapi.util.exceptions.ChatParseException
getFriendlyDifference(long) - Static method in class com.datdeveloper.datmoddingapi.util.AgeUtil: Get a friendly string representing the difference in time
For example, if the timestamp represents 3500 seconds, it would return "58 minutes" Supports seconds, minutes, hours, days, months, and years
getFriendlyRelativeTime(long) - Static method in class com.datdeveloper.datmoddingapi.util.AgeUtil: Get a friendly string representing the difference between now and the given timestamp
For example, if the timestamp represents 3500 seconds in the future, it would return "In 58 minutes", equally, if the timestamp represents 80000 seconds in the past, it would return "22 hours ago" Supports seconds, minutes, hours, days, months, and years
getHeader() - Method in class com.datdeveloper.datmoddingapi.command.util.Pager: Get the header for the pager
getInstance() - Static method in class com.datdeveloper.datmoddingapi.localisation.DatLocalisation: Get the DatLocalisation instance
getLeftHand() - Method in class com.datdeveloper.datmoddingapi.collections.Pair
getLocalisation(String) - Method in class com.datdeveloper.datmoddingapi.localisation.DatLocalisation: Get a localised string from the store
getLocalisation(String, String) - Method in class com.datdeveloper.datmoddingapi.localisation.DatLocalisation: Get a localised string from the store, returning the fallback if it doesn't exist
getMaxConcurrentThreadCount() - Static method in class com.datdeveloper.datmoddingapi.DatConfig
getMessage() - Method in exception com.datdeveloper.datmoddingapi.util.exceptions.ChatParseException
getPage(int) - Method in class com.datdeveloper.datmoddingapi.command.util.Pager
getPortalInfo(Entity, ServerLevel, Function<ServerLevel, PortalInfo>) - Method in class com.datdeveloper.datmoddingapi.util.DatTeleporter
getRightHand() - Method in class com.datdeveloper.datmoddingapi.collections.Pair

H

hasAllPermissions(CommandSource, PermissionNode<Boolean>...) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Checks if the given CommandSource has all the given permission
hasAnyPermissions(CommandSource, PermissionNode<Boolean>...) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Checks if the given CommandSource has any of the given permission
hasPermission(CommandSource, PermissionNode<Boolean>) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Checks if the given CommandSource has the given permission
HEADER - Static variable in class com.datdeveloper.datmoddingapi.util.DatChatFormatting.TextColour
hotbarNotification(ServerPlayer, Component) - Static method in class com.datdeveloper.datmoddingapi.util.NotificationHelper: Display a notification for the given player just above their hotbar

I

IDelayedEvent - Interface in com.datdeveloper.datmoddingapi.delayedEvents: The base interface for Delayed events
INFO - Static variable in class com.datdeveloper.datmoddingapi.util.DatChatFormatting.TextColour
initialise() - Static method in class com.datdeveloper.datmoddingapi.concurrentTask.ConcurrentHandler: Set up the Concurrent handler, expects the config to be loaded

L

loadLocalisations(String) - Method in class com.datdeveloper.datmoddingapi.localisation.DatLocalisation: Load in a JSON file of localisations from a file
First checks filepath, then checks classpath
Keys already in the table will be overridden.

M

MODID - Static variable in class com.datdeveloper.datmoddingapi.Datmoddingapi

N

NotificationHelper - Class in com.datdeveloper.datmoddingapi.util: A class to simplify sending notifications to the player

O

OFFLINE - Static variable in class com.datdeveloper.datmoddingapi.util.DatChatFormatting.PlayerColour
ONLINE - Static variable in class com.datdeveloper.datmoddingapi.util.DatChatFormatting.PlayerColour
onTick(TickEvent.ServerTickEvent) - Static method in class com.datdeveloper.datmoddingapi.concurrentTask.ConcurrentHandler
onTick(TickEvent.ServerTickEvent) - Static method in class com.datdeveloper.datmoddingapi.delayedEvents.DelayedEventsHandler

P

Pager<PagedElement> - Class in com.datdeveloper.datmoddingapi.command.util: A class to split the results of a command into pages Commands that implement this should take an integer as the last argument that is passed to the Pager.sendPage(int, CommandSource) method
Pager(String, String, int, Collection<? extends PagedElement>, Pager.ElementTransformer<PagedElement>) - Constructor for class com.datdeveloper.datmoddingapi.command.util.Pager: Construct a pager
Pager(String, String, Collection<? extends PagedElement>, Pager.ElementTransformer<PagedElement>) - Constructor for class com.datdeveloper.datmoddingapi.command.util.Pager: Construct a pager with the default amount of items per page (10)
Pager.ElementTransformer<PagedElement> - Interface in com.datdeveloper.datmoddingapi.command.util: A Functional interface to transform the given PagedElement into a Chat Component
Pair<lh,rh> - Class in com.datdeveloper.datmoddingapi.collections: A simple container for 2 values
Pair(lh, rh) - Constructor for class com.datdeveloper.datmoddingapi.collections.Pair
parse() - Method in class com.datdeveloper.datmoddingapi.util.DatMessageFormatter: Parse the given formatString using the arguments
placeEntity(Entity, ServerLevel, ServerLevel, float, Function<Boolean, Entity>) - Method in class com.datdeveloper.datmoddingapi.util.DatTeleporter
player - Variable in class com.datdeveloper.datmoddingapi.delayedEvents.DelayedTeleportEvent: The Player being teleported
PlayerColour() - Constructor for class com.datdeveloper.datmoddingapi.util.DatChatFormatting.PlayerColour
playTeleportSound(ServerPlayer, ServerLevel, ServerLevel) - Method in class com.datdeveloper.datmoddingapi.util.DatTeleporter

R

removeTranslation(String) - Method in class com.datdeveloper.datmoddingapi.localisation.DatLocalisation: Remove the translation with the matching key
removeTranslations(Predicate<String>) - Method in class com.datdeveloper.datmoddingapi.localisation.DatLocalisation: Remove any translations that match the given predicate
runConcurrentTask(Runnable) - Static method in class com.datdeveloper.datmoddingapi.concurrentTask.ConcurrentHandler: Queue an concurrent task
runOnMainThread(Runnable) - Static method in class com.datdeveloper.datmoddingapi.concurrentTask.ConcurrentHandler: Queue a runnable to be executed on the server thread.

S

scheduleConcurrentTask(long, TimeUnit, Runnable) - Static method in class com.datdeveloper.datmoddingapi.concurrentTask.ConcurrentHandler: Schedule a concurrent task
scheduleConcurrentTask(long, TimeUnit, Callable<T>) - Static method in class com.datdeveloper.datmoddingapi.concurrentTask.ConcurrentHandler: Schedule a task with a return value to run after the given delay
scheduleFixedRateConcurrentTask(long, long, TimeUnit, Runnable) - Static method in class com.datdeveloper.datmoddingapi.concurrentTask.ConcurrentHandler: Schedule a task to run repeatedly with a fixed period after an initial delay
sendPage(int, CommandSource) - Method in class com.datdeveloper.datmoddingapi.command.util.Pager: Send the given page to the given CommandSource
setLeftHand(lh) - Method in class com.datdeveloper.datmoddingapi.collections.Pair
setRightHand(rh) - Method in class com.datdeveloper.datmoddingapi.collections.Pair
shouldRequeue(boolean) - Method in class com.datdeveloper.datmoddingapi.delayedEvents.DelayedTeleportEvent
shouldRequeue(boolean) - Method in interface com.datdeveloper.datmoddingapi.delayedEvents.IDelayedEvent: Checks to see if the code should be requeued to continue waiting to be executed Can be used to restart the delay for the event
shouldRequeue(boolean) - Method in class com.datdeveloper.datmoddingapi.delayedEvents.TimeDelayedEvent
startingPos - Variable in class com.datdeveloper.datmoddingapi.delayedEvents.DelayedTeleportEvent: The starting position of the player Used to calculate if the event should cancel for the player moving

T

TextColour() - Constructor for class com.datdeveloper.datmoddingapi.util.DatChatFormatting.TextColour
TimeDelayedEvent - Class in com.datdeveloper.datmoddingapi.delayedEvents: An abstract implementation of IDelayedEvent that waits until the given delay has passed before executing
TimeDelayedEvent(int) - Constructor for class com.datdeveloper.datmoddingapi.delayedEvents.TimeDelayedEvent
TITLE - Enum constant in enum class com.datdeveloper.datmoddingapi.util.ENotificationType: A message in the middle of the player's screen
titleNotification(ServerPlayer, Component, Component, int, int, int) - Static method in class com.datdeveloper.datmoddingapi.util.NotificationHelper: Display a notification for the given player in the middle of their screen
titleNotification(ServerPlayer, Component, Component) - Static method in class com.datdeveloper.datmoddingapi.util.NotificationHelper: Display a notification for the given player in the middle of their screen
Uses 10, 40, 10 for fadeIn, stay, and fadeOut respectively
transform(PagedElement) - Method in interface com.datdeveloper.datmoddingapi.command.util.Pager.ElementTransformer

U

UUID_CODEC - Static variable in class com.datdeveloper.datmoddingapi.util.DatCodec: A Codec for handling UUID
Converts it into a string for storage

V

valueOf(String) - Static method in enum class com.datdeveloper.datmoddingapi.util.ENotificationType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.datdeveloper.datmoddingapi.util.ENotificationType: Returns an array containing the constants of this enum class, in the order they are declared.

A C D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form