buildcraft.core.triggers

Class BCTrigger

java.lang.Object

buildcraft.core.triggers.BCTrigger

All Implemented Interfaces:

ITrigger

Direct Known Subclasses:

TriggerClockTimer, TriggerEngineHeat, TriggerFluidContainer, TriggerFluidContainerLevel, TriggerInventory, TriggerInventoryLevel, TriggerMachine, TriggerPipeContents, TriggerPipeSignal, TriggerRedstoneFaderInput, TriggerRedstoneInput

public abstract class BCTrigger
extends java.lang.Object
implements ITrigger

This class has to be implemented to create new triggers kinds to BuildCraft gates. There is an instance per kind, which will get called wherever the trigger can be active.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	uniqueTag

Constructor Summary

Constructors

Constructor and Description
BCTrigger(java.lang.String... uniqueTag) UniqueTag accepts multiple possible tags, use this feature to migrate to more standardized tags if needed, otherwise just pass a single string.

Method Summary

Methods

Modifier and Type	Method and Description
ITriggerParameter	createParameter() Create parameters for the trigger.
java.lang.String	getDescription() Return the trigger description in the UI
net.minecraft.util.IIcon	getIcon()
int	getIconIndex()
java.lang.String	getUniqueTag() Every trigger needs a unique tag, it should be in the format of ":".
boolean	hasParameter() Return true if this trigger can accept parameters
void	registerIcons(net.minecraft.client.renderer.texture.IIconRegister iconRegister)
boolean	requiresParameter() Return true if this trigger requires a parameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface buildcraft.api.gates.ITrigger

rotateLeft

Field Detail

uniqueTag

protected final java.lang.String uniqueTag

Constructor Detail

BCTrigger

public BCTrigger(java.lang.String... uniqueTag)

UniqueTag accepts multiple possible tags, use this feature to migrate to more standardized tags if needed, otherwise just pass a single string. The first passed string will be the one used when saved to disk.

Parameters:

uniqueTag -

Method Detail

getUniqueTag

public java.lang.String getUniqueTag()

Description copied from interface: ITrigger

Every trigger needs a unique tag, it should be in the format of ":".

Specified by:

getUniqueTag in interface ITrigger

Returns:

the unique id

getIconIndex

public int getIconIndex()

getIcon

public net.minecraft.util.IIcon getIcon()

Specified by:

getIcon in interface ITrigger

registerIcons

public void registerIcons(net.minecraft.client.renderer.texture.IIconRegister iconRegister)

Specified by:

registerIcons in interface ITrigger

hasParameter

public boolean hasParameter()

Description copied from interface: ITrigger

Return true if this trigger can accept parameters

Specified by:

hasParameter in interface ITrigger

requiresParameter

public boolean requiresParameter()

Description copied from interface: ITrigger

Return true if this trigger requires a parameter

Specified by:

requiresParameter in interface ITrigger

getDescription

public java.lang.String getDescription()

Description copied from interface: ITrigger

Return the trigger description in the UI

Specified by:

getDescription in interface ITrigger

createParameter

public final ITriggerParameter createParameter()

Description copied from interface: ITrigger

Create parameters for the trigger. As for now, there is only one kind of trigger parameter available so this subprogram is final.

Specified by:

createParameter in interface ITrigger