li.cil.oc.api.event

Class FileSystemAccessEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

li.cil.oc.api.event.FileSystemAccessEvent

Direct Known Subclasses:

FileSystemAccessEvent.Client, FileSystemAccessEvent.Server

public class FileSystemAccessEvent
extends net.minecraftforge.fml.common.eventhandler.Event

Events for handling file system access and representing it on the client.

This is used to play file system access sounds and render disk activity indicators on some containers (e.g. disk drive, computer, server).

Use this to implement rendering of disk access indicators on you own containers / computers / drive bays.

Canceling this event is provided to allow registering higher priority event handlers that override default behavior.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileSystemAccessEvent.Client
static class	FileSystemAccessEvent.Server

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.fml.common.eventhandler.Event.HasResult, net.minecraftforge.fml.common.eventhandler.Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
protected net.minecraft.nbt.NBTTagCompound	data
protected java.lang.String	sound
protected net.minecraft.tileentity.TileEntity	tileEntity
protected net.minecraft.world.World	world
protected double	x
protected double	y
protected double	z

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileSystemAccessEvent(java.lang.String sound, net.minecraft.tileentity.TileEntity tileEntity, net.minecraft.nbt.NBTTagCompound data) Constructor for tile entity hosted file systems.
protected	FileSystemAccessEvent(java.lang.String sound, net.minecraft.world.World world, double x, double y, double z, net.minecraft.nbt.NBTTagCompound data) Constructor for arbitrarily hosted file systems.

Method Summary

Modifier and Type	Method and Description
net.minecraft.nbt.NBTTagCompound	getData() Addition custom data, this is used to transmit the number of the server in a server rack the file system lives in, for example.
java.lang.String	getSound() The name of the sound effect to play for the file system.
net.minecraft.tileentity.TileEntity	getTileEntity() The tile entity hosting the file system.
net.minecraft.world.World	getWorld() The world the file system lives in.
double	getX() The x coordinate of the file system's container.
double	getY() The y coordinate of the file system's container.
double	getZ() The z coordinate of the file system's container.

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

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

Field Detail

sound

protected java.lang.String sound

world

protected net.minecraft.world.World world

x

protected double x

y

protected double y

z

protected double z

tileEntity

protected net.minecraft.tileentity.TileEntity tileEntity

data

protected net.minecraft.nbt.NBTTagCompound data

Constructor Detail

FileSystemAccessEvent

protected FileSystemAccessEvent(java.lang.String sound,
                                net.minecraft.tileentity.TileEntity tileEntity,
                                net.minecraft.nbt.NBTTagCompound data)

Constructor for tile entity hosted file systems.

Parameters:

sound - the name of the sound effect to play.

tileEntity - the tile entity hosting the file system.

data - the additional data.

FileSystemAccessEvent

protected FileSystemAccessEvent(java.lang.String sound,
                                net.minecraft.world.World world,
                                double x,
                                double y,
                                double z,
                                net.minecraft.nbt.NBTTagCompound data)

Constructor for arbitrarily hosted file systems.

Parameters:

sound - the name of the sound effect to play.

world - the world the file system lives in.

x - the x coordinate of the file system's container.

y - the y coordinate of the file system's container.

z - the z coordinate of the file system's container.

data - the additional data.

Method Detail

getSound

public java.lang.String getSound()

The name of the sound effect to play for the file system.

getWorld

public net.minecraft.world.World getWorld()

The world the file system lives in.

getX

public double getX()

The x coordinate of the file system's container.

getY

public double getY()

The y coordinate of the file system's container.

getZ

public double getZ()

The z coordinate of the file system's container.

getTileEntity

public net.minecraft.tileentity.TileEntity getTileEntity()

The tile entity hosting the file system.

Important: this can be null, which is usually the case when the container is an entity or item.

getData

public net.minecraft.nbt.NBTTagCompound getData()

Addition custom data, this is used to transmit the number of the server in a server rack the file system lives in, for example.