Interface LocalTileEntity

Interface passed to TileEntity.registerPrototype function as client property.

interface LocalTileEntity {
    containerEvents?: {
        [eventName: string]: ((container: ItemContainer, window:
            | Window
            | StandartWindow
            | StandardWindow
            | TabbedWindow
            | null, windowContent: WindowContent | null, eventData: any) => void);
    };
    dimension: number;
    events?: {
        [packetName: string]: ((packetData: any, packetExtra: any) => void);
    };
    load?: (() => void);
    networkData: SyncedNetworkData;
    networkEntity: NetworkEntity;
    noupdate: boolean;
    remove: boolean;
    sendPacket: ((name: string, data: object) => void);
    tick?: (() => void);
    unload?: (() => void);
    x: number;
    y: number;
    z: number;
}

Hierarchy (view full)

Properties

containerEvents? dimension events? load? networkData networkEntity noupdate remove sendPacket tick? unload? x y z

Properties

OptionalcontainerEvents

containerEvents?: {
    [eventName: string]: ((container: ItemContainer, window:
        | Window
        | StandartWindow
        | StandardWindow
        | TabbedWindow
        | null, windowContent: WindowContent | null, eventData: any) => void);
}

Events of the container's client copy.

Type declaration

Readonlydimension

dimension: number

Dimension where the tile is located.

Optionalevents

events?: {
    [packetName: string]: ((packetData: any, packetExtra: any) => void);
}

Events that receive packets on the client side.

Type declaration

  • [packetName: string]: ((packetData: any, packetExtra: any) => void)

    Example of the client packet event function.

      • (packetData, packetExtra): void

      • Parameters

        • packetData: any
        • packetExtra: any

        Returns void

Optionalload

load?: (() => void)

Called when the client copy is created.

Since

2.0.2b29

ReadonlynetworkData

networkData: SyncedNetworkData

SyncedNetworkData object of the tile.

ReadonlynetworkEntity

networkEntity: NetworkEntity

Instance of TileEntity.networkEntityType for the tile.

noupdate

noupdate: boolean

true if tile cannot tick, update functions will not work in that case.

remove

remove: boolean

true if tile has been destroyed.

sendPacket

sendPacket: ((name: string, data: object) => void)

Sends the packet from client to server.

Optionaltick

tick?: (() => void)

Called every tick on client thread; you cannot set tick later if there is no function at all.

Optionalunload

unload?: (() => void)

Called on destroying the client copy.

Since

2.0.2b29

Readonlyx

x: number

X coord of the tile in it's dimension.

Readonlyy

y: number

Y coord of the tile in it's dimension.

Readonlyz

z: number

Z coord of the tile in it's dimension.

Settings

Member Visibility

On This Page

Properties

Copyright © 2024 Nernar. Copyright © 2020 #mineprogramming. Built with ❤ and TypeDoc.