li.cil.oc.api.prefab

Class AbstractProvider

java.lang.Object

li.cil.oc.api.prefab.AbstractProvider

All Implemented Interfaces:

BehaviorProvider

public abstract class AbstractProvider
extends java.lang.Object
implements BehaviorProvider

Example base implementation of nanomachine behavior provider.

This class takes care of handling the unique identifier used to tell if a behavior is its own when loading from NBT.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	id Unique identifier used to tell if a behavior is ours when asked to load it.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractProvider(java.lang.String id) For the ID passed in here, it is suggested to use a one-time generated UUID that is hard-coded into your provider implementation.

Method Summary

Modifier and Type	Method and Description
protected abstract Behavior	readBehaviorFromNBT(net.minecraft.entity.player.EntityPlayer player, net.minecraft.nbt.NBTTagCompound nbt) Called when loading a behavior from NBT.
Behavior	readFromNBT(net.minecraft.entity.player.EntityPlayer player, net.minecraft.nbt.NBTTagCompound nbt) Restore a behavior from NBT.
protected void	writeBehaviorToNBT(Behavior behavior, net.minecraft.nbt.NBTTagCompound nbt) Called when saving a behavior created using this behavior to NBT.
net.minecraft.nbt.NBTTagCompound	writeToNBT(Behavior behavior) Write a behavior to NBT.

Methods inherited from class java.lang.Object

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

Methods inherited from interface li.cil.oc.api.nanomachines.BehaviorProvider

createBehaviors

Field Detail

id

protected final java.lang.String id

Unique identifier used to tell if a behavior is ours when asked to load it.

Constructor Detail

AbstractProvider

protected AbstractProvider(java.lang.String id)

For the ID passed in here, it is suggested to use a one-time generated UUID that is hard-coded into your provider implementation. Take care to use a different one for each provider you create!

Parameters:

id - the unique identifier for this provider.

Method Detail

writeBehaviorToNBT

protected void writeBehaviorToNBT(Behavior behavior,
                                  net.minecraft.nbt.NBTTagCompound nbt)

Called when saving a behavior created using this behavior to NBT.

The ID will already have been written, don't overwrite it. Store any additional data you need to restore the behavior here, if any.

Parameters:

behavior - the behavior to persist.

nbt - the NBT tag to persist it to.

readBehaviorFromNBT

protected abstract Behavior readBehaviorFromNBT(net.minecraft.entity.player.EntityPlayer player,
                                                net.minecraft.nbt.NBTTagCompound nbt)

Called when loading a behavior from NBT.

Use the data written in writeBehaviorToNBT(li.cil.oc.api.nanomachines.Behavior, net.minecraft.nbt.NBTTagCompound) to restore the behavior to its previous state, then return it.

Parameters:

player - the player to restore the behavior for.

nbt - the NBT tag to load restore the behavior from.

Returns:

the restored behavior.

writeToNBT

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

Description copied from interface: BehaviorProvider

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 BehaviorProvider.createBehaviors(net.minecraft.entity.player.EntityPlayer), so make sure to save all your behaviors.

Specified by:

writeToNBT in interface BehaviorProvider

Parameters:

behavior - the behavior to serialize.

Returns:

the serialized representation of the specified behavior.

readFromNBT

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

Description copied from interface: BehaviorProvider

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.

Specified by:

readFromNBT in interface BehaviorProvider

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.