LiquidBounce/net.ccbluex.liquidbounce.utils.render.placement/PlacementRenderer

PlacementRenderer

open class PlacementRenderer(name: String, enabled: Boolean, val module: EventListener, val keep: Boolean = true, clump: Boolean = true, defaultColor: Color4b = Color4b.GREEN.alpha(90)) : ToggleableValueGroup

Render boxes, manages fade-in/-out and culling.

Modules that want to provide a color not set in here can simply extend this class, register all settings except for the color settings, and override the color getters as needed.

Inheritors

NotebotRenderer

Constructors

PlacementRenderer

constructor(name: String, enabled: Boolean, module: EventListener, keep: Boolean = true, clump: Boolean = true, defaultColor: Color4b = Color4b.GREEN.alpha(90))

Properties

aliases

val aliases: List<String>

base

var base: ValueGroup?

Stores the ValueGroup in which the ValueGroup is included, can be null.

baseKey

open val baseKey: String

The base key used when base is null, otherwise the baseKey from base is used when its base is null and so on.

clump

val clump: Boolean

colorSetting

val colorSetting: Color4b

containedValues

@get:JvmName(name = "getContainedValues")

val containedValues: Array<Value<*>>

description

open var description: Supplier<String?>

descriptionKey

var descriptionKey: String?

doNotInclude

var doNotInclude: () -> Boolean

If true, value will not be included in generated public config

enabled

open override var enabled: Boolean

enabledValue

@get:JvmName(name = "getEnabledValue")

val enabledValue: Value<Boolean>

endSize

val endSize: Float

endSizeCurve

val endSizeCurve: Easing

eventListenerScope

val EventListener.eventListenerScope: CoroutineScope

Get the related CoroutineScope of receiver EventListener.

fadeInCurve

val fadeInCurve: Easing

fadeOutCurve

val fadeOutCurve: Easing

gpuDevice

open val gpuDevice: GpuDevice

independentDescription

var independentDescription: Boolean

If true, the description won't be bound to any net.ccbluex.liquidbounce.config.types.group.ValueGroup.

interaction

open val interaction: MultiPlayerGameMode

inTime

val inTime: Int

isImmutable

var isImmutable: Boolean

If true, value will always keep inner equals defaultValue

keep

val keep: Boolean

key

var key: String?

open val mc: Minecraft

module

val module: EventListener

name

@SerializedName(value = "name")

val name: String

network

open val network: ClientPacketListener

notAnOption

var notAnOption: Boolean

If true, value will not be included in generated RestAPI config

outlineColorSetting

val outlineColorSetting: Color4b

outTime

val outTime: Int

parent

val parent: EventListener?

player

open val player: LocalPlayer

running

open override val running: Boolean

Only run when the module and this is enabled or out-animations are running.

startSize

val startSize: Float

startSizeCurve

val startSizeCurve: Easing

valueType

val valueType: ValueType

world

open val world: ClientLevel

worldChangeHandler

val worldChangeHandler: EventHook<WorldChangeEvent>

Functions

addBlock

fun addBlock(pos: BlockPos, update: Boolean = true, box: AABB = pos.outlineBox, handlerId: Int = 0)

Adds a block to be rendered. First it will make an appear-animation, then it will continue to get rendered until it's removed or the world changes.

asRefreshable

fun Value<ClosedFloatingPointRange<Float>>.asRefreshable(): RefreshableFloatState

fun Value<IntRange>.asRefreshable(): RefreshableIntState

asStateFlow

fun asStateFlow(): StateFlow<MutableCollection<Value<*>>>

bind

fun bind(name: String, default: Int = GLFW.GLFW_KEY_UNKNOWN): BindValue

fun bind(name: String, default: InputBind): BindValue

bind

fun Value<InputBind>.bind(name: String)

Binds to the given input name.

fun Value<InputBind>.bind(key: InputConstants.Key, action: InputBind.BindAction, modifiers: Set<InputBind.Modifier>)

Binds to the given input type and code.

block

fun block(name: String, default: Block): Value<Block>

blocks

fun <C : SequencedSet<Block>> blocks(name: String, default: C): RegistryListValue<C, Block>

boolean

fun boolean(name: String, default: Boolean, aliases: List<String> = emptyList()): Value<Boolean>

