Agriculture.CropTile

Interface passed to TileEntity.registerPrototype function.

Hierarchy

TileEntityBase
- CropTile

Index

Constructors

constructor

Constructors

constructor

new CropTile(): CropTile

Inherited from TileEntityBase.constructor
Returns CropTile

Properties

__clientMethods

__clientMethods: {}

Type declaration

[key string]: boolean

__containerEvents

__containerEvents: {}

Type declaration

[key string]: Side

__initialized

__initialized: boolean

__networkEvents

__networkEvents: {}

Type declaration

[key string]: Side

readonlyblockID

blockID: number

Block ID of tile.

blockSource

blockSource: BlockSource

BlockSource object to manipulate tile position in world.

click

click: (id: number, count: number, data: number, coords: ItemUseCoordinates, player: number, extra: ItemExtraData) => boolean | void

Called when player uses some item on a TileEntity.

@returns: true if the event is handled and should not be propagated to the next handlers. Return true if you don't want the user interface to be opened.

Type declaration

- (id: number, count: number, data: number, coords: ItemUseCoordinates, player: number, extra: ItemExtraData): boolean | void
- Parameters
  - id: number
  - count: number
  - data: number
  - coords: ItemUseCoordinates
  - player: number
  - extra: ItemExtraData
  Returns boolean | void

client

client: { containerEvents: {}; events: {}; load: () => void; tick: () => void; unload: () => void }

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
- - (): void
  - Returns void
tick: () => void
- - (): void
  - Returns void
unload: () => void
- - (): void
  - Returns void

container

container: ItemContainer

Tile item container.

containerEvents

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

crop

crop: CropCard

data

data: CropTileData

Tile data values object.

defaultValues

defaultValues: { crop: any; crossingBase: boolean; currentSize: number; dirty: boolean; growthPoints: number; scanLevel: number; statGain: number; statGrowth: number; statResistance: number; storageNutrients: number; storageWater: number; storageWeedEX: number; terrainAirQuality: number; terrainHumidity: number; terrainNutrients: number }

Default data values, will be initially added to TileEntity.data field.

Type declaration

crop: any
crossingBase: boolean
currentSize: number
dirty: boolean
growthPoints: number
scanLevel: number
statGain: number
statGrowth: number
statResistance: number
storageNutrients: number
storageWater: number
storageWeedEX: number
terrainAirQuality: number
terrainHumidity: number
terrainNutrients: number

readonlydimension

dimension: number

Dimension where the tile is located.

events

events: {}

Events that receive packets on the server side.

Type declaration

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

getGuiScreen

getGuiScreen: () => IWindow

Called to get the UI.IWindow object for the current TileEntity. The window is then opened within TileEntity.container when the player clicks it.

That feature is obsolete

Client-side method only.

Type declaration

- (): IWindow
- Returns IWindow

isLoaded

isLoaded: boolean

true if tile is loaded in the world.

liquidStorage

liquidStorage: Storage

Tile liquid storage.

networkData

networkData: SyncedNetworkData

SyncedNetworkData object of the tile.

networkEntity

networkEntity: NetworkEntity

Instance of TileEntity.networkEntityType for the tile.

networkEntityType

networkEntityType: NetworkEntityType

NetworkEntityType object of the tile.

networkEntityTypeName
since: 2.2.1b92

networkEntityTypeName: string

noupdate

noupdate: boolean

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

optionalonConnectionPlayer
since: 2.3.1b116-3

onConnectionPlayer?: (client: NetworkClient) => void

Called when player connects to server.

Type declaration

- (client: NetworkClient): void
- Parameters
  - client: NetworkClient
  Returns void

optionalonDisconnectionPlayer
since: 2.3.1b116-3

onDisconnectionPlayer?: (client: NetworkClient) => void

Called when player disconnects from server.

Type declaration

- (client: NetworkClient): void
- Parameters
  - client: NetworkClient
  Returns void

region

region: WorldRegion

Interface for BlockSource of the TileEntity. Provides more functionality.

remove

remove: boolean

true if tile has been destroyed.

sendPacket

sendPacket: (name: string, data: object) => {}

Sends the packet from server to all clients.

Type declaration

- (name: string, data: object): {}
- Parameters
  - name: string
  - data: object
  Returns {}

sendResponse

sendResponse: (packetName: string, someData: object) => {}

Sends packet to specified client.

More about capabilities

Available only in server-side methods!

Type declaration

- (packetName: string, someData: object): {}
- Parameters
  - packetName: string
  - someData: object
  Returns {}

update

update: () => void

