mirror of
https://gitlab.bixilon.de/bixilon/minosoft.git
synced 2025-09-17 11:24:56 -04:00
profiles: add java doc for all options
This commit is contained in:
parent
0982e4226c
commit
5f74e88fa2
@ -6,6 +6,9 @@ import de.bixilon.minosoft.config.profile.profiles.eros.ErosProfileManager.lates
|
|||||||
import de.bixilon.minosoft.config.profile.profiles.eros.general.GeneralC
|
import de.bixilon.minosoft.config.profile.profiles.eros.general.GeneralC
|
||||||
import de.bixilon.minosoft.config.profile.profiles.eros.server.ServerC
|
import de.bixilon.minosoft.config.profile.profiles.eros.server.ServerC
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Profile for Eros
|
||||||
|
*/
|
||||||
class ErosProfile(
|
class ErosProfile(
|
||||||
description: String? = null,
|
description: String? = null,
|
||||||
) : Profile {
|
) : Profile {
|
||||||
|
@ -5,7 +5,7 @@ import java.util.*
|
|||||||
|
|
||||||
class GeneralC {
|
class GeneralC {
|
||||||
/**
|
/**
|
||||||
* Language to use for eros (and the fallback for the connection)
|
* Language to use for eros. This is also the fallback language for other profiles
|
||||||
*/
|
*/
|
||||||
var language: Locale by delegate(Locale.getDefault())
|
var language: Locale by delegate(Locale.getDefault())
|
||||||
}
|
}
|
||||||
|
@ -3,7 +3,18 @@ package de.bixilon.minosoft.config.profile.profiles.eros.server.list
|
|||||||
import de.bixilon.minosoft.config.profile.profiles.eros.ErosProfileManager.delegate
|
import de.bixilon.minosoft.config.profile.profiles.eros.ErosProfileManager.delegate
|
||||||
|
|
||||||
class ListC {
|
class ListC {
|
||||||
|
/**
|
||||||
|
* Hides all servers in the server list that can not be pinged
|
||||||
|
*/
|
||||||
var hideOffline by delegate(false)
|
var hideOffline by delegate(false)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hides all servers in the server list, when the amount of online players exceeds the slots
|
||||||
|
*/
|
||||||
var hideFull by delegate(false)
|
var hideFull by delegate(false)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hides all servers in the server list when <= 0 players are online
|
||||||
|
*/
|
||||||
var hideEmpty by delegate(false)
|
var hideEmpty by delegate(false)
|
||||||
}
|
}
|
||||||
|
@ -2,7 +2,17 @@ package de.bixilon.minosoft.config.profile.profiles.eros.server.modify
|
|||||||
|
|
||||||
import de.bixilon.minosoft.config.profile.profiles.eros.ErosProfileManager.delegate
|
import de.bixilon.minosoft.config.profile.profiles.eros.ErosProfileManager.delegate
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configuration for the add or edit server dialog
|
||||||
|
*/
|
||||||
class ModifyC {
|
class ModifyC {
|
||||||
|
/**
|
||||||
|
* Shows releases in the version select dropdown
|
||||||
|
*/
|
||||||
var showReleases by delegate(true)
|
var showReleases by delegate(true)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shows snapshots in the version select dropdown
|
||||||
|
*/
|
||||||
var showSnapshots by delegate(false)
|
var showSnapshots by delegate(false)
|
||||||
}
|
}
|
||||||
|
@ -5,6 +5,9 @@ import de.bixilon.minosoft.config.profile.profiles.particle.ParticleProfileManag
|
|||||||
import de.bixilon.minosoft.config.profile.profiles.particle.ParticleProfileManager.latestVersion
|
import de.bixilon.minosoft.config.profile.profiles.particle.ParticleProfileManager.latestVersion
|
||||||
import de.bixilon.minosoft.gui.rendering.RenderConstants
|
import de.bixilon.minosoft.gui.rendering.RenderConstants
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Profile for particle
|
||||||
|
*/
|
||||||
class ParticleProfile(
|
class ParticleProfile(
|
||||||
description: String? = null,
|
description: String? = null,
|
||||||
) : Profile {
|
) : Profile {
|
||||||
@ -14,8 +17,18 @@ class ParticleProfile(
|
|||||||
override val version: Int = latestVersion
|
override val version: Int = latestVersion
|
||||||
override val description by delegate(description ?: "")
|
override val description by delegate(description ?: "")
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enabled or disables particle renderer
|
||||||
|
* Does not skip loading of particles
|
||||||
|
*/
|
||||||
var enabled by delegate(true)
|
var enabled by delegate(true)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Limits the number of particles.
|
||||||
|
* Particles that exceed that count will be ignored
|
||||||
|
* Must not be negative or exceed $RenderConstants.MAXIMUM_PARTICLE_AMOUNT
|
||||||
|
* @see RenderConstants.MAXIMUM_PARTICLE_AMOUNT
|
||||||
|
*/
|
||||||
var maxAmount by delegate(RenderConstants.MAXIMUM_PARTICLE_AMOUNT) { check(it in 0..RenderConstants.MAXIMUM_PARTICLE_AMOUNT) { "Particle amount must be non-negative and may not exceed ${RenderConstants.MAXIMUM_PARTICLE_AMOUNT}" } }
|
var maxAmount by delegate(RenderConstants.MAXIMUM_PARTICLE_AMOUNT) { check(it in 0..RenderConstants.MAXIMUM_PARTICLE_AMOUNT) { "Particle amount must be non-negative and may not exceed ${RenderConstants.MAXIMUM_PARTICLE_AMOUNT}" } }
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user