Index (datmoddingapi 1.21.4-1.9.0 API)

A B 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: The player is online but not currently active

B

booleanNodeBuilder(String, String, PermissionNode.PermissionResolver<Boolean>) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: A shortcut to build a boolean node

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 Class in com.datdeveloper.datmoddingapi.util.exceptions: An exception that occurs when failing to parse a chat message
ChatParseException(String, String, int) - Constructor for exception class 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: Text that is a command
COMPONENT_EMPTY_RESOLVER - Static variable in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Empty Component literal
componentNodeBuilder(String, String, PermissionNode.PermissionResolver<Component>) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: A shortcut to build a component node
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
createAdminNode(String, String) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Create a boolean node that defaults to being available for admins
createBasicNode(String, String) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Create a boolean node that defaults to being available for all players
createComponentLiteralNode(String, String, String) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Create a component node that defaults to the given value
createComponentLiteralNode(String, String, Component) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Create a component node that defaults to the given value
createEmptyComponentNode(String, String) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Create a component node that defaults to empty
createEmptyStringNode(String, String) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Create a string node that defaults to empty
createIntegerLiteralNode(String, String, int) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Create an integer node that defaults to the given value
createModNode(String, String) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Create a boolean node that defaults to being available for moderators
createOpNode(String, String) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Create a boolean node that defaults to being available for ops
createOwnerNode(String, String) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Create a boolean node that defaults to being available for owners
createStringLiteralNode(String, String, String) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Create a string node that defaults to the given value
createZeroNode(String, String) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Create an integer node that defaults to 0

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
DatConfig - Class in com.datdeveloper.datmoddingapi: The config for 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: The entry point for the mod
Datmoddingapi(IEventBus, ModContainer) - Constructor for class com.datdeveloper.datmoddingapi.Datmoddingapi: Entrypoint for mod
DatPermissions - Class in com.datdeveloper.datmoddingapi.permissions: A utility class for checking permissions
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: Content that describes an error
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

G

getAllTranslations() - Method in class com.datdeveloper.datmoddingapi.localisation.DatLocalisation
getBody(int) - Method in class com.datdeveloper.datmoddingapi.command.util.Pager: Get the body of the page
This performs the transformations on the snippet of the elements, formatted as a list
getComponent(String, Object...) - Method in class com.datdeveloper.datmoddingapi.localisation.DatLocalisation: Get a localisation as a component
The component will be formatted using DatChatFormatting
getComponentLiteralResolver(String) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Build a component resolver that returns a literal component
getComponentLiteralResolver(Component) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Build a component resolver that returns a literal component
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: Get the footer for the page
This will generate the navigation buttons, accounting for which buttons are enabled
getFormatMessage() - Method in exception class 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 Returns the DatLocalisation instance.
getIntegerLiteralResolver(int) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Build an integer resolver that returns a constant number
getLeftHand() - Method in class com.datdeveloper.datmoddingapi.collections.Pair: Deprecated.
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 class com.datdeveloper.datmoddingapi.util.exceptions.ChatParseException
getRightHand() - Method in class com.datdeveloper.datmoddingapi.collections.Pair: Deprecated.
getStringLiteralResolver(String) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Build a string resolver that returns a constant string

H

hasAllPermissions(CommandSource, PermissionNode<Boolean>...) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Checks if the given CommandSource has all the given permission
hasAllPermissions(PermissionNode<Boolean>...) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Generate a predicate that checks the CommandSourceStack has all the given permissions
hasAnyPermissions(CommandSource, PermissionNode<Boolean>...) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Checks if the given CommandSource has any of the given permission
hasAnyPermissions(PermissionNode<Boolean>...) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Generate a predicate that checks the CommandSourceStack has any of the given permissions
hasPermission(CommandSource, PermissionNode<Boolean>) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Checks if the given CommandSource has the given permission
hasPermission(PermissionNode<Boolean>) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Generate a predicate that checks the CommandSourceStack has the given permission
HEADER - Static variable in class com.datdeveloper.datmoddingapi.util.DatChatFormatting.TextColour: Content is the header of a group of text
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: Content that intends to inform the user
initialise() - Static method in class com.datdeveloper.datmoddingapi.concurrentTask.ConcurrentHandler: Set up the Concurrent handler, expects the config to be loaded
INTEGER_ZERO_RESOLVER - Static variable in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Integer literal 0
integerNodeBuilder(String, String, PermissionNode.PermissionResolver<Integer>) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: A shortcut to build an integer node

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: The ID of the mod

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: The player is offline
ONLINE - Static variable in class com.datdeveloper.datmoddingapi.util.DatChatFormatting.PlayerColour: The player is online
onTick(ServerTickEvent.Post) - Static method in class com.datdeveloper.datmoddingapi.concurrentTask.ConcurrentHandler: A Server tick event used to handle any Runnables that have been passed from a Concurrent thread to be executed on the main thread
onTick(ServerTickEvent.Post) - Static method in class com.datdeveloper.datmoddingapi.delayedEvents.DelayedEventsHandler: A tick event to execute delayed events

P

Pager<T> - 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 T>, Pager.ElementTransformer<T>) - Constructor for class com.datdeveloper.datmoddingapi.command.util.Pager: Construct a pager
Pager(String, String, Collection<? extends T>, Pager.ElementTransformer<T>) - Constructor for class com.datdeveloper.datmoddingapi.command.util.Pager: Construct a pager with the default amount of items per page (10)
Pager.ElementTransformer<T> - Interface in com.datdeveloper.datmoddingapi.command.util: A Functional interface to transform the given PagedElement into a Chat Component
Pair<L,R> - Class in com.datdeveloper.datmoddingapi.collections: Deprecated.
Use Pair instead
Pair(L, R) - Constructor for class com.datdeveloper.datmoddingapi.collections.Pair: Deprecated.
parse() - Method in class com.datdeveloper.datmoddingapi.util.DatMessageFormatter: Parse the given formatString using the arguments
player - Variable in class com.datdeveloper.datmoddingapi.delayedEvents.DelayedTeleportEvent: The Player being teleported
PLAYER_ADMIN_RESOLVER - Static variable in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Player has permission level Admin
PLAYER_ALL_RESOLVER - Static variable in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Player has permission level All
PLAYER_MOD_RESOLVER - Static variable in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Player has permission level Mod
PLAYER_OP_RESOLVER - Static variable in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Player has permission level Op
PLAYER_OWNER_RESOLVER - Static variable in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Player has permission level Owner

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
renderPage(int) - Method in class com.datdeveloper.datmoddingapi.command.util.Pager: Render the page of the pager
This produces a full component ready to display to the user, with the header, body, and footer, rendered and combined
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(L) - Method in class com.datdeveloper.datmoddingapi.collections.Pair: Deprecated.
setRightHand(R) - Method in class com.datdeveloper.datmoddingapi.collections.Pair: Deprecated.
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
STRING_EMPTY_RESOLVER - Static variable in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: Empty String literal
stringNodeBuilder(String, String, PermissionNode.PermissionResolver<String>) - Static method in class com.datdeveloper.datmoddingapi.permissions.DatPermissions: A shortcut to build a string node

T

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(T) - Method in interface com.datdeveloper.datmoddingapi.command.util.Pager.ElementTransformer

U

UUID_CODEC - Static variable in class com.datdeveloper.datmoddingapi.util.DatCodec: Deprecated.
Use UUIDUtil.CODEC instead

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 B 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