com.github.shynixn.petblocks.api.persistence.entity

Interface PetMeta

All Superinterfaces:

Persistenceable

public interface PetMeta
extends Persistenceable

Properties of petblocks meta data.

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
long	getAge() Returns the age in ticks.
EngineContainer	getEngine() Returns the data of the engine.
Object	getHeadItemStack() Returns the itemStack for the head.
int	getItemDamage() Returns the damage of the item.
int	getItemId() Returns the id of the item.
ParticleEffectMeta	getParticleEffectMeta() Returns the particleEffect meta.
String	getPetDisplayName() Returns the stored display name of the pet which appear above it's head on respawn.
PlayerMeta	getPlayerMeta() Returns the meta of the owner.
String	getSkin() Returns the skin of the pet.
boolean	isEnabled() Returns if the petblock is enabled.
boolean	isItemStackUnbreakable() Returns if the itemStack is unbreakable.
boolean	isItemUnbreakable() Returns if the item is unbreakable.
boolean	isSoundEnabled() Returns if the pet-sound is enabled.
void	setAge(long ticks) Sets the age in ticks.
void	setEnabled(boolean enabled) Sets the petblock enabled.
void	setEngine(EngineContainer engine) Sets the data of the engine.
void	setPetDisplayName(String name) Sets the stored display name of the pet which appears above it's head on respawn.
void	setSkin(int id, int damage, String skin, boolean unbreakable) Sets the itemStack.
void	setSoundEnabled(boolean enabled) Sets the pet sound enabled.

Methods inherited from interface com.github.shynixn.petblocks.api.persistence.entity.Persistenceable

getId

Method Detail

isEnabled

boolean isEnabled()

Returns if the petblock is enabled.

Returns:

enabled

setEnabled

void setEnabled(boolean enabled)

Sets the petblock enabled.

Parameters:

enabled - enabled

getAge

long getAge()

Returns the age in ticks.

Returns:

age

getSkin

String getSkin()

Returns the skin of the pet.

Returns:

skin

setAge

void setAge(long ticks)

Sets the age in ticks.

Parameters:

ticks - ticks

getEngine

EngineContainer getEngine()

Returns the data of the engine.

Returns:

engine

setEngine

void setEngine(EngineContainer engine)

Sets the data of the engine.

Parameters:

engine - engine

setSoundEnabled

void setSoundEnabled(boolean enabled)

Sets the pet sound enabled.

Parameters:

enabled - enabled

isSoundEnabled

boolean isSoundEnabled()

Returns if the pet-sound is enabled.

Returns:

enabled

isItemStackUnbreakable

boolean isItemStackUnbreakable()

Returns if the itemStack is unbreakable.

Returns:

unbreakable

setSkin

void setSkin(int id,
             int damage,
             String skin,
             boolean unbreakable)

Sets the itemStack.

Parameters:

id - id

damage - damage

skin - skin

unbreakable - unbreakable

setPetDisplayName

void setPetDisplayName(String name)

Sets the stored display name of the pet which appears above it's head on respawn.

Parameters:

name - name

getPetDisplayName

String getPetDisplayName()

Returns the stored display name of the pet which appear above it's head on respawn.

Returns:

name

getParticleEffectMeta

ParticleEffectMeta getParticleEffectMeta()

Returns the particleEffect meta.

Returns:

meta

getPlayerMeta

PlayerMeta getPlayerMeta()

Returns the meta of the owner.

Returns:

player

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

getHeadItemStack

Object getHeadItemStack()

Returns the itemStack for the head.

Returns:

headItemStack