Package io.github.thebusybiscuit.slimefun4.implementation.items.androids

Enum Class Instruction

java.lang.Object

java.lang.Enum<Instruction>

io.github.thebusybiscuit.slimefun4.implementation.items.androids.Instruction

All Implemented Interfaces:

Serializable, Comparable<Instruction>, Constable

public enum Instruction
extends Enum<Instruction>

This enum holds every Instruction for the ProgrammableAndroid added by Slimefun itself.

Author:

TheBusyBiscuit

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTACK_ANIMALS	This will make a ButcherAndroid attack any Animal ahead of them.
ATTACK_ANIMALS_ADULT	This will make a ButcherAndroid attack any adult Animal ahead of them.
ATTACK_MOBS	This will make a ButcherAndroid attack any Monster ahead of them.
ATTACK_MOBS_ANIMALS	This will make a ButcherAndroid attack any LivingEntity ahead of them.
CATCH_FISH	This Instruction makes a FishermanAndroid try to catch fish from the water below.
CHOP_TREE	This will make a WoodcutterAndroid chop down the tree in front of them.
DIG_DOWN	This will make a MinerAndroid dig the Block below.
DIG_FORWARD	This will make a MinerAndroid dig the Block ahead.
DIG_UP	This will make a MinerAndroid dig the Block above.
FARM_DOWN	This Instruction will make a FarmerAndroid try to harvest the Block below.
FARM_EXOTIC_DOWN	This Instruction will make a FarmerAndroid try to harvest the Block below.
FARM_EXOTIC_FORWARD	This Instruction will make a FarmerAndroid try to harvest the Block in front of them.
FARM_FORWARD	This Instruction will make a FarmerAndroid try to harvest the Block in front of them.
GO_DOWN	This will make the ProgrammableAndroid go down.
GO_FORWARD	This will make the ProgrammableAndroid go forward.
GO_UP	This will make the ProgrammableAndroid go up.
INTERFACE_FUEL	This Instruction will force the ProgrammableAndroid to pull fuel from an AndroidInterface ahead of them.
INTERFACE_ITEMS	This Instruction will force the ProgrammableAndroid to push their items into an AndroidInterface ahead of them.
MOVE_AND_DIG_DOWN	This will make a MinerAndroid dig the Block below and then move itself to that new Location.
MOVE_AND_DIG_FORWARD	This will make a MinerAndroid dig the Block ahead and then move itself to that new Location.
MOVE_AND_DIG_UP	This will make a MinerAndroid dig the Block above and then move itself to that new Location.
REPEAT	This Instruction is the end token of a Script.
START	This Instruction is the starting point of a Script.
TURN_LEFT	This will make the ProgrammableAndroid rotate to the left side.
TURN_RIGHT	This will make the ProgrammableAndroid rotate to the right side.
WAIT	This Instruction will make the ProgrammableAndroid wait for one Slimefun tick.

Field Summary

Fields

Modifier and Type	Field	Description
static final Instruction[]	valuesCache

Method Summary

Modifier and Type	Method	Description
void	execute(ProgrammableAndroid android, Block b, BlockMenu inventory, BlockFace face)
static Instruction	getInstruction(String value)	Get a value from the cache map rather than calling Enum.valueOf(Class, String).
ItemStack	getItem()
AndroidType	getRequiredType()
static Instruction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Instruction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

START

public static final Instruction START

This Instruction is the starting point of a Script.

REPEAT

public static final Instruction REPEAT

This Instruction is the end token of a Script. Once this Instruction is reached, the Script will start again.

WAIT

public static final Instruction WAIT

This Instruction will make the ProgrammableAndroid wait for one Slimefun tick.

GO_FORWARD

public static final Instruction GO_FORWARD

This will make the ProgrammableAndroid go forward.

GO_UP

public static final Instruction GO_UP

This will make the ProgrammableAndroid go up.

GO_DOWN

public static final Instruction GO_DOWN

