Labels stop being clickable?

yahwho · Mar 30th 2018

Something odd is happening. Probably relating to my lack of understanding.

Code

GuiLabel Label1 = new GuiLabel("TEXT", 10.0f, 25.0f, false);
Label1.setClickable(true);

This works fine, but it appears that when someone logs off, everyone's labels stop being clickable.

Does anyone have a complete mini/simple example of how I should be using "clickable labels" ?

yahwho · Apr 1st 2018

Minotorious · Apr 1st 2018

I am not currently at home but i will write you a small reply soon

yahwho · Apr 1st 2018

Thanks Minotorious! I'm guessing every player needs their own listener object or something like that? But I can't for the love of it work it out!

Minotorious · Apr 2nd 2018

sorry for the long delay but I didn't have any time in the past few days, so yes your problem is basically that you are using the same label for all players.

The way I (and a few others) have handled this is by giving every player their own GUI. That can be done by assigning every player an attribute containing their personal GUI upon spawning (onSpawnEvent, I would recommend not using the onConnectEvent because sometimes the players are not registering correctly in that one since they are not really in the server yet). Make sure the attribute really has a very unique name to not clash with other plugins

Something like this:

Java

@EventMethod
    public void onPlayerSpawn(PlayerSpawnEvent event){
        Player player = event.getPlayer();


        GuiLabel AreaNameLabel = CreateAreaNameGUI("Default Area");
        player.setAttribute("MinoLabel", AreaNameLabel);
        player.addGuiElement(AreaNameLabel);
    }

Where my CreateAreaNameGUI method is:

Java

public GuiLabel CreateAreaNameGUI(String AreaName){
        GuiLabel AreaNameLabel = new GuiLabel(AreaName,0.05f,0.05f,true);
        AreaNameLabel.setPivot(PivotPosition.BottomLeft);
        AreaNameLabel.setFont(Font.Default);
        AreaNameLabel.setFontColor(1.0f, 1.0f, 1.0f, 1.0f);
        AreaNameLabel.setColor(0.0f, 0.0f, 0.0f, 0.6f);
        AreaNameLabel.setFontSize(18);
        return AreaNameLabel;
    }

