Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
@j1sk1ss
j1sk1ss committed Jul 29, 2024
2 parents 6ba32b8 + 98ebd29 commit 9416f48
Showing 1 changed file with 84 additions and 62 deletions.
146 changes: 84 additions & 62 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,13 @@

# **Main info:**
This is a very simple basis for creating your own menu in Minecraft.</br>
To get started, you will need to create a new inventory: </br>

var window = Bukkit.createInventory(player, 27, Component.text("Test_Inventory"));

Then create a new **MenuWindow** object. This object is representation of your future menu: </br>
To get started, you will need to create a new window: </br>

public static MenuWindow TestMenu = new MenuWindow(new ArrayList<Panel>());

In array list should be placed **Panels**. Panels, in few words, is representation of separated pages in your future menu. Let`s create a simple page:

var testPage = new Panel(new ArrayList<Component>());
var testPage = new Panel(new ArrayList<Component>(), "PanelName", MenuSizes panelSize, String UI, String color); // UI and color give ability to create custom GUI

As you can see, panels should take **Components**. **Components** is a UI objects in your menu. Let`s talk about them a little more:</br>
**Components** presented by next types of UI objects:</br>
Expand All @@ -28,6 +24,7 @@ As you can see, panels should take **Components**. **Components** is a UI object
- **CheckBox**
- **Bar**
- **ClickArea**
- **ItemArea**
- **LittleButton**
- **Icon**
</br>
Expand All @@ -36,103 +33,111 @@ As you can see, panels should take **Components**. **Components** is a UI object

<h2 align="center"> Buttons </h2>

**Buttons** can be created by next code:</br>
GUI **buttons** can be created by next code:</br>

var button = new Button(int firstPos, int secPos, String name, String lore, Action action);
var button = new Button(Margin position, String name, String lore, Action action);

First and second positions - is positions of button`s corners. Main idea you can see on image below:</br>
Position - is positions of button`s corners. Main idea you can see on image below, and usualy you will use next code:</br>

var buttonPosition = new Margin(int row, int col, int h, int w);

</br>
<p align="center">
<img width="600" height="800" src="https://github.com/j1sk1ss/MenuFramework.PC/blob/master/covers/ButtonCoordinates.jpg">
</p>
</br>

Actions for buttons presented as functions that can be added to button and invoked by *button.click(event)*, where *event* is *InventoryClickEvent* (Component click envokes ComponentClickEvent). </br>
Also, example of adding delegate to **button**:

var button = new Button(6, 26, "Name", "Lore",
(event) -> {
var button = new Button(new Margin(0, 0, 3, 3), "Name", "Lore",
(event, menu) -> {
var player = (Player)event.getWhoClicked();
var title = event.getView().getTitle();

player.sendMessage(title);
})


player.sendMessage("Button clicked!");
});

<h2 align="center"> Slider </h2>

**Sliders** can be created by next code:</br>
**Sliders** can be used as a default sliders from popular frameworks. It can be created by next code:</br>

var slider = new Slider(Margin position, ArrayList<String> Options, String lore, String name, Action action);

var slider = new Slider(ArrayList<Integer> coordinates, ArrayList<String> Options, String lore, String name, Action action);
In this case we can use another **margin** constructor. Like next:

var sliderPosition = new Margin(int row, int col, int w, Direction dir); // Direction can be horizontal and vertical.

</br>
<p align="center">
<img width="600" height="800" src="https://github.com/j1sk1ss/MenuFramework.PC/blob/master/covers/SliderCover.png">
</br><text> Red slot - chosen option in slider </text>
</p>
</br>

Note, that slider has default delegate. This "default" delegate regenerate **slider** body on click when chosen parameter changes. </br>
If you need to take chosen param from **Slider**, you can use next code:</br>

var slider = new Slider(panelWhereStoredSlider.getSliders("SliderName"), event.getInventory());
var parameter = slider.getChose(event); // parameter is a String lore line from Options
var currentChosenParameter = PanelWindow.getPanel("PanelWhereSlider").getComponent("SliderName", Slider.class).getChose(event);

