com.github.shynixn.blockball.api.business.enumeration.PlaceHolder.kt Maven / Gradle / Ivy
package com.github.shynixn.blockball.api.business.enumeration
/**
* Placeholder being used in BlockBall.
*
* Version 1.2
*
* MIT License
*
* Copyright (c) 2018 by Shynixn
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
enum class PlaceHolder(
/**
* Placeholder value.
*/
val placeHolder: String) {
/**
* Replaces this placeholder with the display name of the arena.
*/
ARENA_DISPLAYNAME(""),
/**
* Replaces this placeholder with the max player amount of this arena.
*/
ARENA_SUM_MAXPLAYERS(""),
/**
* Replaces this placeholder with the current amount of players of this game.
*/
ARENA_SUM_CURRENTPLAYERS(""),
/**
* Replaces this placeholder with the amount of goals team red has scored.
*/
RED_GOALS(""),
/**
* Replaces this placeholder with the amount of goals team blue has scored.
*/
BLUE_GOALS(""),
/**
* Replaces this placeholder with the name of team red.
*/
TEAM_RED(""),
/**
* Replaces this placeholder with the name of team blue.
*/
TEAM_BLUE(""),
/**
* Replaces this placeholder with the prefix/color of the team red.
*/
RED_COLOR(""),
/**
* Replaces this placeholder with the prefix/color of the team blue.
*/
BLUE_COLOR(""),
/**
* Replaces this placeholder with the current time of the game.
*/
TIME("