BattleRulesBaseScreen (Pixelmon 1.16.5-9.1.7-pipe20926 API)

java.lang.Object
- net.minecraft.client.gui.AbstractGui
- - net.minecraft.client.gui.FocusableGui
  - - net.minecraft.client.gui.screen.Screen
    - - com.pixelmonmod.pixelmon.client.gui.widgets.DropDownScreen
      - com.pixelmonmod.pixelmon.client.gui.battles.rules.BattleRulesBaseScreen

All Implemented Interfaces:

IImportableContainer, net.minecraft.client.gui.IGuiEventListener, net.minecraft.client.gui.INestedGuiEventHandler, net.minecraft.client.gui.IRenderable, net.minecraft.client.gui.screen.IScreen

Direct Known Subclasses:

BattleRulesFixedScreen, BattleRulesNPCEditorScreen, BattleRulesPlayerScreen
```
public abstract class BattleRulesBaseScreen
extends DropDownScreen
implements IImportableContainer
```
Base screen for selecting rules for a battle.

Field Summary

Fields
Modifier and Type	Field and Description
`protected net.minecraft.client.gui.widget.button.Button`	`battleTypeButton` The button used to switch between battle types.
`protected int`	`centerX` The x coordinate of the screen's center.
`protected int`	`centerY` The y coordinate of the screen's center.
`protected int`	`clauseListHeight` The height of clause lists.
`protected net.minecraft.client.gui.widget.button.Button[]`	`editButtons` Buttons used to edit the rules.
`protected boolean`	`editingEnabled` Whether rules can be edited.
`protected OnOffButton`	`fullHealButton` The button used to toggle full healing.
`protected net.minecraft.client.gui.widget.button.Button`	`importExportButton` The button used to navigate to the import/export screen.
`protected OnOffButton`	`raiseToCapButton` The button used to toggle the raise-to-cap rule.
`protected int`	`rectBottom` The y coordinate of the bottom of the screen.
`protected java.util.List<DescriptiveText>`	`ruleLabels` Rule labels and their descriptions.
`protected BattleRules`	`rules` The battle rules that are currently being edited in the screen.
`protected java.util.List<BattleClause>`	`selectedClauses` The clauses that have been selected to be included in the rules.
`protected OnOffButton`	`teamPreviewButton` The button used to toggle team preview.
`protected java.util.List<net.minecraft.client.gui.widget.TextFieldWidget>`	`textFields` All text fields in the screen.
`protected DropDown<Tier>`	`tierMenu` The drop-down menu for tier selection.
`protected int`	`yChange` Changes the default y coordinates of screen elements.

Fields inherited from class com.pixelmonmod.pixelmon.client.gui.widgets.DropDownScreen
dropDownManager, guiLeft, guiTop, xSize, ySize

Fields inherited from class net.minecraft.client.gui.screen.Screen
buttons, children, font, height, itemRenderer, minecraft, passEvents, title, width

Fields inherited from class net.minecraft.client.gui.AbstractGui
BACKGROUND_LOCATION, GUI_ICONS_LOCATION, STATS_ICON_LOCATION

Constructor Summary

Constructors
Constructor and Description

BattleRulesBaseScreen()
Initializes a battle rules screen.

Constructors
Constructor and Description
`BattleRulesBaseScreen()` Initializes a battle rules screen.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`actionPerformed(net.minecraft.client.gui.widget.button.Button button)`
`boolean`	`charTyped(char key, int keyCode)`
`protected void`	`dimScreen(com.mojang.blaze3d.matrix.MatrixStack matrix)` Darkens the whole screen.
`protected boolean`	`disableMenus()` Checks if drop-down menus are disabled and uninteractable.
`protected void`	`drawBackgroundUnderMenus(com.mojang.blaze3d.matrix.MatrixStack matrix, float partialTicks, int mouseX, int mouseY)` Draws the screen background under the drop-down menus.
`protected int`	`getBackgroundHeight()` Returns the height of the background rectangle.
`java.lang.String`	`getExportText()` Gets exportable text for the current Pokémon.
`net.minecraft.client.gui.screen.Screen`	`getScreen()` Returns the screen containing the import/export.
`protected void`	`highlightButtons(com.mojang.blaze3d.matrix.MatrixStack matrix, int highlightOffsetX, int bottomOffset)` Highlights a part of the screen where buttons appear.
`java.lang.String`	`importText(java.lang.String importText)` Parses import text and saves it to the current Pokémon.
`void`	`init()`
`boolean`	`mouseClickedUnderMenus(double x, double y, int mouseButton)` Handles mouse input when a drop-down menu is not clicked.
`protected void`	`registerRules()` Registers entered fields in the screen into the rules object.
`void`	`removed()`
`void`	`setRules(BattleRules rules)` Updates the screen with a new set of rules.

