li.cil.oc.api.prefab

Class AbstractBehavior

java.lang.Object

li.cil.oc.api.prefab.AbstractBehavior

All Implemented Interfaces:

Behavior

public abstract class AbstractBehavior
extends java.lang.Object
implements Behavior

Base class for behaviors, mostly useful to have less cluttered classes when you only need one or two of the methods in the interface.

This implementation will also store the player the behavior was created for.

Field Summary

Fields

Modifier and Type	Field and Description
net.minecraft.entity.player.EntityPlayer	player The player this behavior was created for.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBehavior() Use this if you do not need the player reference in your implementation.
protected	AbstractBehavior(net.minecraft.entity.player.EntityPlayer player) Pass along the player the behavior was created for here to have it stored for later use.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNameHint() A short name / description of this behavior.
void	onDisable(DisableReason reason) Called when this behavior becomes inactive.
void	onEnable() Called when this behavior becomes active because all its required inputs are now satisfied.
void	update() Called each tick while this behavior is active.

Methods inherited from class java.lang.Object

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

Field Detail

player

public final net.minecraft.entity.player.EntityPlayer player

The player this behavior was created for.

Constructor Detail

AbstractBehavior

protected AbstractBehavior(net.minecraft.entity.player.EntityPlayer player)

Pass along the player the behavior was created for here to have it stored for later use.

Parameters:

player - the player the behavior was created for.

AbstractBehavior

protected AbstractBehavior()

Use this if you do not need the player reference in your implementation.

Method Detail

getNameHint

public java.lang.String getNameHint()

Description copied from interface: Behavior

A short name / description of this behavior.

You can not use commas (,) or double quotes (") in the returned string. If you do, they'll automatically be replaced with underscores.

This is entirely optional and may even return null. It is made accessible via the controller's wireless protocol, to allow better automating reconfigurations / determining input mappings. In some cases you may not wish to make this possible, in those cases return null or a random string.

Again, you can return whatever you like here, it's not used in mod internal logic, but only provided to ingame devices as a hint to make configuring nanomachines a little easier.

Specified by:

getNameHint in interface Behavior

Returns:

the name to provide for this behavior, if any.

onEnable

public void onEnable()

Description copied from interface: Behavior

Called when this behavior becomes active because all its required inputs are now satisfied.

Use this to initialize permanent effects.

Specified by:

onEnable in interface Behavior

onDisable

public void onDisable(DisableReason reason)

Description copied from interface: Behavior

Called when this behavior becomes inactive.

Use this to remove permanent effects.

Specified by:

onDisable in interface Behavior

Parameters:

reason - the reason the behavior is being disabled.

update

public void update()

Description copied from interface: Behavior

Called each tick while this behavior is active.

Specified by:

update in interface Behavior