This will make the ProgrammableAndroid go down.

TURN_LEFT

public static final Instruction TURN_LEFT

This will make the ProgrammableAndroid rotate to the left side.

TURN_RIGHT

public static final Instruction TURN_RIGHT

This will make the ProgrammableAndroid rotate to the right side.

DIG_UP

public static final Instruction DIG_UP

This will make a MinerAndroid dig the Block above.

DIG_FORWARD

public static final Instruction DIG_FORWARD

This will make a MinerAndroid dig the Block ahead.

DIG_DOWN

public static final Instruction DIG_DOWN

This will make a MinerAndroid dig the Block below.

MOVE_AND_DIG_UP

public static final Instruction MOVE_AND_DIG_UP

This will make a MinerAndroid dig the Block above and then move itself to that new Location.

MOVE_AND_DIG_FORWARD

public static final Instruction MOVE_AND_DIG_FORWARD

This will make a MinerAndroid dig the Block ahead and then move itself to that new Location.

MOVE_AND_DIG_DOWN

public static final Instruction MOVE_AND_DIG_DOWN

This will make a MinerAndroid dig the Block below and then move itself to that new Location.

ATTACK_MOBS_ANIMALS

public static final Instruction ATTACK_MOBS_ANIMALS

This will make a ButcherAndroid attack any LivingEntity ahead of them.

ATTACK_MOBS

public static final Instruction ATTACK_MOBS

This will make a ButcherAndroid attack any Monster ahead of them.

ATTACK_ANIMALS

public static final Instruction ATTACK_ANIMALS

This will make a ButcherAndroid attack any Animal ahead of them.

ATTACK_ANIMALS_ADULT

public static final Instruction ATTACK_ANIMALS_ADULT

This will make a ButcherAndroid attack any adult Animal ahead of them.

CHOP_TREE

public static final Instruction CHOP_TREE

This will make a WoodcutterAndroid chop down the tree in front of them.

CATCH_FISH

public static final Instruction CATCH_FISH

This Instruction makes a FishermanAndroid try to catch fish from the water below.

FARM_FORWARD

public static final Instruction FARM_FORWARD

This Instruction will make a FarmerAndroid try to harvest the Block in front of them.

FARM_DOWN

public static final Instruction FARM_DOWN

This Instruction will make a FarmerAndroid try to harvest the Block below.

FARM_EXOTIC_FORWARD

public static final Instruction FARM_EXOTIC_FORWARD

This Instruction will make a FarmerAndroid try to harvest the Block in front of them. This includes plants from ExoticGarden.

FARM_EXOTIC_DOWN

public static final Instruction FARM_EXOTIC_DOWN

This Instruction will make a FarmerAndroid try to harvest the Block below. This includes plants from ExoticGarden.

INTERFACE_ITEMS

public static final Instruction INTERFACE_ITEMS

This Instruction will force the ProgrammableAndroid to push their items into an AndroidInterface ahead of them.

INTERFACE_FUEL

public static final Instruction INTERFACE_FUEL

This Instruction will force the ProgrammableAndroid to pull fuel from an AndroidInterface ahead of them.

Field Details

valuesCache

public static final Instruction[] valuesCache

Method Details

values

public static Instruction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Instruction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getItem

@Nonnull
public ItemStack getItem()

getRequiredType

@Nonnull
public AndroidType getRequiredType()

execute

@ParametersAreNonnullByDefault
public void execute(ProgrammableAndroid android,
 Block b,
 BlockMenu inventory,
 BlockFace face)

getInstruction

@Nullable
public static Instruction getInstruction(@Nonnull
 String value)

Get a value from the cache map rather than calling Enum.valueOf(Class, String). This is 25-40% quicker than the standard Enum.valueOf(Class, String) depending on your Java version. It also means that you can avoid an IllegalArgumentException which let's face it is always good.

Parameters:

value - The value which you would like to look up.

Returns:

The Instruction or null if it does not exist.