forestry.mail

Class PostalCarrier

java.lang.Object

forestry.mail.PostalCarrier

All Implemented Interfaces:

IPostalCarrier

public class PostalCarrier
extends java.lang.Object
implements IPostalCarrier

Constructor Summary

Constructors

Constructor and Description
PostalCarrier(EnumAddressee type)

Method Summary

Modifier and Type	Method and Description
IPostalState	deliverLetter(net.minecraft.world.World world, IPostOffice office, IMailAddress recipient, net.minecraft.item.ItemStack letterStack, boolean doDeliver) Handle delivery of a letter addressed to this carrier.
java.lang.String	getName()
net.minecraft.client.renderer.texture.TextureAtlasSprite	getSprite() Sprite registered to the Gui Texture Map at ITextureManager.
EnumAddressee	getType()

Methods inherited from class java.lang.Object

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

Constructor Detail

PostalCarrier

public PostalCarrier(EnumAddressee type)

Method Detail

getType

public EnumAddressee getType()

Specified by:

getType in interface IPostalCarrier

Returns:

An EnumAddressee identifying the type of carrier

getName

public java.lang.String getName()

Specified by:

getName in interface IPostalCarrier

Returns:

A human-readable name for this carrier.

getSprite

public net.minecraft.client.renderer.texture.TextureAtlasSprite getSprite()

Description copied from interface: IPostalCarrier

Sprite registered to the Gui Texture Map at ITextureManager. Must be 26 pixels wide and 15 pixels tall. The texture itself must be 32x32 square.

Specified by:

getSprite in interface IPostalCarrier

deliverLetter

public IPostalState deliverLetter(net.minecraft.world.World world,
                                  IPostOffice office,
                                  IMailAddress recipient,
                                  net.minecraft.item.ItemStack letterStack,
                                  boolean doDeliver)

Description copied from interface: IPostalCarrier

Handle delivery of a letter addressed to this carrier.

Specified by:

deliverLetter in interface IPostalCarrier

Parameters:

world - The world the IPostOffice handles.

office - {link @IPostOffice} which received this letter and handed it to the carrier.

recipient - An identifier for the recipient as typed by the player into the address field.

letterStack - ItemStack representing the letter. See IPostRegistry for helper functions to validate and extract it.

doDeliver - Whether or not the letter is supposed to actually be delivered or if delivery is only to be simulated.

Returns:

{link IPostalState} holding information on success or failure for delivery.