me.thundertnt33.animatronics.api

Class Animatronic

java.lang.Object

me.thundertnt33.animatronics.api.Animatronic

public class Animatronic
extends java.lang.Object

Animatronic.

Constructor Summary

Constructors

Constructor and Description
Animatronic(java.lang.String name) Animatronic object can be instantiated with just the name.

Method Summary

Modifier and Type	Method and Description
void	addPose(org.bukkit.entity.ArmorStand from) Adds a pose through a existing armorstand, will also copy clothes.
void	addPose(org.bukkit.Location loc, org.bukkit.util.EulerAngle head, org.bukkit.util.EulerAngle body, org.bukkit.util.EulerAngle leftArm, org.bukkit.util.EulerAngle rightArm, org.bukkit.util.EulerAngle leftLeg, org.bukkit.util.EulerAngle rightLeg) Adds a pose through specific angles and location
void	editPose(int poseNum, org.bukkit.entity.ArmorStand from) Edit the position saved with the given armorstands pose, including clothes
void	editPose(int poseNum, org.bukkit.Location loc, org.bukkit.util.EulerAngle head, org.bukkit.util.EulerAngle body, org.bukkit.util.EulerAngle leftArm, org.bukkit.util.EulerAngle rightArm, org.bukkit.util.EulerAngle leftLeg, org.bukkit.util.EulerAngle rightLeg) Edit the position saved with given location and angles
org.bukkit.entity.ArmorStand	getArmorstand() Gets the armorstand associated with the Animatronic.
org.bukkit.inventory.ItemStack	getBoots(int poseNum) Get boots for specified position number.
org.bukkit.inventory.ItemStack	getChestplate(int poseNum) Get chestplate for specified position number.
java.lang.Integer	getDelay(int poseNum) Gets the delay for given position number
java.lang.Integer	getGlobalDelay() Gets the delay set globally for the animatronic, can be overriden by indivudually set delays.
org.bukkit.inventory.ItemStack	getHelmet(int poseNum) Get helmet for specified position number.
org.bukkit.inventory.ItemStack	getLeggings(int poseNum) Get leggings for specified position number.
ApiPose	getPose(int poseNum) Gets the position info saved for given pose number
ApiPose[]	getPositions() Returns all positions saved for this Animatronic
boolean	gotoPose(int pose) Teleports/sets Animatronic to specified pose
boolean	gotoStart() Teleports a Animatronic to the start position
void	removePosition(int positionToRemove) Remove a position by number
void	setBoots(int poseNum, org.bukkit.inventory.ItemStack item) Set boots for specified position.
void	setChestplate(int poseNum, org.bukkit.inventory.ItemStack item) Set chestplate for specified position.
boolean	setDelay(int delay) Deprecated. Replaced by setGlobalDelay
boolean	setDelay(int poseNum, int delayInTicks) Sets the delay between the posenumber and pose number + 1
boolean	setGlobalDelay(int delay) Set the delay of the Animatronic globally, these can be overwritten by individually set delays.
void	setHelmet(int poseNum, org.bukkit.inventory.ItemStack item) Set helmet for specified position.
void	setLeggings(int poseNum, org.bukkit.inventory.ItemStack item) Set leggings for specified position.
boolean	start() Start a Animatronic
boolean	start(int amount) Start a Animatronic, with given repeat count
boolean	startRev() Spawn a Animatronic in reverse
boolean	stop() Stop a Animatronic
boolean	toggle() Toggle a Animatronic

Methods inherited from class java.lang.Object

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

Constructor Detail

Animatronic

public Animatronic(java.lang.String name)

Animatronic object can be instantiated with just the name.

Parameters:

name - Name of the Animatronic.

Method Detail

addPose

public void addPose(org.bukkit.entity.ArmorStand from)

Adds a pose through a existing armorstand, will also copy clothes.

Parameters:

from - Armorstand to copy pose from

addPose

public void addPose(org.bukkit.Location loc,
                    org.bukkit.util.EulerAngle head,
                    org.bukkit.util.EulerAngle body,
                    org.bukkit.util.EulerAngle leftArm,
                    org.bukkit.util.EulerAngle rightArm,
                    org.bukkit.util.EulerAngle leftLeg,
                    org.bukkit.util.EulerAngle rightLeg)

Adds a pose through specific angles and location

Parameters:

loc - Location

head - Head euler angle

body - Body euler angle

leftArm - Left arm euler angle

rightArm - Right arm euler angle

leftLeg - Left leg euler angle

rightLeg - Right leg euler angle

removePosition

public void removePosition(int positionToRemove)

Remove a position by number

Parameters:

positionToRemove - position number to remove, starts at 1

editPose