Methods inherited from class com.pixelmonmod.pixelmon.client.gui.widgets.DropDownScreen
addDropDown, drawGuiContainerBackgroundLayer, drawGuiContainerForegroundLayer, isPauseScreen, mouseClicked, mouseDragged, mouseScrolled, removeDropDown, render

Methods inherited from class net.minecraft.client.gui.screen.Screen
addButton, addWidget, children, getMinecraft, getNarrationMessage, getTitle, getTooltipFromItem, handleComponentClicked, hasAltDown, hasControlDown, hasShiftDown, init, insertText, isCopy, isCut, isMouseOver, isPaste, isSelectAll, isValidCharacterForName, keyPressed, onClose, onFilesDrop, renderBackground, renderBackground, renderComponentHoverEffect, renderComponentTooltip, renderDirtBackground, renderTooltip, renderTooltip, renderTooltip, renderToolTip, renderWrappedToolTip, resize, sendMessage, sendMessage, shouldCloseOnEsc, tick, wrapScreenError

Methods inherited from class net.minecraft.client.gui.FocusableGui
getFocused, isDragging, setDragging, setFocused

Methods inherited from class net.minecraft.client.gui.AbstractGui
blit, blit, blit, blit, blit, blitOutlineBlack, drawCenteredString, drawCenteredString, drawString, drawString, fill, fillGradient, fillGradient, getBlitOffset, hLine, setBlitOffset, vLine

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pixelmonmod.pixelmon.client.gui.pokemoneditor.IImportableContainer
getPokemon, setPokemon

Methods inherited from interface net.minecraft.client.gui.INestedGuiEventHandler
changeFocus, getChildAt, keyReleased, magicalSpecialHackyFocus, mouseReleased, setInitialFocus

Methods inherited from interface net.minecraft.client.gui.IGuiEventListener
mouseMoved

- Field Detail
  - rules
```
protected BattleRules rules
```
    The battle rules that are currently being edited in the screen.
  - textFields
```
protected java.util.List<net.minecraft.client.gui.widget.TextFieldWidget> textFields
```
    All text fields in the screen.
  - editingEnabled
```
protected boolean editingEnabled
```
    Whether rules can be edited.
  - importExportButton
```
protected net.minecraft.client.gui.widget.button.Button importExportButton
```
    The button used to navigate to the import/export screen.
  - raiseToCapButton
```
protected OnOffButton raiseToCapButton
```
    The button used to toggle the raise-to-cap rule.
  - battleTypeButton
```
protected net.minecraft.client.gui.widget.button.Button battleTypeButton
```
    The button used to switch between battle types.
  - fullHealButton
```
protected OnOffButton fullHealButton
```
    The button used to toggle full healing.
  - teamPreviewButton
```
protected OnOffButton teamPreviewButton
```
    The button used to toggle team preview.
  - editButtons
```
protected net.minecraft.client.gui.widget.button.Button[] editButtons
```
    Buttons used to edit the rules.
  - ruleLabels
```
protected java.util.List<DescriptiveText> ruleLabels
```
    Rule labels and their descriptions.
  - selectedClauses
```
protected java.util.List<BattleClause> selectedClauses
```
    The clauses that have been selected to be included in the rules.
  - centerX
```
protected int centerX
```
    The x coordinate of the screen's center.
  - centerY
```
protected int centerY
```
    The y coordinate of the screen's center.
  - rectBottom
```
protected int rectBottom
```
    The y coordinate of the bottom of the screen.
  - yChange
```
protected int yChange
```
    Changes the default y coordinates of screen elements.
  - clauseListHeight
```
protected int clauseListHeight
```
    The height of clause lists.
  - tierMenu
```
protected DropDown<Tier> tierMenu
```
    The drop-down menu for tier selection.
- Constructor Detail
  - BattleRulesBaseScreen
```
public BattleRulesBaseScreen()
```
    Initializes a battle rules screen.
- Method Detail
  - init
```
public void init()
```
    Overrides:
    
    init in class DropDownScreen
  - setRules
```
public void setRules(BattleRules rules)
```
    Updates the screen with a new set of rules.
    
    Parameters:
    
    rules - The rules to update the screen with.
  - drawBackgroundUnderMenus
```
protected void drawBackgroundUnderMenus(com.mojang.blaze3d.matrix.MatrixStack matrix,
                                        float partialTicks,
                                        int mouseX,
                                        int mouseY)
```
    Description copied from class: DropDownScreen
    
    Draws the screen background under the drop-down menus. Disables mouse hovering if over a menu.
    
    Specified by:
    
    drawBackgroundUnderMenus in class DropDownScreen
    
    partialTicks - The current number of partial ticks.
    
    mouseX - The x coordinate of the mouse.
    
    mouseY - The y coordinate of the mouse.
  - getBackgroundHeight
