abstractMachine.Generator
Hierarchy
Index
Constructors
Properties
- __clientMethods
- __containerEvents
- __initialized
- __networkEvents
- audioSource
- blockID
- blockSource
- click
- client
- container
- containerEvents
- data
- defaultDrop
- defaultValues
- dimension
- energyNode
- energyTypes
- events
- finishingSound
- getGuiScreen
- isLoaded
- liquidStorage
- networkData
- networkEntity
- networkEntityType
- networkEntityTypeName
- noupdate
- onConnectionPlayer
- onDisconnectionPlayer
- region
- remove
- sendPacket
- sendResponse
- update
- upgrades
- useNetworkItemContainer
- x
- y
- z
Methods
- addLiquidTank
- adjustDrop
- canExtractEnergy
- canReceiveEnergy
- canRotate
- chargeSlot
- clientLoad
- clientTick
- clientUnload
- created
- decreaseSlot
- destroy
- destroyBlock
- dischargeSlot
- energyReceive
- energyTick
- getDefaultDrop
- getEnergyStorage
- getExplosionPower
- getFacing
- getInterruptSound
- getMaxPacketSize
- getOperationSound
- getRelativeEnergy
- getScreenByName
- getScreenName
- getStartingSound
- getTier
- init
- isConductor
- load
- onCheckerTick
- onCreate
- onInit
- onItemClick
- onItemUse
- onLoad
- onRedstoneUpdate
- onTick
- onUnload
- preventClick
- projectileHit
- rebuildGrid
- redstone
- renderModel
- requireMoreLiquid
- selfDestroy
- setActive
- setFacing
- setLiquidScale
- setupContainer
- startPlaySound
- stopPlaySound
- tick
- unload
- updateLiquidScale
Constructors
constructor
Returns Generator
Properties
__clientMethods
Type declaration
[key string]: boolean
__containerEvents
Type declaration
[key string]: Side
__initialized
__networkEvents
Type declaration
[key string]: Side
audioSource
readonlyblockID
Block ID of tile.
blockSource
BlockSource object to manipulate tile position in world.
click
Called when player uses some item on a TileEntity.
Type declaration
Parameters
id: number
count: number
data: number
coords: ItemUseCoordinates
player: number
extra: ItemExtraData
Returns boolean | void
client
Client tile entity prototype copy.
Type declaration
containerEvents: {}
[eventName string]: (container: ItemContainer, window: UI.IWindow | null, windowContent: UI.WindowContent | null, eventData: any) => void
events: {}
[packetName string]: (packetData: any, packetExtra: any) => void
load: () => void
Returns void
tick: () => void
Returns void
unload: () => void
Returns void
container
Tile item container.
containerEvents
Events of the container on the server side.
Type declaration
[eventName string]: (container: ItemContainer, window: UI.IWindow | null, windowContent: UI.WindowContent | null, eventData: any) => void
data
Tile data values object.
Type declaration
energy: number
defaultDrop
defaultValues
Default data values, will be initially added to TileEntity.data field.
Type declaration
energy: number
readonlydimension
Dimension where the tile is located.
energyNode
energyTypes
events
Events that receive packets on the server side.
Type declaration
[packetName string]: (packetData: any, packetExtra: any, connectedClient: NetworkClient) => void
finishingSound
getGuiScreen
Called to get the UI.IWindow object for the current TileEntity. The window is then opened within TileEntity.container when the player clicks it.
Client-side method only.
Type declaration
Returns IWindow
isLoaded
true if tile is loaded in the world.
liquidStorage
Tile liquid storage.
networkData
SyncedNetworkData object of the tile.
networkEntity
Instance of TileEntity.networkEntityType for the tile.
networkEntityType
NetworkEntityType object of the tile.
networkEntityTypeNamesince: 2.2.1b92
noupdate
true if tile cannot tick, update functions will
not work in that case.
optionalonConnectionPlayersince: 2.3.1b116-3
optionalonDisconnectionPlayersince: 2.3.1b116-3
Called when player disconnects from server.
Type declaration
Parameters
client: NetworkClient
Returns void
region
Interface for BlockSource of the TileEntity. Provides more functionality.
remove
true if tile has been destroyed.
sendPacket
Sends the packet from server to all clients.
Type declaration
Parameters
name: string
data: object
Returns {}
sendResponse
Sends packet to specified client.
Available only in server-side methods!
Type declaration
Parameters
packetName: string
someData: object
Returns {}
update
Called every tick to TileEntity.TileEntityPrototype.tick each tile if TileEntity.noupdate not active.
Type declaration
Returns void
optionalupgrades
readonlyuseNetworkItemContainer
Use ItemContainer that supports multiplayer.
x
X coord of the tile in it's dimension.
y
Y coord of the tile in it's dimension.
z
Z coord of the tile in it's dimension.
Methods
addLiquidTank
Parameters
name: string
limit: number
optionalliquids: string[]
Returns LiquidTank
adjustDrop
Parameters
item: ItemInstance
Returns ItemInstance
canExtractEnergy
Returns boolean
canReceiveEnergy
Returns boolean
canRotate
Parameters
side: number
Returns boolean
chargeSlot
Parameters
slotName: string
Returns void
clientLoad
Called when the client copy is created
Returns void
clientTick
Called every tick on client thread
Returns void
clientUnload
Called on destroying the client copy
Returns void
created
Returns void
decreaseSlot
Parameters
slot: ItemContainerSlot
count: number
Returns void
destroy
Returns boolean
destroyBlock
Parameters
coords: ItemUseCoordinates
player: number
Returns void
dischargeSlot
Parameters
slotName: string
Returns void
energyReceive
Parameters
type: string
amount: number
voltage: number
Returns number
energyTick
Parameters
type: string
src: EnergyTileNode
Returns void
getDefaultDrop
Returns number
getEnergyStorage
Returns number
getExplosionPower
Returns number
getFacing
Returns number
getInterruptSound
Returns string
getMaxPacketSize
Returns number
getOperationSound
Returns string
getRelativeEnergy
Returns number
getScreenByName
Parameters
screenName: string
container: ItemContainer
Returns IWindow
getScreenName
Parameters
player: number
coords: ItemUseCoordinates
Returns string
getStartingSound
Returns string
getTier
Returns number
init
- That feature is obsolete
Returns void
isConductor
Parameters
type: string
Returns boolean
loadsince: 2.0.2b29
- That feature is obsolete
Returns void
onCheckerTicksince: 2.0.2b29
Parameters
isInitialized: boolean
isLoaded: boolean
wasLoaded: boolean
Returns void
onCreate
Called when a TileEntity is created
Returns void
onInit
Called when a TileEntity is initialised in the world
Returns void
onItemClick
Parameters
id: number
count: number
data: number
coords: ItemUseCoordinates
player: number
extra: ItemExtraData
Returns boolean
onItemUse
Called when player uses some item on a TileEntity. Replaces "click" function.
Parameters
coords: ItemUseCoordinates
item: ItemStack
player: number
Returns boolean
true if should prevent opening UI.
onLoad
Called when a chunk with TileEntity is loaded
Returns void
onRedstoneUpdate
Occurs when redstone signal on TileEntity block was updated
Parameters
signal: number
signal power (0-15)
Returns void
onTick
Called every tick and should be used for all the updates of the TileEntity
Returns void
onUnload
Called when a chunk with TileEntity is unloaded
Returns void
preventClick
Prevents all actions on click
Returns void
projectileHit
Parameters
coords: ItemUseCoordinates
target: ProjectileHitTarget
Returns void
rebuildGrid
Returns void
redstone
- That feature is obsolete
Parameters
params: { onLoad: boolean; power: number; signal: number }
onLoad: boolean
power: number
signal: number
Returns void
renderModel
Returns void
requireMoreLiquid
Parameters
liquid: string
amount: number
Returns void
selfDestroy
Returns void
setActive
Parameters
isActive: boolean
Returns void
setFacing
Parameters
side: number
Returns boolean
setLiquidScale
Parameters
container: any
window: any
content: any
data: { amount: number; liquid: string; scale: string }
amount: number
liquid: string
scale: string
Returns void
setupContainer
Returns void
startPlaySound
Returns void
stopPlaySound
Returns void
tick
- That feature is obsolete
Returns void
unloadsince: 2.0.2b29
- That feature is obsolete
Returns void
updateLiquidScale
Parameters
scale: string
liquid: string
Returns void
Interface passed to TileEntity.registerPrototype function.