rebar/io.github.pylonmc.rebar.block.base/RebarGroupCulledBlock

RebarGroupCulledBlock

interface RebarGroupCulledBlock : RebarCulledBlock(source)

A variant of RebarCulledBlock that defines groups of RebarGroupCulledBlocks that should be culled together. (i.e. all blocks in the group must be culled for any of the blocks in the group to be culled)

For an example use case, see RebarEntityGroupCulledBlock

Inheritors

RebarEntityGroupCulledBlock

Types

CullingGroup

open class CullingGroup(val id: String, val blocks: MutableSet<RebarGroupCulledBlock> = mutableSetOf())

Properties

cullingGroups

abstract val cullingGroups: Iterable<RebarGroupCulledBlock.CullingGroup>

isCulledAsync

open val isCulledAsync: Boolean

If onVisible and onCulled should be called asynchronously instead of scheduled to be called on the main thread.

Functions

isVisible

abstract fun isVisible(player: Player): Boolean

If the block is currently visible to the player. Used only to determine which io.github.pylonmc.rebar.culling.PlayerCullingConfig interval to use

onCulled

open override fun onCulled(player: Player)

Does not do anything for group culled blocks, see onGroupCulled

onGroupCulled

abstract fun onGroupCulled(player: Player, group: RebarGroupCulledBlock.CullingGroup)

onGroupVisible

abstract fun onGroupVisible(player: Player, group: RebarGroupCulledBlock.CullingGroup)

onVisible

open override fun onVisible(player: Player)

Does not do anything for group culled blocks, see onGroupVisible