c2sPackets

fun <C : SequencedSet<Identifier>> c2sPackets(name: String, default: C): RegistryListValue<C, Identifier>

children

open fun children(): List<EventListener>

Children EventListener

clearSilently

fun clearSilently()

Puts all currently rendered positions in the out-animation state and keeps it being rendered until all animations have been finished even though the module might be already disabled.

collectValueGroupsRecursively

fun collectValueGroupsRecursively(): Array<ValueGroup>

fun collectValueGroupsRecursively(prefix: String): Sequence<ValueGroup>

collectValuesRecursively

fun collectValuesRecursively(): Array<Value<*>>

fun collectValuesRecursively(prefix: String): Sequence<Value<*>>

color

fun color(name: String, default: Color4b): Value<Color4b>

computedOn

inline fun <E : Event, V> EventListener.computedOn(initialValue: V, priority: Short = 0, crossinline accumulator: (event: E, prev: V) -> V): ReadWriteProperty<EventListener, V>

Returns computed ReadWriteProperty based on the accumulator of specific event.

createEventHook

open override fun <T : Event> EventListener.createEventHook(eventClass: Class<T>, wrappedContext: CoroutineContext, priority: Short, handler: SuspendableEventHandler<T>): EventHook<T>

curve

inline fun curve(name: String, block: CurveValue.Builder.() -> Unit): CurveValue

fun curve(name: String, default: MutableList<Vector2f>, xAxis: CurveValue.Axis, yAxis: CurveValue.Axis, tension: Float = CurveValue.DEFAULT_TENSION): CurveValue

debugGeometry

inline fun DebuggedOwner.debugGeometry(name: String, lazyGeometry: () -> ModuleDebug.DebuggedGeometry?)

debugParameter

inline fun DebuggedOwner.debugParameter(name: String, lazyValue: () -> Any?)

deserializeFrom

open fun deserializeFrom(gson: Gson, element: JsonElement)

Deserialize value from JSON

doNotIncludeAlways

fun doNotIncludeAlways(): Value<MutableCollection<Value<*>>>

doNotIncludeWhen

fun doNotIncludeWhen(condition: () -> Boolean): Value<MutableCollection<Value<*>>>

drop

fun <T : ValueGroup> drop(valueGroup: T): T

easing

fun easing(name: String, default: Easing): ChoiceListValue<Easing>

entityTypes

fun <C : SequencedSet<EntityType<*>>> entityTypes(name: String, default: C): RegistryListValue<C, EntityType<*>>

enumChoice

inline fun <T : Enum<T>, Tagged> enumChoice(name: String, default: T): ChoiceListValue<T>

fun <T : Tagged> enumChoice(name: String, default: T, choices: Set<T>): ChoiceListValue<T>

ExpiringList

@JvmStatic

fun <E> EventListener.ExpiringList(): ExpiringList<E>

file

fun file(name: String, default: File? = null, dialogMode: FileDialogMode = FileDialogMode.OPEN_FILE, supportedExtensions: Set<String>? = null): FileValue

float

fun float(name: String, default: Float, range: ClosedFloatingPointRange<Float>, suffix: String = "", aliases: List<String> = emptyList()): RangedValue<Float>

floatRange

fun floatRange(name: String, default: ClosedFloatingPointRange<Float>, range: ClosedFloatingPointRange<Float>, suffix: String = "", aliases: List<String> = emptyList()): RangedValue<ClosedFloatingPointRange<Float>>

get

fun get(): MutableCollection<Value<*>>

getColor

open fun getColor(id: Int): Color4b

Returns the box color.

getOutlineColor

open fun getOutlineColor(id: Int): Color4b

Returns the outline color.

getTagValue

@JvmName(name = "getTagValue")

fun getTagValue(): Any

getValue

@JvmName(name = "getValue")

fun getValue(): Any

operator fun getValue(u: Any?, property: KProperty<*>): MutableCollection<Value<*>>

Support for delegated properties example: var autoaim by boolean(name = "autoaim", default = true) if(!autoaim) autoaim = true

handler

inline fun <T : Event> EventListener.handler(priority: Short = 0, handler: Consumer<T>): EventHook<T>

