• Home
• dev.arbjerg
• lavalink-client
• 3.1.0
• source code
• IPenaltyProvider.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

dev.arbjerg.lavalink.client.loadbalancing.builtin.IPenaltyProvider.kt Maven / Gradle / Ivy

package dev.arbjerg.lavalink.client.loadbalancing.builtin

import dev.arbjerg.lavalink.client.LavalinkNode
import dev.arbjerg.lavalink.client.loadbalancing.VoiceRegion
import dev.arbjerg.lavalink.client.loadbalancing.MAX_ERROR

fun interface IPenaltyProvider {
    /**
     * Calculate the penalty for the provider.
     *
     * Return value should never exceed [MAX_ERROR]. Lower means to take preference.
     *
     * @param node The lavalink node to calculate the penalty for.
     * @param region The preferred voice region for the node, null if not specified.
     *
     * @return A number between 0 and [MAX_ERROR] (inclusive), using numbers outside of this range may cause errors.
     */
    fun getPenalty(node: LavalinkNode, region: VoiceRegion?): Int
}