Called every tick to TileEntity.TileEntityPrototype.tick each tile if TileEntity.noupdate not active.

Type declaration

- (): void
- Returns void

readonlyuseNetworkItemContainer

useNetworkItemContainer: boolean

Use ItemContainer that supports multiplayer.

x

x: number

X coord of the tile in it's dimension.

y

y: number

Y coord of the tile in it's dimension.

z

z: number

Z coord of the tile in it's dimension.

Methods

applyFertilizer

applyFertilizer(manual: boolean): boolean

Parameters
- manual: boolean
Returns boolean

applyHydration

applyHydration(amount: number): number

Parameters
- amount: number
Returns number

applyWeedEx

applyWeedEx(stack: ItemStack, manual: boolean): boolean

Parameters
- stack: ItemStack
- manual: boolean
Returns boolean

askCropJoinCross

askCropJoinCross(coordsArray: [number[], number[], number[], number[]]): any[]

Parameters
- coordsArray: [number[], number[], number[], number[]]
Returns any[]

attemptCrossing

attemptCrossing(): boolean

Returns boolean

calculateRatioFor

calculateRatioFor(newCrop: CropCard, oldCrop: CropCard): number

Parameters
- newCrop: CropCard
- oldCrop: CropCard
Returns number

checkGround

checkGround(): void

Returns void

checkPlayerRunning

checkPlayerRunning(playerUid: number): void

Parameters
- playerUid: number
Returns void

clientLoad

clientLoad(): void

Overrides TileEntityBase.clientLoad
Called when the client copy is created
Returns void

clientTick

clientTick(): void

Inherited from TileEntityBase.clientTick
Called every tick on client thread
Returns void

clientUnload

clientUnload(): void

Overrides TileEntityBase.clientUnload
Called on destroying the client copy
Returns void

created

created(): void

Inherited from TileEntityBase.created
Returns void

destroy

destroy(): boolean

Inherited from TileEntityBase.destroy
Returns boolean

destroyBlock

destroyBlock(coords: ItemUseCoordinates, playerUid: number): void

Overrides TileEntityBase.destroyBlock
Parameters
- coords: ItemUseCoordinates
- playerUid: number
Returns void

generateSeeds

generateSeeds(data: any): ItemInstance

Parameters
- data: any
Returns ItemInstance

getRelativeCoords

getRelativeCoords(): [number[], number[], number[], number[]]

Returns [number[], number[], number[], number[]]

getScreenByName

getScreenByName(screenName: string, container: ItemContainer): IWindow

Inherited from TileEntityBase.getScreenByName
Parameters
- screenName: string
- container: ItemContainer
Returns IWindow

getScreenName

getScreenName(player: number, coords: ItemUseCoordinates): string

Inherited from TileEntityBase.getScreenName
Parameters
- player: number
- coords: ItemUseCoordinates
Returns string

hasWeedEX

hasWeedEX(): boolean

Returns boolean

init

init(): void

Inherited from TileEntityBase.init
That feature is obsolete
Returns void

isBlockBelow

isBlockBelow(reqBlockID: number): boolean

Parameters
- reqBlockID: number
Returns boolean

lim

lim(value: number, min: number, max: number): number

Parameters
- value: number
- min: number
- max: number
Returns number

load
since: 2.0.2b29

load(): void

Inherited from TileEntityBase.load
That feature is obsolete
Returns void

nextGaussian

nextGaussian(): number

Returns number

onCheckerTick
since: 2.0.2b29

onCheckerTick(isInitialized: boolean, isLoaded: boolean, wasLoaded: boolean): void

Inherited from TileEntityBase.onCheckerTick
Parameters
- isInitialized: boolean
- isLoaded: boolean
- wasLoaded: boolean
Returns void

onCreate

onCreate(): void

Inherited from TileEntityBase.onCreate
Called when a TileEntity is created
Returns void

onInit

onInit(): void

Overrides TileEntityBase.onInit
Called when a TileEntity is initialised in the world
Returns void

onItemClick

onItemClick(id: number, count: number, data: number, coords: ItemUseCoordinates, playerUid: number, extra: ItemExtraData): boolean

Overrides TileEntityBase.onItemClick
Parameters
- id: number
- count: number
- data: number
- coords: ItemUseCoordinates
- playerUid: number
- extra: ItemExtraData
Returns boolean

onItemUse

onItemUse(coords: ItemUseCoordinates, item: ItemStack, player: number): boolean

Inherited from TileEntityBase.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

onLoad(): void

Inherited from TileEntityBase.onLoad
Called when a chunk with TileEntity is loaded
Returns void

