li.cil.oc.api.nanomachines

Interface BehaviorProvider

All Known Implementing Classes:

AbstractProvider

public interface BehaviorProvider

Implemented by providers for behaviors.

You may implement one provider for each of your behaviors, or one provider for all of your behaviors; it really doesn't matter. This just allows for some logical grouping of behaviors, where desired.

Each behavior provider must be capable or serializing the behaviors it creates, and re-create the behavior from its serialized form. It will not be given any hints as to whether a provided tag was originally produced by it, so you should add a sufficiently unique marker to the output NBT to allow identification later on. I recommend generating a UUID once, and using that. This is necessary to both save and restore neural connection state between saves without breaking the state when new behaviors are added, as well as to send states to the client.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<Behavior>	createBehaviors(net.minecraft.entity.player.EntityPlayer player) Create all behaviors valid for the specified player.
Behavior	readFromNBT(net.minecraft.entity.player.EntityPlayer player, net.minecraft.nbt.NBTTagCompound nbt) Restore a behavior from NBT.
net.minecraft.nbt.NBTTagCompound	writeToNBT(Behavior behavior) Write a behavior to NBT.

Method Detail

createBehaviors

java.lang.Iterable<Behavior> createBehaviors(net.minecraft.entity.player.EntityPlayer player)

Create all behaviors valid for the specified player.

Note that this is only called on the server side when reconfiguring nanomachines. If you have a behavior that actually acts client-only, you still need to return it here, as it will be synchronized to the client using writeToNBT(li.cil.oc.api.nanomachines.Behavior) and readFromNBT(net.minecraft.entity.player.EntityPlayer, net.minecraft.nbt.NBTTagCompound).

Parameters:

player - the player the behaviors should be created for.

Returns:

list of new behaviors, may be null.

writeToNBT

net.minecraft.nbt.NBTTagCompound writeToNBT(Behavior behavior)

Write a behavior to NBT.

This will only be called for behaviors originally created by this provider.

This will only be called on the server. All behaviors not saved will be lost when loading again, they will not be regenerated using createBehaviors(net.minecraft.entity.player.EntityPlayer), so make sure to save all your behaviors.

Parameters:

behavior - the behavior to serialize.

Returns:

the serialized representation of the specified behavior.

readFromNBT

Behavior readFromNBT(net.minecraft.entity.player.EntityPlayer player,
                     net.minecraft.nbt.NBTTagCompound nbt)

Restore a behavior from NBT.

You are not guaranteed that his nbt belongs to a behavior created by this provider! If the NBT cannot be handled, return null.

This is called both on the server and the client; on the server it is called when restoring a saved player, on the client when synchronizing a configuration.

Parameters:

player - the player the behaviors should be created for.

nbt - the tag to restore the behavior from.

Returns:

the restored behavior, or null if unhandled.