fun <T : Event> EventListener.handler(eventClass: Class<T>, priority: Short = 0, handler: Consumer<T>): EventHook<T>

immutable

fun immutable(): Value<MutableCollection<Value<*>>>

independentDescription

fun independentDescription(): Value<MutableCollection<Value<*>>>

int

fun int(name: String, default: Int, range: IntRange, suffix: String = "", aliases: List<String> = emptyList()): RangedValue<Int>

intRange

fun intRange(name: String, default: IntRange, range: IntRange, suffix: String = "", aliases: List<String> = emptyList()): RangedValue<IntRange>

item

fun item(name: String, default: Item): Value<Item>

items

fun <C : SequencedSet<Item>> items(name: String, default: C): RegistryListValue<C, Item>

json

fun json(valueObject: JsonObject)

Assigns the value of the settings to the component

key

fun key(name: String, default: InputConstants.Key = InputConstants.UNKNOWN): Value<InputConstants.Key>

fun key(name: String, default: Int): Value<InputConstants.Key>

mobEffects

fun <C : SequencedSet<MobEffect>> mobEffects(name: String, default: C): RegistryListValue<C, MobEffect>

multiEnumChoice

inline fun <T : Enum<T>, Tagged> multiEnumChoice(name: String, vararg default: T, canBeNone: Boolean = true): MultiChoiceListValue<T?>

inline fun <T : Enum<T>, Tagged> multiEnumChoice(name: String, default: Iterable<T>, canBeNone: Boolean = true): MultiChoiceListValue<T?>

inline fun <T : Enum<T>, Tagged> multiEnumChoice(name: String, default: EnumSet<T> = enumSetOf(), choices: EnumSet<T> = enumSetAllOf(), canBeNone: Boolean = true): MultiChoiceListValue<T?>

inline fun <T : Enum<T>, Tagged> multiEnumChoice(name: String, default: SequencedSet<T>, choices: EnumSet<T> = enumSetAllOf(), canBeNone: Boolean = true): MultiChoiceListValue<T?>

fun <T : Tagged> multiEnumChoice(name: String, default: MutableSet<T>, choices: Set<T>, canBeNone: Boolean, isOrderSensitive: Boolean): MultiChoiceListValue<T>

newEventHook

inline fun <E : Event> EventListener.newEventHook(priority: Short = 0, handler: Consumer<E>): EventHook<E>

notAnOption

fun notAnOption(): Value<MutableCollection<Value<*>>>

once

inline fun <T : Event> EventListener.once(priority: Short = 0, crossinline handler: (T) -> Unit): EventHook<T>

onChange

fun onChange(listener: ValueListener<MutableCollection<Value<*>>>): Value<MutableCollection<Value<*>>>

onChanged

fun onChanged(listener: ValueChangedListener<MutableCollection<Value<*>>>): Value<MutableCollection<Value<*>>>

onDisabled

open override fun onDisabled()

Will be called when the state is toggled off.

onEnabled

open fun onEnabled()

Will be called when the state is toggled on.

onEnabledValueRegistration

open fun onEnabledValueRegistration(value: Value<Boolean>): Value<Boolean>

onToggled

open override fun onToggled(state: Boolean): Boolean

The listener that will be called when the state is toggled. By default, it will simply call onEnabled or onDisabled depending on the state.

fun onToggled(state: Boolean, isParentUpdate: Boolean): Boolean

parent

override fun parent(): EventListener?

Parent EventListener

regex

fun regex(name: String, default: Regex): Value<Regex>

regexList

fun <C : MutableCollection<Regex>> regexList(name: String, default: C): MutableListValue<C, Regex>

removeBlock

fun removeBlock(pos: BlockPos, handlerId: Int = 0)

Removes a block from the rendering, it will get an out animation tho.

removeEventListenerScope

fun EventListener.removeEventListenerScope()

Remove cached scope and cancel it.

repeated

inline fun <T : Event> EventListener.repeated(times: Int = 1, priority: Short = 1, crossinline handler: (T) -> Unit): EventHook<T>

restore

open override fun restore()

Restore all values to their default values

s2cPackets

fun <C : SequencedSet<Identifier>> s2cPackets(name: String, default: C): RegistryListValue<C, Identifier>