onLongClick

onLongClick(playerUid: number): boolean

Parameters
- playerUid: number
Returns boolean

onRedstoneUpdate

onRedstoneUpdate(signal: number): void

Inherited from TileEntityBase.onRedstoneUpdate
Occurs when redstone signal on TileEntity block was updated
Parameters
- signal: number
  signal power (0-15)
Returns void

onTick

onTick(): void

Overrides TileEntityBase.onTick
Called every tick and should be used for all the updates of the TileEntity
Returns void

onUnload

onUnload(): void

Inherited from TileEntityBase.onUnload
Called when a chunk with TileEntity is unloaded
Returns void

performGrowthTick

performGrowthTick(): void

Returns void

performHarvest

performHarvest(): ItemInstance[]

Returns ItemInstance[]

performManualHarvest

performManualHarvest(): boolean

Returns boolean

performTick

performTick(): void

Returns void

performWeedWork

performWeedWork(): void

Returns void

pick

pick(): boolean

Returns boolean

preventClick

preventClick(): void

Inherited from TileEntityBase.preventClick
Prevents all actions on click
Returns void

projectileHit

projectileHit(coords: ItemUseCoordinates, target: ProjectileHitTarget): void

Inherited from TileEntityBase.projectileHit
Parameters
- coords: ItemUseCoordinates
- target: ProjectileHitTarget
Returns void

redstone

redstone(params: { onLoad: boolean; power: number; signal: number }): void

Inherited from TileEntityBase.redstone
That feature is obsolete
Parameters
- params: { onLoad: boolean; power: number; signal: number }
Returns void

renderModel

renderModel(): void

Returns void

requireMoreLiquid

requireMoreLiquid(liquid: string, amount: number): void

Inherited from TileEntityBase.requireMoreLiquid
Parameters
- liquid: string
- amount: number
Returns void

reset

reset(): void

Returns void

selfDestroy

selfDestroy(): void

Inherited from TileEntityBase.selfDestroy
Returns void

setLiquidScale

setLiquidScale(container: any, window: any, content: any, data: { amount: number; liquid: string; scale: string }): void

Inherited from TileEntityBase.setLiquidScale
Parameters
- container: any
- window: any
- content: any
- data: { amount: number; liquid: string; scale: string }
Returns void

tick

tick(): void

Inherited from TileEntityBase.tick
That feature is obsolete
Returns void

tryPlantIn

tryPlantIn(cropCardID: number, size: number, statGr: number, statGa: number, statRe: number, scan: number): boolean

Parameters
- cropCardID: number
- size: number
- statGr: number
- statGa: number
- statRe: number
- scan: number
Returns boolean

unload
since: 2.0.2b29

unload(): void

Inherited from TileEntityBase.unload
That feature is obsolete
Returns void

updateLiquidScale

updateLiquidScale(scale: string, liquid: string): void

Inherited from TileEntityBase.updateLiquidScale
Parameters
- scale: string
- liquid: string
Returns void

updateRender

updateRender(): void

Returns void

updateTerrainAirQuality

updateTerrainAirQuality(): void

Returns void

updateTerrainHumidity

updateTerrainHumidity(): void

Returns void

updateTerrainNutrients

updateTerrainNutrients(): void

Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CropTile

Properties

__clientMethods

Type declaration

[key string]: boolean

__containerEvents

Type declaration

[key string]: Side

__initialized

__networkEvents

Type declaration

[key string]: Side

readonlyblockID

blockSource

click

Type declaration

Parameters

id: number

count: number

data: number

coords: ItemUseCoordinates

player: number

extra: ItemExtraData

Returns boolean | void

client

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

containerEvents

Type declaration

[eventName string]: (container: ItemContainer, window: UI.IWindow | null, windowContent: UI.WindowContent | null, eventData: any) => void

crop

data

defaultValues

Type declaration

crop: any

crossingBase: boolean

currentSize: number

dirty: boolean

growthPoints: number

scanLevel: number

statGain: number

statGrowth: number

statResistance: number

storageNutrients: number

storageWater: number

storageWeedEX: number

terrainAirQuality: number

terrainHumidity: number

terrainNutrients: number

readonlydimension

events

Type declaration

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

getGuiScreen

Type declaration

Returns IWindow

isLoaded

liquidStorage

networkData

networkEntity

networkEntityType

networkEntityTypeNamesince: 2.2.1b92

noupdate

networkEntityTypeName
since: 2.2.1b92

optionalonConnectionPlayer
since: 2.3.1b116-3

optionalonDisconnectionPlayer
since: 2.3.1b116-3