com.mindlin.clientBridge.api

Class CustomGUI

java.lang.Object

com.mindlin.clientBridge.api.CustomGUI

public class CustomGUI
extends java.lang.Object

A custom GUI that can be sent to the client from this plugin.
Yes, you *can* access a lot of variables, but it's generally a bad idea to change
them unless you understand exactly what they do.

Author:

mailmindlin

Field Summary

Fields

Modifier and Type	Field and Description
java.util.ArrayList<DrawCommand>	backgroundCommands A list of DrawCommands that are drawn first.
static java.util.HashMap<java.lang.String,CustomGUI>	clientRegister Map of registered GUIs.
java.util.ArrayList<GuiButton>	controlList Deprecated.
java.util.ArrayList<DrawCommand>	initCommands A list of DrawCommands that are drawn second.
static int	lastIndex Integer that stores the last GUI_ID, to prevent mismatches
static java.util.HashMap<java.lang.Integer,java.lang.String>	registerIndex Map of GUI_ID to GUI names
ServerInterface	serverInterface Server interface of GUI.

Constructor Summary

Constructors

Constructor and Description
CustomGUI()

Method Summary

Methods

Modifier and Type	Method and Description
static CustomGUI	getActiveGUI(int index) Returns the gui given its GUI_ID Nonexistent GUIs return false; Only retrieves registered guis.
static CustomGUI	getActiveGUI(java.lang.String name) Returns the gui, given its name.
GuiButton	getButtonById(int id) Deprecated.
static CustomGUI	getGUI(java.lang.String name) Returns a GUI, given its name.
int	getIndex() Returns the GUI_ID.
java.lang.String	getName() Returns the registered name of the GUI.
void	initGui() super commands
static boolean	isRegistered(int index) Returns whether the given index is registered.
static boolean	isRegistered(java.lang.String name) Returns whether the given name is registered.
void	log(java.lang.String s) Logs s to console.
void	register()
static void	register(CustomGUI gui, java.lang.String name) Registeres gui with to string name. Puts gui into clientRegister
static void	showGui(int index, BridgePlayer player) Shows a guiof given index to BridgePlayer p.
static void	showGui(java.lang.String name, BridgePlayer player) Shows a registered GUI of given name to BridgePlayer p.
JSONObject	toJSON() Converts GUI into JSON object, to send to client.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientRegister

public static java.util.HashMap<java.lang.String,CustomGUI> clientRegister

Map of registered GUIs. The key is the GUI name.

registerIndex

public static java.util.HashMap<java.lang.Integer,java.lang.String> registerIndex

Map of GUI_ID to GUI names

lastIndex

public static int lastIndex

Integer that stores the last GUI_ID, to prevent mismatches

backgroundCommands

public java.util.ArrayList<DrawCommand> backgroundCommands

A list of DrawCommands that are drawn first.

initCommands

public java.util.ArrayList<DrawCommand> initCommands

A list of DrawCommands that are drawn second.

controlList

@Deprecated
public java.util.ArrayList<GuiButton> controlList

Deprecated.

serverInterface

public ServerInterface serverInterface

Server interface of GUI. Controls which events are sent to server.

Constructor Detail

CustomGUI

public CustomGUI()

Method Detail

getGUI

public static CustomGUI getGUI(java.lang.String name)

Returns a GUI, given its name.

Parameters:

name -

Returns:

GUI

isRegistered

public static boolean isRegistered(java.lang.String name)

Returns whether the given name is registered.

Parameters:

name -

Returns:

if name is registered

isRegistered

public static boolean isRegistered(int index)

Returns whether the given index is registered.

Parameters:

index -

Returns:

if index is registered

register

public static void register(CustomGUI gui,
            java.lang.String name)

Registeres gui with to string name.
Puts gui into clientRegister

Parameters:

gui -

name -

showGui

public static void showGui(java.lang.String name,
           BridgePlayer player)

Shows a registered GUI of given name to BridgePlayer p.

Parameters:

name -

player -

showGui

public static void showGui(int index,
           BridgePlayer player)

Shows a guiof given index to BridgePlayer p.

Parameters:

index -

player -

getActiveGUI

public static CustomGUI getActiveGUI(int index)

Returns the gui given its GUI_ID Nonexistent GUIs return false; Only retrieves registered guis.

Parameters:

index -

Returns:

Active GUI

getActiveGUI

public static CustomGUI getActiveGUI(java.lang.String name)

Returns the gui, given its name. Nonexistent GUIs return false;

Parameters:

name -

Returns:

Active GUI

register

public void register()

getName

public java.lang.String getName()

Returns the registered name of the GUI. Only if GUI has been registered with CustomGUI.register(this,name)

Returns:

GUI name

getIndex

public int getIndex()

Returns the GUI_ID. If not registered, attempts to register self.

Returns:

GUI_ID

log

public void log(java.lang.String s)

Logs s to console.

Parameters:

s -

initGui

public void initGui()

super commands

getButtonById

@Deprecated
public GuiButton getButtonById(int id)

Deprecated.

toJSON

public JSONObject toJSON()

Converts GUI into JSON object, to send to client.

Returns:

JSON representation of GUI