150 private static int $worldIdCounter = 1;
152 public const Y_MAX = 320;
153 public const Y_MIN = -64;
155 public const TIME_DAY = 1000;
156 public const TIME_NOON = 6000;
157 public const TIME_SUNSET = 12000;
158 public const TIME_NIGHT = 13000;
159 public const TIME_MIDNIGHT = 18000;
160 public const TIME_SUNRISE = 23000;
162 public const TIME_FULL = 24000;
164 public const DIFFICULTY_PEACEFUL = 0;
165 public const DIFFICULTY_EASY = 1;
166 public const DIFFICULTY_NORMAL = 2;
167 public const DIFFICULTY_HARD = 3;
169 public const DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK = 3;
172 private const BLOCK_CACHE_SIZE_CAP = 2048;
178 private array $players = [];
184 private array $entities = [];
189 private array $entityLastKnownPositions = [];
195 private array $entitiesByChunk = [];
201 public array $updateEntities = [];
203 private bool $inDynamicStateRecalculation =
false;
208 private array $blockCache = [];
209 private int $blockCacheSize = 0;
214 private array $blockCollisionBoxCache = [];
216 private int $sendTimeTicker = 0;
218 private int $worldId;
220 private int $providerGarbageCollectionTicker = 0;
229 private array $registeredTickingChunks = [];
237 private array $validTickingChunks = [];
244 private array $recheckTickingChunks = [];
250 private array $chunkLoaders = [];
256 private array $chunkListeners = [];
261 private array $playerChunkListeners = [];
267 private array $packetBuffersByChunk = [];
273 private array $unloadQueue = [];
276 public bool $stopTime =
false;
278 private float $sunAnglePercentage = 0.0;
279 private int $skyLightReduction = 0;
281 private string $folderName;
282 private string $displayName;
288 private array $chunks = [];
294 private array $changedBlocks = [];
302 private array $scheduledBlockUpdateQueueIndex = [];
305 private \SplQueue $neighbourBlockUpdateQueue;
310 private array $neighbourBlockUpdateQueueIndex = [];
316 private array $activeChunkPopulationTasks = [];
321 private array $chunkLock = [];
322 private int $maxConcurrentChunkPopulationTasks = 2;
327 private array $chunkPopulationRequestMap = [];
332 private \SplQueue $chunkPopulationRequestQueue;
337 private array $chunkPopulationRequestQueueIndex = [];
343 private array $generatorRegisteredWorkers = [];
345 private bool $autoSave =
true;
347 private int $sleepTicks = 0;
349 private int $chunkTickRadius;
350 private int $tickedBlocksPerSubchunkPerTick = self::DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK;
355 private array $randomTickBlocks = [];
359 public float $tickRateTime = 0;
361 private bool $doingTick =
false;
364 private string $generator;
366 private bool $unloaded =
false;
371 private array $unloadCallbacks = [];
376 private \Logger $logger;
384 return morton2d_encode($x, $z);
387 private const MORTON3D_BIT_SIZE = 21;
388 private const BLOCKHASH_Y_BITS = 9;
389 private const BLOCKHASH_Y_PADDING = 64;
390 private const BLOCKHASH_Y_OFFSET = self::BLOCKHASH_Y_PADDING - self::Y_MIN;
391 private const BLOCKHASH_Y_MASK = (1 << self::BLOCKHASH_Y_BITS) - 1;
392 private const BLOCKHASH_XZ_MASK = (1 << self::MORTON3D_BIT_SIZE) - 1;
393 private const BLOCKHASH_XZ_EXTRA_BITS = (self::MORTON3D_BIT_SIZE - self::BLOCKHASH_Y_BITS) >> 1;
394 private const BLOCKHASH_XZ_EXTRA_MASK = (1 << self::BLOCKHASH_XZ_EXTRA_BITS) - 1;
395 private const BLOCKHASH_XZ_SIGN_SHIFT = 64 - self::MORTON3D_BIT_SIZE - self::BLOCKHASH_XZ_EXTRA_BITS;
396 private const BLOCKHASH_X_SHIFT = self::BLOCKHASH_Y_BITS;
397 private const BLOCKHASH_Z_SHIFT = self::BLOCKHASH_X_SHIFT + self::BLOCKHASH_XZ_EXTRA_BITS;
402 public static function blockHash(
int $x,
int $y,
int $z) : int{
403 $shiftedY = $y + self::BLOCKHASH_Y_OFFSET;
404 if(($shiftedY & (~0 << self::BLOCKHASH_Y_BITS)) !== 0){
405 throw new \InvalidArgumentException(
"Y coordinate $y is out of range!");
410 return morton3d_encode(
411 $x & self::BLOCKHASH_XZ_MASK,
413 ((($x >> self::MORTON3D_BIT_SIZE) & self::BLOCKHASH_XZ_EXTRA_MASK) << self::BLOCKHASH_X_SHIFT) |
414 ((($z >> self::MORTON3D_BIT_SIZE) & self::BLOCKHASH_XZ_EXTRA_MASK) << self::BLOCKHASH_Z_SHIFT),
415 $z & self::BLOCKHASH_XZ_MASK
423 return morton3d_encode($x, $y, $z);
432 public static function getBlockXYZ(
int $hash, ?
int &$x, ?
int &$y, ?
int &$z) : void{
433 [$baseX, $baseY, $baseZ] = morton3d_decode($hash);
435 $extraX = ((($baseY >> self::BLOCKHASH_X_SHIFT) & self::BLOCKHASH_XZ_EXTRA_MASK) << self::MORTON3D_BIT_SIZE);
436 $extraZ = ((($baseY >> self::BLOCKHASH_Z_SHIFT) & self::BLOCKHASH_XZ_EXTRA_MASK) << self::MORTON3D_BIT_SIZE);
438 $x = (($baseX & self::BLOCKHASH_XZ_MASK) | $extraX) << self::BLOCKHASH_XZ_SIGN_SHIFT >> self::BLOCKHASH_XZ_SIGN_SHIFT;
439 $y = ($baseY & self::BLOCKHASH_Y_MASK) - self::BLOCKHASH_Y_OFFSET;
440 $z = (($baseZ & self::BLOCKHASH_XZ_MASK) | $extraZ) << self::BLOCKHASH_XZ_SIGN_SHIFT >> self::BLOCKHASH_XZ_SIGN_SHIFT;
448 public static function getXZ(
int $hash, ?
int &$x, ?
int &$z) : void{
449 [$x, $z] = morton2d_decode($hash);
452 public static function getDifficultyFromString(
string $str) : int{
453 switch(strtolower(trim($str))){
457 return World::DIFFICULTY_PEACEFUL;
462 return World::DIFFICULTY_EASY;
467 return World::DIFFICULTY_NORMAL;
472 return World::DIFFICULTY_HARD;
487 $this->folderName = $name;
488 $this->worldId = self::$worldIdCounter++;
490 $this->displayName = $this->provider->getWorldData()->getName();
491 $this->logger = new \PrefixedLogger($server->getLogger(),
"World: $this->displayName");
493 $this->blockStateRegistry = RuntimeBlockStateRegistry::getInstance();
494 $this->minY = $this->provider->getWorldMinY();
495 $this->maxY = $this->provider->getWorldMaxY();
497 $this->
server->getLogger()->info($this->
server->getLanguage()->translate(KnownTranslationFactory::pocketmine_level_preparing($this->displayName)));
498 $generator = GeneratorManager::getInstance()->getGenerator($this->provider->getWorldData()->getGenerator()) ??
499 throw new AssumptionFailedError(
"WorldManager should already have checked that the generator exists");
500 $generator->validateGeneratorOptions($this->provider->getWorldData()->getGeneratorOptions());
501 $this->generator = $generator->getGeneratorClass();
502 $this->chunkPopulationRequestQueue = new \SplQueue();
503 $this->addOnUnloadCallback(
function() :
void{
504 $this->logger->debug(
"Cancelling unfulfilled generation requests");
506 foreach($this->chunkPopulationRequestMap as $chunkHash => $promise){
508 unset($this->chunkPopulationRequestMap[$chunkHash]);
510 if(count($this->chunkPopulationRequestMap) !== 0){
518 $this->scheduledBlockUpdateQueue->setExtractFlags(\SplPriorityQueue::EXTR_BOTH);
520 $this->neighbourBlockUpdateQueue = new \SplQueue();
522 $this->time = $this->provider->getWorldData()->getTime();
524 $cfg = $this->
server->getConfigGroup();
525 $this->chunkTickRadius = min($this->
server->getViewDistance(), max(0, $cfg->getPropertyInt(YmlServerProperties::CHUNK_TICKING_TICK_RADIUS, 4)));
526 if($cfg->getPropertyInt(
"chunk-ticking.per-tick", 40) <= 0){
528 $this->logger->warning(
"\"chunk-ticking.per-tick\" setting is deprecated, but you've used it to disable chunk ticking. Set \"chunk-ticking.tick-radius\" to 0 in \"pocketmine.yml\" instead.");
529 $this->chunkTickRadius = 0;
531 $this->tickedBlocksPerSubchunkPerTick = $cfg->getPropertyInt(YmlServerProperties::CHUNK_TICKING_BLOCKS_PER_SUBCHUNK_PER_TICK, self::DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK);
532 $this->maxConcurrentChunkPopulationTasks = $cfg->getPropertyInt(YmlServerProperties::CHUNK_GENERATION_POPULATION_QUEUE_SIZE, 2);
534 $this->initRandomTickBlocksFromConfig($cfg);
538 $this->workerPool->addWorkerStartHook($workerStartHook =
function(
int $workerId) :
void{
539 if(array_key_exists($workerId, $this->generatorRegisteredWorkers)){
540 $this->logger->debug(
"Worker $workerId with previously registered generator restarted, flagging as unregistered");
541 unset($this->generatorRegisteredWorkers[$workerId]);
544 $workerPool = $this->workerPool;
545 $this->addOnUnloadCallback(
static function() use ($workerPool, $workerStartHook) :
void{
551 $dontTickBlocks = [];
552 $parser = StringToItemParser::getInstance();
553 foreach($cfg->getProperty(YmlServerProperties::CHUNK_TICKING_DISABLE_BLOCK_TICKING, []) as $name){
554 $name = (string) $name;
555 $item = $parser->parse($name);
557 $block = $item->getBlock();
558 }elseif(preg_match(
"/^-?\d+$/", $name) === 1){
561 $blockStateData = GlobalBlockStateHandlers::getUpgrader()->upgradeIntIdMeta((
int) $name, 0);
562 }
catch(BlockStateDeserializeException){
565 $block = $this->blockStateRegistry->fromStateId(GlobalBlockStateHandlers::getDeserializer()->deserialize($blockStateData));
571 if($block->getTypeId() !== BlockTypeIds::AIR){
572 $dontTickBlocks[$block->getTypeId()] = $name;
576 foreach($this->blockStateRegistry->getAllKnownStates() as $state){
577 $dontTickName = $dontTickBlocks[$state->getTypeId()] ??
null;
578 if($dontTickName ===
null && $state->ticksRandomly()){
579 $this->randomTickBlocks[$state->getStateId()] =
true;
584 public function getTickRateTime() : float{
585 return $this->tickRateTime;
588 public function registerGeneratorToWorker(
int $worker) : void{
589 $this->logger->debug(
"Registering generator on worker $worker");
590 $this->workerPool->submitTaskToWorker(
new GeneratorRegisterTask($this, $this->generator, $this->provider->getWorldData()->getGeneratorOptions()), $worker);
591 $this->generatorRegisteredWorkers[$worker] =
true;
594 public function unregisterGenerator() : void{
595 foreach($this->workerPool->getRunningWorkers() as $i){
596 if(isset($this->generatorRegisteredWorkers[$i])){
597 $this->workerPool->submitTaskToWorker(
new GeneratorUnregisterTask($this), $i);
600 $this->generatorRegisteredWorkers = [];
603 public function getServer() : Server{
607 public function getLogger() : \
Logger{
608 return $this->logger;
611 final public function getProvider() : WritableWorldProvider{
612 return $this->provider;
618 final public function getId() : int{
619 return $this->worldId;
622 public function isLoaded() : bool{
623 return !$this->unloaded;
629 public function onUnload() : void{
631 throw new \LogicException(
"Tried to close a world which is already closed");
634 foreach($this->unloadCallbacks as $callback){
637 $this->unloadCallbacks = [];
639 foreach($this->chunks as $chunkHash => $chunk){
640 self::getXZ($chunkHash, $chunkX, $chunkZ);
641 $this->unloadChunk($chunkX, $chunkZ,
false);
643 foreach($this->entitiesByChunk as $chunkHash => $entities){
644 self::getXZ($chunkHash, $chunkX, $chunkZ);
647 foreach($entities as $entity){
648 if(!$entity->isFlaggedForDespawn()){
653 if($leakedEntities !== 0){
654 $this->logger->warning(
"$leakedEntities leaked entities found in ungenerated chunk $chunkX $chunkZ during unload, they won't be saved!");
660 $this->unregisterGenerator();
662 $this->provider->close();
663 $this->blockCache = [];
664 $this->blockCacheSize = 0;
665 $this->blockCollisionBoxCache = [];
667 $this->unloaded =
true;
672 $this->unloadCallbacks[spl_object_id($callback)] = $callback;
677 unset($this->unloadCallbacks[spl_object_id($callback)]);
688 private function filterViewersForPosition(
Vector3 $pos, array $allowed) : array{
689 $candidates = $this->getViewersForPosition($pos);
691 foreach($allowed as $player){
692 $k = spl_object_id($player);
693 if(isset($candidates[$k])){
694 $filtered[$k] = $candidates[$k];
705 $players ??= $this->getViewersForPosition($pos);
707 if(WorldSoundEvent::hasHandlers()){
710 if($ev->isCancelled()){
714 $sound = $ev->getSound();
715 $players = $ev->getRecipients();
718 $pk = $sound->
encode($pos);
720 if($players === $this->getViewersForPosition($pos)){
722 $this->broadcastPacketToViewers($pos, $e);
725 NetworkBroadcastUtils::broadcastPackets($this->filterViewersForPosition($pos, $players), $pk);
734 $players ??= $this->getViewersForPosition($pos);
736 if(WorldParticleEvent::hasHandlers()){
739 if($ev->isCancelled()){
743 $particle = $ev->getParticle();
744 $players = $ev->getRecipients();
747 $pk = $particle->
encode($pos);
749 if($players === $this->getViewersForPosition($pos)){
751 $this->broadcastPacketToViewers($pos, $e);
754 NetworkBroadcastUtils::broadcastPackets($this->filterViewersForPosition($pos, $players), $pk);
759 public function getAutoSave() : bool{
760 return $this->autoSave;
763 public function setAutoSave(
bool $value) : void{
764 $this->autoSave = $value;
777 return $this->playerChunkListeners[
World::chunkHash($chunkX, $chunkZ)] ?? [];
787 return $this->chunkLoaders[
World::chunkHash($chunkX, $chunkZ)] ?? [];
797 return $this->getChunkPlayers($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE);
804 $this->broadcastPacketToPlayersUsingChunk($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE, $packet);
807 private function broadcastPacketToPlayersUsingChunk(
int $chunkX,
int $chunkZ,
ClientboundPacket $packet) : void{
808 if(!isset($this->packetBuffersByChunk[$index =
World::chunkHash($chunkX, $chunkZ)])){
809 $this->packetBuffersByChunk[$index] = [$packet];
811 $this->packetBuffersByChunk[$index][] = $packet;
815 public function registerChunkLoader(ChunkLoader $loader,
int $chunkX,
int $chunkZ,
bool $autoLoad =
true) : void{
816 $loaderId = spl_object_id($loader);
818 if(!isset($this->chunkLoaders[$chunkHash = World::chunkHash($chunkX, $chunkZ)])){
819 $this->chunkLoaders[$chunkHash] = [];
820 }elseif(isset($this->chunkLoaders[$chunkHash][$loaderId])){
824 $this->chunkLoaders[$chunkHash][$loaderId] = $loader;
826 $this->cancelUnloadChunkRequest($chunkX, $chunkZ);
829 $this->loadChunk($chunkX, $chunkZ);
833 public function unregisterChunkLoader(ChunkLoader $loader,
int $chunkX,
int $chunkZ) : void{
834 $chunkHash = World::chunkHash($chunkX, $chunkZ);
835 $loaderId = spl_object_id($loader);
836 if(isset($this->chunkLoaders[$chunkHash][$loaderId])){
837 if(count($this->chunkLoaders[$chunkHash]) === 1){
838 unset($this->chunkLoaders[$chunkHash]);
839 $this->unloadChunkRequest($chunkX, $chunkZ,
true);
840 if(isset($this->chunkPopulationRequestMap[$chunkHash]) && !isset($this->activeChunkPopulationTasks[$chunkHash])){
841 $this->chunkPopulationRequestMap[$chunkHash]->reject();
842 unset($this->chunkPopulationRequestMap[$chunkHash]);
845 unset($this->chunkLoaders[$chunkHash][$loaderId]);
854 $hash =
World::chunkHash($chunkX, $chunkZ);
855 if(isset($this->chunkListeners[$hash])){
856 $this->chunkListeners[$hash][spl_object_id($listener)] = $listener;
858 $this->chunkListeners[$hash] = [spl_object_id($listener) => $listener];
860 if($listener instanceof
Player){
861 $this->playerChunkListeners[$hash][spl_object_id($listener)] = $listener;
871 $hash =
World::chunkHash($chunkX, $chunkZ);
872 if(isset($this->chunkListeners[$hash])){
873 if(count($this->chunkListeners[$hash]) === 1){
874 unset($this->chunkListeners[$hash]);
875 unset($this->playerChunkListeners[$hash]);
877 unset($this->chunkListeners[$hash][spl_object_id($listener)]);
878 unset($this->playerChunkListeners[$hash][spl_object_id($listener)]);
887 foreach($this->chunkListeners as $hash => $listeners){
888 World::getXZ($hash, $chunkX, $chunkZ);
889 $this->unregisterChunkListener($listener, $chunkX, $chunkZ);
900 return $this->chunkListeners[
World::chunkHash($chunkX, $chunkZ)] ?? [];
906 public function sendTime(
Player ...$targets) : void{
907 if(count($targets) === 0){
908 $targets = $this->players;
910 foreach($targets as $player){
911 $player->getNetworkSession()->syncWorldTime($this->time);
915 public function isDoingTick() : bool{
916 return $this->doingTick;
922 public function doTick(
int $currentTick) : void{
924 throw new \LogicException(
"Attempted to tick a world which has been closed");
927 $this->timings->doTick->startTiming();
928 $this->doingTick =
true;
930 $this->actuallyDoTick($currentTick);
932 $this->doingTick =
false;
933 $this->timings->doTick->stopTiming();
937 protected function actuallyDoTick(
int $currentTick) : void{
938 if(!$this->stopTime){
940 if($this->time === PHP_INT_MAX){
941 $this->time = PHP_INT_MIN;
947 $this->sunAnglePercentage = $this->computeSunAnglePercentage();
948 $this->skyLightReduction = $this->computeSkyLightReduction();
950 if(++$this->sendTimeTicker === 200){
952 $this->sendTimeTicker = 0;
955 $this->unloadChunks();
956 if(++$this->providerGarbageCollectionTicker >= 6000){
957 $this->provider->doGarbageCollection();
958 $this->providerGarbageCollectionTicker = 0;
961 $this->timings->scheduledBlockUpdates->startTiming();
963 while($this->scheduledBlockUpdateQueue->count() > 0 && $this->scheduledBlockUpdateQueue->current()[
"priority"] <= $currentTick){
965 $vec = $this->scheduledBlockUpdateQueue->extract()[
"data"];
966 unset($this->scheduledBlockUpdateQueueIndex[World::blockHash($vec->x, $vec->y, $vec->z)]);
967 if(!$this->isInLoadedTerrain($vec)){
970 $block = $this->getBlock($vec);
971 $block->onScheduledUpdate();
973 $this->timings->scheduledBlockUpdates->stopTiming();
975 $this->timings->neighbourBlockUpdates->startTiming();
977 while($this->neighbourBlockUpdateQueue->count() > 0){
978 $index = $this->neighbourBlockUpdateQueue->dequeue();
979 unset($this->neighbourBlockUpdateQueueIndex[$index]);
980 World::getBlockXYZ($index, $x, $y, $z);
981 if(!$this->isChunkLoaded($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)){
985 $block = $this->getBlockAt($x, $y, $z);
987 if(BlockUpdateEvent::hasHandlers()){
988 $ev =
new BlockUpdateEvent($block);
990 if($ev->isCancelled()){
994 foreach($this->getNearbyEntities(AxisAlignedBB::one()->offset($x, $y, $z)) as $entity){
995 $entity->onNearbyBlockChange();
997 $block->onNearbyBlockChange();
1000 $this->timings->neighbourBlockUpdates->stopTiming();
1002 $this->timings->entityTick->startTiming();
1004 foreach($this->updateEntities as $id => $entity){
1005 if($entity->isClosed() || $entity->isFlaggedForDespawn() || !$entity->onUpdate($currentTick)){
1006 unset($this->updateEntities[$id]);
1008 if($entity->isFlaggedForDespawn()){
1012 $this->timings->entityTick->stopTiming();
1014 $this->timings->randomChunkUpdates->startTiming();
1015 $this->tickChunks();
1016 $this->timings->randomChunkUpdates->stopTiming();
1018 $this->executeQueuedLightUpdates();
1020 if(count($this->changedBlocks) > 0){
1021 if(count($this->players) > 0){
1022 foreach($this->changedBlocks as $index => $blocks){
1023 if(count($blocks) === 0){
1026 World::getXZ($index, $chunkX, $chunkZ);
1027 if(!$this->isChunkLoaded($chunkX, $chunkZ)){
1031 if(count($blocks) > 512){
1032 $chunk = $this->getChunk($chunkX, $chunkZ) ??
throw new AssumptionFailedError(
"We already checked that the chunk is loaded");
1033 foreach($this->getChunkPlayers($chunkX, $chunkZ) as $p){
1034 $p->onChunkChanged($chunkX, $chunkZ, $chunk);
1037 foreach($this->createBlockUpdatePackets($blocks) as $packet){
1038 $this->broadcastPacketToPlayersUsingChunk($chunkX, $chunkZ, $packet);
1044 $this->changedBlocks = [];
1048 if($this->sleepTicks > 0 && --$this->sleepTicks <= 0){
1049 $this->checkSleep();
1052 foreach($this->packetBuffersByChunk as $index => $entries){
1053 World::getXZ($index, $chunkX, $chunkZ);
1054 $chunkPlayers = $this->getChunkPlayers($chunkX, $chunkZ);
1055 if(count($chunkPlayers) > 0){
1056 NetworkBroadcastUtils::broadcastPackets($chunkPlayers, $entries);
1060 $this->packetBuffersByChunk = [];
1063 public function checkSleep() : void{
1064 if(count($this->players) === 0){
1069 foreach($this->getPlayers() as $p){
1070 if(!$p->isSleeping()){
1077 $time = $this->getTimeOfDay();
1079 if($time >= World::TIME_NIGHT && $time < World::TIME_SUNRISE){
1080 $this->setTime($this->getTime() + World::TIME_FULL - $time);
1082 foreach($this->getPlayers() as $p){
1089 public function setSleepTicks(
int $ticks) : void{
1090 $this->sleepTicks = $ticks;
1102 $blockTranslator = TypeConverter::getInstance()->getBlockTranslator();
1104 foreach($blocks as $b){
1106 throw new \TypeError(
"Expected Vector3 in blocks array, got " . (is_object($b) ? get_class($b) : gettype($b)));
1109 $fullBlock = $this->getBlockAt($b->x, $b->y, $b->z);
1110 $blockPosition = BlockPosition::fromVector3($b);
1112 $tile = $this->getTileAt($b->x, $b->y, $b->z);
1114 $expectedClass = $fullBlock->getIdInfo()->getTileClass();
1115 if($expectedClass !==
null && $tile instanceof $expectedClass && count($fakeStateProperties = $tile->getRenderUpdateBugWorkaroundStateProperties($fullBlock)) > 0){
1116 $originalStateData = $blockTranslator->internalIdToNetworkStateData($fullBlock->getStateId());
1118 $originalStateData->getName(),
1119 array_merge($originalStateData->getStates(), $fakeStateProperties),
1120 $originalStateData->getVersion()
1122 $packets[] = UpdateBlockPacket::create(
1124 $blockTranslator->getBlockStateDictionary()->lookupStateIdFromData($fakeStateData) ??
throw new AssumptionFailedError(
"Unmapped fake blockstate data: " . $fakeStateData->toNbt()),
1125 UpdateBlockPacket::FLAG_NETWORK,
1126 UpdateBlockPacket::DATA_LAYER_NORMAL
1130 $packets[] = UpdateBlockPacket::create(
1132 $blockTranslator->internalIdToNetworkId($fullBlock->getStateId()),
1133 UpdateBlockPacket::FLAG_NETWORK,
1134 UpdateBlockPacket::DATA_LAYER_NORMAL
1138 $packets[] = BlockActorDataPacket::create($blockPosition, $tile->getSerializedSpawnCompound());
1145 public function clearCache(
bool $force =
false) : void{
1147 $this->blockCache = [];
1148 $this->blockCacheSize = 0;
1149 $this->blockCollisionBoxCache = [];
1152 $this->blockCacheSize = 0;
1153 foreach($this->blockCache as $list){
1154 $this->blockCacheSize += count($list);
1155 if($this->blockCacheSize > self::BLOCK_CACHE_SIZE_CAP){
1156 $this->blockCache = [];
1157 $this->blockCacheSize = 0;
1163 foreach($this->blockCollisionBoxCache as $list){
1164 $count += count($list);
1165 if($count > self::BLOCK_CACHE_SIZE_CAP){
1167 $this->blockCollisionBoxCache = [];
1174 private function trimBlockCache() : void{
1175 $before = $this->blockCacheSize;
1178 foreach($this->blockCache as $chunkHash => $blocks){
1179 unset($this->blockCache[$chunkHash]);
1180 $this->blockCacheSize -= count($blocks);
1181 if($this->blockCacheSize < self::BLOCK_CACHE_SIZE_CAP){
1192 return $this->randomTickBlocks;
1195 public function addRandomTickedBlock(
Block $block) : void{
1197 throw new \InvalidArgumentException(
"Cannot do random-tick on unknown block");
1199 $this->randomTickBlocks[$block->getStateId()] =
true;
1202 public function removeRandomTickedBlock(Block $block) : void{
1203 unset($this->randomTickBlocks[$block->getStateId()]);
1211 return $this->chunkTickRadius;
1219 $this->chunkTickRadius = $radius;
1230 return array_keys($this->validTickingChunks);
1238 $chunkPosHash =
World::chunkHash($chunkX, $chunkZ);
1239 $this->registeredTickingChunks[$chunkPosHash][spl_object_id($ticker)] = $ticker;
1240 $this->recheckTickingChunks[$chunkPosHash] = $chunkPosHash;
1248 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
1249 $tickerId = spl_object_id($ticker);
1250 if(isset($this->registeredTickingChunks[$chunkHash][$tickerId])){
1251 if(count($this->registeredTickingChunks[$chunkHash]) === 1){
1253 $this->registeredTickingChunks[$chunkHash],
1254 $this->recheckTickingChunks[$chunkHash],
1255 $this->validTickingChunks[$chunkHash]
1258 unset($this->registeredTickingChunks[$chunkHash][$tickerId]);
1263 private function tickChunks() : void{
1264 if($this->chunkTickRadius <= 0 || count($this->registeredTickingChunks) === 0){
1268 if(count($this->recheckTickingChunks) > 0){
1269 $this->timings->randomChunkUpdatesChunkSelection->startTiming();
1271 $chunkTickableCache = [];
1273 foreach($this->recheckTickingChunks as $hash => $_){
1274 World::getXZ($hash, $chunkX, $chunkZ);
1275 if($this->isChunkTickable($chunkX, $chunkZ, $chunkTickableCache)){
1276 $this->validTickingChunks[$hash] = $hash;
1279 $this->recheckTickingChunks = [];
1281 $this->timings->randomChunkUpdatesChunkSelection->stopTiming();
1284 foreach($this->validTickingChunks as $index => $_){
1285 World::getXZ($index, $chunkX, $chunkZ);
1287 $this->tickChunk($chunkX, $chunkZ);
1297 private function isChunkTickable(
int $chunkX,
int $chunkZ, array &$cache) : bool{
1298 for($cx = -1; $cx <= 1; ++$cx){
1299 for($cz = -1; $cz <= 1; ++$cz){
1300 $chunkHash = World::chunkHash($chunkX + $cx, $chunkZ + $cz);
1301 if(isset($cache[$chunkHash])){
1302 if(!$cache[$chunkHash]){
1307 if($this->isChunkLocked($chunkX + $cx, $chunkZ + $cz)){
1308 $cache[$chunkHash] =
false;
1311 $adjacentChunk = $this->getChunk($chunkX + $cx, $chunkZ + $cz);
1312 if($adjacentChunk ===
null || !$adjacentChunk->isPopulated()){
1313 $cache[$chunkHash] =
false;
1316 $lightPopulatedState = $adjacentChunk->isLightPopulated();
1317 if($lightPopulatedState !==
true){
1318 if($lightPopulatedState ===
false){
1319 $this->orderLightPopulation($chunkX + $cx, $chunkZ + $cz);
1321 $cache[$chunkHash] =
false;
1325 $cache[$chunkHash] =
true;
1341 private function markTickingChunkForRecheck(
int $chunkX,
int $chunkZ) : void{
1342 for($cx = -1; $cx <= 1; ++$cx){
1343 for($cz = -1; $cz <= 1; ++$cz){
1344 $chunkHash = World::chunkHash($chunkX + $cx, $chunkZ + $cz);
1345 unset($this->validTickingChunks[$chunkHash]);
1346 if(isset($this->registeredTickingChunks[$chunkHash])){
1347 $this->recheckTickingChunks[$chunkHash] = $chunkHash;
1349 unset($this->recheckTickingChunks[$chunkHash]);
1355 private function orderLightPopulation(
int $chunkX,
int $chunkZ) : void{
1356 $chunkHash = World::chunkHash($chunkX, $chunkZ);
1357 $lightPopulatedState = $this->chunks[$chunkHash]->isLightPopulated();
1358 if($lightPopulatedState ===
false){
1359 $this->chunks[$chunkHash]->setLightPopulated(
null);
1360 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
1362 $this->workerPool->submitTask(
new LightPopulationTask(
1363 $this->chunks[$chunkHash],
1364 function(array $blockLight, array $skyLight, array $heightMap) use ($chunkX, $chunkZ) :
void{
1371 if($this->unloaded || ($chunk = $this->getChunk($chunkX, $chunkZ)) ===
null || $chunk->isLightPopulated() ===
true){
1376 $chunk->setHeightMapArray($heightMap);
1377 foreach($blockLight as $y => $lightArray){
1378 $chunk->getSubChunk($y)->setBlockLightArray($lightArray);
1380 foreach($skyLight as $y => $lightArray){
1381 $chunk->getSubChunk($y)->setBlockSkyLightArray($lightArray);
1383 $chunk->setLightPopulated(
true);
1384 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
1390 private function tickChunk(
int $chunkX,
int $chunkZ) : void{
1391 $chunk = $this->getChunk($chunkX, $chunkZ);
1392 if($chunk ===
null){
1396 foreach($this->getChunkEntities($chunkX, $chunkZ) as $entity){
1397 $entity->onRandomUpdate();
1400 $blockFactory = $this->blockStateRegistry;
1401 foreach($chunk->getSubChunks() as $Y => $subChunk){
1402 if(!$subChunk->isEmptyFast()){
1404 for($i = 0; $i < $this->tickedBlocksPerSubchunkPerTick; ++$i){
1407 $k = mt_rand(0, (1 << 60) - 1);
1409 $x = $k & SubChunk::COORD_MASK;
1410 $y = ($k >> SubChunk::COORD_BIT_SIZE) & SubChunk::COORD_MASK;
1411 $z = ($k >> (SubChunk::COORD_BIT_SIZE * 2)) & SubChunk::COORD_MASK;
1412 $k >>= (SubChunk::COORD_BIT_SIZE * 3);
1414 $state = $subChunk->getBlockStateId($x, $y, $z);
1416 if(isset($this->randomTickBlocks[$state])){
1417 $block = $blockFactory->fromStateId($state);
1418 $block->position($this, $chunkX * Chunk::EDGE_LENGTH + $x, ($Y << SubChunk::COORD_BIT_SIZE) + $y, $chunkZ * Chunk::EDGE_LENGTH + $z);
1419 $block->onRandomTick();
1433 public function save(
bool $force =
false) : bool{
1435 if(!$this->getAutoSave() && !$force){
1439 (
new WorldSaveEvent($this))->call();
1441 $timings = $this->timings->syncDataSave;
1442 $timings->startTiming();
1444 $this->provider->getWorldData()->setTime($this->time);
1445 $this->saveChunks();
1446 $this->provider->getWorldData()->save();
1448 $timings->stopTiming();
1453 public function saveChunks() : void{
1454 $this->timings->syncChunkSave->startTiming();
1456 foreach($this->chunks as $chunkHash => $chunk){
1457 self::getXZ($chunkHash, $chunkX, $chunkZ);
1458 $this->provider->saveChunk($chunkX, $chunkZ,
new ChunkData(
1459 $chunk->getSubChunks(),
1460 $chunk->isPopulated(),
1461 array_map(fn(Entity $e) => $e->saveNBT(), array_values(array_filter($this->getChunkEntities($chunkX, $chunkZ), fn(Entity $e) => $e->canSaveWithChunk()))),
1462 array_map(fn(Tile $t) => $t->saveNBT(), array_values($chunk->getTiles())),
1463 ), $chunk->getTerrainDirtyFlags());
1464 $chunk->clearTerrainDirtyFlags();
1467 $this->timings->syncChunkSave->stopTiming();
1477 !$this->isInWorld($pos->x, $pos->y, $pos->z) ||
1478 (isset($this->scheduledBlockUpdateQueueIndex[$index =
World::blockHash($pos->x, $pos->y, $pos->z)]) && $this->scheduledBlockUpdateQueueIndex[$index] <= $delay)
1482 $this->scheduledBlockUpdateQueueIndex[$index] = $delay;
1483 $this->scheduledBlockUpdateQueue->insert(
new Vector3((
int) $pos->x, (
int) $pos->y, (
int) $pos->z), $delay + $this->server->getTick());
1486 private function tryAddToNeighbourUpdateQueue(
int $x,
int $y,
int $z) : void{
1487 if($this->isInWorld($x, $y, $z)){
1488 $hash = World::blockHash($x, $y, $z);
1489 if(!isset($this->neighbourBlockUpdateQueueIndex[$hash])){
1490 $this->neighbourBlockUpdateQueue->enqueue($hash);
1491 $this->neighbourBlockUpdateQueueIndex[$hash] =
true;
1502 private function internalNotifyNeighbourBlockUpdate(
int $x,
int $y,
int $z) : void{
1503 $this->tryAddToNeighbourUpdateQueue($x, $y, $z);
1504 foreach(Facing::OFFSET as [$dx, $dy, $dz]){
1505 $this->tryAddToNeighbourUpdateQueue($x + $dx, $y + $dy, $z + $dz);
1517 $this->internalNotifyNeighbourBlockUpdate($pos->getFloorX(), $pos->getFloorY(), $pos->getFloorZ());
1525 $minX = (int) floor($bb->minX - 1);
1526 $minY = (int) floor($bb->minY - 1);
1527 $minZ = (int) floor($bb->minZ - 1);
1528 $maxX = (int) floor($bb->maxX + 1);
1529 $maxY = (int) floor($bb->maxY + 1);
1530 $maxZ = (int) floor($bb->maxZ + 1);
1534 $collisionInfo = $this->blockStateRegistry->collisionInfo;
1536 for($z = $minZ; $z <= $maxZ; ++$z){
1537 $zOverflow = $z === $minZ || $z === $maxZ;
1538 for($x = $minX; $x <= $maxX; ++$x){
1539 $zxOverflow = $zOverflow || $x === $minX || $x === $maxX;
1540 for($y = $minY; $y <= $maxY; ++$y){
1541 $overflow = $zxOverflow || $y === $minY || $y === $maxY;
1543 $stateCollisionInfo = $this->getBlockCollisionInfo($x, $y, $z, $collisionInfo);
1545 $stateCollisionInfo === RuntimeBlockStateRegistry::COLLISION_MAY_OVERFLOW && $this->getBlockAt($x, $y, $z)->collidesWithBB($bb) :
1546 match ($stateCollisionInfo) {
1547 RuntimeBlockStateRegistry::COLLISION_CUBE =>
true,
1548 RuntimeBlockStateRegistry::COLLISION_NONE =>
false,
1549 default => $this->getBlockAt($x, $y, $z)->collidesWithBB($bb)
1552 return [$this->getBlockAt($x, $y, $z)];
1559 for($z = $minZ; $z <= $maxZ; ++$z){
1560 $zOverflow = $z === $minZ || $z === $maxZ;
1561 for($x = $minX; $x <= $maxX; ++$x){
1562 $zxOverflow = $zOverflow || $x === $minX || $x === $maxX;
1563 for($y = $minY; $y <= $maxY; ++$y){
1564 $overflow = $zxOverflow || $y === $minY || $y === $maxY;
1566 $stateCollisionInfo = $this->getBlockCollisionInfo($x, $y, $z, $collisionInfo);
1568 $stateCollisionInfo === RuntimeBlockStateRegistry::COLLISION_MAY_OVERFLOW && $this->getBlockAt($x, $y, $z)->collidesWithBB($bb) :
1569 match ($stateCollisionInfo) {
1570 RuntimeBlockStateRegistry::COLLISION_CUBE =>
true,
1571 RuntimeBlockStateRegistry::COLLISION_NONE =>
false,
1572 default => $this->getBlockAt($x, $y, $z)->collidesWithBB($bb)
1575 $collides[] = $this->getBlockAt($x, $y, $z);
1589 private function getBlockCollisionInfo(
int $x,
int $y,
int $z, array $collisionInfo) : int{
1590 if(!$this->isInWorld($x, $y, $z)){
1591 return RuntimeBlockStateRegistry::COLLISION_NONE;
1593 $chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE);
1594 if($chunk ===
null){
1595 return RuntimeBlockStateRegistry::COLLISION_NONE;
1598 ->getSubChunk($y >> SubChunk::COORD_BIT_SIZE)
1600 $x & SubChunk::COORD_MASK,
1601 $y & SubChunk::COORD_MASK,
1602 $z & SubChunk::COORD_MASK
1604 return $collisionInfo[$stateId];
1618 private function getBlockCollisionBoxesForCell(
int $x,
int $y,
int $z, array $collisionInfo) : array{
1619 $stateCollisionInfo = $this->getBlockCollisionInfo($x, $y, $z, $collisionInfo);
1620 $boxes = match($stateCollisionInfo){
1621 RuntimeBlockStateRegistry::COLLISION_NONE => [],
1622 RuntimeBlockStateRegistry::COLLISION_CUBE => [AxisAlignedBB::one()->offset($x, $y, $z)],
1623 default => $this->getBlockAt($x, $y, $z)->getCollisionBoxes()
1627 if($stateCollisionInfo !== RuntimeBlockStateRegistry::COLLISION_CUBE){
1629 foreach(Facing::OFFSET as [$dx, $dy, $dz]){
1630 $offsetX = $x + $dx;
1631 $offsetY = $y + $dy;
1632 $offsetZ = $z + $dz;
1633 $stateCollisionInfo = $this->getBlockCollisionInfo($offsetX, $offsetY, $offsetZ, $collisionInfo);
1634 if($stateCollisionInfo === RuntimeBlockStateRegistry::COLLISION_MAY_OVERFLOW){
1636 $cellBB ??= AxisAlignedBB::one()->offset($x, $y, $z);
1637 $extraBoxes = $this->getBlockAt($offsetX, $offsetY, $offsetZ)->getCollisionBoxes();
1638 foreach($extraBoxes as $extraBox){
1639 if($extraBox->intersectsWith($cellBB)){
1640 $boxes[] = $extraBox;
1655 $minX = (int) floor($bb->minX);
1656 $minY = (int) floor($bb->minY);
1657 $minZ = (int) floor($bb->minZ);
1658 $maxX = (int) floor($bb->maxX);
1659 $maxY = (int) floor($bb->maxY);
1660 $maxZ = (int) floor($bb->maxZ);
1664 $collisionInfo = $this->blockStateRegistry->collisionInfo;
1666 for($z = $minZ; $z <= $maxZ; ++$z){
1667 for($x = $minX; $x <= $maxX; ++$x){
1668 $chunkPosHash = World::chunkHash($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE);
1669 for($y = $minY; $y <= $maxY; ++$y){
1670 $relativeBlockHash = World::chunkBlockHash($x, $y, $z);
1672 $boxes = $this->blockCollisionBoxCache[$chunkPosHash][$relativeBlockHash] ??= $this->getBlockCollisionBoxesForCell($x, $y, $z, $collisionInfo);
1674 foreach($boxes as $blockBB){
1675 if($blockBB->intersectsWith($bb)){
1676 $collides[] = $blockBB;
1691 $timeProgress = ($this->time % self::TIME_FULL) / self::TIME_FULL;
1694 $sunProgress = $timeProgress + ($timeProgress < 0.25 ? 0.75 : -0.25);
1698 $diff = (((1 - ((cos($sunProgress * M_PI) + 1) / 2)) - $sunProgress) / 3);
1700 return $sunProgress + $diff;
1707 return $this->sunAnglePercentage;
1714 return $this->sunAnglePercentage * 2 * M_PI;
1721 return $this->sunAnglePercentage * 360.0;
1729 $percentage = max(0, min(1, -(cos($this->getSunAngleRadians()) * 2 - 0.5)));
1733 return (
int) ($percentage * 11);
1740 return $this->skyLightReduction;
1748 $floorX = $pos->getFloorX();
1749 $floorY = $pos->getFloorY();
1750 $floorZ = $pos->getFloorZ();
1751 return $this->getFullLightAt($floorX, $floorY, $floorZ);
1759 $skyLight = $this->getRealBlockSkyLightAt($x, $y, $z);
1761 return max($skyLight, $this->getBlockLightAt($x, $y, $z));
1772 return $this->getHighestAdjacentLight($x, $y, $z, $this->getFullLightAt(...));
1780 $floorX = $pos->getFloorX();
1781 $floorY = $pos->getFloorY();
1782 $floorZ = $pos->getFloorZ();
1783 return $this->getPotentialLightAt($floorX, $floorY, $floorZ);
1791 return max($this->getPotentialBlockSkyLightAt($x, $y, $z), $this->getBlockLightAt($x, $y, $z));
1799 return $this->getHighestAdjacentLight($x, $y, $z, $this->getPotentialLightAt(...));
1809 if(!$this->isInWorld($x, $y, $z)){
1810 return $y >= self::Y_MAX ? 15 : 0;
1812 if(($chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)) !==
null && $chunk->isLightPopulated() ===
true){
1813 return $chunk->getSubChunk($y >> Chunk::COORD_BIT_SIZE)->getBlockSkyLightArray()->get($x & SubChunk::COORD_MASK, $y & SubChunk::COORD_MASK, $z & SubChunk::COORD_MASK);
1824 $light = $this->getPotentialBlockSkyLightAt($x, $y, $z) - $this->skyLightReduction;
1825 return $light < 0 ? 0 : $light;
1834 if(!$this->isInWorld($x, $y, $z)){
1837 if(($chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)) !==
null && $chunk->isLightPopulated() ===
true){
1838 return $chunk->getSubChunk($y >> Chunk::COORD_BIT_SIZE)->getBlockLightArray()->get($x & SubChunk::COORD_MASK, $y & SubChunk::COORD_MASK, $z & SubChunk::COORD_MASK);
1843 public function updateAllLight(
int $x,
int $y,
int $z) : void{
1844 if(($chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)) === null || $chunk->isLightPopulated() !== true){
1848 $blockFactory = $this->blockStateRegistry;
1849 $this->timings->doBlockSkyLightUpdates->startTiming();
1850 if($this->skyLightUpdate ===
null){
1851 $this->skyLightUpdate =
new SkyLightUpdate(
new SubChunkExplorer($this), $blockFactory->lightFilter, $blockFactory->blocksDirectSkyLight);
1853 $this->skyLightUpdate->recalculateNode($x, $y, $z);
1854 $this->timings->doBlockSkyLightUpdates->stopTiming();
1856 $this->timings->doBlockLightUpdates->startTiming();
1857 if($this->blockLightUpdate ===
null){
1858 $this->blockLightUpdate =
new BlockLightUpdate(
new SubChunkExplorer($this), $blockFactory->lightFilter, $blockFactory->light);
1860 $this->blockLightUpdate->recalculateNode($x, $y, $z);
1861 $this->timings->doBlockLightUpdates->stopTiming();
1867 private function getHighestAdjacentLight(
int $x,
int $y,
int $z, \Closure $lightGetter) : int{
1869 foreach(Facing::OFFSET as [$offsetX, $offsetY, $offsetZ]){
1870 $x1 = $x + $offsetX;
1871 $y1 = $y + $offsetY;
1872 $z1 = $z + $offsetZ;
1874 !$this->isInWorld($x1, $y1, $z1) ||
1875 ($chunk = $this->getChunk($x1 >> Chunk::COORD_BIT_SIZE, $z1 >> Chunk::COORD_BIT_SIZE)) ===
null ||
1876 $chunk->isLightPopulated() !==
true
1880 $max = max($max, $lightGetter($x1, $y1, $z1));
1889 return $this->getHighestAdjacentLight($x, $y, $z, $this->getPotentialBlockSkyLightAt(...));
1897 return $this->getHighestAdjacentPotentialBlockSkyLight($x, $y, $z) - $this->skyLightReduction;
1904 return $this->getHighestAdjacentLight($x, $y, $z, $this->getBlockLightAt(...));
1907 private function executeQueuedLightUpdates() : void{
1908 if($this->blockLightUpdate !== null){
1909 $this->timings->doBlockLightUpdates->startTiming();
1910 $this->blockLightUpdate->execute();
1911 $this->blockLightUpdate =
null;
1912 $this->timings->doBlockLightUpdates->stopTiming();
1915 if($this->skyLightUpdate !==
null){
1916 $this->timings->doBlockSkyLightUpdates->startTiming();
1917 $this->skyLightUpdate->execute();
1918 $this->skyLightUpdate =
null;
1919 $this->timings->doBlockSkyLightUpdates->stopTiming();
1926 $y < $this->maxY && $y >= $this->minY &&
1942 return $this->getBlockAt((int) floor($pos->x), (int) floor($pos->y), (int) floor($pos->z), $cached, $addToCache);
1954 public function getBlockAt(
int $x,
int $y,
int $z,
bool $cached =
true,
bool $addToCache =
true) :
Block{
1955 $relativeBlockHash = null;
1956 $chunkHash = World::chunkHash($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE);
1958 if($this->isInWorld($x, $y, $z)){
1959 $relativeBlockHash = World::chunkBlockHash($x, $y, $z);
1961 if($cached && isset($this->blockCache[$chunkHash][$relativeBlockHash])){
1962 return $this->blockCache[$chunkHash][$relativeBlockHash];
1965 $chunk = $this->chunks[$chunkHash] ??
null;
1966 if($chunk !==
null){
1967 $block = $this->blockStateRegistry->fromStateId($chunk->getBlockStateId($x & Chunk::COORD_MASK, $y, $z & Chunk::COORD_MASK));
1969 $addToCache =
false;
1970 $block = VanillaBlocks::AIR();
1973 $block = VanillaBlocks::AIR();
1976 $block->position($this, $x, $y, $z);
1978 if($this->inDynamicStateRecalculation){
1982 $addToCache =
false;
1984 $this->inDynamicStateRecalculation =
true;
1985 $replacement = $block->readStateFromWorld();
1986 if($replacement !== $block){
1987 $replacement->position($this, $x, $y, $z);
1988 $block = $replacement;
1990 $this->inDynamicStateRecalculation =
false;
1993 if($addToCache && $relativeBlockHash !==
null){
1994 $this->blockCache[$chunkHash][$relativeBlockHash] = $block;
1996 if(++$this->blockCacheSize >= self::BLOCK_CACHE_SIZE_CAP){
1997 $this->trimBlockCache();
2010 $this->setBlockAt((int) floor($pos->x), (int) floor($pos->y), (int) floor($pos->z), $block, $update);
2021 public function setBlockAt(
int $x,
int $y,
int $z,
Block $block,
bool $update =
true) : void{
2022 if(!$this->isInWorld($x, $y, $z)){
2023 throw new \InvalidArgumentException(
"Pos x=$x,y=$y,z=$z is outside of the world bounds");
2025 $chunkX = $x >> Chunk::COORD_BIT_SIZE;
2026 $chunkZ = $z >> Chunk::COORD_BIT_SIZE;
2027 if($this->loadChunk($chunkX, $chunkZ) ===
null){
2028 throw new WorldException(
"Cannot set a block in un-generated terrain");
2032 $stateId = $block->getStateId();
2033 if(!$this->blockStateRegistry->hasStateId($stateId)){
2034 throw new \LogicException(
"Block state ID not known to RuntimeBlockStateRegistry (probably not registered)");
2036 if(!GlobalBlockStateHandlers::getSerializer()->isRegistered($block)){
2037 throw new \LogicException(
"Block not registered with GlobalBlockStateHandlers serializer");
2040 $this->timings->setBlock->startTiming();
2042 $this->unlockChunk($chunkX, $chunkZ,
null);
2044 $block = clone $block;
2046 $block->position($this, $x, $y, $z);
2047 $block->writeStateToWorld();
2048 $pos =
new Vector3($x, $y, $z);
2050 $chunkHash = World::chunkHash($chunkX, $chunkZ);
2051 $relativeBlockHash = World::chunkBlockHash($x, $y, $z);
2053 unset($this->blockCache[$chunkHash][$relativeBlockHash]);
2054 $this->blockCacheSize--;
2055 unset($this->blockCollisionBoxCache[$chunkHash][$relativeBlockHash]);
2058 foreach(Facing::OFFSET as [$offsetX, $offsetY, $offsetZ]){
2059 $sideChunkPosHash = World::chunkHash(($x + $offsetX) >> Chunk::COORD_BIT_SIZE, ($z + $offsetZ) >> Chunk::COORD_BIT_SIZE);
2060 $sideChunkBlockHash = World::chunkBlockHash($x + $offsetX, $y + $offsetY, $z + $offsetZ);
2061 unset($this->blockCollisionBoxCache[$sideChunkPosHash][$sideChunkBlockHash]);
2064 if(!isset($this->changedBlocks[$chunkHash])){
2065 $this->changedBlocks[$chunkHash] = [];
2067 $this->changedBlocks[$chunkHash][$relativeBlockHash] = $pos;
2069 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2070 $listener->onBlockChanged($pos);
2074 $this->updateAllLight($x, $y, $z);
2075 $this->internalNotifyNeighbourBlockUpdate($x, $y, $z);
2078 $this->timings->setBlock->stopTiming();
2081 public function dropItem(Vector3 $source, Item $item, ?Vector3 $motion =
null,
int $delay = 10) : ?ItemEntity{
2082 if($item->isNull()){
2086 $itemEntity =
new ItemEntity(Location::fromObject($source, $this, Utils::getRandomFloat() * 360, 0), $item);
2088 $itemEntity->setPickupDelay($delay);
2089 $itemEntity->setMotion($motion ??
new Vector3(Utils::getRandomFloat() * 0.2 - 0.1, 0.2, Utils::getRandomFloat() * 0.2 - 0.1));
2090 $itemEntity->spawnToAll();
2104 foreach(ExperienceOrb::splitIntoOrbSizes($amount) as $split){
2105 $orb =
new ExperienceOrb(Location::fromObject($pos, $this, Utils::getRandomFloat() * 360, 0), $split);
2107 $orb->setMotion(
new Vector3((Utils::getRandomFloat() * 0.2 - 0.1) * 2, Utils::getRandomFloat() * 0.4, (Utils::getRandomFloat() * 0.2 - 0.1) * 2));
2124 public function useBreakOn(
Vector3 $vector, ?
Item &$item =
null, ?
Player $player =
null,
bool $createParticles =
false, array &$returnedItems = []) : bool{
2125 $vector = $vector->floor();
2127 $chunkX = $vector->getFloorX() >> Chunk::COORD_BIT_SIZE;
2128 $chunkZ = $vector->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2129 if(!$this->isChunkLoaded($chunkX, $chunkZ) || $this->isChunkLocked($chunkX, $chunkZ)){
2133 $target = $this->getBlock($vector);
2134 $affectedBlocks = $target->getAffectedBlocks();
2137 $item = VanillaItems::AIR();
2141 if($player ===
null || $player->hasFiniteResources()){
2142 $drops = array_merge(...array_map(fn(Block $block) => $block->getDrops($item), $affectedBlocks));
2146 if($player !==
null && $player->hasFiniteResources()){
2147 $xpDrop = array_sum(array_map(fn(Block $block) => $block->getXpDropForTool($item), $affectedBlocks));
2150 if($player !==
null){
2151 $ev =
new BlockBreakEvent($player, $target, $item, $player->isCreative(), $drops, $xpDrop);
2153 if($target instanceof Air || ($player->isSurvival() && !$target->getBreakInfo()->isBreakable()) || $player->isSpectator()){
2157 if($player->isAdventure(
true) && !$ev->isCancelled()){
2159 $itemParser = LegacyStringToItemParser::getInstance();
2160 foreach($item->getCanDestroy() as $v){
2161 $entry = $itemParser->parse($v);
2162 if($entry->getBlock()->hasSameTypeId($target)){
2174 if($ev->isCancelled()){
2178 $drops = $ev->getDrops();
2179 $xpDrop = $ev->getXpDropAmount();
2181 }elseif(!$target->getBreakInfo()->isBreakable()){
2185 foreach($affectedBlocks as $t){
2186 $this->destroyBlockInternal($t, $item, $player, $createParticles, $returnedItems);
2189 $item->onDestroyBlock($target, $returnedItems);
2191 if(count($drops) > 0){
2192 $dropPos = $vector->add(0.5, 0.5, 0.5);
2193 foreach($drops as $drop){
2194 if(!$drop->isNull()){
2195 $this->dropItem($dropPos, $drop);
2201 $this->dropExperience($vector->add(0.5, 0.5, 0.5), $xpDrop);
2210 private function destroyBlockInternal(Block $target, Item $item, ?Player $player,
bool $createParticles, array &$returnedItems) : void{
2211 if($createParticles){
2212 $this->addParticle($target->getPosition()->add(0.5, 0.5, 0.5),
new BlockBreakParticle($target));
2215 $target->onBreak($item, $player, $returnedItems);
2217 $tile = $this->getTile($target->getPosition());
2219 $tile->onBlockDestroyed();
2230 public function useItemOn(
Vector3 $vector,
Item &$item,
int $face, ?
Vector3 $clickVector =
null, ?
Player $player =
null,
bool $playSound =
false, array &$returnedItems = []) : bool{
2231 $blockClicked = $this->getBlock($vector);
2232 $blockReplace = $blockClicked->getSide($face);
2234 if($clickVector ===
null){
2235 $clickVector =
new Vector3(0.0, 0.0, 0.0);
2238 min(1.0, max(0.0, $clickVector->x)),
2239 min(1.0, max(0.0, $clickVector->y)),
2240 min(1.0, max(0.0, $clickVector->z))
2244 if(!$this->isInWorld($blockReplace->getPosition()->x, $blockReplace->getPosition()->y, $blockReplace->getPosition()->z)){
2248 $chunkX = $blockReplace->getPosition()->getFloorX() >> Chunk::COORD_BIT_SIZE;
2249 $chunkZ = $blockReplace->getPosition()->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2250 if(!$this->isChunkLoaded($chunkX, $chunkZ) || $this->isChunkLocked($chunkX, $chunkZ)){
2254 if($blockClicked->getTypeId() === BlockTypeIds::AIR){
2258 if($player !==
null){
2259 $ev = new PlayerInteractEvent($player, $item, $blockClicked, $clickVector, $face, PlayerInteractEvent::RIGHT_CLICK_BLOCK);
2260 if($player->isSneaking()){
2261 $ev->setUseItem(false);
2262 $ev->setUseBlock($item->isNull());
2264 if($player->isSpectator()){
2269 if(!$ev->isCancelled()){
2270 if($ev->useBlock() && $blockClicked->onInteract($item, $face, $clickVector, $player, $returnedItems)){
2275 $result = $item->onInteractBlock($player, $blockReplace, $blockClicked, $face, $clickVector, $returnedItems);
2276 if($result !== ItemUseResult::NONE){
2277 return $result === ItemUseResult::SUCCESS;
2283 }elseif($blockClicked->onInteract($item, $face, $clickVector, $player, $returnedItems)){
2287 if($item->isNull() || !$item->canBePlaced()){
2291 $hand->position($this, $blockReplace->getPosition()->x, $blockReplace->getPosition()->y, $blockReplace->getPosition()->z);
2293 if($hand->canBePlacedAt($blockClicked, $clickVector, $face,
true)){
2294 $blockReplace = $blockClicked;
2299 $hand->position($this, $blockReplace->getPosition()->x, $blockReplace->getPosition()->y, $blockReplace->getPosition()->z);
2300 }elseif(!$hand->canBePlacedAt($blockReplace, $clickVector, $face,
false)){
2304 $tx =
new BlockTransaction($this);
2305 if(!$hand->place($tx, $item, $blockReplace, $blockClicked, $face, $clickVector, $player)){
2309 foreach($tx->getBlocks() as [$x, $y, $z, $block]){
2310 $block->position($this, $x, $y, $z);
2311 foreach($block->getCollisionBoxes() as $collisionBox){
2312 if(count($this->getCollidingEntities($collisionBox)) > 0){
2318 if($player !==
null){
2319 $ev =
new BlockPlaceEvent($player, $tx, $blockClicked, $item);
2320 if($player->isSpectator()){
2324 if($player->isAdventure(
true) && !$ev->isCancelled()){
2326 $itemParser = LegacyStringToItemParser::getInstance();
2328 $entry = $itemParser->parse($v);
2329 if($entry->getBlock()->hasSameTypeId($blockClicked)){
2341 if($ev->isCancelled()){
2349 foreach($tx->getBlocks() as [$x, $y, $z, $_]){
2350 $tile = $this->getTileAt($x, $y, $z);
2353 $tile->copyDataFromItem($item);
2356 $this->getBlockAt($x, $y, $z)->onPostPlace();
2360 $this->addSound($hand->getPosition(),
new BlockPlaceSound($hand));
2368 public function getEntity(
int $entityId) : ?Entity{
2369 return $this->entities[$entityId] ?? null;
2379 return $this->entities;
2395 foreach($this->getNearbyEntities($bb, $entity) as $ent){
2396 if($ent->canBeCollidedWith() && ($entity ===
null || $entity->canCollideWith($ent))){
2413 $minX = ((int) floor($bb->minX - 2)) >> Chunk::COORD_BIT_SIZE;
2414 $maxX = ((int) floor($bb->maxX + 2)) >> Chunk::COORD_BIT_SIZE;
2415 $minZ = ((int) floor($bb->minZ - 2)) >> Chunk::COORD_BIT_SIZE;
2416 $maxZ = ((int) floor($bb->maxZ + 2)) >> Chunk::COORD_BIT_SIZE;
2418 for($x = $minX; $x <= $maxX; ++$x){
2419 for($z = $minZ; $z <= $maxZ; ++$z){
2420 foreach($this->getChunkEntities($x, $z) as $ent){
2421 if($ent !== $entity && $ent->boundingBox->intersectsWith($bb)){
2443 assert(is_a($entityType,
Entity::class, true));
2445 $minX = ((int) floor($pos->x - $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2446 $maxX = ((int) floor($pos->x + $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2447 $minZ = ((int) floor($pos->z - $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2448 $maxZ = ((int) floor($pos->z + $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2450 $currentTargetDistSq = $maxDistance ** 2;
2456 $currentTarget =
null;
2458 for($x = $minX; $x <= $maxX; ++$x){
2459 for($z = $minZ; $z <= $maxZ; ++$z){
2460 foreach($this->getChunkEntities($x, $z) as $entity){
2461 if(!($entity instanceof $entityType) || $entity->isFlaggedForDespawn() || (!$includeDead && !$entity->isAlive())){
2464 $distSq = $entity->getPosition()->distanceSquared($pos);
2465 if($distSq < $currentTargetDistSq){
2466 $currentTargetDistSq = $distSq;
2467 $currentTarget = $entity;
2473 return $currentTarget;
2483 return $this->players;
2493 return $this->getTileAt((int) floor($pos->x), (int) floor($pos->y), (int) floor($pos->z));
2500 return ($chunk = $this->loadChunk($x >>
Chunk::COORD_BIT_SIZE, $z >>
Chunk::COORD_BIT_SIZE)) !== null ? $chunk->getTile($x &
Chunk::COORD_MASK, $y, $z &
Chunk::COORD_MASK) : null;
2503 public function getBiomeId(
int $x,
int $y,
int $z) : int{
2504 if(($chunk = $this->loadChunk($x >>
Chunk::COORD_BIT_SIZE, $z >>
Chunk::COORD_BIT_SIZE)) !== null){
2505 return $chunk->getBiomeId($x & Chunk::COORD_MASK, $y & Chunk::COORD_MASK, $z & Chunk::COORD_MASK);
2507 return BiomeIds::OCEAN;
2510 public function getBiome(
int $x,
int $y,
int $z) : Biome{
2511 return BiomeRegistry::getInstance()->getBiome($this->getBiomeId($x, $y, $z));
2514 public function setBiomeId(
int $x,
int $y,
int $z,
int $biomeId) : void{
2515 $chunkX = $x >> Chunk::COORD_BIT_SIZE;
2516 $chunkZ = $z >> Chunk::COORD_BIT_SIZE;
2517 $this->unlockChunk($chunkX, $chunkZ,
null);
2518 if(($chunk = $this->loadChunk($chunkX, $chunkZ)) !==
null){
2519 $chunk->setBiomeId($x & Chunk::COORD_MASK, $y & Chunk::COORD_MASK, $z & Chunk::COORD_MASK, $biomeId);
2522 throw new WorldException(
"Cannot set biome in a non-generated chunk");
2531 return $this->chunks;
2534 public function getChunk(
int $chunkX,
int $chunkZ) : ?
Chunk{
2535 return $this->chunks[
World::chunkHash($chunkX, $chunkZ)] ?? null;
2543 return $this->entitiesByChunk[
World::chunkHash($chunkX, $chunkZ)] ?? [];
2550 return $this->loadChunk($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE);
2561 for($xx = -1; $xx <= 1; ++$xx){
2562 for($zz = -1; $zz <= 1; ++$zz){
2563 if($xx === 0 && $zz === 0){
2566 $result[World::chunkHash($xx, $zz)] = $this->loadChunk($x + $xx, $z + $zz);
2588 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
2589 if(isset($this->chunkLock[$chunkHash])){
2590 throw new \InvalidArgumentException(
"Chunk $chunkX $chunkZ is already locked");
2592 $this->chunkLock[$chunkHash] = $lockId;
2593 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
2605 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
2606 if(isset($this->chunkLock[$chunkHash]) && ($lockId ===
null || $this->chunkLock[$chunkHash] === $lockId)){
2607 unset($this->chunkLock[$chunkHash]);
2608 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
2620 return isset($this->chunkLock[
World::chunkHash($chunkX, $chunkZ)]);
2623 public function setChunk(
int $chunkX,
int $chunkZ,
Chunk $chunk) : void{
2624 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
2625 $oldChunk = $this->loadChunk($chunkX, $chunkZ);
2626 if($oldChunk !==
null && $oldChunk !== $chunk){
2628 $transferredTiles = 0;
2629 foreach($oldChunk->getTiles() as $oldTile){
2630 $tilePosition = $oldTile->getPosition();
2631 $localX = $tilePosition->getFloorX() & Chunk::COORD_MASK;
2632 $localY = $tilePosition->getFloorY();
2633 $localZ = $tilePosition->getFloorZ() & Chunk::COORD_MASK;
2635 $newBlock = $this->blockStateRegistry->fromStateId($chunk->
getBlockStateId($localX, $localY, $localZ));
2636 $expectedTileClass = $newBlock->getIdInfo()->getTileClass();
2638 $expectedTileClass ===
null ||
2639 !($oldTile instanceof $expectedTileClass) ||
2640 (($newTile = $chunk->
getTile($localX, $localY, $localZ)) !==
null && $newTile !== $oldTile)
2645 $transferredTiles++;
2646 $chunk->addTile($oldTile);
2647 $oldChunk->removeTile($oldTile);
2650 if($deletedTiles > 0 || $transferredTiles > 0){
2651 $this->logger->debug(
"Replacement of chunk $chunkX $chunkZ caused deletion of $deletedTiles obsolete/conflicted tiles, and transfer of $transferredTiles");
2655 $this->chunks[$chunkHash] = $chunk;
2657 $this->blockCacheSize -= count($this->blockCache[$chunkHash] ?? []);
2658 unset($this->blockCache[$chunkHash]);
2659 unset($this->blockCollisionBoxCache[$chunkHash]);
2660 unset($this->changedBlocks[$chunkHash]);
2661 $chunk->setTerrainDirty();
2662 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
2664 if(!$this->isChunkInUse($chunkX, $chunkZ)){
2665 $this->unloadChunkRequest($chunkX, $chunkZ);
2668 if($oldChunk ===
null){
2669 if(ChunkLoadEvent::hasHandlers()){
2670 (
new ChunkLoadEvent($this, $chunkX, $chunkZ, $chunk,
true))->call();
2673 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2674 $listener->onChunkLoaded($chunkX, $chunkZ, $chunk);
2677 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2678 $listener->onChunkChanged($chunkX, $chunkZ, $chunk);
2682 for($cX = -1; $cX <= 1; ++$cX){
2683 for($cZ = -1; $cZ <= 1; ++$cZ){
2684 foreach($this->getChunkEntities($chunkX + $cX, $chunkZ + $cZ) as $entity){
2685 $entity->onNearbyBlockChange();
2698 if(($chunk = $this->loadChunk($x >>
Chunk::COORD_BIT_SIZE, $z >>
Chunk::COORD_BIT_SIZE)) !== null){
2699 return $chunk->
getHighestBlockAt($x & Chunk::COORD_MASK, $z & Chunk::COORD_MASK);
2701 throw new WorldException(
"Cannot get highest block in an ungenerated chunk");
2708 return $this->isChunkLoaded($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE);
2711 public function isChunkLoaded(
int $x,
int $z) : bool{
2712 return isset($this->chunks[
World::chunkHash($x, $z)]);
2715 public function isChunkGenerated(
int $x,
int $z) : bool{
2716 return $this->loadChunk($x, $z) !== null;
2719 public function isChunkPopulated(
int $x,
int $z) : bool{
2720 $chunk = $this->loadChunk($x, $z);
2721 return $chunk !==
null && $chunk->isPopulated();
2728 return
Position::fromObject($this->provider->getWorldData()->getSpawn(), $this);
2735 $previousSpawn = $this->getSpawnLocation();
2736 $this->provider->getWorldData()->setSpawn($pos);
2739 $location = Position::fromObject($pos, $this);
2740 foreach($this->players as $player){
2741 $player->getNetworkSession()->syncWorldSpawnPoint($location);
2749 if($entity->isClosed()){
2750 throw new \InvalidArgumentException(
"Attempted to add a garbage closed Entity to world");
2752 if($entity->getWorld() !== $this){
2753 throw new \InvalidArgumentException(
"Invalid Entity world");
2755 if(array_key_exists($entity->getId(), $this->entities)){
2756 if($this->entities[$entity->getId()] === $entity){
2757 throw new \InvalidArgumentException(
"Entity " . $entity->getId() .
" has already been added to this world");
2759 throw new AssumptionFailedError(
"Found two different entities sharing entity ID " . $entity->getId());
2762 if(!EntityFactory::getInstance()->isRegistered($entity::class)){
2765 throw new \LogicException(
"Entity " . $entity::class .
" is not registered for a save ID in EntityFactory");
2767 $pos = $entity->getPosition()->
asVector3();
2768 $this->entitiesByChunk[World::chunkHash($pos->getFloorX() >> Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE)][$entity->getId()] = $entity;
2769 $this->entityLastKnownPositions[$entity->getId()] = $pos;
2771 if($entity instanceof Player){
2772 $this->players[$entity->getId()] = $entity;
2774 $this->entities[$entity->getId()] = $entity;
2783 if($entity->getWorld() !== $this){
2784 throw new \InvalidArgumentException(
"Invalid Entity world");
2786 if(!array_key_exists($entity->getId(), $this->entities)){
2787 throw new \InvalidArgumentException(
"Entity is not tracked by this world (possibly already removed?)");
2789 $pos = $this->entityLastKnownPositions[$entity->getId()];
2790 $chunkHash = World::chunkHash($pos->getFloorX() >> Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE);
2791 if(isset($this->entitiesByChunk[$chunkHash][$entity->getId()])){
2792 if(count($this->entitiesByChunk[$chunkHash]) === 1){
2793 unset($this->entitiesByChunk[$chunkHash]);
2795 unset($this->entitiesByChunk[$chunkHash][$entity->getId()]);
2798 unset($this->entityLastKnownPositions[$entity->getId()]);
2800 if($entity instanceof Player){
2801 unset($this->players[$entity->getId()]);
2802 $this->checkSleep();
2805 unset($this->entities[$entity->getId()]);
2806 unset($this->updateEntities[$entity->getId()]);
2812 public function onEntityMoved(Entity $entity) : void{
2813 if(!array_key_exists($entity->getId(), $this->entityLastKnownPositions)){
2817 $oldPosition = $this->entityLastKnownPositions[$entity->getId()];
2818 $newPosition = $entity->getPosition();
2820 $oldChunkX = $oldPosition->getFloorX() >> Chunk::COORD_BIT_SIZE;
2821 $oldChunkZ = $oldPosition->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2822 $newChunkX = $newPosition->getFloorX() >> Chunk::COORD_BIT_SIZE;
2823 $newChunkZ = $newPosition->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2825 if($oldChunkX !== $newChunkX || $oldChunkZ !== $newChunkZ){
2826 $oldChunkHash = World::chunkHash($oldChunkX, $oldChunkZ);
2827 if(isset($this->entitiesByChunk[$oldChunkHash][$entity->getId()])){
2828 if(count($this->entitiesByChunk[$oldChunkHash]) === 1){
2829 unset($this->entitiesByChunk[$oldChunkHash]);
2831 unset($this->entitiesByChunk[$oldChunkHash][$entity->getId()]);
2835 $newViewers = $this->getViewersForPosition($newPosition);
2836 foreach($entity->getViewers() as $player){
2837 if(!isset($newViewers[spl_object_id($player)])){
2838 $entity->despawnFrom($player);
2840 unset($newViewers[spl_object_id($player)]);
2843 foreach($newViewers as $player){
2844 $entity->spawnTo($player);
2847 $newChunkHash = World::chunkHash($newChunkX, $newChunkZ);
2848 $this->entitiesByChunk[$newChunkHash][$entity->getId()] = $entity;
2850 $this->entityLastKnownPositions[$entity->getId()] = $newPosition->asVector3();
2857 public function addTile(Tile $tile) : void{
2858 if($tile->isClosed()){
2859 throw new \InvalidArgumentException(
"Attempted to add a garbage closed Tile to world");
2861 $pos = $tile->getPosition();
2862 if(!$pos->isValid() || $pos->getWorld() !== $this){
2863 throw new \InvalidArgumentException(
"Invalid Tile world");
2865 if(!$this->isInWorld($pos->getFloorX(), $pos->getFloorY(), $pos->getFloorZ())){
2866 throw new \InvalidArgumentException(
"Tile position is outside the world bounds");
2868 if(!TileFactory::getInstance()->isRegistered($tile::class)){
2869 throw new \LogicException(
"Tile " . $tile::class .
" is not registered for a save ID in TileFactory");
2872 $chunkX = $pos->getFloorX() >> Chunk::COORD_BIT_SIZE;
2873 $chunkZ = $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2875 if(isset($this->chunks[$hash = World::chunkHash($chunkX, $chunkZ)])){
2876 $this->chunks[$hash]->addTile($tile);
2878 throw new \InvalidArgumentException(
"Attempted to create tile " . get_class($tile) .
" in unloaded chunk $chunkX $chunkZ");
2882 $this->scheduleDelayedBlockUpdate($pos->
asVector3(), 1);
2889 public function removeTile(Tile $tile) : void{
2891 if(!$pos->isValid() || $pos->getWorld() !== $this){
2892 throw new \InvalidArgumentException(
"Invalid Tile world");
2895 $chunkX = $pos->getFloorX() >> Chunk::COORD_BIT_SIZE;
2896 $chunkZ = $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2898 if(isset($this->chunks[$hash = World::chunkHash($chunkX, $chunkZ)])){
2899 $this->chunks[$hash]->removeTile($tile);
2901 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2902 $listener->onBlockChanged($pos->
asVector3());
2906 public function isChunkInUse(
int $x,
int $z) : bool{
2907 return isset($this->chunkLoaders[$index = World::chunkHash($x, $z)]) && count($this->chunkLoaders[$index]) > 0;
2917 if(isset($this->chunks[$chunkHash =
World::chunkHash($x, $z)])){
2918 return $this->chunks[$chunkHash];
2921 $this->timings->syncChunkLoad->startTiming();
2923 $this->cancelUnloadChunkRequest($x, $z);
2925 $this->timings->syncChunkLoadData->startTiming();
2927 $loadedChunkData =
null;
2930 $loadedChunkData = $this->provider->loadChunk($x, $z);
2931 }
catch(CorruptedChunkException $e){
2932 $this->logger->critical(
"Failed to load chunk x=$x z=$z: " . $e->getMessage());
2935 $this->timings->syncChunkLoadData->stopTiming();
2937 if($loadedChunkData ===
null){
2938 $this->timings->syncChunkLoad->stopTiming();
2942 $chunkData = $loadedChunkData->getData();
2943 $chunk =
new Chunk($chunkData->getSubChunks(), $chunkData->isPopulated());
2944 if(!$loadedChunkData->isUpgraded()){
2945 $chunk->clearTerrainDirtyFlags();
2947 $this->logger->debug(
"Chunk $x $z has been upgraded, will be saved at the next autosave opportunity");
2949 $this->chunks[$chunkHash] = $chunk;
2951 $this->blockCacheSize -= count($this->blockCache[$chunkHash] ?? []);
2952 unset($this->blockCache[$chunkHash]);
2953 unset($this->blockCollisionBoxCache[$chunkHash]);
2955 $this->initChunk($x, $z, $chunkData);
2957 if(ChunkLoadEvent::hasHandlers()){
2958 (
new ChunkLoadEvent($this, $x, $z, $this->chunks[$chunkHash],
false))->call();
2961 if(!$this->isChunkInUse($x, $z)){
2962 $this->logger->debug(
"Newly loaded chunk $x $z has no loaders registered, will be unloaded at next available opportunity");
2963 $this->unloadChunkRequest($x, $z);
2965 foreach($this->getChunkListeners($x, $z) as $listener){
2966 $listener->onChunkLoaded($x, $z, $this->chunks[$chunkHash]);
2968 $this->markTickingChunkForRecheck($x, $z);
2970 $this->timings->syncChunkLoad->stopTiming();
2972 return $this->chunks[$chunkHash];
2975 private function initChunk(
int $chunkX,
int $chunkZ, ChunkData $chunkData) : void{
2976 $logger = new \
PrefixedLogger($this->logger,
"Loading chunk $chunkX $chunkZ");
2978 if(count($chunkData->getEntityNBT()) !== 0){
2979 $this->timings->syncChunkLoadEntities->startTiming();
2980 $entityFactory = EntityFactory::getInstance();
2981 foreach($chunkData->getEntityNBT() as $k => $nbt){
2983 $entity = $entityFactory->createFromData($this, $nbt);
2984 }catch(SavedDataLoadingException $e){
2985 $logger->error(
"Bad entity data at list position $k: " . $e->getMessage());
2986 $logger->logException($e);
2989 if($entity === null){
2990 $saveIdTag = $nbt->getTag(
"identifier") ?? $nbt->getTag(
"id");
2991 $saveId =
"<unknown>";
2992 if($saveIdTag instanceof StringTag){
2993 $saveId = $saveIdTag->getValue();
2994 }elseif($saveIdTag instanceof IntTag){
2995 $saveId =
"legacy(" . $saveIdTag->getValue() .
")";
2997 $logger->warning(
"Deleted unknown entity type $saveId");
3003 $this->timings->syncChunkLoadEntities->stopTiming();
3006 if(count($chunkData->getTileNBT()) !== 0){
3007 $this->timings->syncChunkLoadTileEntities->startTiming();
3008 $tileFactory = TileFactory::getInstance();
3009 foreach($chunkData->getTileNBT() as $k => $nbt){
3011 $tile = $tileFactory->createFromData($this, $nbt);
3012 }catch(SavedDataLoadingException $e){
3013 $logger->error(
"Bad tile entity data at list position $k: " . $e->getMessage());
3014 $logger->logException($e);
3018 $logger->warning(
"Deleted unknown tile entity type " . $nbt->getString(
"id",
"<unknown>"));
3022 $tilePosition = $tile->getPosition();
3023 if(!$this->isChunkLoaded($tilePosition->getFloorX() >> Chunk::COORD_BIT_SIZE, $tilePosition->getFloorZ() >> Chunk::COORD_BIT_SIZE)){
3024 $logger->error(
"Found tile saved on wrong chunk - unable to fix due to correct chunk not loaded");
3025 }elseif(!$this->isInWorld($tilePosition->getFloorX(), $tilePosition->getFloorY(), $tilePosition->getFloorZ())){
3026 $logger->error(
"Cannot add tile with position outside the world bounds: x=$tilePosition->x,y=$tilePosition->y,z=$tilePosition->z");
3027 }elseif($this->getTile($tilePosition) !== null){
3028 $logger->error(
"Cannot add tile at x=$tilePosition->x,y=$tilePosition->y,z=$tilePosition->z: Another tile is already at that position");
3030 $this->addTile($tile);
3034 $this->timings->syncChunkLoadTileEntities->stopTiming();
3038 private function queueUnloadChunk(
int $x,
int $z) : void{
3039 $this->unloadQueue[World::chunkHash($x, $z)] = microtime(true);
3042 public function unloadChunkRequest(
int $x,
int $z,
bool $safe =
true) : bool{
3043 if(($safe && $this->isChunkInUse($x, $z)) || $this->isSpawnChunk($x, $z)){
3047 $this->queueUnloadChunk($x, $z);
3052 public function cancelUnloadChunkRequest(
int $x,
int $z) : void{
3053 unset($this->unloadQueue[World::chunkHash($x, $z)]);
3056 public function unloadChunk(
int $x,
int $z,
bool $safe =
true,
bool $trySave =
true) : bool{
3057 if($safe && $this->isChunkInUse($x, $z)){
3061 if(!$this->isChunkLoaded($x, $z)){
3065 $this->timings->doChunkUnload->startTiming();
3067 $chunkHash = World::chunkHash($x, $z);
3069 $chunk = $this->chunks[$chunkHash] ??
null;
3071 if($chunk !==
null){
3072 if(ChunkUnloadEvent::hasHandlers()){
3073 $ev =
new ChunkUnloadEvent($this, $x, $z, $chunk);
3075 if($ev->isCancelled()){
3076 $this->timings->doChunkUnload->stopTiming();
3082 if($trySave && $this->getAutoSave()){
3083 $this->timings->syncChunkSave->startTiming();
3085 $this->provider->saveChunk($x, $z,
new ChunkData(
3087 $chunk->isPopulated(),
3088 array_map(fn(Entity $e) => $e->saveNBT(), array_values(array_filter($this->getChunkEntities($x, $z), fn(Entity $e) => $e->canSaveWithChunk()))),
3089 array_map(fn(Tile $t) => $t->saveNBT(), array_values($chunk->
getTiles())),
3090 ), $chunk->getTerrainDirtyFlags());
3092 $this->timings->syncChunkSave->stopTiming();
3096 foreach($this->getChunkListeners($x, $z) as $listener){
3097 $listener->onChunkUnloaded($x, $z, $chunk);
3100 foreach($this->getChunkEntities($x, $z) as $entity){
3101 if($entity instanceof Player){
3110 unset($this->chunks[$chunkHash]);
3111 $this->blockCacheSize -= count($this->blockCache[$chunkHash] ?? []);
3112 unset($this->blockCache[$chunkHash]);
3113 unset($this->blockCollisionBoxCache[$chunkHash]);
3114 unset($this->changedBlocks[$chunkHash]);
3115 unset($this->registeredTickingChunks[$chunkHash]);
3116 $this->markTickingChunkForRecheck($x, $z);
3118 if(array_key_exists($chunkHash, $this->chunkPopulationRequestMap)){
3119 $this->logger->debug(
"Rejecting population promise for chunk $x $z");
3120 $this->chunkPopulationRequestMap[$chunkHash]->reject();
3121 unset($this->chunkPopulationRequestMap[$chunkHash]);
3122 if(isset($this->activeChunkPopulationTasks[$chunkHash])){
3123 $this->logger->debug(
"Marking population task for chunk $x $z as orphaned");
3124 $this->activeChunkPopulationTasks[$chunkHash] =
false;
3128 $this->timings->doChunkUnload->stopTiming();
3137 $spawn = $this->getSpawnLocation();
3138 $spawnX = $spawn->x >> Chunk::COORD_BIT_SIZE;
3139 $spawnZ = $spawn->z >> Chunk::COORD_BIT_SIZE;
3141 return abs($X - $spawnX) <= 1 && abs($Z - $spawnZ) <= 1;
3154 $spawn ??= $this->getSpawnLocation();
3159 $this->requestChunkPopulation($spawn->getFloorX() >> Chunk::COORD_BIT_SIZE, $spawn->getFloorZ() >> Chunk::COORD_BIT_SIZE,
null)->onCompletion(
3160 function() use ($spawn, $resolver) :
void{
3161 $spawn = $this->getSafeSpawn($spawn);
3162 $resolver->resolve($spawn);
3164 function() use ($resolver) : void{
3165 $resolver->reject();
3169 return $resolver->getPromise();
3179 if(!($spawn instanceof
Vector3) || $spawn->y <= $this->minY){
3180 $spawn = $this->getSpawnLocation();
3184 $v = $spawn->floor();
3185 $chunk = $this->getOrLoadChunkAtPosition($v);
3186 if($chunk ===
null){
3187 throw new WorldException(
"Cannot find a safe spawn point in non-generated terrain");
3191 $y = (int) min($max - 2, $v->y);
3192 $wasAir = $this->getBlockAt($x, $y - 1, $z)->getTypeId() === BlockTypeIds::AIR;
3193 for(; $y > $this->minY; --$y){
3194 if($this->getBlockAt($x, $y, $z)->isFullCube()){
3204 for(; $y >= $this->minY && $y < $max; ++$y){
3205 if(!$this->getBlockAt($x, $y + 1, $z)->isFullCube()){
3206 if(!$this->getBlockAt($x, $y, $z)->isFullCube()){
3207 return new Position($spawn->x, $y === (
int) $spawn->y ? $spawn->y : $y, $spawn->z, $this);
3214 return new Position($spawn->x, $y, $spawn->z, $this);
3228 return $this->time % self::TIME_FULL;
3236 return $this->displayName;
3245 $this->displayName = $name;
3246 $this->provider->getWorldData()->setName($name);
3253 return $this->folderName;
3260 $this->time = $time;
3268 $this->stopTime = true;
3276 $this->stopTime = false;
3284 return $this->provider->getWorldData()->getSeed();
3295 public function getDifficulty() : int{
3296 return $this->provider->getWorldData()->getDifficulty();
3299 public function setDifficulty(
int $difficulty) : void{
3300 if($difficulty < 0 || $difficulty > 3){
3301 throw new \InvalidArgumentException(
"Invalid difficulty level $difficulty");
3303 (
new WorldDifficultyChangeEvent($this, $this->getDifficulty(), $difficulty))->call();
3304 $this->provider->getWorldData()->setDifficulty($difficulty);
3306 foreach($this->players as $player){
3307 $player->getNetworkSession()->syncWorldDifficulty($this->getDifficulty());
3311 private function addChunkHashToPopulationRequestQueue(
int $chunkHash) : void{
3312 if(!isset($this->chunkPopulationRequestQueueIndex[$chunkHash])){
3313 $this->chunkPopulationRequestQueue->enqueue($chunkHash);
3314 $this->chunkPopulationRequestQueueIndex[$chunkHash] =
true;
3321 private function enqueuePopulationRequest(
int $chunkX,
int $chunkZ, ?ChunkLoader $associatedChunkLoader) : Promise{
3322 $chunkHash = World::chunkHash($chunkX, $chunkZ);
3323 $this->addChunkHashToPopulationRequestQueue($chunkHash);
3325 $resolver = $this->chunkPopulationRequestMap[$chunkHash] =
new PromiseResolver();
3326 if($associatedChunkLoader ===
null){
3327 $temporaryLoader =
new class implements ChunkLoader{};
3328 $this->registerChunkLoader($temporaryLoader, $chunkX, $chunkZ);
3329 $resolver->getPromise()->onCompletion(
3330 fn() => $this->unregisterChunkLoader($temporaryLoader, $chunkX, $chunkZ),
3331 static function() :
void{}
3334 return $resolver->getPromise();
3337 private function drainPopulationRequestQueue() : void{
3339 while(count($this->activeChunkPopulationTasks) < $this->maxConcurrentChunkPopulationTasks && !$this->chunkPopulationRequestQueue->isEmpty()){
3340 $nextChunkHash = $this->chunkPopulationRequestQueue->dequeue();
3341 unset($this->chunkPopulationRequestQueueIndex[$nextChunkHash]);
3342 World::getXZ($nextChunkHash, $nextChunkX, $nextChunkZ);
3343 if(isset($this->chunkPopulationRequestMap[$nextChunkHash])){
3344 assert(!($this->activeChunkPopulationTasks[$nextChunkHash] ??
false),
"Population for chunk $nextChunkX $nextChunkZ already running");
3346 !$this->orderChunkPopulation($nextChunkX, $nextChunkZ,
null)->isResolved() &&
3347 !isset($this->activeChunkPopulationTasks[$nextChunkHash])
3349 $failed[] = $nextChunkHash;
3356 foreach($failed as $hash){
3357 $this->addChunkHashToPopulationRequestQueue($hash);
3366 private function checkChunkPopulationPreconditions(
int $chunkX,
int $chunkZ) : array{
3367 $chunkHash = World::chunkHash($chunkX, $chunkZ);
3368 $resolver = $this->chunkPopulationRequestMap[$chunkHash] ??
null;
3369 if($resolver !==
null && isset($this->activeChunkPopulationTasks[$chunkHash])){
3371 return [$resolver,
false];
3374 $temporaryChunkLoader =
new class implements ChunkLoader{};
3375 $this->registerChunkLoader($temporaryChunkLoader, $chunkX, $chunkZ);
3376 $chunk = $this->loadChunk($chunkX, $chunkZ);
3377 $this->unregisterChunkLoader($temporaryChunkLoader, $chunkX, $chunkZ);
3378 if($chunk !==
null && $chunk->isPopulated()){
3380 $resolver ??=
new PromiseResolver();
3381 unset($this->chunkPopulationRequestMap[$chunkHash]);
3382 $resolver->resolve($chunk);
3383 return [$resolver,
false];
3385 return [$resolver,
true];
3400 [$resolver, $proceedWithPopulation] = $this->checkChunkPopulationPreconditions($chunkX, $chunkZ);
3401 if(!$proceedWithPopulation){
3402 return $resolver?->getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3405 if(count($this->activeChunkPopulationTasks) >= $this->maxConcurrentChunkPopulationTasks){
3407 return $resolver?->getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3409 return $this->internalOrderChunkPopulation($chunkX, $chunkZ, $associatedChunkLoader, $resolver);
3423 [$resolver, $proceedWithPopulation] = $this->checkChunkPopulationPreconditions($chunkX, $chunkZ);
3424 if(!$proceedWithPopulation){
3425 return $resolver?->getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3428 return $this->internalOrderChunkPopulation($chunkX, $chunkZ, $associatedChunkLoader, $resolver);
3435 private function internalOrderChunkPopulation(
int $chunkX,
int $chunkZ, ?ChunkLoader $associatedChunkLoader, ?
PromiseResolver $resolver) :
Promise{
3436 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
3438 $timings = $this->timings->chunkPopulationOrder;
3439 $timings->startTiming();
3442 for($xx = -1; $xx <= 1; ++$xx){
3443 for($zz = -1; $zz <= 1; ++$zz){
3444 if($this->isChunkLocked($chunkX + $xx, $chunkZ + $zz)){
3446 return $resolver?->
getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3451 $this->activeChunkPopulationTasks[$chunkHash] =
true;
3452 if($resolver ===
null){
3453 $resolver =
new PromiseResolver();
3454 $this->chunkPopulationRequestMap[$chunkHash] = $resolver;
3457 $chunkPopulationLockId =
new ChunkLockId();
3459 $temporaryChunkLoader =
new class implements ChunkLoader{
3461 for($xx = -1; $xx <= 1; ++$xx){
3462 for($zz = -1; $zz <= 1; ++$zz){
3463 $this->lockChunk($chunkX + $xx, $chunkZ + $zz, $chunkPopulationLockId);
3464 $this->registerChunkLoader($temporaryChunkLoader, $chunkX + $xx, $chunkZ + $zz);
3468 $centerChunk = $this->loadChunk($chunkX, $chunkZ);
3469 $adjacentChunks = $this->getAdjacentChunks($chunkX, $chunkZ);
3470 $task =
new PopulationTask(
3476 function(Chunk $centerChunk, array $adjacentChunks) use ($chunkPopulationLockId, $chunkX, $chunkZ, $temporaryChunkLoader) :
void{
3477 if(!$this->isLoaded()){
3481 $this->generateChunkCallback($chunkPopulationLockId, $chunkX, $chunkZ, $centerChunk, $adjacentChunks, $temporaryChunkLoader);
3484 $workerId = $this->workerPool->selectWorker();
3485 if(!isset($this->workerPool->getRunningWorkers()[$workerId]) && isset($this->generatorRegisteredWorkers[$workerId])){
3486 $this->logger->debug(
"Selected worker $workerId previously had generator registered, but is now offline");
3487 unset($this->generatorRegisteredWorkers[$workerId]);
3489 if(!isset($this->generatorRegisteredWorkers[$workerId])){
3490 $this->registerGeneratorToWorker($workerId);
3492 $this->workerPool->submitTaskToWorker($task, $workerId);
3496 $timings->stopTiming();
3504 private function generateChunkCallback(ChunkLockId $chunkLockId,
int $x,
int $z, Chunk $chunk, array $adjacentChunks, ChunkLoader $temporaryChunkLoader) : void{
3505 $timings = $this->timings->chunkPopulationCompletion;
3506 $timings->startTiming();
3509 for($xx = -1; $xx <= 1; ++$xx){
3510 for($zz = -1; $zz <= 1; ++$zz){
3511 $this->unregisterChunkLoader($temporaryChunkLoader, $x + $xx, $z + $zz);
3512 if(!$this->unlockChunk($x + $xx, $z + $zz, $chunkLockId)){
3518 $index = World::chunkHash($x, $z);
3519 if(!isset($this->activeChunkPopulationTasks[$index])){
3520 throw new AssumptionFailedError(
"This should always be set, regardless of whether the task was orphaned or not");
3522 if(!$this->activeChunkPopulationTasks[$index]){
3523 $this->logger->debug(
"Discarding orphaned population result for chunk x=$x,z=$z");
3524 unset($this->activeChunkPopulationTasks[$index]);
3526 if($dirtyChunks === 0){
3527 $oldChunk = $this->loadChunk($x, $z);
3528 $this->setChunk($x, $z, $chunk);
3530 foreach($adjacentChunks as $relativeChunkHash => $adjacentChunk){
3531 World::getXZ($relativeChunkHash, $relativeX, $relativeZ);
3532 if($relativeX < -1 || $relativeX > 1 || $relativeZ < -1 || $relativeZ > 1){
3533 throw new AssumptionFailedError(
"Adjacent chunks should be in range -1 ... +1 coordinates");
3535 $this->setChunk($x + $relativeX, $z + $relativeZ, $adjacentChunk);
3538 if(($oldChunk ===
null || !$oldChunk->isPopulated()) && $chunk->isPopulated()){
3539 if(ChunkPopulateEvent::hasHandlers()){
3540 (
new ChunkPopulateEvent($this, $x, $z, $chunk))->call();
3543 foreach($this->getChunkListeners($x, $z) as $listener){
3544 $listener->onChunkPopulated($x, $z, $chunk);
3548 $this->logger->debug(
"Discarding population result for chunk x=$x,z=$z - terrain was modified on the main thread before async population completed");
3557 unset($this->activeChunkPopulationTasks[$index]);
3559 if($dirtyChunks === 0){
3560 $promise = $this->chunkPopulationRequestMap[$index] ??
null;
3561 if($promise !==
null){
3562 unset($this->chunkPopulationRequestMap[$index]);
3563 $promise->resolve($chunk);
3566 $this->logger->debug(
"Unable to resolve population promise for chunk x=$x,z=$z - populated chunk was forcibly unloaded while setting modified chunks");
3572 $this->addChunkHashToPopulationRequestQueue($index);
3575 $this->drainPopulationRequestQueue();
3577 $timings->stopTiming();
3580 public function doChunkGarbageCollection() : void{
3581 $this->timings->doChunkGC->startTiming();
3583 foreach($this->chunks as $index => $chunk){
3584 if(!isset($this->unloadQueue[$index])){
3585 World::getXZ($index, $X, $Z);
3586 if(!$this->isSpawnChunk($X, $Z)){
3587 $this->unloadChunkRequest($X, $Z,
true);
3590 $chunk->collectGarbage();
3593 $this->provider->doGarbageCollection();
3595 $this->timings->doChunkGC->stopTiming();
3598 public function unloadChunks(
bool $force =
false) : void{
3599 if(count($this->unloadQueue) > 0){
3601 $now = microtime(
true);
3602 foreach($this->unloadQueue as $index => $time){
3603 World::getXZ($index, $X, $Z);
3606 if($maxUnload <= 0){
3608 }elseif($time > ($now - 30)){
3614 if($this->unloadChunk($X, $Z,
true)){
3615 unset($this->unloadQueue[$index]);