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

Interface PetBlock

public interface PetBlock

PetBlock entity which can be perform the defined actions.

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
void	damage(double amount) Damages the petblock the given amount of damage.
void	eject(Object player) Ejects the given player riding from the petblock.
Object	getArmorStand() Returns the armorstand of the petblock.
String	getDisplayName() Returns the displayName of the petblock.
EffectPipeline	getEffectPipeline() Returns the pipeline for managed effect playing.
Object	getEngineEntity() Returns the entity being used as engine.
Object	getLocation() Returns the location of the entity.
PetMeta	getMeta() Returns the meta of the petblock.
Object	getPlayer() Returns the owner of the petblock.
boolean	isDead() Returns if the petblock is already removed or dead.
boolean	isDieing() Deprecated.
void	jump() Lets the petblock perform a jump.
void	remove() Removes the petblock.
void	respawn() Respawns the petblock
void	ride(Object player) Lets the given player ride on the petblock.
void	setDieing() Deprecated.
void	setDisplayName(String name) Sets the displayName of the petblock.
void	setSkin(Object material, byte data) Deprecated.
void	setSkin(String skin) Deprecated.
void	setVelocity(Object vector) Sets the velocity of the petblock.
void	teleport(Object location) Teleports the the petblock to the given location.
void	teleportWithOwner(Object location) Deprecated.
void	wear(Object player) Lets the given player wear the petblock.

Method Detail

setSkin

@Deprecated
void setSkin(String skin)

Deprecated.

setSkin

@Deprecated
void setSkin(Object material,
                          byte data)

Deprecated.

setDieing

@Deprecated
void setDieing()

Deprecated.

teleportWithOwner

@Deprecated
void teleportWithOwner(Object location)

Deprecated.

isDieing

@Deprecated
boolean isDieing()

Deprecated.

getEffectPipeline

EffectPipeline getEffectPipeline()

Returns the pipeline for managed effect playing.

Returns:

effectPipeLine

getMeta

PetMeta getMeta()

Returns the meta of the petblock.

Returns:

meta

getPlayer

Object getPlayer()

Returns the owner of the petblock.

Returns:

player

remove

void remove()

Removes the petblock.

ride

void ride(Object player)

Lets the given player ride on the petblock.

Parameters:

player - player

wear

void wear(Object player)

Lets the given player wear the petblock.

Parameters:

player - player

eject

void eject(Object player)

Ejects the given player riding from the petblock.

Parameters:

player - player

setDisplayName

void setDisplayName(String name)

Sets the displayName of the petblock.

Parameters:

name - name

getDisplayName

String getDisplayName()

Returns the displayName of the petblock.

Returns:

name

respawn

void respawn()

Respawns the petblock

isDead

boolean isDead()

Returns if the petblock is already removed or dead.

Returns:

dead

getArmorStand

Object getArmorStand()

Returns the armorstand of the petblock.

Returns:

armorstand

getEngineEntity

Object getEngineEntity()

Returns the entity being used as engine.

Returns:

entity

getLocation

Object getLocation()

Returns the location of the entity.

Returns:

position

damage

void damage(double amount)

Damages the petblock the given amount of damage.

Parameters:

amount - amount

jump

void jump()

Lets the petblock perform a jump.

setVelocity

void setVelocity(Object vector)

Sets the velocity of the petblock.

Parameters:

vector - vector

teleport

void teleport(Object location)

Teleports the the petblock to the given location.

Parameters:

location - location