HOOK_CHUNK_GENERATING


Index:
Articles
Classes
Hooks

Quick navigation:
BLOCK_SPREAD
BLOCK_TO_PICKUPS
BREWING_COMPLETED
BREWING_COMPLETING
CHAT
CHUNK_AVAILABLE
CHUNK_GENERATED
CHUNK_GENERATING
CHUNK_UNLOADED
CHUNK_UNLOADING
COLLECTING_PICKUP
CRAFTING_NO_RECIPE
DISCONNECT
ENTITY_ADD_EFFECT
ENTITY_CHANGED_WORLD
ENTITY_CHANGING_WORLD
ENTITY_TELEPORT
EXECUTE_COMMAND
EXPLODED
EXPLODING
HANDSHAKE
HOPPER_PULLING_ITEM
HOPPER_PUSHING_ITEM
KILLED
KILLING
LOGIN
PLAYER_ANIMATION
PLAYER_BREAKING_BLOCK
PLAYER_BROKEN_BLOCK
PLAYER_DESTROYED
PLAYER_EATING
PLAYER_FISHED
PLAYER_FISHING
PLAYER_FOOD_LEVEL_CHANGE
PLAYER_JOINED
PLAYER_LEFT_CLICK
PLAYER_MOVING
PLAYER_PLACED_BLOCK
PLAYER_PLACING_BLOCK
PLAYER_RIGHT_CLICK
PLAYER_RIGHT_CLICKING_ENTITY
PLAYER_SHOOTING
PLAYER_SPAWNED
PLAYER_TOSSING_ITEM
PLAYER_USED_BLOCK
PLAYER_USED_ITEM
PLAYER_USING_BLOCK
PLAYER_USING_ITEM
PLUGINS_LOADED
PLUGIN_MESSAGE
POST_CRAFTING
PRE_CRAFTING
PROJECTILE_HIT_BLOCK
PROJECTILE_HIT_ENTITY
SERVER_PING
SPAWNED_ENTITY
SPAWNED_MONSTER
SPAWNING_ENTITY
SPAWNING_MONSTER
TAKE_DAMAGE
TICK
UPDATED_SIGN
UPDATING_SIGN
WEATHER_CHANGED
WEATHER_CHANGING
WORLD_STARTED
WORLD_TICK

This hook is called before the world generator starts generating a chunk. The plugin may provide some or all parts of the generation, by-passing the built-in generator. The function is given access to the ChunkDesc object representing the contents of the chunk. It may override parts of the built-in generator by using the object's SetUseDefaultXXX(false) functions. After all the callbacks for a chunk have been processed, the server will generate the chunk based on the ChunkDesc description - those parts that are set for generating (by default everything) are generated, the rest are read from the ChunkDesc object.

See also the HOOK_CHUNK_GENERATED hook.


Callback function

The default name for the callback function is OnChunkGenerating. It has the following signature:

function MyOnChunkGenerating(World, ChunkX, ChunkZ, ChunkDesc)

Parameters:

NameTypeNotes
WorldcWorldThe world to which the chunk will be added
ChunkXnumberX-coord of the chunk
ChunkZnumberZ-coord of the chunk
ChunkDesccChunkDescGenerated chunk data.

If this function returns true, the server will not call any other plugin with the same chunk. If this function returns false, the server will call the rest of the plugins with the same chunk, possibly overwriting the ChunkDesc's contents.


Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_CHUNK_GENERATING, MyOnChunkGenerating);
Generated on 2017-06-26 01:00:07, Build ID Unknown, Commit approx: bd025e2bdbaf86425b1d692ffc4aa87c3c086cc7