public void editPose(int poseNum,
                     org.bukkit.entity.ArmorStand from)

Edit the position saved with the given armorstands pose, including clothes

Parameters:

poseNum - Position number

from - Armorstand to get pose from

editPose

public void editPose(int poseNum,
                     org.bukkit.Location loc,
                     org.bukkit.util.EulerAngle head,
                     org.bukkit.util.EulerAngle body,
                     org.bukkit.util.EulerAngle leftArm,
                     org.bukkit.util.EulerAngle rightArm,
                     org.bukkit.util.EulerAngle leftLeg,
                     org.bukkit.util.EulerAngle rightLeg)

Edit the position saved with given location and angles

Parameters:

poseNum - Position number

getPose

public ApiPose getPose(int poseNum)

Gets the position info saved for given pose number

Parameters:

poseNum - Pose number to get

Returns:

Pose angles

getPositions

@Nullable
public ApiPose[] getPositions()

Returns all positions saved for this Animatronic

Returns:

Array of all position, nullable

setDelay

public boolean setDelay(int poseNum,
                        int delayInTicks)

Sets the delay between the posenumber and pose number + 1

Parameters:

poseNum - Pose number

delayInTicks - Delay in ticks

Returns:

succesfull?

getDelay

@Nullable
public java.lang.Integer getDelay(int poseNum)

Gets the delay for given position number

Parameters:

poseNum - position number

Returns:

delay that is set for position number, can be null

getGlobalDelay

@Nullable
public java.lang.Integer getGlobalDelay()

Gets the delay set globally for the animatronic, can be overriden by indivudually set delays.

Returns:

Global delay in ticks

setDelay

@Deprecated
public boolean setDelay(int delay)

Deprecated. Replaced by setGlobalDelay

Set the delay of the Animatronic globally, these can be overwritten by individually set delays.

Parameters:

delay - Delay in ticks (must be at least 3 ticks)

Returns:

succesfull?

setGlobalDelay

public boolean setGlobalDelay(int delay)

Set the delay of the Animatronic globally, these can be overwritten by individually set delays.

Parameters:

delay - Delay in ticks (must be at least 3 ticks)

Returns:

succesfull?

gotoPose

public boolean gotoPose(int pose)

Teleports/sets Animatronic to specified pose

Parameters:

pose - Pose number

Returns:

succesfull?

gotoStart

public boolean gotoStart()

Teleports a Animatronic to the start position

Returns:

succesfull?

startRev

public boolean startRev()

Spawn a Animatronic in reverse

Returns:

succesfull?

start

public boolean start()

Start a Animatronic

Returns:

succesfull?

start

public boolean start(int amount)

Start a Animatronic, with given repeat count

Parameters:

amount - repeat count

Returns:

succesfull?

stop

public boolean stop()

Stop a Animatronic

Returns:

succesfull?

toggle

public boolean toggle()

Toggle a Animatronic

Returns:

succesfull?

getArmorstand

public org.bukkit.entity.ArmorStand getArmorstand()

Gets the armorstand associated with the Animatronic. If it does not exists, it will spawn one.

Returns:

the armorstand entity

getHelmet

@Nullable
public org.bukkit.inventory.ItemStack getHelmet(int poseNum)

Get helmet for specified position number.

Parameters:

poseNum - position number

Returns:

ItemStack that it wears

getChestplate

@Nullable
public org.bukkit.inventory.ItemStack getChestplate(int poseNum)

Get chestplate for specified position number.

Parameters:

poseNum - position number

Returns:

ItemStack that it wears

getLeggings

@Nullable
public org.bukkit.inventory.ItemStack getLeggings(int poseNum)

Get leggings for specified position number.

Parameters:

poseNum - position number

Returns:

ItemStack that it wears

getBoots

@Nullable
public org.bukkit.inventory.ItemStack getBoots(int poseNum)

Get boots for specified position number.

Parameters:

poseNum - position number

Returns:

ItemStack that it wears

setHelmet

public void setHelmet(int poseNum,
                      org.bukkit.inventory.ItemStack item)

Set helmet for specified position.

Parameters:

poseNum - Position number

item - Itemstack to save

setChestplate

public void setChestplate(int poseNum,
                          org.bukkit.inventory.ItemStack item)

Set chestplate for specified position.

Parameters:

poseNum - Position number

item - Itemstack to save

setLeggings

public void setLeggings(int poseNum,
                        org.bukkit.inventory.ItemStack item)

Set leggings for specified position.

Parameters:

poseNum - Position number

item - Itemstack to save

setBoots

public void setBoots(int poseNum,
                     org.bukkit.inventory.ItemStack item)

Set boots for specified position.

Parameters:

poseNum - Position number

item - Itemstack to save