com.chrismin13.additionsapi.permissions

Class ItemPermissions

java.lang.Object

com.chrismin13.additionsapi.permissions.ItemPermissions

Direct Known Subclasses:

ArmorPermissions, BowPermissions, CarrotStickPermissions, ElytraPermissions, FishingRodPermissions, FlintAndSteelPermissions, HoePermissions, ShearPermissions, ShieldPermissions, SpadePermissions

public class ItemPermissions
extends java.lang.Object

This specifies the permissions that will be checked when using the Custom Item. There are similar classes available for most other types of Custom Items.

Author:

chrismin13

Constructor Summary

Constructors

Constructor and Description
ItemPermissions(java.lang.String permissionPrefix, PermissionType type) Create a new ItemPermissions Object

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBreak()
java.lang.String	getCraft()
java.lang.String	getDrop()
java.lang.String	getHit()
java.lang.String	getPermissionPrefix()
java.lang.String	getPickup()
PermissionType	getType()
ItemPermissions	setBreak(java.lang.String blockBreak) Set the permission node for breaking a block.
void	setCraft(java.lang.String craft) Set the permission node for Crafting the Custom Item.
void	setDrop(java.lang.String drop) Set the permission node for Dropping the Custom Item by a Player.
ItemPermissions	setHit(java.lang.String hit) Set the permission node for hitting another entity.
void	setPermissionPrefix(java.lang.String permissionPrefix) Set the first part of the Permission Node.
void	setPickup(java.lang.String pickUp) Set the permission node for a player to pick up the Custom Item.
void	setType(PermissionType type) Set the PermissionType.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemPermissions

public ItemPermissions(java.lang.String permissionPrefix,
                       PermissionType type)

Create a new ItemPermissions Object

Parameters:

permissionPrefix - The first part of the permission node - must be simmilar to "plugin_name.item_name". By default, this is taken from the Custom Item's Id Name.

type - The PermissionType of the permission node. Will go right after the permissionPrefix

Method Detail

getBreak

public java.lang.String getBreak()

Returns:

The permission node for breaking a block.

setBreak

public ItemPermissions setBreak(java.lang.String blockBreak)

Set the permission node for breaking a block.

Parameters:

blockBreak -

getHit

public java.lang.String getHit()

Returns:

The permission node for hitting another entity.

setHit

public ItemPermissions setHit(java.lang.String hit)

Set the permission node for hitting another entity.

Parameters:

hit -

getPermissionPrefix

public java.lang.String getPermissionPrefix()

Returns:

The first part of the Permission Node.

setPermissionPrefix

public void setPermissionPrefix(java.lang.String permissionPrefix)

Set the first part of the Permission Node.

Parameters:

permissionPrefix -

getType

public PermissionType getType()

Returns:

The PermissionType. Follows the Permission Prefix.

setType

public void setType(PermissionType type)

Set the PermissionType. Follows the Permission Prefix.

Parameters:

type -

getCraft

public java.lang.String getCraft()

Returns:

The permission node for Crafting the Custom Item.

setCraft

public void setCraft(java.lang.String craft)

Set the permission node for Crafting the Custom Item.

Parameters:

craft -

getDrop

public java.lang.String getDrop()

Returns:

The permission node for Dropping the Custom Item by a Player.

setDrop

public void setDrop(java.lang.String drop)

Set the permission node for Dropping the Custom Item by a Player.

Parameters:

drop -

getPickup

public java.lang.String getPickup()

Returns:

The permission node for a player to pick up the Custom Item.

setPickup

public void setPickup(java.lang.String pickUp)

Set the permission node for a player to pick up the Custom Item.

Parameters:

pickUp -