event

Documentation

Index

• type Dispatcher
  • func (dispatcher *Dispatcher[T]) AddListener(listener Listener[T]) int
  • func (dispatcher *Dispatcher[T]) Fire(event Event[T], arguments ...any) bool
  • func (dispatcher *Dispatcher[T]) HasListener(id int) bool
  • func (dispatcher *Dispatcher[T]) Ordered() bool
  • func (dispatcher *Dispatcher[T]) RemoveListener(id int) bool
  • func (dispatcher *Dispatcher[T]) SetOrdered(ordered bool)
• type Event
• type Listener
  • func Listen[T comparable, E Event[T], H ~func(E, ...any)](eventType T, handler H) Listener[T]

Types

type Dispatcher

type Dispatcher[T comparable] struct {
	// contains filtered or unexported fields
}

Dispatcher manages event listeners

func (*Dispatcher[T]) AddListener

func (dispatcher *Dispatcher[T]) AddListener(listener Listener[T]) int

AddListener registers a Listener

func (*Dispatcher[T]) Fire

func (dispatcher *Dispatcher[T]) Fire(event Event[T], arguments ...any) bool

Fire fires event

func (*Dispatcher[T]) HasListener

func (dispatcher *Dispatcher[T]) HasListener(id int) bool

HasListener reports whether dispatcher has specified listener

func (*Dispatcher[T]) Ordered

func (dispatcher *Dispatcher[T]) Ordered() bool

Ordered reports whether the listeners fired by added order

func (*Dispatcher[T]) RemoveListener

func (dispatcher *Dispatcher[T]) RemoveListener(id int) bool

RemoveListener removes specified listener

func (*Dispatcher[T]) SetOrdered

func (dispatcher *Dispatcher[T]) SetOrdered(ordered bool)

SetOrdered sets whether the listeners fired by added order

type Event

type Event[T comparable] interface {
	Typeof() T // Type gets type of event
}

Event is the interface that wraps the basic Type method.

type Listener

type Listener[T comparable] interface {
	EventType() T            // EventType gets type of listening event
	Handle(Event[T], ...any) // Handle handles fired event
}

A Listener handles fired event

func Listen

func Listen[T comparable, E Event[T], H ~func(E, ...any)](eventType T, handler H) Listener[T]

Listen creates a Listener by eventType and handler function