com.github.shynixn.petblocks.api.business.entity

Interface GUIItemContainer<Player>

public interface GUIItemContainer<Player>

Holds general info about the UI items.

Version 1.1

MIT License

Copyright (c) 2017 by Shynixn

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Method Summary

Modifier and Type	Method and Description
Object	generate(Player player, String... permissions) Generates a new itemStack for the player and his permissions.
Optional<String>	getDisplayName() Returns the displayName of the itemStack if present.
Optional<String>	getExecuteableScript() Returns the optional executable script.
int	getItemDamage() Returns the damage of the item.
int	getItemId() Returns the id of the item.
Optional<String[]>	getLore() Returns the lore of the itemStack if present.
GUIPage	getPage() Returns the guiPage of this container.
int	getPosition() Returns the position of the itemStack in the ui.
String	getSkin() Returns the skin of the itemStack.
boolean	isEnabled() Returns if the itemContainer is enabled.
boolean	isItemUnbreakable() Returns if the item is unbreakable.
void	setEnabled(boolean enabled) Sets the itemContainer enabled.

Method Detail

isEnabled

boolean isEnabled()

Returns if the itemContainer is enabled.

Returns:

enabled

setEnabled

void setEnabled(boolean enabled)

Sets the itemContainer enabled.

Parameters:

enabled - enabled

generate

Object generate(Player player,
                String... permissions)

Generates a new itemStack for the player and his permissions.

Parameters:

player - player

permissions - permission

Returns:

itemStack

getDisplayName

Optional<String> getDisplayName()

Returns the displayName of the itemStack if present.

Returns:

displayName

getLore

Optional<String[]> getLore()

Returns the lore of the itemStack if present.

Returns:

lore

getPosition

int getPosition()

Returns the position of the itemStack in the ui.

Returns:

position

getPage

GUIPage getPage()

Returns the guiPage of this container.

Returns:

guiPage

getSkin

String getSkin()

Returns the skin of the itemStack.

Returns:

skin

getItemId

int getItemId()

Returns the id of the item.

Returns:

itemId

getItemDamage

int getItemDamage()

Returns the damage of the item.

Returns:

itemDamage

isItemUnbreakable

boolean isItemUnbreakable()

Returns if the item is unbreakable.

Returns:

unbreakable

getExecuteableScript

Optional<String> getExecuteableScript()

Returns the optional executable script.

Returns:

script