Then to get the attribute from every player when they want to use their GUI you need something like this (i.e. casting the attribute to the correct object type else it won't know what object to create):

Java

GuiLabel label = (GuiLabel) player.getAttribute("MinoLabel");

yahwho · Apr 2nd 2018

Thanks for the code snippets Minotorious! I will digest what you have suggested and see if I can add implement it!

No worries about the delay pal - I've been busy pondering animal spawning; it looks to me like there is no API call so a direct database write is in order. Much testing and experimentation will need to be done!

yahwho · Apr 5th 2018

Hmm my code albeit different does indeed use unique attribute name for labels, which are unique for each player (the set attribute in part uses the players UID).

Only thing different is my labels are added to panels and then the panels added to the players gui.

I think I'll rewrite the whole GUI (starting with something super super simple) and see if I can stop the listeners from unregistering / being garbage collected.

It will probably turn out I've missed a "new" constructor somewhere.

Minotorious · Apr 6th 2018

If you have a panel with a lot of labels unfortunately each of the labels and the panel separately would need to be added to separate attributes and then all added one at a time to the player's screen. Child - Parent relations are not adhered when adding elements in the RW GUI system. i.e. if I add the parent the children do not get automatically added!

yahwho · Apr 6th 2018

Yep that's what I have done, everything works normally (panels buttons etc for all users), but when a player logs off the listener for clicks (for all remaining users) stops working I'm just about to start another one from scratch. See if I can see where I was going wrong.

And yes - good advice on the onSpawn rather than onConnect - my onConnect method contained a lot! Moved it all to onSpawn instead

Minotorious · Apr 6th 2018

btw just had a thought, do you have a onPlayerDisconnect method and if yes does it contain anything related to the GUI?

yahwho · Apr 6th 2018

Yep there is an onPlayerDisconnectEvent but nothing to do with the GUI in there

Here's an example of how I have done the set attribute

Code

GuiLabel confirm = new GuiLabel(" CONFIRM ", 0.45f, 0.5f, true);


confirm.setClickable(true);


player.setAttribute("confirm" + player.getUID(), (Object)confirm);

Code

public void onPlayerSpawnEvent(PlayerSpawnEvent event) {


this.GuiPlayerPanels(player);


}

Code

@EventMethod
private void GuiPlayerPanels(Player player) {


        GuiPanel confirmBinAreaPanel = new GuiPanel(0.5f, 0.5f, true, 380.0f, 75.0f, false);
        confirmBinAreaPanel.setPivot(PivotPosition.Center);
        confirmBinAreaPanel.setColor(0.0f, 0.0f, 0.0f, 0.75f);
        confirmBinAreaPanel.setVisible(false);
        confirmBinAreaPanel.setClickable(true); //trying to fix bug with this
        player.setAttribute("ConfirmPanel" + player.getUID(), (Object)confirmBinAreaPanel);
        GuiLabel message = new GuiLabel(" You are about to sell this land. ", 0.50f, 0.8f, true);
        GuiLabel message2 = new GuiLabel(" You will recieve " + COST_OF_LAND + " crowns. ", 0.50f, 0.2f, true);
        message.setFontSize(16);
        message2.setFontSize(16);
        message.setPivot(PivotPosition.Center);
        message2.setPivot(PivotPosition.Center);
        player.setAttribute("message" + player.getUID(), (Object)message);
        player.setAttribute("message2" + player.getUID(), (Object)message2);
        GuiLabel confirm = new GuiLabel(" CONFIRM ", 0.45f, 0.5f, true);
        GuiLabel cancel =  new GuiLabel("  CANCEL  ", 0.55f, 0.5f, true);
        confirm.setColor(0.0f, 1.0f, 0.0f, 0.25f);
        cancel.setColor(1.0f, 0.0f, 0.0f, 0.25f);
        confirm.setBorderThickness(1.0f, false);
        cancel.setBorderThickness(1.0f, false);
        confirm.setBorderColor(0.0f, 1.0f, 0.0f, 1.0f);
        cancel.setBorderColor(1.0f, 0.0f, 0.0f, 1.0f);
        confirm.setClickable(true);
        cancel.setClickable(true);
        player.setAttribute("confirm" + player.getUID(), (Object)confirm);
        player.setAttribute("cancel" + player.getUID(), (Object)cancel);


        confirm.setPivot(PivotPosition.CenterRight);
        cancel.setPivot(PivotPosition.CenterLeft);
       confirmBinAreaPanel.addChild(message);
       confirmBinAreaPanel.addChild(message2);
       confirmBinAreaPanel.addChild(confirm);
       confirmBinAreaPanel.addChild(cancel);
       player.addGuiElement(message);
       player.addGuiElement(message2);
       player.addGuiElement(confirm);
       player.addGuiElement(cancel);
       player.addGuiElement(confirmBinAreaPanel);


        GuiLabel protectionLabel = new GuiLabel(0.5f, 0.98f, true);
	protectionLabel.setPivot(PivotPosition.Center);
	protectionLabel.setAlpha(0.5f);


	protectionLabel.setFont(Font.DefaultMono_Bold);	


	protectionLabel.setFontSize(16);
        player.setAttribute("ProtectionStatus", (Object)protectionLabel);
        player.addGuiElement(protectionLabel);
    }

Display More

Defo a weird one, it's like the event listeners gets garbage collected when a player disconnects.

Minotorious · Apr 6th 2018

The attributes don't really need to be unique between players, they just need to be unique between plugins (e.g. if one plugin sets a string attribute named Job and another plugin names an int attribute named Job again they will probably crash each other), but that shouldn't be your problem anyway.

Why are you casting the GuiLabel into an object in the setAttribute() method? imo there is no need for that, but again don't think that is your problem either.

Do you at any point in your code use the GUIElement .destroy() method?
Do you by any chance get any errors when other people try to use the plugin GUI after someone has disconnected?

yahwho · Apr 6th 2018

Yeah the + player.getUID was added as I've tried (desperately) to fix the problem (same issue though with or without it).

Casting into a label was just done for personal reasons - ease of reading code! (I know they're all objects and dont need the implicit cast).

Nope I don't use GUIElement.destroy()

And nope again, I don't get any kind of errors at all.

See! A really easy logic bug!

noci · Apr 6th 2018

the same error occurs on "PlayerGuiElementClickEvent" after logging out of a player.
I've tested it so far that I spend after signing off a player the status of my GuiElemente, they are all right. The data stored in attributes also fit. There will be no event triggered.

yahwho · Apr 6th 2018

zumindest ist es nicht nur ich

und

"Ich habe einen PlayerDisconnectEvent hinzugefügt und lasse mir player.isListeningForKeyInput() und z.b. player.Attribute.GuiImage.isClickable() für alle Spieler ausgeben, sie sind nach dem Abmelden eines Spielers TRUE. "

I had not thought of that - good idea for testing!

Although I suspect I will have the same problem as you. . .

yahwho · Apr 6th 2018

OK so I have started again on a GUI to try and work this out using the most minimal of code. I have removed the panels and I am just working on one single label that is set to be clickable.

Here is the complete code for the plugin.

All it does is listen for a key press (R key). When a player presses R it sets the mouse cursor to visible, so we should be able to click on an element.

The element is a single label in the bottom left hand corner of the screen with the text "Test text which should be clickable. . ." (of course this is set to setClickable(true).

Now, when this plugin is run and a player presses the R key the listener onPlayerGuiElementClickEvent is never called whilst clicking on the label?

Code

package org.yahwho.medievalrealmsgui;


import net.risingworld.api.Plugin;
import net.risingworld.api.events.EventMethod;
import net.risingworld.api.events.Listener;
import net.risingworld.api.events.player.PlayerKeyEvent;
import net.risingworld.api.events.player.PlayerSpawnEvent;
import net.risingworld.api.events.player.gui.PlayerGuiElementClickEvent;
import net.risingworld.api.gui.GuiLabel;
import net.risingworld.api.gui.GuiPanel;
import net.risingworld.api.objects.Player;


public class MedievalRealmsGUI extends Plugin  implements Listener {


    @Override
    public void onEnable() {
        registerEventListener(this);

    }


    @Override
    public void onDisable() {

    }



    
    @EventMethod
    public void onPlayerGuiClick(PlayerGuiElementClickEvent evt){

        System.out.println("Testing one two three, anyone there?");

    }

    @EventMethod
    public void onPlayerSpawnEvent(PlayerSpawnEvent event) {

        Player player = event.getPlayer();
        player.registerKeys(new int[]{19});
        player.setListenForKeyInput(true);
        this.GuiPlayerPanels(player);

    }  

    @EventMethod
    public void onPlayerKeyInput(PlayerKeyEvent event) {

        Player player = event.getPlayer();

        if (event.isPressed() && event.getKeyCode() == 19 ) { 

            System.out.println("R key pressed so let us make the cursor visible so we can get element click events. . .");

            player.setMouseCursorVisible(true);

        }

    }


    @EventMethod
    private void GuiPlayerPanels(Player player) {


        GuiPanel gp = new GuiPanel();
        gp.setAlpha(0.5f);
        gp.setClickable(true);
        GuiLabel gl = new GuiLabel(0.1f, 0.1f, true);
        gl.setVisible(true);
        gl.setText("Test text which should be clickable. . .");
        gl.setClickable(true);
        player.setAttribute("LabelTest", gl);
        player.addGuiElement(gl);
        player.addGuiElement(gp);


    } 

}

Display More

yahwho · Apr 6th 2018

~~oops think I missed an @EventMethod ill edit. . .~~

I have also tried changing the PlayerGuiElementClickEvent to onPlayerGuiClick

It's the same behaviour, works fine, but as soon as anyone else disconnects from the server, this is no longer works.

noci · Apr 6th 2018

Quote from yahwho

40. @EventMethod

you do not need that, I do not know if that makes any problems. That's to start plugin events, you have a simple function.

Quote from yahwho

event.getKeyCode() == 19

I would use the static fields constant "KEY_R"

otherwise that looks coherent, only line 40 I would take out.

yahwho · Apr 6th 2018

Quote from noci

you do not need that, I do not know if that makes any problems. That's to start plugin events, you have a simple function.
I would use the static fields constant "KEY_R"

otherwise that looks coherent, only line 40 I would take out.

HA! Key constants! Thank you noci! That will make life a lot easier than using integers! Danks!

But yes, it does look like it is bugged. Maybe @red51 could confirm this? My GUI plans are all on hold at the moment due to this problem

@noci Why would you take out line 40? Because player.registerKeys(new int[]{19}); is enough? edit: just checked - if you take out player.setListenForKeyInput(true); you dont get any input from keys including the registered key(s).

noci · Apr 6th 2018

Quote from yahwho

@noci Why would you take out line 40? Because player.registerKeys(new int[]{19}); is enough? edit: just checked - if you take out player.setListenForKeyInput(true); you dont get any input from keys including the registered key(s).

Line 40 was related to the first source code. After updating it, it is line 61. Because you do not include a plugin event in this funktion.

Participate now!