```
protected int getBackgroundHeight()
```
    Returns the height of the background rectangle.
    
    Returns:
    
    The height of the background rectangle.
  - charTyped
```
public boolean charTyped(char key,
                         int keyCode)
```
    Specified by:
    
    charTyped in interface net.minecraft.client.gui.IGuiEventListener
    
    Specified by:
    
    charTyped in interface net.minecraft.client.gui.INestedGuiEventHandler
  - mouseClickedUnderMenus
```
public boolean mouseClickedUnderMenus(double x,
                                      double y,
                                      int mouseButton)
```
    Description copied from class: DropDownScreen
    
    Handles mouse input when a drop-down menu is not clicked.
    
    Overrides:
    
    mouseClickedUnderMenus in class DropDownScreen
    
    Parameters:
    
    x - The x coordinate of the mouse.
    
    y - The y coordinate of the mouse.
    
    mouseButton - The index of the clicked button.
  - actionPerformed
```
protected void actionPerformed(net.minecraft.client.gui.widget.button.Button button)
```
  - registerRules
```
protected void registerRules()
```
    Registers entered fields in the screen into the rules object.
  - getExportText
```
public java.lang.String getExportText()
```
    Description copied from interface: IImportableContainer
    
    Gets exportable text for the current Pokémon.
    
    Specified by:
    
    getExportText in interface IImportableContainer
    
    Returns:
    
    Exportable text for the current Pokémon.
  - importText
```
public java.lang.String importText(java.lang.String importText)
```
    Description copied from interface: IImportableContainer
    
    Parses import text and saves it to the current Pokémon.
    
    Specified by:
    
    importText in interface IImportableContainer
    
    Parameters:
    
    importText - The text to save to the current Pokémon.
    
    Returns:
    
    Null if the import was successful, or an error description if the import failed.
  - removed
```
public void removed()
```
    Overrides:
    
    removed in class net.minecraft.client.gui.screen.Screen
  - dimScreen
```
protected void dimScreen(com.mojang.blaze3d.matrix.MatrixStack matrix)
```
    Darkens the whole screen.
  - highlightButtons
```
protected void highlightButtons(com.mojang.blaze3d.matrix.MatrixStack matrix,
                                int highlightOffsetX,
                                int bottomOffset)
```
    Highlights a part of the screen where buttons appear.
    
    Parameters:
    
    highlightOffsetX - Half of the width of the highlight box.
    
    bottomOffset - The offset from the bottom of the box that the top of the highlight will be at.
  - getScreen
```
public net.minecraft.client.gui.screen.Screen getScreen()
```
    Description copied from interface: IImportableContainer
    
    Returns the screen containing the import/export.
    
    Specified by:
    
    getScreen in interface IImportableContainer
    
    Returns:
    
    The screen containing the import/export.
  - disableMenus
```
protected boolean disableMenus()
```
    Description copied from class: DropDownScreen
    
    Checks if drop-down menus are disabled and uninteractable.
    
    Overrides:
    
    disableMenus in class DropDownScreen
    
    Returns:
    
    Whether drop-down menus are disabled and uninteractable.

Class BattleRulesBaseScreen

Field Summary

Fields inherited from class com.pixelmonmod.pixelmon.client.gui.widgets.DropDownScreen

Fields inherited from class net.minecraft.client.gui.screen.Screen

Fields inherited from class net.minecraft.client.gui.AbstractGui

Constructor Summary

Method Summary

Methods inherited from class com.pixelmonmod.pixelmon.client.gui.widgets.DropDownScreen

Methods inherited from class net.minecraft.client.gui.screen.Screen

Methods inherited from class net.minecraft.client.gui.FocusableGui

Methods inherited from class net.minecraft.client.gui.AbstractGui

Methods inherited from class java.lang.Object

Methods inherited from interface com.pixelmonmod.pixelmon.client.gui.pokemoneditor.IImportableContainer

Methods inherited from interface net.minecraft.client.gui.INestedGuiEventHandler

Methods inherited from interface net.minecraft.client.gui.IGuiEventListener

Field Detail

rules

textFields

editingEnabled

importExportButton

raiseToCapButton

battleTypeButton

fullHealButton

teamPreviewButton

editButtons

ruleLabels

selectedClauses

centerX

centerY

rectBottom

yChange

clauseListHeight

tierMenu

Constructor Detail

BattleRulesBaseScreen

Method Detail

init

setRules

drawBackgroundUnderMenus

getBackgroundHeight

charTyped

mouseClickedUnderMenus

actionPerformed

registerRules

getExportText

importText

removed

dimScreen

highlightButtons

getScreen

disableMenus