| net.gtaun.shoebill.object.Menu |
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | INVALID_ID | ||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
addItem(int column, String text)
Adds a Item
| ||||||||||
| abstract static Menu |
create(String title, int columns, Vector2D pos, float col1Width, float col2Width)
Create a Menu with params.
| ||||||||||
| abstract static Menu |
create(String title, int columns, float x, float y, float col1Width, float col2Width)
Create a Menu with params.
| ||||||||||
| abstract void |
disable()
Disables the Menu
| ||||||||||
| abstract void |
disableRow(int row)
Disables the Row
| ||||||||||
| abstract static Menu |
get(int id)
Gets a Menu by its Id
| ||||||||||
| abstract static Collection<Menu> |
get()
Gets all Menus
| ||||||||||
| abstract float |
getColumn1Width()
Gets the width of Column 1.
| ||||||||||
| abstract float |
getColumn2Width()
Gets the width of Column 2.
| ||||||||||
| abstract String[] |
getColumnHeader()
Gets the Column Header.
| ||||||||||
| abstract int |
getColumns()
Get the Column Count.
| ||||||||||
| abstract int |
getId()
Gets the Id of the Menu.
| ||||||||||
| abstract Vector2D |
getPosition()
Gets the Position of the Menu.
| ||||||||||
| abstract String |
getTitle()
Gets the Title of the Menu.
| ||||||||||
| abstract void |
hide(Player player)
Hides the menu for a specific player
| ||||||||||
| abstract void |
setColumnHeader(int column, String text)
Sets the Column Header
| ||||||||||
| abstract void |
show(Player player)
Shows the Menu for a specific player
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
net.gtaun.shoebill.object.Destroyable
| |||||||||||
|
From interface
net.gtaun.shoebill.object.Proxyable
| |||||||||||
Constants
public static final int INVALID_ID
Constant Value:
255
(0x000000ff)
Public Methods
public abstract void addItem (int column, String text)
Adds a Item
Parameters
| column | The Column where the Text will be displayed |
|---|---|
| text | The displayed Text |
public static abstract Menu create (String title, int columns, Vector2D pos, float col1Width, float col2Width)
Create a Menu with params. If the Creation fails, it will throw a CreationFailedException.
Parameters
| title | The Title of the menu. |
|---|---|
| columns | The amount of columns. |
| pos | Vector2D-Position where the Menu should appear. |
| col1Width | The Columnwidth of column 1. |
| col2Width | The Columnwidth of column 2. |
Returns
- The created Menu.
Throws
| CreationFailedException |
|---|
public static abstract Menu create (String title, int columns, float x, float y, float col1Width, float col2Width)
Create a Menu with params. If the Creation fails, it will throw a CreationFailedException.
Parameters
| title | The Title of the menu. |
|---|---|
| columns | The amount of columns. |
| x | X-Pos where the Menu should appear. |
| y | Y-Pos where the Menu should appear. |
| col1Width | The Columnwidth of column 1. |
| col2Width | The Columnwidth of column 2. |
Returns
- The created Menu.
Throws
| CreationFailedException |
|---|
public abstract void disable ()
Disables the Menu
public abstract void disableRow (int row)
Disables the Row
Parameters
| row | Rowid |
|---|
public static abstract Menu get (int id)
Gets a Menu by its Id
Parameters
| id | Id of the Menu |
|---|
Returns
- The Menu
public abstract float getColumn1Width ()
Gets the width of Column 1.
Returns
- Width of Column 1
public abstract float getColumn2Width ()
Gets the width of Column 2.
Returns
- Width of Column 2
public abstract int getColumns ()
Get the Column Count.
Returns
- The Columncount
public abstract int getId ()
Gets the Id of the Menu.
Returns
- The Id of the Menu.
public abstract Vector2D getPosition ()
Gets the Position of the Menu.
Returns
- The Position of the Menu
public abstract void hide (Player player)
Hides the menu for a specific player
Parameters
| player | The Player |
|---|
public abstract void setColumnHeader (int column, String text)
Sets the Column Header
Parameters
| column | The Column Id |
|---|---|
| text | The The displayed Text |
public abstract void show (Player player)
Shows the Menu for a specific player
Parameters
| player | The Player |
|---|