Index

C E F G I M O P S U
All Classes and Interfaces|All Packages

C

com.pixerena.firework - module com.pixerena.firework

This is the main module for the Firework framework.

Component - Annotation Interface in io.github.pixerena.firework.inject

Annotation to mark a class as a component.

create() - Static method in interface io.github.pixerena.firework.reactive.Signal

Creates a signal with no initial value, which will be set as null.

create(Runnable) - Static method in interface io.github.pixerena.firework.reactive.Effect

Creates an effect.

create(Supplier<T>) - Static method in interface io.github.pixerena.firework.reactive.Memo

Creates a readonly derived reactive memoized signal

create(T) - Static method in interface io.github.pixerena.firework.reactive.Signal

Creates a signal with an initial value.

E

Effect - Interface in io.github.pixerena.firework.reactive

An effect is a function that is executed when it is created or its inner signal is changed.

EventListener - Annotation Interface in io.github.pixerena.firework.event

Marks a class as an event listener.

F

FireworkPlugin - Class in io.github.pixerena.firework

This class is the main class of the Firework framework and the entrypoint for the plugin.

FireworkPlugin(String...) - Constructor for class io.github.pixerena.firework.FireworkPlugin

Creates a new instance of FireworkPlugin.

G

get() - Method in interface io.github.pixerena.firework.reactive.Memo

Gets the value of the memo.

getContent() - Method in class io.github.pixerena.firework.ui.PlayerActionBar

Get the content of action bar.

getLine(int) - Method in class io.github.pixerena.firework.ui.Sidebar

Returns the line of given position of the sidebar content.

getLineCount() - Method in class io.github.pixerena.firework.ui.Sidebar

Returns the number of lines of the sidebar content.

getPlayers() - Method in class io.github.pixerena.firework.ui.PlayerActionBar

Get the players that will receive the action bar.

getTitle() - Method in class io.github.pixerena.firework.ui.Sidebar

Returns the title of the sidebar.

I

io.github.pixerena.firework - package io.github.pixerena.firework

Main class for the Firework framework and paper plugin entry point.

io.github.pixerena.firework.event - package io.github.pixerena.firework.event

Annotations for handling Bukkit's event listeners.

io.github.pixerena.firework.inject - package io.github.pixerena.firework.inject

Annotations for dependency injection.

io.github.pixerena.firework.lifecycle - package io.github.pixerena.firework.lifecycle

Annotations for the lifecycle hook of the plugin.

io.github.pixerena.firework.reactive - package io.github.pixerena.firework.reactive

Classes that provides the reactive programming functionality.

io.github.pixerena.firework.ui - package io.github.pixerena.firework.ui

Classes provides Minecraft UI with reactivity.

isDisplayed() - Method in class io.github.pixerena.firework.ui.Sidebar

Returns whether the sidebar is displayed or not.

M

Memo<T> - Interface in io.github.pixerena.firework.reactive

A memo is a signal that is set when it is created.

O

onDisable() - Method in class io.github.pixerena.firework.FireworkPlugin

OnDisable - Annotation Interface in io.github.pixerena.firework.lifecycle

Marks a method to be called when the plugin is disabled.

onEnable() - Method in class io.github.pixerena.firework.FireworkPlugin

OnEnable - Annotation Interface in io.github.pixerena.firework.lifecycle

Marks a method to be called when the plugin is enabled.

OnFirstTick - Annotation Interface in io.github.pixerena.firework.lifecycle

Marks a method to be called when the server handling the first tick.

onLoad() - Method in class io.github.pixerena.firework.FireworkPlugin

P

PlayerActionBar - Class in io.github.pixerena.firework.ui

PlayerActionBar is a UI component that can be used to show dynamic and persistent action bar to players.

PlayerActionBar() - Constructor for class io.github.pixerena.firework.ui.PlayerActionBar

S

set(T) - Method in interface io.github.pixerena.firework.reactive.Signal

Sets the value of the signal.

Sidebar - Class in io.github.pixerena.firework.ui

Inherit this class to create a sidebar.

Sidebar() - Constructor for class io.github.pixerena.firework.ui.Sidebar

Signal<T> - Interface in io.github.pixerena.firework.reactive

A signal is a value that can be set and get.

U

UIComponent - Annotation Interface in io.github.pixerena.firework.ui

Annotate a class with this annotation to create a UI component.

C E F G I M O P S U
All Classes and Interfaces|All Packages