sequenceHandler

inline fun <T : Event> EventListener.sequenceHandler(priority: Short = 0, dispatcher: CoroutineDispatcher? = null, onCancellation: Runnable? = null, crossinline eventHandler: SuspendableEventHandler<T>): EventHook<T>

Registers an event hook for events of type T and launches a sequence

set

fun set(t: MutableCollection<Value<*>>)

fun set(t: MutableCollection<Value<*>>, apply: Consumer<in MutableCollection<Value<*>>>)

setByString

open fun setByString(string: String)

setValue

@JvmName(name = "setValue")

fun setValue(t: Value): Result<Unit>

operator fun setValue(u: Any?, property: KProperty<*>, t: MutableCollection<Value<*>>)

sounds

fun <C : SequencedSet<SoundEvent>> sounds(name: String, default: C): RegistryListValue<C, SoundEvent>

suspendHandler

inline fun <T : Event> EventListener.suspendHandler(context: CoroutineContext = EmptyCoroutineContext, priority: Short = 0, behavior: SuspendHandlerBehavior = SuspendHandlerBehavior.Parallel.Default, noinline handler: SuspendableEventHandler<T>): EventHook<T>

Start a Job on event.

text

fun text(name: String, default: String): Value<String>

textList

fun <C : MutableCollection<String>> textList(name: String, default: C): MutableListValue<C, String>

tickHandler

inline fun EventListener.tickHandler(dispatcher: CoroutineDispatcher? = null, onCancellation: Runnable? = null, crossinline eventHandler: suspend CoroutineScope.() -> Unit): EventHook<GameTickEvent>

Registers a repeatable sequence which repeats the execution of code on GameTickEvent.

toString

open override fun toString(): String

tree

fun <T : ValueGroup> tree(valueGroup: T): T

treeAll

fun <T : ValueGroup> treeAll(vararg valueGroups: T)

type

fun type(): ValueType

unbind

fun Value<InputBind>.unbind()

Unbinds the key by setting it to UNKNOWN_KEY.

unregister

open fun unregister()

Unregisters the event handler from the manager. This decision is FINAL! After the class was unregistered we cannot restore the handlers.

until

inline fun <T : Event> EventListener.until(priority: Short = 0, crossinline handler: (T) -> Boolean): EventHook<T>

updateAll

fun updateAll(handlerId: Int = 0)

Updates all culling data.

updateBox

fun updateBox(pos: BlockPos, box: AABB, handlerId: Int = 0)

Updates the box of pos to box.

value

fun <V : Value<*>> value(value: V): V

fun <T : Any> value(name: String, defaultValue: T, valueType: ValueType = ValueType.INVALID, aliases: List<String> = emptyList()): Value<T>

vec2f

fun vec2f(name: String, default: Vector2fc): Value<Vector2fc>

vec3d

@JvmOverloads

fun vec3d(name: String, default: Vec3 = Vec3.ZERO, useLocateButton: Boolean = true, aliases: List<String> = emptyList()): Value<Vec3>

vec3i

@JvmOverloads

fun vec3i(name: String, default: Vec3i = Vec3i.ZERO, useLocateButton: Boolean = true, aliases: List<String> = emptyList()): Value<Vec3i>

waitMatches

inline suspend fun <T : Event> EventListener.waitMatches(priority: Short = 0, predicate: Predicate<T>): T

Wait an event of type T which matches given predicate.

suspend fun <T : Event> EventListener.waitMatches(eventClass: Class<T>, priority: Short, predicate: Predicate<T>): T

waitMatchesWithTimeout

inline suspend fun <T : Event> EventListener.waitMatchesWithTimeout(timeout: Duration, priority: Short = 0, predicate: Predicate<T>): T?

Wait an event of type T which matches given predicate. If the timeout is exceeded, return null.

walkInit

open fun walkInit()

walkKeyPath

fun walkKeyPath(previousBaseKey: String? = null)

Walks the path of the ValueGroup and its children

wrapContinuationInterceptor

fun EventListener.wrapContinuationInterceptor(original: ContinuationInterceptor? = null): ContinuationInterceptor

Wrap the original interceptor and make it auto-detect the listener's running state at suspension to determine whether to resume the continuation.