geary-core/com.mineinabyss.geary.systems/Listener

Listener

abstract class Listener : AccessorOperations, System, AccessorScopeSelector

Guide: Listeners

Exposes a way to match against certain combinations of source/target/event entities present on a fired event.

Handlers can be defined inside by annotating a function with Handler, these are the actual functions that run when a matching event is found.

Constructors

Listener

constructor()

Functions

get

inline fun <T : Component> get(): AccessorBuilder<ComponentAccessor<T>>

Gets a component, ensuring it is on the entity.

getOrDefault

inline fun <T : Component?> getOrDefault(default: T): AccessorBuilder<ComponentOrDefaultAccessor<T>>

Gets a component or provides a default if the entity doesn't have it.

getOrNull

inline fun <T : Component?> getOrNull(): AccessorBuilder<ComponentOrDefaultAccessor<T?>>

Gets a component or null if the entity doesn't have it.

getRelations

inline fun <K : Component?, T : Component?> getRelations(): AccessorBuilder<RelationWithDataAccessor<K, T>>

Queries for a specific relation or by kind/target.

getValue

operator fun <T> Accessor<T>.getValue(thisRef: EventScope, property: KProperty<*>): T

operator fun <T> Accessor<T>.getValue(thisRef: SourceScope, property: KProperty<*>): T

operator fun <T> Accessor<T>.getValue(thisRef: TargetScope, property: KProperty<*>): T

onAdd

inline fun <T : Component> onAdd(): Family

Fires when an entity has a component of type T added, updates are not considered since no data changes.

onEvent

fun Family.onEvent(): DirectAccessor<Family>

fun <T> AccessorBuilder<ComponentAccessor<T>>.onEvent(): ComponentAccessor<T>

onFirstSet

inline fun <T : Component> onFirstSet(): AccessorBuilder<ComponentAccessor<T>>

Fires when an entity has a component of type T set, only if it was not set before.

onSet

inline fun <T : Component> onSet(): AccessorBuilder<ComponentAccessor<T>>

Fires when an entity has a component of type T set or updated.

onSource

fun Family.onSource(): DirectAccessor<Family>

fun <T> AccessorBuilder<ComponentAccessor<T>>.onSource(): ComponentAccessor<T>

onStart

open fun onStart()

onTarget

fun Family.onTarget(): DirectAccessor<Family>

fun <T> AccessorBuilder<ComponentAccessor<T>>.onTarget(): ComponentAccessor<T>

start

fun start()

Properties

event

val event: AccessorHolder

source

val source: AccessorHolder

target

val target: AccessorHolder