This **slider`s** ability give us a opportunity to connect **Buttons** and **Sliders** like in example below:</br>

public static MenuWindow Menu = new MenuWindow(Arrays.asList(
var panel = new Panel(Arrays.asList(
new Slider(Arrays.asList(
0, 1, 2, 3, 4, 5
), Arrays.asList(
"100", "200", "300", "400", "500", "600"
), "", "Slider", null),

new Button(9, 21, "TestButton", "Lore",
(event) -> {
var player = (Player)event.getWhoClicked();
var sliderChose = Menu.getPanel("TestPanel").getSliders("Slider").getChose(event);
if (sliderChose.equals("none")) return;

player.sendMessage(sliderChose); // Will prints current slider parameter
}),
), "TestPanel")));


public static MenuWindow Menu = new MenuWindow(List.of(
new Panel(
List.of(
new Slider(new Margin(0, 0, 4, Direction.Horizontal), Arrays.asList(
"100", "200", "300", "400", "500", "600"
), "SliderLore", "Slider1", null),
new Button(new Margin(1, 0, 2, 2), "TestButton", "Lore",
(event, menu) -> {
var player = (Player)event.getWhoClicked();
var sliderValue = menu.getPanel("TestPanel").getComponent("Slider", Slider.class).getChose(event);
if (sliderChose.equals(Slider.None)) return;
player.sendMessage("Current slider value: " + sliderValue); // Will prints current slider parameter
}),
),
"TestPanel", MenuSizes.FiveLines)
));

<h2 align="center"> Checkbox </h2>

**Checkboxes** can be created by next code:</br>
**Checkboxes** have same functions with buttons instead one addition. Checkboxes, as Sliders, have action on click. Checkbox regenerate himself on every click like checkboxes from popular frameworks. This component can be created by next code:</br>

var checkbox = new Checkbox(int firstSlot, int secondSlot, String name, String lore, Action action);
var checkbox = new Checkbox(Margin position, String name, String lore, Action action, int cdm, int ddm, Material cm, Material dm);
// cdm - Checked data model
// ddm - Default data model
// cm - Checked material
// dm - Default material

</br>
<p align="center">
<img width="600" height="800" src="https://github.com/j1sk1ss/MenuFramework.PC/blob/master/covers/CheckBoxCover.png">
</p>
</br>

Note, that checkbox has default delegate too. This "default" delegate regenerate **checkbox** body on click (Checked and unchecked). </br>
Again. remember, that checkbox has default delegate too. This "default" delegate regenerate **checkbox** body on click (Checked and unchecked). </br>
Here first slot and second slot works like in **Button** part. One difference in method *isChecked*.

var check = checkbox.isChecked(event) // event -> InventoryClickEvent
var check = MainWindow.getPanel("PanelWhereCheckBow").getComponent("checkBox1", CheckBox.class).isChecked(event) // event -> InventoryClickEvent

<h2 align="center"> Click area </h2>
<h2 align="center"> Click area and Item area </h2>

**ClickArea** can be created by next code:</br>

var clickArea = ClickArea(firstCoordinate, secondCoordinate, action, name, lore);
var clickArea = ClickArea(coordinates, action, name, lore);
var clickArea = ClickArea(Margin position, action, name, lore);

**ClickArea** solves problem with generated (non-static) buttons. You can just put **ClickArea** where will be generated non-static **Components** then just handle any clicks in action delegate. </br>
For example next code shoulde handle clicks on generated options in menu:

new ClickArea(0, 44,
(event) -> {
new ClickArea(new Margin(0, 0, 4, 8),
(event, menu) -> {
var player = (Player) event.getWhoClicked();
var option = event.getCurrentItem();
if (option == null) return;

if (option.getLoreLines().size() < 2) return;
var amount = option.getDoubleFromContainer("item-bank-value");

func1(Math.abs(amount), player);
openMenu(player, event.getInventory());
player.sendMessage("You click " + option.getType().toString());
}),

*Note*: **Component** class has his own **PDC**. You can use it with next methods:
Expand All @@ -143,49 +148,66 @@ For example next code shoulde handle clicks on generated options in menu:
public int getIntegerFromContainer(key);
public void deleteKeyFromContainer(key);

</br>
<p align="center">
<img width="600" height="800" src="https://github.com/j1sk1ss/MenuFramework.PC/blob/master/covers/ClickAreaCover.png">
</p>
</br>

<h2 align="center"> Little buttons </h2>

**LittleButton** can be created by next code:</br>
If you want create traditional GUI without resoursepacks, you can use **littleButton**. This component can be created by next code:</br>

var button = new LittleButton(41, "LB", "\n" + Math.round(playerBalance * 100) / 100 + CashManager.currencySigh);
var button = new LittleButton(Margin position, String name, String lore, Action action, Material material, int dataModel);

</br>
<p align="center">
<img width="600" height="800" src="https://github.com/j1sk1ss/MenuFramework.PC/blob/master/covers/LittleButtonCover.png">
</p>
</br>

**LittleButton** works like **Button**, but this component has onlu one position.
*Note*: **LittleButton** works like **Button**.

<h2 align="center"> Icons </h2>

**Icon** can be created by next code:</br>
**Icon** looks like **LittleButtons**, but difference in action. **Icons** don`t have action on click, that`s why you can use them as decoration. This component can be created by next code:</br>

var icon = Icon(position, name, lore, material, dataModel);
var icon = Icon(Margin position, String name, String lore, Material material, int dataModel);

<h2 align="center"> How to use it? </h2>

**Components** placed in **panels**. **Panels** placed in **Menu**. After all preparations we can start using all stuff what we make earlier.</br>

public static MenuWindow Menu = ... // Create new menu with panels
public static MenuWindow Menu = new MenuWindow(new Panel(List.of(new Button(...), new Slider(...))), "MenuName", new LocalizationManager("path")) // Create new menu with panels

After this, MenuFramework listen all inventory clicks and anvoke functions that was linked to **buttons** in **panels**.
After this, MenuFramework listen all inventory clicks and invoke functions that was linked to **components** in **panels**.

<h2 align="center"> Panel </h2>

**Panel** is a representation of every inventory that used as menu in your plugin. Creation of panel is simple:

var panel = new Panel(Arrays.asList( ... ), "InventoryTitlePart", MenuSizes.SixLines);
var panel = new Panel(Arrays.asList( ... ), "InventoryTitlePart", MenuSizes.SixLines, String UI, Strign color);

</br>
<p align="center">
<img width="600" height="800" src="https://github.com/j1sk1ss/MenuFramework.PC/blob/master/covers/PanelCover.png">
</br><text> Example of panel with click area, stider, checkbox \ button and little button \ icon </text>
</p>
</br>

<h2 align="center"> Localization </h2>

**MenuFramework** support multi-language GUI. For this, you should download **CordellDB** plugin (It used for working with localization files), create **localization file** and insert into **MenuWindow** **LocalizationManager**.</br>
**Localization file** has next structure:</br>

LNG_componentName:translatedName/translatedLore
// For example:
RU_button1:кнопка1/кнопка
EN_кнп:button
IT_button:- // - means, that name not translated

Remember that **MenuFramework** will execute linked function in situation, when used inventory have same name with panel. (Or **panel** name is a part of inventory title). </br>
To place all components to inventory you shoukd use next code:
</br> Remember that **MenuFramework** will execute linked function in situation, when used inventory have same name with panel. (Or **panel** name is a part of inventory title). </br>
To place all components to inventory you should use next code:

public void getView(player);
public void getView(player, inventory);
Expand Down

0 comments on commit 9416f48

Please sign in to comment.