PlaceholderAPI

Un sistema de marcadores flexible y potente para desarrolladores de servidores de Hytale. Permite el registro y la recuperación sencilla de valores dinámicos en cadenas, con soporte para almacenamiento en caché, datos específicos de jugadores, parámetros y contextos delimitados.

Características

• Fácil de usar: API sencilla tanto para desarrolladores de Java como de Kotlin.
• Valores dinámicos: Soporte para marcadores específicos de jugadores (Sensibles al visitante).
• Caché: Soporte incorporado para almacenamiento en caché y actualizaciones automáticas.
• Parámetros: Soporte para marcadores complejos con parámetros como %player_name<lc>%.
• Ámbitos: Contextos delimitados (por ejemplo, Chat, Mensaje) para proporcionar datos relevantes solo donde se necesiten.
• Kotlin Primero: DSL seguro en tipos y funciones de extensión para desarrolladores de Kotlin.

Empezando

Para usar la API, primero necesitas obtener la instancia de PlaceholderAPI.

Java:

PlaceholderAPI api = PlaceholderAPI.getInstance();

Kotlin:

val api = PlaceholderAPI.getInstance()

Uso

Traduciendo Cadenas

Para reemplazar automáticamente todos los marcadores en una cadena, utiliza el método translateString().

Java:

String result = api.translateString("Hola %player_display_name%!", player);

Kotlin:

val result = "Hola %player_display_name%!".translatePlaceholders(player)

Registrando Marcadores

Marcadores Estáticos

Ejemplo de un marcador que devuelve el tick actual del servidor:

Kotlin DSL:

api.build<Int>("tick") {
    loader {
        Server.getInstance().tick
    }
}

Marcadores Sensibles al Visitante

Ejemplo de un marcador que devuelve el nombre del jugador:

Kotlin DSL:

api.build<String>("player_name") {
    visitorLoader {
        player.name
    }
}

Características Avanzadas

Parámetros

Los marcadores pueden aceptar parámetros utilizando la sintaxis %name<param1,param2>%. Ejemplo: %player_name<lc>% devuelve el nombre en minúsculas.

Ámbitos y Contextos

Los ámbitos permiten que los marcadores estén disponibles solo en situaciones específicas (por ejemplo, %message% solo disponible en eventos de chat).

Marcadores Incorporados

Marcador
Descripción
Ámbito

%player_display_name%
Nombre de visualización del jugador
Global

%player_gamemode%
Modo de juego del jugador
Global

%player_x%, %player_y%, %player_z%
Coordenadas del jugador
Global

%server_online%
Número de jugadores en línea
Global

%server_ram_used%
Uso de RAM del servidor
Global

%time%
Hora actual del servidor
Global

%message%
Contenido del chat/mensaje
Chat/Mensaje

%message_sender%
Remitente del mensaje
Chat/Mensaje

Soporte para Kotlin

PlaceholderAPI ofrece un DSL seguro en tipos para registrar marcadores y Funciones de extensión convenientes para una fácil integración.