me.desht.pneumaticcraft.api.client.pneumatic_helmet

Interface IOptionPage

All Known Implementing Classes:

AbstractSliderOptions, AirConditionerOptions, BlockTrackOptions, ChestplateLauncherOptions, CoordinateTrackerOptions, CoreComponentsOptions, DroneDebuggerOptions, EntityTrackOptions, HackOptions, IOptionPage.SimpleOptionPage, JetBootsOptions, JumpBoostOptions, KickOptions, NullOptions, SearchOptions, SpeedBoostOptions

public interface IOptionPage

An Option Page is the GUI object which holds the control widgets for a particular Pneumatic Armor upgrade. Create and return an instance of this class in IArmorUpgradeClientHandler.getGuiOptionsPage(IGuiScreen).

It is strongly recommended to extend the IOptionPage.SimpleOptionPage class rather than implement this interface directly.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IOptionPage.SimpleOptionPage<T extends IArmorUpgradeClientHandler<?>> Convenience class for simple armor features with no additional settings.

Method Summary

Modifier and Type	Method and Description
boolean	displaySettingsHeader() Should the "Settings" header be displayed?
IGuiScreen	getGuiScreen() Get a reference to the IGuiScreen object.
default java.util.Optional<IKeybindingButton>	getKeybindingButton() Get the keybinding button for this page, if any.
net.minecraft.util.text.IFormattableTextComponent	getPageName() This text is used in the GUI button for this page.
boolean	isToggleable() Can this upgrade be toggled off & on? If true, a checkbox (with the ability to bind a key) will be automatically displayed in this upgrade's GUI.
boolean	keyPressed(int keyCode, int scanCode, int modifiers) Called by Screen.keyPressed(int, int, int) when a key is pressed.
boolean	keyReleased(int keyCode, int scanCode, int modifiers) Called by INestedGuiEventHandler.keyReleased(int, int, int) when a key is released.
boolean	mouseClicked(double x, double y, int button) Called when mouse is clicked via INestedGuiEventHandler.mouseClicked(double, double, int)
boolean	mouseDragged(double mouseX, double mouseY, int button, double dragX, double dragY) Called when the mouse is dragged across the GUI
boolean	mouseScrolled(double x, double y, double dir) Called when the mouse wheel is rolled.
void	populateGui(IGuiScreen gui) Here you can initialize your buttons and stuff like with a Screen.
void	renderPost(com.mojang.blaze3d.matrix.MatrixStack matrixStack, int x, int y, float partialTicks) Called immediately after Screen.render(MatrixStack, int, int, float) Here you can render additional things like text.
void	renderPre(com.mojang.blaze3d.matrix.MatrixStack matrixStack, int x, int y, float partialTicks) Called immediately before Screen.render(MatrixStack, int, int, float)
default int	settingsYposition() Y position from the "Setting" header.
default void	tick() Called immediately after Screen.tick()

Method Detail

getGuiScreen

IGuiScreen getGuiScreen()

Get a reference to the IGuiScreen object. You can use this to get the font renderer, for example.

Returns:

the screen

getPageName

net.minecraft.util.text.IFormattableTextComponent getPageName()

This text is used in the GUI button for this page.

Returns:

the page name

populateGui

void populateGui(IGuiScreen gui)

Here you can initialize your buttons and stuff like with a Screen.

Parameters:

gui - the holding GUI

renderPre

void renderPre(com.mojang.blaze3d.matrix.MatrixStack matrixStack,
               int x,
               int y,
               float partialTicks)

Called immediately before Screen.render(MatrixStack, int, int, float)

Parameters:

matrixStack - the matrix stack

x - mouse X

y - mouse Y

partialTicks - partial ticks since last world ticks

renderPost

void renderPost(com.mojang.blaze3d.matrix.MatrixStack matrixStack,
                int x,
                int y,
                float partialTicks)

Called immediately after Screen.render(MatrixStack, int, int, float) Here you can render additional things like text.

Parameters:

matrixStack - the matrix stack

x - mouse X

y - mouse Y

partialTicks - partial ticks since last world ticks

keyPressed

boolean keyPressed(int keyCode,
                   int scanCode,
                   int modifiers)

Called by Screen.keyPressed(int, int, int) when a key is pressed.

Parameters:

keyCode - typed keycode

scanCode - the scan code (rarely useful)

modifiers - key modifiers

Returns:

true if the event has been handled, false otherwise

keyReleased

boolean keyReleased(int keyCode,
                    int scanCode,
                    int modifiers)

Called by INestedGuiEventHandler.keyReleased(int, int, int) when a key is released.

Parameters:

keyCode - typed keycode

scanCode - the scan code (rarely useful)

modifiers - key modifiers

Returns:

true if the event has been handled, false otherwise

mouseClicked

boolean mouseClicked(double x,
                     double y,
                     int button)

Called when mouse is clicked via INestedGuiEventHandler.mouseClicked(double, double, int)

Parameters:

x - mouse X

y - mouse Y

button - mouse button

Returns:

true if the event has been handled, false otherwise

mouseScrolled

boolean mouseScrolled(double x,
                      double y,
                      double dir)

Called when the mouse wheel is rolled.

Parameters:

x - mouse X

y - mouse Y

dir - scroll direction

Returns:

true if the event has been handled, false otherwise

mouseDragged

boolean mouseDragged(double mouseX,
                     double mouseY,
                     int button,
                     double dragX,
                     double dragY)

Called when the mouse is dragged across the GUI

Parameters:

mouseX - mouse X

mouseY - mouse Y

button - mouse button

dragX - drag X

dragY - drag Y

Returns:

true if the event has been handled, false otherwise

isToggleable

boolean isToggleable()

Can this upgrade be toggled off & on? If true, a checkbox (with the ability to bind a key) will be automatically displayed in this upgrade's GUI.

Returns:

true if the upgrade is toggleable, false otherwise

displaySettingsHeader

boolean displaySettingsHeader()

Should the "Settings" header be displayed?

Returns:

true if the header should be displayed, false otherwise

settingsYposition

default int settingsYposition()

Y position from the "Setting" header. The default is fine in most cases, but if your options page has many buttons (e.g. like the Block Tracker), you may wish to adjust this.

Returns:

Y position, default 115

tick

default void tick()

Called immediately after Screen.tick()

getKeybindingButton

default java.util.Optional<IKeybindingButton> getKeybindingButton()

Get the keybinding button for this page, if any. You can create a keybinding button with IPneumaticHelmetRegistry.makeKeybindingButton(int, KeyBinding).

Returns:

the keybinding button, or Optional.empty() if there isn't one