153 private static int $worldIdCounter = 1;
155 public const Y_MAX = 320;
156 public const Y_MIN = -64;
158 public const TIME_DAY = 1000;
159 public const TIME_NOON = 6000;
160 public const TIME_SUNSET = 12000;
161 public const TIME_NIGHT = 13000;
162 public const TIME_MIDNIGHT = 18000;
163 public const TIME_SUNRISE = 23000;
165 public const TIME_FULL = 24000;
167 public const DIFFICULTY_PEACEFUL = 0;
168 public const DIFFICULTY_EASY = 1;
169 public const DIFFICULTY_NORMAL = 2;
170 public const DIFFICULTY_HARD = 3;
172 public const DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK = 3;
175 private const BLOCK_CACHE_SIZE_CAP = 2048;
181 private array $players = [];
187 private array $entities = [];
192 private array $entityLastKnownPositions = [];
198 private array $entitiesByChunk = [];
204 public array $updateEntities = [];
206 private bool $inDynamicStateRecalculation =
false;
211 private array $blockCache = [];
212 private int $blockCacheSize = 0;
217 private array $blockCollisionBoxCache = [];
219 private int $sendTimeTicker = 0;
221 private int $worldId;
223 private int $providerGarbageCollectionTicker = 0;
232 private array $registeredTickingChunks = [];
240 private array $validTickingChunks = [];
247 private array $recheckTickingChunks = [];
253 private array $chunkLoaders = [];
259 private array $chunkListeners = [];
264 private array $playerChunkListeners = [];
270 private array $packetBuffersByChunk = [];
276 private array $unloadQueue = [];
279 public bool $stopTime =
false;
281 private float $sunAnglePercentage = 0.0;
282 private int $skyLightReduction = 0;
284 private string $displayName;
290 private array $chunks = [];
296 private array $knownUngeneratedChunks = [];
302 private array $changedBlocks = [];
310 private array $scheduledBlockUpdateQueueIndex = [];
313 private \SplQueue $neighbourBlockUpdateQueue;
318 private array $neighbourBlockUpdateQueueIndex = [];
324 private array $activeChunkPopulationTasks = [];
329 private array $chunkLock = [];
330 private int $maxConcurrentChunkPopulationTasks = 2;
335 private array $chunkPopulationRequestMap = [];
340 private \SplQueue $chunkPopulationRequestQueue;
345 private array $chunkPopulationRequestQueueIndex = [];
349 private bool $autoSave =
true;
351 private int $sleepTicks = 0;
353 private int $chunkTickRadius;
354 private int $tickedBlocksPerSubchunkPerTick = self::DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK;
359 private array $randomTickBlocks = [];
363 public float $tickRateTime = 0;
365 private bool $doingTick =
false;
367 private bool $unloaded =
false;
372 private array $unloadCallbacks = [];
377 private \Logger $logger;
385 return morton2d_encode($x, $z);
388 private const MORTON3D_BIT_SIZE = 21;
389 private const BLOCKHASH_Y_BITS = 9;
390 private const BLOCKHASH_Y_PADDING = 64;
391 private const BLOCKHASH_Y_OFFSET = self::BLOCKHASH_Y_PADDING - self::Y_MIN;
392 private const BLOCKHASH_Y_MASK = (1 << self::BLOCKHASH_Y_BITS) - 1;
393 private const BLOCKHASH_XZ_MASK = (1 << self::MORTON3D_BIT_SIZE) - 1;
394 private const BLOCKHASH_XZ_EXTRA_BITS = (self::MORTON3D_BIT_SIZE - self::BLOCKHASH_Y_BITS) >> 1;
395 private const BLOCKHASH_XZ_EXTRA_MASK = (1 << self::BLOCKHASH_XZ_EXTRA_BITS) - 1;
396 private const BLOCKHASH_XZ_SIGN_SHIFT = 64 - self::MORTON3D_BIT_SIZE - self::BLOCKHASH_XZ_EXTRA_BITS;
397 private const BLOCKHASH_X_SHIFT = self::BLOCKHASH_Y_BITS;
398 private const BLOCKHASH_Z_SHIFT = self::BLOCKHASH_X_SHIFT + self::BLOCKHASH_XZ_EXTRA_BITS;
403 public static function blockHash(
int $x,
int $y,
int $z) : int{
404 $shiftedY = $y + self::BLOCKHASH_Y_OFFSET;
405 if(($shiftedY & (~0 << self::BLOCKHASH_Y_BITS)) !== 0){
406 throw new \InvalidArgumentException(
"Y coordinate $y is out of range!");
411 return morton3d_encode(
412 $x & self::BLOCKHASH_XZ_MASK,
414 ((($x >> self::MORTON3D_BIT_SIZE) & self::BLOCKHASH_XZ_EXTRA_MASK) << self::BLOCKHASH_X_SHIFT) |
415 ((($z >> self::MORTON3D_BIT_SIZE) & self::BLOCKHASH_XZ_EXTRA_MASK) << self::BLOCKHASH_Z_SHIFT),
416 $z & self::BLOCKHASH_XZ_MASK
424 return morton3d_encode($x, $y, $z);
433 public static function getBlockXYZ(
int $hash, ?
int &$x, ?
int &$y, ?
int &$z) : void{
434 [$baseX, $baseY, $baseZ] = morton3d_decode($hash);
436 $extraX = ((($baseY >> self::BLOCKHASH_X_SHIFT) & self::BLOCKHASH_XZ_EXTRA_MASK) << self::MORTON3D_BIT_SIZE);
437 $extraZ = ((($baseY >> self::BLOCKHASH_Z_SHIFT) & self::BLOCKHASH_XZ_EXTRA_MASK) << self::MORTON3D_BIT_SIZE);
439 $x = (($baseX & self::BLOCKHASH_XZ_MASK) | $extraX) << self::BLOCKHASH_XZ_SIGN_SHIFT >> self::BLOCKHASH_XZ_SIGN_SHIFT;
440 $y = ($baseY & self::BLOCKHASH_Y_MASK) - self::BLOCKHASH_Y_OFFSET;
441 $z = (($baseZ & self::BLOCKHASH_XZ_MASK) | $extraZ) << self::BLOCKHASH_XZ_SIGN_SHIFT >> self::BLOCKHASH_XZ_SIGN_SHIFT;
449 public static function getXZ(
int $hash, ?
int &$x, ?
int &$z) : void{
450 [$x, $z] = morton2d_decode($hash);
453 public static function getDifficultyFromString(
string $str) : int{
454 switch(strtolower(trim($str))){
458 return World::DIFFICULTY_PEACEFUL;
463 return World::DIFFICULTY_EASY;
468 return World::DIFFICULTY_NORMAL;
473 return World::DIFFICULTY_HARD;
484 private string $folderName,
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());
503 worldMinY: $this->minY,
504 worldMaxY: $this->maxY,
505 generatorSeed: $this->getSeed(),
506 generatorClass: $generator->getGeneratorClass(),
507 generatorSettings: $this->provider->getWorldData()->getGeneratorOptions()
509 $this->generatorExecutor = $generator->isFast() ?
514 $executorSetupParameters,
518 $this->chunkPopulationRequestQueue = new \SplQueue();
519 $this->addOnUnloadCallback(
function() :
void{
520 $this->logger->debug(
"Cancelling unfulfilled generation requests");
522 foreach($this->chunkPopulationRequestMap as $chunkHash => $promise){
524 unset($this->chunkPopulationRequestMap[$chunkHash]);
526 if(count($this->chunkPopulationRequestMap) !== 0){
534 $this->scheduledBlockUpdateQueue->setExtractFlags(\SplPriorityQueue::EXTR_BOTH);
536 $this->neighbourBlockUpdateQueue = new \SplQueue();
538 $this->time = $this->provider->getWorldData()->getTime();
540 $cfg = $this->
server->getConfigGroup();
541 $this->chunkTickRadius = min($this->
server->getViewDistance(), max(0, $cfg->getPropertyInt(YmlServerProperties::CHUNK_TICKING_TICK_RADIUS, 4)));
542 if($cfg->getPropertyInt(
"chunk-ticking.per-tick", 40) <= 0){
544 $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.");
545 $this->chunkTickRadius = 0;
547 $this->tickedBlocksPerSubchunkPerTick = $cfg->getPropertyInt(YmlServerProperties::CHUNK_TICKING_BLOCKS_PER_SUBCHUNK_PER_TICK, self::DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK);
548 $this->maxConcurrentChunkPopulationTasks = $cfg->getPropertyInt(YmlServerProperties::CHUNK_GENERATION_POPULATION_QUEUE_SIZE, 2);
550 $this->initRandomTickBlocksFromConfig($cfg);
556 $dontTickBlocks = [];
557 $parser = StringToItemParser::getInstance();
558 foreach($cfg->getProperty(YmlServerProperties::CHUNK_TICKING_DISABLE_BLOCK_TICKING, []) as $name){
559 $name = (string) $name;
560 $item = $parser->parse($name);
562 $block = $item->getBlock();
563 }elseif(preg_match(
"/^-?\d+$/", $name) === 1){
566 $blockStateData = GlobalBlockStateHandlers::getUpgrader()->upgradeIntIdMeta((
int) $name, 0);
567 }
catch(BlockStateDeserializeException){
570 $block = $this->blockStateRegistry->fromStateId(GlobalBlockStateHandlers::getDeserializer()->deserialize($blockStateData));
576 if($block->getTypeId() !== BlockTypeIds::AIR){
577 $dontTickBlocks[$block->getTypeId()] = $name;
581 foreach($this->blockStateRegistry->getAllKnownStates() as $state){
582 $dontTickName = $dontTickBlocks[$state->getTypeId()] ??
null;
583 if($dontTickName ===
null && $state->ticksRandomly()){
584 $this->randomTickBlocks[$state->getStateId()] =
true;
589 public function getTickRateTime() : float{
590 return $this->tickRateTime;
593 public function getServer() : Server{
597 public function getLogger() : \
Logger{
598 return $this->logger;
601 final public function getProvider() : WritableWorldProvider{
602 return $this->provider;
608 final public function getId() : int{
609 return $this->worldId;
612 public function isLoaded() : bool{
613 return !$this->unloaded;
619 public function onUnload() : void{
621 throw new \LogicException(
"Tried to close a world which is already closed");
624 foreach($this->unloadCallbacks as $callback){
627 $this->unloadCallbacks = [];
629 foreach($this->chunks as $chunkHash => $chunk){
630 self::getXZ($chunkHash, $chunkX, $chunkZ);
631 $this->unloadChunk($chunkX, $chunkZ,
false);
633 $this->knownUngeneratedChunks = [];
634 foreach($this->entitiesByChunk as $chunkHash => $entities){
635 self::getXZ($chunkHash, $chunkX, $chunkZ);
638 foreach($entities as $entity){
639 if(!$entity->isFlaggedForDespawn()){
644 if($leakedEntities !== 0){
645 $this->logger->warning(
"$leakedEntities leaked entities found in ungenerated chunk $chunkX $chunkZ during unload, they won't be saved!");
651 $this->generatorExecutor->shutdown();
653 $this->provider->close();
654 $this->blockCache = [];
655 $this->blockCacheSize = 0;
656 $this->blockCollisionBoxCache = [];
658 $this->unloaded =
true;
663 $this->unloadCallbacks[spl_object_id($callback)] = $callback;
668 unset($this->unloadCallbacks[spl_object_id($callback)]);
679 private function filterViewersForPosition(
Vector3 $pos, array $allowed) : array{
680 $candidates = $this->getViewersForPosition($pos);
682 foreach($allowed as $player){
683 $k = spl_object_id($player);
684 if(isset($candidates[$k])){
685 $filtered[$k] = $candidates[$k];
696 $players ??= $this->getViewersForPosition($pos);
698 if(WorldSoundEvent::hasHandlers()){
701 if($ev->isCancelled()){
705 $sound = $ev->getSound();
706 $players = $ev->getRecipients();
709 $pk = $sound->
encode($pos);
711 if($players === $this->getViewersForPosition($pos)){
713 $this->broadcastPacketToViewers($pos, $e);
716 NetworkBroadcastUtils::broadcastPackets($this->filterViewersForPosition($pos, $players), $pk);
725 $players ??= $this->getViewersForPosition($pos);
727 if(WorldParticleEvent::hasHandlers()){
730 if($ev->isCancelled()){
734 $particle = $ev->getParticle();
735 $players = $ev->getRecipients();
738 $pk = $particle->
encode($pos);
740 if($players === $this->getViewersForPosition($pos)){
742 $this->broadcastPacketToViewers($pos, $e);
745 NetworkBroadcastUtils::broadcastPackets($this->filterViewersForPosition($pos, $players), $pk);
750 public function getAutoSave() : bool{
751 return $this->autoSave;
754 public function setAutoSave(
bool $value) : void{
755 $this->autoSave = $value;
768 return $this->playerChunkListeners[
World::chunkHash($chunkX, $chunkZ)] ?? [];
778 return $this->chunkLoaders[
World::chunkHash($chunkX, $chunkZ)] ?? [];
788 return $this->getChunkPlayers($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE);
795 $this->broadcastPacketToPlayersUsingChunk($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE, $packet);
798 private function broadcastPacketToPlayersUsingChunk(
int $chunkX,
int $chunkZ,
ClientboundPacket $packet) : void{
799 if(!isset($this->packetBuffersByChunk[$index =
World::chunkHash($chunkX, $chunkZ)])){
800 $this->packetBuffersByChunk[$index] = [$packet];
802 $this->packetBuffersByChunk[$index][] = $packet;
806 public function registerChunkLoader(ChunkLoader $loader,
int $chunkX,
int $chunkZ,
bool $autoLoad =
true) : void{
807 $loaderId = spl_object_id($loader);
809 if(!isset($this->chunkLoaders[$chunkHash = World::chunkHash($chunkX, $chunkZ)])){
810 $this->chunkLoaders[$chunkHash] = [];
811 }elseif(isset($this->chunkLoaders[$chunkHash][$loaderId])){
815 $this->chunkLoaders[$chunkHash][$loaderId] = $loader;
817 $this->cancelUnloadChunkRequest($chunkX, $chunkZ);
820 $this->loadChunk($chunkX, $chunkZ);
824 public function unregisterChunkLoader(ChunkLoader $loader,
int $chunkX,
int $chunkZ) : void{
825 $chunkHash = World::chunkHash($chunkX, $chunkZ);
826 $loaderId = spl_object_id($loader);
827 if(isset($this->chunkLoaders[$chunkHash][$loaderId])){
828 if(count($this->chunkLoaders[$chunkHash]) === 1){
829 unset($this->chunkLoaders[$chunkHash]);
830 $this->unloadChunkRequest($chunkX, $chunkZ,
true);
831 if(isset($this->chunkPopulationRequestMap[$chunkHash]) && !isset($this->activeChunkPopulationTasks[$chunkHash])){
832 $this->chunkPopulationRequestMap[$chunkHash]->reject();
833 unset($this->chunkPopulationRequestMap[$chunkHash]);
836 unset($this->chunkLoaders[$chunkHash][$loaderId]);
845 $hash =
World::chunkHash($chunkX, $chunkZ);
846 if(isset($this->chunkListeners[$hash])){
847 $this->chunkListeners[$hash][spl_object_id($listener)] = $listener;
849 $this->chunkListeners[$hash] = [spl_object_id($listener) => $listener];
851 if($listener instanceof
Player){
852 $this->playerChunkListeners[$hash][spl_object_id($listener)] = $listener;
862 $hash =
World::chunkHash($chunkX, $chunkZ);
863 if(isset($this->chunkListeners[$hash])){
864 if(count($this->chunkListeners[$hash]) === 1){
865 unset($this->chunkListeners[$hash]);
866 unset($this->playerChunkListeners[$hash]);
868 unset($this->chunkListeners[$hash][spl_object_id($listener)]);
869 unset($this->playerChunkListeners[$hash][spl_object_id($listener)]);
878 foreach($this->chunkListeners as $hash => $listeners){
879 World::getXZ($hash, $chunkX, $chunkZ);
880 $this->unregisterChunkListener($listener, $chunkX, $chunkZ);
891 return $this->chunkListeners[
World::chunkHash($chunkX, $chunkZ)] ?? [];
897 public function sendTime(
Player ...$targets) : void{
898 if(count($targets) === 0){
899 $targets = $this->players;
901 foreach($targets as $player){
902 $player->getNetworkSession()->syncWorldTime($this->time);
906 public function isDoingTick() : bool{
907 return $this->doingTick;
913 public function doTick(
int $currentTick) : void{
915 throw new \LogicException(
"Attempted to tick a world which has been closed");
918 $this->timings->doTick->startTiming();
919 $this->doingTick =
true;
921 $this->actuallyDoTick($currentTick);
923 $this->doingTick =
false;
924 $this->timings->doTick->stopTiming();
928 protected function actuallyDoTick(
int $currentTick) : void{
929 if(!$this->stopTime){
931 if($this->time === PHP_INT_MAX){
932 $this->time = PHP_INT_MIN;
938 $this->sunAnglePercentage = $this->computeSunAnglePercentage();
939 $this->skyLightReduction = $this->computeSkyLightReduction();
941 if(++$this->sendTimeTicker === 200){
943 $this->sendTimeTicker = 0;
946 $this->unloadChunks();
947 if(++$this->providerGarbageCollectionTicker >= 6000){
948 $this->provider->doGarbageCollection();
949 $this->providerGarbageCollectionTicker = 0;
952 $this->timings->scheduledBlockUpdates->startTiming();
954 while($this->scheduledBlockUpdateQueue->count() > 0 && $this->scheduledBlockUpdateQueue->current()[
"priority"] <= $currentTick){
956 $vec = $this->scheduledBlockUpdateQueue->extract()[
"data"];
957 unset($this->scheduledBlockUpdateQueueIndex[World::blockHash($vec->x, $vec->y, $vec->z)]);
958 if(!$this->isInLoadedTerrain($vec)){
961 $block = $this->getBlock($vec);
962 $block->onScheduledUpdate();
964 $this->timings->scheduledBlockUpdates->stopTiming();
966 $this->timings->neighbourBlockUpdates->startTiming();
968 while($this->neighbourBlockUpdateQueue->count() > 0){
969 $index = $this->neighbourBlockUpdateQueue->dequeue();
970 unset($this->neighbourBlockUpdateQueueIndex[$index]);
971 World::getBlockXYZ($index, $x, $y, $z);
972 if(!$this->isChunkLoaded($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)){
976 $block = $this->getBlockAt($x, $y, $z);
978 if(BlockUpdateEvent::hasHandlers()){
979 $ev =
new BlockUpdateEvent($block);
981 if($ev->isCancelled()){
985 foreach($this->getNearbyEntities(AxisAlignedBB::one()->offsetCopy($x, $y, $z)) as $entity){
986 $entity->onNearbyBlockChange();
988 $block->onNearbyBlockChange();
991 $this->timings->neighbourBlockUpdates->stopTiming();
993 $this->timings->entityTick->startTiming();
995 foreach($this->updateEntities as $id => $entity){
996 if($entity->isClosed() || $entity->isFlaggedForDespawn() || !$entity->onUpdate($currentTick)){
997 unset($this->updateEntities[$id]);
999 if($entity->isFlaggedForDespawn()){
1003 $this->timings->entityTick->stopTiming();
1005 $this->timings->randomChunkUpdates->startTiming();
1006 $this->tickChunks();
1007 $this->timings->randomChunkUpdates->stopTiming();
1009 $this->executeQueuedLightUpdates();
1011 if(count($this->changedBlocks) > 0){
1012 if(count($this->players) > 0){
1013 foreach($this->changedBlocks as $index => $blocks){
1014 if(count($blocks) === 0){
1017 World::getXZ($index, $chunkX, $chunkZ);
1018 if(!$this->isChunkLoaded($chunkX, $chunkZ)){
1022 if(count($blocks) > 512){
1023 $chunk = $this->getChunk($chunkX, $chunkZ) ??
throw new AssumptionFailedError(
"We already checked that the chunk is loaded");
1024 foreach($this->getChunkPlayers($chunkX, $chunkZ) as $p){
1025 $p->onChunkChanged($chunkX, $chunkZ, $chunk);
1028 foreach($this->createBlockUpdatePackets($blocks) as $packet){
1029 $this->broadcastPacketToPlayersUsingChunk($chunkX, $chunkZ, $packet);
1035 $this->changedBlocks = [];
1039 if($this->sleepTicks > 0 && --$this->sleepTicks <= 0){
1040 $this->checkSleep();
1043 foreach($this->packetBuffersByChunk as $index => $entries){
1044 World::getXZ($index, $chunkX, $chunkZ);
1045 $chunkPlayers = $this->getChunkPlayers($chunkX, $chunkZ);
1046 if(count($chunkPlayers) > 0){
1047 NetworkBroadcastUtils::broadcastPackets($chunkPlayers, $entries);
1051 $this->packetBuffersByChunk = [];
1054 public function checkSleep() : void{
1055 if(count($this->players) === 0){
1060 foreach($this->getPlayers() as $p){
1061 if(!$p->isSleeping()){
1068 $time = $this->getTimeOfDay();
1070 if($time >= World::TIME_NIGHT && $time < World::TIME_SUNRISE){
1071 $this->setTime($this->getTime() + World::TIME_FULL - $time);
1073 foreach($this->getPlayers() as $p){
1080 public function setSleepTicks(
int $ticks) : void{
1081 $this->sleepTicks = $ticks;
1093 $blockTranslator = TypeConverter::getInstance()->getBlockTranslator();
1095 foreach($blocks as $b){
1097 throw new \TypeError(
"Expected Vector3 in blocks array, got " . (is_object($b) ? get_class($b) : gettype($b)));
1100 $fullBlock = $this->getBlockAt($b->x, $b->y, $b->z);
1101 $blockPosition = BlockPosition::fromVector3($b);
1103 $tile = $this->getTileAt($b->x, $b->y, $b->z);
1105 $expectedClass = $fullBlock->getIdInfo()->getTileClass();
1106 if($expectedClass !==
null && $tile instanceof $expectedClass && count($fakeStateProperties = $tile->getRenderUpdateBugWorkaroundStateProperties($fullBlock)) > 0){
1107 $originalStateData = $blockTranslator->internalIdToNetworkStateData($fullBlock->getStateId());
1109 $originalStateData->getName(),
1110 array_merge($originalStateData->getStates(), $fakeStateProperties),
1111 $originalStateData->getVersion()
1113 $packets[] = UpdateBlockPacket::create(
1115 $blockTranslator->getBlockStateDictionary()->lookupStateIdFromData($fakeStateData) ??
throw new AssumptionFailedError(
"Unmapped fake blockstate data: " . $fakeStateData->toNbt()),
1116 UpdateBlockPacket::FLAG_NETWORK,
1117 UpdateBlockPacket::DATA_LAYER_NORMAL
1121 $packets[] = UpdateBlockPacket::create(
1123 $blockTranslator->internalIdToNetworkId($fullBlock->getStateId()),
1124 UpdateBlockPacket::FLAG_NETWORK,
1125 UpdateBlockPacket::DATA_LAYER_NORMAL
1129 $packets[] = BlockActorDataPacket::create($blockPosition, $tile->getSerializedSpawnCompound());
1136 public function clearCache(
bool $force =
false) : void{
1138 $this->blockCache = [];
1139 $this->blockCacheSize = 0;
1140 $this->blockCollisionBoxCache = [];
1143 $this->blockCacheSize = 0;
1144 foreach($this->blockCache as $list){
1145 $this->blockCacheSize += count($list);
1146 if($this->blockCacheSize > self::BLOCK_CACHE_SIZE_CAP){
1147 $this->blockCache = [];
1148 $this->blockCacheSize = 0;
1154 foreach($this->blockCollisionBoxCache as $list){
1155 $count += count($list);
1156 if($count > self::BLOCK_CACHE_SIZE_CAP){
1158 $this->blockCollisionBoxCache = [];
1165 private function trimBlockCache() : void{
1166 $before = $this->blockCacheSize;
1169 foreach($this->blockCache as $chunkHash => $blocks){
1170 unset($this->blockCache[$chunkHash]);
1171 $this->blockCacheSize -= count($blocks);
1172 if($this->blockCacheSize < self::BLOCK_CACHE_SIZE_CAP){
1183 return $this->randomTickBlocks;
1186 public function addRandomTickedBlock(
Block $block) : void{
1188 throw new \InvalidArgumentException(
"Cannot do random-tick on unknown block");
1190 $this->randomTickBlocks[$block->getStateId()] =
true;
1193 public function removeRandomTickedBlock(Block $block) : void{
1194 unset($this->randomTickBlocks[$block->getStateId()]);
1202 return $this->chunkTickRadius;
1210 $this->chunkTickRadius = $radius;
1221 return array_keys($this->validTickingChunks);
1229 $chunkPosHash =
World::chunkHash($chunkX, $chunkZ);
1230 $this->registeredTickingChunks[$chunkPosHash][spl_object_id($ticker)] = $ticker;
1231 $this->recheckTickingChunks[$chunkPosHash] = $chunkPosHash;
1239 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
1240 $tickerId = spl_object_id($ticker);
1241 if(isset($this->registeredTickingChunks[$chunkHash][$tickerId])){
1242 if(count($this->registeredTickingChunks[$chunkHash]) === 1){
1244 $this->registeredTickingChunks[$chunkHash],
1245 $this->recheckTickingChunks[$chunkHash],
1246 $this->validTickingChunks[$chunkHash]
1249 unset($this->registeredTickingChunks[$chunkHash][$tickerId]);
1254 private function tickChunks() : void{
1255 if($this->chunkTickRadius <= 0 || count($this->registeredTickingChunks) === 0){
1259 if(count($this->recheckTickingChunks) > 0){
1260 $this->timings->randomChunkUpdatesChunkSelection->startTiming();
1262 $chunkTickableCache = [];
1264 foreach($this->recheckTickingChunks as $hash => $_){
1265 World::getXZ($hash, $chunkX, $chunkZ);
1266 if($this->isChunkTickable($chunkX, $chunkZ, $chunkTickableCache)){
1267 $this->validTickingChunks[$hash] = $hash;
1270 $this->recheckTickingChunks = [];
1272 $this->timings->randomChunkUpdatesChunkSelection->stopTiming();
1275 foreach($this->validTickingChunks as $index => $_){
1276 World::getXZ($index, $chunkX, $chunkZ);
1278 $this->tickChunk($chunkX, $chunkZ);
1288 private function isChunkTickable(
int $chunkX,
int $chunkZ, array &$cache) : bool{
1289 for($cx = -1; $cx <= 1; ++$cx){
1290 for($cz = -1; $cz <= 1; ++$cz){
1291 $chunkHash = World::chunkHash($chunkX + $cx, $chunkZ + $cz);
1292 if(isset($cache[$chunkHash])){
1293 if(!$cache[$chunkHash]){
1298 if($this->isChunkLocked($chunkX + $cx, $chunkZ + $cz)){
1299 $cache[$chunkHash] =
false;
1302 $adjacentChunk = $this->getChunk($chunkX + $cx, $chunkZ + $cz);
1303 if($adjacentChunk ===
null || !$adjacentChunk->isPopulated()){
1304 $cache[$chunkHash] =
false;
1307 $lightPopulatedState = $adjacentChunk->isLightPopulated();
1308 if($lightPopulatedState !==
true){
1309 if($lightPopulatedState ===
false){
1310 $this->orderLightPopulation($chunkX + $cx, $chunkZ + $cz);
1312 $cache[$chunkHash] =
false;
1316 $cache[$chunkHash] =
true;
1332 private function markTickingChunkForRecheck(
int $chunkX,
int $chunkZ) : void{
1333 for($cx = -1; $cx <= 1; ++$cx){
1334 for($cz = -1; $cz <= 1; ++$cz){
1335 $chunkHash = World::chunkHash($chunkX + $cx, $chunkZ + $cz);
1336 unset($this->validTickingChunks[$chunkHash]);
1337 if(isset($this->registeredTickingChunks[$chunkHash])){
1338 $this->recheckTickingChunks[$chunkHash] = $chunkHash;
1340 unset($this->recheckTickingChunks[$chunkHash]);
1346 private function orderLightPopulation(
int $chunkX,
int $chunkZ) : void{
1347 $chunkHash = World::chunkHash($chunkX, $chunkZ);
1348 $lightPopulatedState = $this->chunks[$chunkHash]->isLightPopulated();
1349 if($lightPopulatedState ===
false){
1350 $this->chunks[$chunkHash]->setLightPopulated(
null);
1351 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
1353 $this->workerPool->submitTask(
new LightPopulationTask(
1354 $this->chunks[$chunkHash],
1355 function(array $blockLight, array $skyLight, array $heightMap) use ($chunkX, $chunkZ) :
void{
1362 if($this->unloaded || ($chunk = $this->getChunk($chunkX, $chunkZ)) ===
null || $chunk->isLightPopulated() ===
true){
1367 $chunk->setHeightMapArray($heightMap);
1368 foreach($blockLight as $y => $lightArray){
1369 $chunk->getSubChunk($y)->setBlockLightArray($lightArray);
1371 foreach($skyLight as $y => $lightArray){
1372 $chunk->getSubChunk($y)->setBlockSkyLightArray($lightArray);
1374 $chunk->setLightPopulated(
true);
1375 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
1381 private function tickChunk(
int $chunkX,
int $chunkZ) : void{
1382 $chunk = $this->getChunk($chunkX, $chunkZ);
1383 if($chunk ===
null){
1387 foreach($this->getChunkEntities($chunkX, $chunkZ) as $entity){
1388 $entity->onRandomUpdate();
1391 $blockFactory = $this->blockStateRegistry;
1392 foreach($chunk->getSubChunks() as $Y => $subChunk){
1393 if(!$subChunk->isEmptyFast()){
1395 for($i = 0; $i < $this->tickedBlocksPerSubchunkPerTick; ++$i){
1398 $k = mt_rand(0, (1 << 60) - 1);
1400 $x = $k & SubChunk::COORD_MASK;
1401 $y = ($k >> SubChunk::COORD_BIT_SIZE) & SubChunk::COORD_MASK;
1402 $z = ($k >> (SubChunk::COORD_BIT_SIZE * 2)) & SubChunk::COORD_MASK;
1403 $k >>= (SubChunk::COORD_BIT_SIZE * 3);
1405 $state = $subChunk->getBlockStateId($x, $y, $z);
1407 if(isset($this->randomTickBlocks[$state])){
1408 $block = $blockFactory->fromStateId($state);
1409 $block->position($this, $chunkX * Chunk::EDGE_LENGTH + $x, ($Y << SubChunk::COORD_BIT_SIZE) + $y, $chunkZ * Chunk::EDGE_LENGTH + $z);
1410 $block->onRandomTick();
1424 public function save(
bool $force =
false) : bool{
1426 if(!$this->getAutoSave() && !$force){
1430 (
new WorldSaveEvent($this))->call();
1432 $timings = $this->timings->syncDataSave;
1433 $timings->startTiming();
1435 $this->provider->getWorldData()->setTime($this->time);
1436 $this->saveChunks();
1437 $this->provider->getWorldData()->save();
1439 $timings->stopTiming();
1444 public function saveChunks() : void{
1445 $this->timings->syncChunkSave->startTiming();
1447 foreach($this->chunks as $chunkHash => $chunk){
1448 self::getXZ($chunkHash, $chunkX, $chunkZ);
1449 $this->provider->saveChunk($chunkX, $chunkZ,
new ChunkData(
1450 $chunk->getSubChunks(),
1451 $chunk->isPopulated(),
1452 array_map(fn(Entity $e) => $e->saveNBT(), array_values(array_filter($this->getChunkEntities($chunkX, $chunkZ), fn(Entity $e) => $e->canSaveWithChunk()))),
1453 array_map(fn(Tile $t) => $t->saveNBT(), array_values($chunk->getTiles())),
1454 ), $chunk->getTerrainDirtyFlags());
1455 $chunk->clearTerrainDirtyFlags();
1458 $this->timings->syncChunkSave->stopTiming();
1468 !$this->isInWorld($pos->x, $pos->y, $pos->z) ||
1469 (isset($this->scheduledBlockUpdateQueueIndex[$index =
World::blockHash($pos->x, $pos->y, $pos->z)]) && $this->scheduledBlockUpdateQueueIndex[$index] <= $delay)
1473 $this->scheduledBlockUpdateQueueIndex[$index] = $delay;
1474 $this->scheduledBlockUpdateQueue->insert(
new Vector3((
int) $pos->x, (
int) $pos->y, (
int) $pos->z), $delay + $this->server->getTick());
1477 private function tryAddToNeighbourUpdateQueue(
int $x,
int $y,
int $z) : void{
1478 if($this->isInWorld($x, $y, $z)){
1479 $hash = World::blockHash($x, $y, $z);
1480 if(!isset($this->neighbourBlockUpdateQueueIndex[$hash])){
1481 $this->neighbourBlockUpdateQueue->enqueue($hash);
1482 $this->neighbourBlockUpdateQueueIndex[$hash] =
true;
1494 $this->tryAddToNeighbourUpdateQueue($x, $y, $z);
1495 foreach(Facing::OFFSET as [$dx, $dy, $dz]){
1496 $this->tryAddToNeighbourUpdateQueue($x + $dx, $y + $dy, $z + $dz);
1505 $minX = (int) floor($bb->minX - 1);
1506 $minY = (int) floor($bb->minY - 1);
1507 $minZ = (int) floor($bb->minZ - 1);
1508 $maxX = (int) floor($bb->maxX + 1);
1509 $maxY = (int) floor($bb->maxY + 1);
1510 $maxZ = (int) floor($bb->maxZ + 1);
1514 $collisionInfo = $this->blockStateRegistry->collisionInfo;
1516 for($z = $minZ; $z <= $maxZ; ++$z){
1517 $zOverflow = $z === $minZ || $z === $maxZ;
1518 for($x = $minX; $x <= $maxX; ++$x){
1519 $zxOverflow = $zOverflow || $x === $minX || $x === $maxX;
1520 for($y = $minY; $y <= $maxY; ++$y){
1521 $overflow = $zxOverflow || $y === $minY || $y === $maxY;
1523 $stateCollisionInfo = $this->getBlockCollisionInfo($x, $y, $z, $collisionInfo);
1525 $stateCollisionInfo === RuntimeBlockStateRegistry::COLLISION_MAY_OVERFLOW && $this->getBlockAt($x, $y, $z)->collidesWithBB($bb) :
1526 match ($stateCollisionInfo) {
1527 RuntimeBlockStateRegistry::COLLISION_CUBE =>
true,
1528 RuntimeBlockStateRegistry::COLLISION_NONE =>
false,
1529 default => $this->getBlockAt($x, $y, $z)->collidesWithBB($bb)
1532 return [$this->getBlockAt($x, $y, $z)];
1539 for($z = $minZ; $z <= $maxZ; ++$z){
1540 $zOverflow = $z === $minZ || $z === $maxZ;
1541 for($x = $minX; $x <= $maxX; ++$x){
1542 $zxOverflow = $zOverflow || $x === $minX || $x === $maxX;
1543 for($y = $minY; $y <= $maxY; ++$y){
1544 $overflow = $zxOverflow || $y === $minY || $y === $maxY;
1546 $stateCollisionInfo = $this->getBlockCollisionInfo($x, $y, $z, $collisionInfo);
1548 $stateCollisionInfo === RuntimeBlockStateRegistry::COLLISION_MAY_OVERFLOW && $this->getBlockAt($x, $y, $z)->collidesWithBB($bb) :
1549 match ($stateCollisionInfo) {
1550 RuntimeBlockStateRegistry::COLLISION_CUBE =>
true,
1551 RuntimeBlockStateRegistry::COLLISION_NONE =>
false,
1552 default => $this->getBlockAt($x, $y, $z)->collidesWithBB($bb)
1555 $collides[] = $this->getBlockAt($x, $y, $z);
1569 private function getBlockCollisionInfo(
int $x,
int $y,
int $z, array $collisionInfo) : int{
1570 if(!$this->isInWorld($x, $y, $z)){
1571 return RuntimeBlockStateRegistry::COLLISION_NONE;
1573 $chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE);
1574 if($chunk ===
null){
1575 return RuntimeBlockStateRegistry::COLLISION_NONE;
1578 ->getSubChunk($y >> SubChunk::COORD_BIT_SIZE)
1580 $x & SubChunk::COORD_MASK,
1581 $y & SubChunk::COORD_MASK,
1582 $z & SubChunk::COORD_MASK
1584 return $collisionInfo[$stateId];
1598 private function getBlockCollisionBoxesForCell(
int $x,
int $y,
int $z, array $collisionInfo) : array{
1599 $stateCollisionInfo = $this->getBlockCollisionInfo($x, $y, $z, $collisionInfo);
1600 $boxes = match($stateCollisionInfo){
1601 RuntimeBlockStateRegistry::COLLISION_NONE => [],
1602 RuntimeBlockStateRegistry::COLLISION_CUBE => [AxisAlignedBB::one()->offsetCopy($x, $y, $z)],
1603 default => $this->getBlockAt($x, $y, $z)->getCollisionBoxes()
1607 if($stateCollisionInfo !== RuntimeBlockStateRegistry::COLLISION_CUBE){
1609 foreach(Facing::OFFSET as [$dx, $dy, $dz]){
1610 $offsetX = $x + $dx;
1611 $offsetY = $y + $dy;
1612 $offsetZ = $z + $dz;
1613 $stateCollisionInfo = $this->getBlockCollisionInfo($offsetX, $offsetY, $offsetZ, $collisionInfo);
1614 if($stateCollisionInfo === RuntimeBlockStateRegistry::COLLISION_MAY_OVERFLOW){
1616 $cellBB ??= AxisAlignedBB::one()->offsetCopy($x, $y, $z);
1617 $extraBoxes = $this->getBlockAt($offsetX, $offsetY, $offsetZ)->getCollisionBoxes();
1618 foreach($extraBoxes as $extraBox){
1619 if($extraBox->intersectsWith($cellBB)){
1620 $boxes[] = $extraBox;
1635 $minX = (int) floor($bb->minX);
1636 $minY = (int) floor($bb->minY);
1637 $minZ = (int) floor($bb->minZ);
1638 $maxX = (int) floor($bb->maxX);
1639 $maxY = (int) floor($bb->maxY);
1640 $maxZ = (int) floor($bb->maxZ);
1644 $collisionInfo = $this->blockStateRegistry->collisionInfo;
1646 for($z = $minZ; $z <= $maxZ; ++$z){
1647 for($x = $minX; $x <= $maxX; ++$x){
1648 $chunkPosHash = World::chunkHash($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE);
1649 for($y = $minY; $y <= $maxY; ++$y){
1650 $relativeBlockHash = World::chunkBlockHash($x, $y, $z);
1652 $boxes = $this->blockCollisionBoxCache[$chunkPosHash][$relativeBlockHash] ??= $this->getBlockCollisionBoxesForCell($x, $y, $z, $collisionInfo);
1654 foreach($boxes as $blockBB){
1655 if($blockBB->intersectsWith($bb)){
1656 $collides[] = $blockBB;
1671 $timeProgress = ($this->time % self::TIME_FULL) / self::TIME_FULL;
1674 $sunProgress = $timeProgress + ($timeProgress < 0.25 ? 0.75 : -0.25);
1678 $diff = (((1 - ((cos($sunProgress * M_PI) + 1) / 2)) - $sunProgress) / 3);
1680 return $sunProgress + $diff;
1687 return $this->sunAnglePercentage;
1694 return $this->sunAnglePercentage * 2 * M_PI;
1701 return $this->sunAnglePercentage * 360.0;
1709 $percentage = max(0, min(1, -(cos($this->getSunAngleRadians()) * 2 - 0.5)));
1713 return (
int) ($percentage * 11);
1720 return $this->skyLightReduction;
1728 $floorX = $pos->getFloorX();
1729 $floorY = $pos->getFloorY();
1730 $floorZ = $pos->getFloorZ();
1731 return $this->getFullLightAt($floorX, $floorY, $floorZ);
1739 $skyLight = $this->getRealBlockSkyLightAt($x, $y, $z);
1741 return max($skyLight, $this->getBlockLightAt($x, $y, $z));
1752 return $this->getHighestAdjacentLight($x, $y, $z, $this->getFullLightAt(...));
1760 $floorX = $pos->getFloorX();
1761 $floorY = $pos->getFloorY();
1762 $floorZ = $pos->getFloorZ();
1763 return $this->getPotentialLightAt($floorX, $floorY, $floorZ);
1771 return max($this->getPotentialBlockSkyLightAt($x, $y, $z), $this->getBlockLightAt($x, $y, $z));
1779 return $this->getHighestAdjacentLight($x, $y, $z, $this->getPotentialLightAt(...));
1789 if(!$this->isInWorld($x, $y, $z)){
1790 return $y >= self::Y_MAX ? 15 : 0;
1792 if(($chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)) !==
null && $chunk->isLightPopulated() ===
true){
1793 return $chunk->getSubChunk($y >> Chunk::COORD_BIT_SIZE)->getBlockSkyLightArray()->get($x & SubChunk::COORD_MASK, $y & SubChunk::COORD_MASK, $z & SubChunk::COORD_MASK);
1804 $light = $this->getPotentialBlockSkyLightAt($x, $y, $z) - $this->skyLightReduction;
1805 return $light < 0 ? 0 : $light;
1814 if(!$this->isInWorld($x, $y, $z)){
1817 if(($chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)) !==
null && $chunk->isLightPopulated() ===
true){
1818 return $chunk->getSubChunk($y >> Chunk::COORD_BIT_SIZE)->getBlockLightArray()->get($x & SubChunk::COORD_MASK, $y & SubChunk::COORD_MASK, $z & SubChunk::COORD_MASK);
1823 public function updateAllLight(
int $x,
int $y,
int $z) : void{
1824 if(($chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)) === null || $chunk->isLightPopulated() !== true){
1828 $blockFactory = $this->blockStateRegistry;
1829 $this->timings->doBlockSkyLightUpdates->startTiming();
1830 if($this->skyLightUpdate ===
null){
1831 $this->skyLightUpdate =
new SkyLightUpdate(
new SubChunkExplorer($this), $blockFactory->lightFilter, $blockFactory->blocksDirectSkyLight);
1833 $this->skyLightUpdate->recalculateNode($x, $y, $z);
1834 $this->timings->doBlockSkyLightUpdates->stopTiming();
1836 $this->timings->doBlockLightUpdates->startTiming();
1837 if($this->blockLightUpdate ===
null){
1838 $this->blockLightUpdate =
new BlockLightUpdate(
new SubChunkExplorer($this), $blockFactory->lightFilter, $blockFactory->light);
1840 $this->blockLightUpdate->recalculateNode($x, $y, $z);
1841 $this->timings->doBlockLightUpdates->stopTiming();
1847 private function getHighestAdjacentLight(
int $x,
int $y,
int $z, \Closure $lightGetter) : int{
1849 foreach(Facing::OFFSET as [$offsetX, $offsetY, $offsetZ]){
1850 $x1 = $x + $offsetX;
1851 $y1 = $y + $offsetY;
1852 $z1 = $z + $offsetZ;
1854 !$this->isInWorld($x1, $y1, $z1) ||
1855 ($chunk = $this->getChunk($x1 >> Chunk::COORD_BIT_SIZE, $z1 >> Chunk::COORD_BIT_SIZE)) ===
null ||
1856 $chunk->isLightPopulated() !==
true
1860 $max = max($max, $lightGetter($x1, $y1, $z1));
1869 return $this->getHighestAdjacentLight($x, $y, $z, $this->getPotentialBlockSkyLightAt(...));
1877 return $this->getHighestAdjacentPotentialBlockSkyLight($x, $y, $z) - $this->skyLightReduction;
1884 return $this->getHighestAdjacentLight($x, $y, $z, $this->getBlockLightAt(...));
1887 private function executeQueuedLightUpdates() : void{
1888 if($this->blockLightUpdate !== null){
1889 $this->timings->doBlockLightUpdates->startTiming();
1890 $this->blockLightUpdate->execute();
1891 $this->blockLightUpdate =
null;
1892 $this->timings->doBlockLightUpdates->stopTiming();
1895 if($this->skyLightUpdate !==
null){
1896 $this->timings->doBlockSkyLightUpdates->startTiming();
1897 $this->skyLightUpdate->execute();
1898 $this->skyLightUpdate =
null;
1899 $this->timings->doBlockSkyLightUpdates->stopTiming();
1906 $y < $this->maxY && $y >= $this->minY &&
1922 return $this->getBlockAt((int) floor($pos->x), (int) floor($pos->y), (int) floor($pos->z), $cached, $addToCache);
1934 public function getBlockAt(
int $x,
int $y,
int $z,
bool $cached =
true,
bool $addToCache =
true) :
Block{
1935 $relativeBlockHash = null;
1936 $chunkHash = World::chunkHash($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE);
1938 if($this->isInWorld($x, $y, $z)){
1939 $relativeBlockHash = World::chunkBlockHash($x, $y, $z);
1941 if($cached && isset($this->blockCache[$chunkHash][$relativeBlockHash])){
1942 return $this->blockCache[$chunkHash][$relativeBlockHash];
1945 $chunk = $this->chunks[$chunkHash] ??
null;
1946 if($chunk !==
null){
1947 $block = $this->blockStateRegistry->fromStateId($chunk->getBlockStateId($x & Chunk::COORD_MASK, $y, $z & Chunk::COORD_MASK));
1949 $addToCache =
false;
1950 $block = VanillaBlocks::AIR();
1953 $block = VanillaBlocks::AIR();
1956 $block->position($this, $x, $y, $z);
1958 if($this->inDynamicStateRecalculation){
1962 $addToCache =
false;
1964 $this->inDynamicStateRecalculation =
true;
1965 $replacement = $block->readStateFromWorld();
1966 if($replacement !== $block){
1967 $replacement->position($this, $x, $y, $z);
1968 $block = $replacement;
1970 $this->inDynamicStateRecalculation =
false;
1973 if($addToCache && $relativeBlockHash !==
null){
1974 $this->blockCache[$chunkHash][$relativeBlockHash] = $block;
1976 if(++$this->blockCacheSize >= self::BLOCK_CACHE_SIZE_CAP){
1977 $this->trimBlockCache();
1990 $this->setBlockAt((int) floor($pos->x), (int) floor($pos->y), (int) floor($pos->z), $block, $update);
2001 public function setBlockAt(
int $x,
int $y,
int $z,
Block $block,
bool $update =
true) : void{
2002 if(!$this->isInWorld($x, $y, $z)){
2003 throw new \InvalidArgumentException(
"Pos x=$x,y=$y,z=$z is outside of the world bounds");
2005 $chunkX = $x >> Chunk::COORD_BIT_SIZE;
2006 $chunkZ = $z >> Chunk::COORD_BIT_SIZE;
2007 if($this->loadChunk($chunkX, $chunkZ) ===
null){
2008 throw new WorldException(
"Cannot set a block in un-generated terrain");
2012 $stateId = $block->getStateId();
2013 if(!$this->blockStateRegistry->hasStateId($stateId)){
2014 throw new \LogicException(
"Block state ID not known to RuntimeBlockStateRegistry (probably not registered)");
2016 if(!GlobalBlockStateHandlers::getSerializer()->isRegistered($block)){
2017 throw new \LogicException(
"Block not registered with GlobalBlockStateHandlers serializer");
2020 $this->timings->setBlock->startTiming();
2022 $this->unlockChunk($chunkX, $chunkZ,
null);
2024 $block = clone $block;
2026 $block->position($this, $x, $y, $z);
2027 $block->writeStateToWorld();
2028 $pos =
new Vector3($x, $y, $z);
2030 $chunkHash = World::chunkHash($chunkX, $chunkZ);
2031 $relativeBlockHash = World::chunkBlockHash($x, $y, $z);
2033 unset($this->blockCache[$chunkHash][$relativeBlockHash]);
2034 $this->blockCacheSize--;
2035 unset($this->blockCollisionBoxCache[$chunkHash][$relativeBlockHash]);
2038 foreach(Facing::OFFSET as [$offsetX, $offsetY, $offsetZ]){
2039 $sideChunkPosHash = World::chunkHash(($x + $offsetX) >> Chunk::COORD_BIT_SIZE, ($z + $offsetZ) >> Chunk::COORD_BIT_SIZE);
2040 $sideChunkBlockHash = World::chunkBlockHash($x + $offsetX, $y + $offsetY, $z + $offsetZ);
2041 unset($this->blockCollisionBoxCache[$sideChunkPosHash][$sideChunkBlockHash]);
2044 if(!isset($this->changedBlocks[$chunkHash])){
2045 $this->changedBlocks[$chunkHash] = [];
2047 $this->changedBlocks[$chunkHash][$relativeBlockHash] = $pos;
2049 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2050 $listener->onBlockChanged($pos);
2054 $this->updateAllLight($x, $y, $z);
2055 $this->notifyNeighbourBlockUpdate($x, $y, $z);
2058 $this->timings->setBlock->stopTiming();
2061 public function dropItem(Vector3 $source, Item $item, ?Vector3 $motion =
null,
int $delay = 10) : ?ItemEntity{
2062 if($item->isNull()){
2066 $itemEntity =
new ItemEntity(Location::fromObject($source, $this, Utils::getRandomFloat() * 360, 0), $item);
2068 $itemEntity->setPickupDelay($delay);
2069 $itemEntity->setMotion($motion ??
new Vector3(Utils::getRandomFloat() * 0.2 - 0.1, 0.2, Utils::getRandomFloat() * 0.2 - 0.1));
2070 $itemEntity->spawnToAll();
2084 foreach(ExperienceOrb::splitIntoOrbSizes($amount) as $split){
2085 $orb =
new ExperienceOrb(Location::fromObject($pos, $this, Utils::getRandomFloat() * 360, 0), $split);
2087 $orb->setMotion(
new Vector3((Utils::getRandomFloat() * 0.2 - 0.1) * 2, Utils::getRandomFloat() * 0.4, (Utils::getRandomFloat() * 0.2 - 0.1) * 2));
2104 public function useBreakOn(
Vector3 $vector, ?
Item &$item =
null, ?
Player $player =
null,
bool $createParticles =
false, array &$returnedItems = []) : bool{
2105 $vector = $vector->floor();
2107 $chunkX = $vector->getFloorX() >> Chunk::COORD_BIT_SIZE;
2108 $chunkZ = $vector->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2109 if(!$this->isChunkLoaded($chunkX, $chunkZ) || $this->isChunkLocked($chunkX, $chunkZ)){
2113 $target = $this->getBlock($vector);
2114 $affectedBlocks = $target->getAffectedBlocks();
2117 $item = VanillaItems::AIR();
2121 if($player ===
null || $player->hasFiniteResources()){
2122 $drops = array_merge(...array_map(fn(Block $block) => $block->getDrops($item), $affectedBlocks));
2126 if($player !==
null && $player->hasFiniteResources()){
2127 $xpDrop = array_sum(array_map(fn(Block $block) => $block->getXpDropForTool($item), $affectedBlocks));
2130 if($player !==
null){
2131 $ev =
new BlockBreakEvent($player, $target, $item, $player->isCreative(), $drops, $xpDrop);
2133 if($target instanceof Air || ($player->isSurvival() && !$target->getBreakInfo()->isBreakable()) || $player->isSpectator()){
2137 if($player->isAdventure(
true) && !$ev->isCancelled()){
2139 $itemParser = LegacyStringToItemParser::getInstance();
2140 foreach($item->getCanDestroy() as $v){
2141 $entry = $itemParser->parse($v);
2142 if($entry->getBlock()->hasSameTypeId($target)){
2154 if($ev->isCancelled()){
2158 $drops = $ev->getDrops();
2159 $xpDrop = $ev->getXpDropAmount();
2161 }elseif(!$target->getBreakInfo()->isBreakable()){
2165 foreach($affectedBlocks as $t){
2166 $this->destroyBlockInternal($t, $item, $player, $createParticles, $returnedItems);
2169 $item->onDestroyBlock($target, $returnedItems);
2171 if(count($drops) > 0){
2172 $dropPos = $vector->add(0.5, 0.5, 0.5);
2173 foreach($drops as $drop){
2174 if(!$drop->isNull()){
2175 $this->dropItem($dropPos, $drop);
2181 $this->dropExperience($vector->add(0.5, 0.5, 0.5), $xpDrop);
2190 private function destroyBlockInternal(Block $target, Item $item, ?Player $player,
bool $createParticles, array &$returnedItems) : void{
2191 if($createParticles){
2192 $this->addParticle($target->getPosition()->add(0.5, 0.5, 0.5),
new BlockBreakParticle($target));
2195 $target->onBreak($item, $player, $returnedItems);
2197 $tile = $this->getTile($target->getPosition());
2199 $tile->onBlockDestroyed();
2211 $blockClicked = $this->getBlock($vector);
2212 $blockReplace = $blockClicked->getSide($face);
2214 if($clickVector ===
null){
2215 $clickVector =
new Vector3(0.0, 0.0, 0.0);
2218 min(1.0, max(0.0, $clickVector->x)),
2219 min(1.0, max(0.0, $clickVector->y)),
2220 min(1.0, max(0.0, $clickVector->z))
2224 if(!$this->isInWorld($blockReplace->getPosition()->x, $blockReplace->getPosition()->y, $blockReplace->getPosition()->z)){
2228 $chunkX = $blockReplace->getPosition()->getFloorX() >> Chunk::COORD_BIT_SIZE;
2229 $chunkZ = $blockReplace->getPosition()->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2230 if(!$this->isChunkLoaded($chunkX, $chunkZ) || $this->isChunkLocked($chunkX, $chunkZ)){
2234 if($blockClicked->getTypeId() === BlockTypeIds::AIR){
2238 if($player !==
null){
2239 $ev = new PlayerInteractEvent($player, $item, $blockClicked, $clickVector, $face, PlayerInteractEvent::RIGHT_CLICK_BLOCK);
2240 if($player->isSneaking()){
2241 $ev->setUseItem(false);
2242 $ev->setUseBlock($item->isNull());
2244 if($player->isSpectator()){
2249 if(!$ev->isCancelled()){
2250 if($ev->useBlock() && $blockClicked->onInteract($item, $face, $clickVector, $player, $returnedItems)){
2255 $result = $item->onInteractBlock($player, $blockReplace, $blockClicked, $face, $clickVector, $returnedItems);
2256 if($result !== ItemUseResult::NONE){
2257 return $result === ItemUseResult::SUCCESS;
2263 }elseif($blockClicked->onInteract($item, $face, $clickVector, $player, $returnedItems)){
2267 if($item->isNull() || !$item->canBePlaced()){
2275 $item->getPlacementTransaction($blockClicked, $blockClicked, Facing::UP, $clickVector, $player) ??
2276 $item->getPlacementTransaction($blockReplace, $blockClicked, $face, $clickVector, $player);
2282 foreach($tx->getBlocks() as [$x, $y, $z, $block]){
2283 $block->position($this, $x, $y, $z);
2284 foreach($block->getCollisionBoxes() as $collisionBox){
2285 if(count($this->getCollidingEntities($collisionBox)) > 0){
2291 if($player !==
null){
2292 $ev =
new BlockPlaceEvent($player, $tx, $blockClicked, $item);
2293 if($player->isSpectator()){
2297 if($player->isAdventure(
true) && !$ev->isCancelled()){
2299 $itemParser = LegacyStringToItemParser::getInstance();
2301 $entry = $itemParser->parse($v);
2302 if($entry->getBlock()->hasSameTypeId($blockClicked)){
2314 if($ev->isCancelled()){
2323 foreach($tx->getBlocks() as [$x, $y, $z, $_]){
2324 $tile = $this->getTileAt($x, $y, $z);
2327 $tile->copyDataFromItem($item);
2330 $placed = $this->getBlockAt($x, $y, $z);
2331 $placed->onPostPlace();
2332 if($first && $playSound){
2333 $this->addSound($placed->getPosition(),
new BlockPlaceSound($placed));
2343 public function getEntity(
int $entityId) : ?Entity{
2344 return $this->entities[$entityId] ?? null;
2354 return $this->entities;
2370 foreach($this->getNearbyEntities($bb, $entity) as $ent){
2371 if($ent->canBeCollidedWith() && ($entity ===
null || $entity->canCollideWith($ent))){
2388 $minX = ((int) floor($bb->minX - 2)) >> Chunk::COORD_BIT_SIZE;
2389 $maxX = ((int) floor($bb->maxX + 2)) >> Chunk::COORD_BIT_SIZE;
2390 $minZ = ((int) floor($bb->minZ - 2)) >> Chunk::COORD_BIT_SIZE;
2391 $maxZ = ((int) floor($bb->maxZ + 2)) >> Chunk::COORD_BIT_SIZE;
2393 for($x = $minX; $x <= $maxX; ++$x){
2394 for($z = $minZ; $z <= $maxZ; ++$z){
2395 foreach($this->getChunkEntities($x, $z) as $ent){
2396 if($ent !== $entity && $ent->boundingBox->intersectsWith($bb)){
2418 assert(is_a($entityType,
Entity::class, true));
2420 $minX = ((int) floor($pos->x - $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2421 $maxX = ((int) floor($pos->x + $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2422 $minZ = ((int) floor($pos->z - $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2423 $maxZ = ((int) floor($pos->z + $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2425 $currentTargetDistSq = $maxDistance ** 2;
2431 $currentTarget =
null;
2433 for($x = $minX; $x <= $maxX; ++$x){
2434 for($z = $minZ; $z <= $maxZ; ++$z){
2435 foreach($this->getChunkEntities($x, $z) as $entity){
2436 if(!($entity instanceof $entityType) || $entity->isFlaggedForDespawn() || (!$includeDead && !$entity->isAlive())){
2439 $distSq = $entity->getPosition()->distanceSquared($pos);
2440 if($distSq < $currentTargetDistSq){
2441 $currentTargetDistSq = $distSq;
2442 $currentTarget = $entity;
2448 return $currentTarget;
2458 return $this->players;
2468 return $this->getTileAt((int) floor($pos->x), (int) floor($pos->y), (int) floor($pos->z));
2475 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;
2478 public function getBiomeId(
int $x,
int $y,
int $z) : int{
2479 if(($chunk = $this->loadChunk($x >>
Chunk::COORD_BIT_SIZE, $z >>
Chunk::COORD_BIT_SIZE)) !== null){
2480 return $chunk->getBiomeId($x & Chunk::COORD_MASK, $y & Chunk::COORD_MASK, $z & Chunk::COORD_MASK);
2482 return BiomeIds::OCEAN;
2485 public function getBiome(
int $x,
int $y,
int $z) : Biome{
2486 return BiomeRegistry::getInstance()->getBiome($this->getBiomeId($x, $y, $z));
2489 public function setBiomeId(
int $x,
int $y,
int $z,
int $biomeId) : void{
2490 $chunkX = $x >> Chunk::COORD_BIT_SIZE;
2491 $chunkZ = $z >> Chunk::COORD_BIT_SIZE;
2492 $this->unlockChunk($chunkX, $chunkZ,
null);
2493 if(($chunk = $this->loadChunk($chunkX, $chunkZ)) !==
null){
2494 $chunk->setBiomeId($x & Chunk::COORD_MASK, $y & Chunk::COORD_MASK, $z & Chunk::COORD_MASK, $biomeId);
2497 throw new WorldException(
"Cannot set biome in a non-generated chunk");
2506 return $this->chunks;
2509 public function getChunk(
int $chunkX,
int $chunkZ) : ?
Chunk{
2510 return $this->chunks[
World::chunkHash($chunkX, $chunkZ)] ?? null;
2518 return $this->entitiesByChunk[
World::chunkHash($chunkX, $chunkZ)] ?? [];
2525 return $this->loadChunk($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE);
2536 for($xx = -1; $xx <= 1; ++$xx){
2537 for($zz = -1; $zz <= 1; ++$zz){
2538 if($xx === 0 && $zz === 0){
2541 $result[World::chunkHash($xx, $zz)] = $this->loadChunk($x + $xx, $z + $zz);
2563 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
2564 if(isset($this->chunkLock[$chunkHash])){
2565 throw new \InvalidArgumentException(
"Chunk $chunkX $chunkZ is already locked");
2567 $this->chunkLock[$chunkHash] = $lockId;
2568 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
2580 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
2581 if(isset($this->chunkLock[$chunkHash]) && ($lockId ===
null || $this->chunkLock[$chunkHash] === $lockId)){
2582 unset($this->chunkLock[$chunkHash]);
2583 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
2595 return isset($this->chunkLock[
World::chunkHash($chunkX, $chunkZ)]);
2598 public function setChunk(
int $chunkX,
int $chunkZ,
Chunk $chunk) : void{
2599 foreach($chunk->getSubChunks() as $subChunk){
2600 foreach($subChunk->getBlockLayers() as $blockLayer){
2601 foreach($blockLayer->getPalette() as $blockStateId){
2602 if(!$this->blockStateRegistry->hasStateId($blockStateId)){
2603 throw new \InvalidArgumentException(
"Provided chunk contains unknown/unregistered blocks (found unknown state ID $blockStateId)");
2609 $chunkHash = World::chunkHash($chunkX, $chunkZ);
2610 $oldChunk = $this->loadChunk($chunkX, $chunkZ);
2611 if($oldChunk !==
null && $oldChunk !== $chunk){
2613 $transferredTiles = 0;
2614 foreach($oldChunk->getTiles() as $oldTile){
2615 $tilePosition = $oldTile->getPosition();
2616 $localX = $tilePosition->getFloorX() & Chunk::COORD_MASK;
2617 $localY = $tilePosition->getFloorY();
2618 $localZ = $tilePosition->getFloorZ() & Chunk::COORD_MASK;
2620 $newBlock = $this->blockStateRegistry->fromStateId($chunk->getBlockStateId($localX, $localY, $localZ));
2621 $expectedTileClass = $newBlock->getIdInfo()->getTileClass();
2623 $expectedTileClass ===
null ||
2624 !($oldTile instanceof $expectedTileClass) ||
2625 (($newTile = $chunk->getTile($localX, $localY, $localZ)) !==
null && $newTile !== $oldTile)
2630 $transferredTiles++;
2631 $chunk->addTile($oldTile);
2632 $oldChunk->removeTile($oldTile);
2635 if($deletedTiles > 0 || $transferredTiles > 0){
2636 $this->logger->debug(
"Replacement of chunk $chunkX $chunkZ caused deletion of $deletedTiles obsolete/conflicted tiles, and transfer of $transferredTiles");
2640 $this->chunks[$chunkHash] = $chunk;
2641 unset($this->knownUngeneratedChunks[$chunkHash]);
2643 $this->blockCacheSize -= count($this->blockCache[$chunkHash] ?? []);
2644 unset($this->blockCache[$chunkHash]);
2645 unset($this->blockCollisionBoxCache[$chunkHash]);
2646 unset($this->changedBlocks[$chunkHash]);
2647 $chunk->setTerrainDirty();
2648 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
2650 if(!$this->isChunkInUse($chunkX, $chunkZ)){
2651 $this->unloadChunkRequest($chunkX, $chunkZ);
2654 if($oldChunk ===
null){
2655 if(ChunkLoadEvent::hasHandlers()){
2656 (
new ChunkLoadEvent($this, $chunkX, $chunkZ, $chunk,
true))->call();
2659 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2660 $listener->onChunkLoaded($chunkX, $chunkZ, $chunk);
2663 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2664 $listener->onChunkChanged($chunkX, $chunkZ, $chunk);
2668 for($cX = -1; $cX <= 1; ++$cX){
2669 for($cZ = -1; $cZ <= 1; ++$cZ){
2670 foreach($this->getChunkEntities($chunkX + $cX, $chunkZ + $cZ) as $entity){
2671 $entity->onNearbyBlockChange();
2684 if(($chunk = $this->loadChunk($x >>
Chunk::COORD_BIT_SIZE, $z >>
Chunk::COORD_BIT_SIZE)) !== null){
2685 return $chunk->getHighestBlockAt($x & Chunk::COORD_MASK, $z & Chunk::COORD_MASK);
2687 throw new WorldException(
"Cannot get highest block in an ungenerated chunk");
2694 return $this->isChunkLoaded($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE);
2697 public function isChunkLoaded(
int $x,
int $z) : bool{
2698 return isset($this->chunks[
World::chunkHash($x, $z)]);
2701 public function isChunkGenerated(
int $x,
int $z) : bool{
2702 return $this->loadChunk($x, $z) !== null;
2705 public function isChunkPopulated(
int $x,
int $z) : bool{
2706 $chunk = $this->loadChunk($x, $z);
2707 return $chunk !==
null && $chunk->isPopulated();
2714 return
Position::fromObject($this->provider->getWorldData()->getSpawn(), $this);
2721 $previousSpawn = $this->getSpawnLocation();
2722 $this->provider->getWorldData()->setSpawn($pos);
2725 $location = Position::fromObject($pos, $this);
2726 foreach($this->players as $player){
2727 $player->getNetworkSession()->syncWorldSpawnPoint($location);
2735 if($entity->isClosed()){
2736 throw new \InvalidArgumentException(
"Attempted to add a garbage closed Entity to world");
2738 if($entity->getWorld() !== $this){
2739 throw new \InvalidArgumentException(
"Invalid Entity world");
2741 if(array_key_exists($entity->getId(), $this->entities)){
2742 if($this->entities[$entity->getId()] === $entity){
2743 throw new \InvalidArgumentException(
"Entity " . $entity->getId() .
" has already been added to this world");
2745 throw new AssumptionFailedError(
"Found two different entities sharing entity ID " . $entity->getId());
2748 if(!EntityFactory::getInstance()->isRegistered($entity::class) && !$entity instanceof NeverSavedWithChunkEntity){
2751 throw new \LogicException(
"Entity " . $entity::class .
" is not registered for a save ID in EntityFactory");
2753 $pos = $entity->getPosition()->
asVector3();
2754 $this->entitiesByChunk[World::chunkHash($pos->getFloorX() >> Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE)][$entity->getId()] = $entity;
2755 $this->entityLastKnownPositions[$entity->getId()] = $pos;
2757 if($entity instanceof Player){
2758 $this->players[$entity->getId()] = $entity;
2760 $this->entities[$entity->getId()] = $entity;
2769 if($entity->getWorld() !== $this){
2770 throw new \InvalidArgumentException(
"Invalid Entity world");
2772 if(!array_key_exists($entity->getId(), $this->entities)){
2773 throw new \InvalidArgumentException(
"Entity is not tracked by this world (possibly already removed?)");
2775 $pos = $this->entityLastKnownPositions[$entity->getId()];
2776 $chunkHash = World::chunkHash($pos->getFloorX() >> Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE);
2777 if(isset($this->entitiesByChunk[$chunkHash][$entity->getId()])){
2778 if(count($this->entitiesByChunk[$chunkHash]) === 1){
2779 unset($this->entitiesByChunk[$chunkHash]);
2781 unset($this->entitiesByChunk[$chunkHash][$entity->getId()]);
2784 unset($this->entityLastKnownPositions[$entity->getId()]);
2786 if($entity instanceof Player){
2787 unset($this->players[$entity->getId()]);
2788 $this->checkSleep();
2791 unset($this->entities[$entity->getId()]);
2792 unset($this->updateEntities[$entity->getId()]);
2798 public function onEntityMoved(Entity $entity) : void{
2799 if(!array_key_exists($entity->getId(), $this->entityLastKnownPositions)){
2803 $oldPosition = $this->entityLastKnownPositions[$entity->getId()];
2804 $newPosition = $entity->getPosition();
2806 $oldChunkX = $oldPosition->getFloorX() >> Chunk::COORD_BIT_SIZE;
2807 $oldChunkZ = $oldPosition->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2808 $newChunkX = $newPosition->getFloorX() >> Chunk::COORD_BIT_SIZE;
2809 $newChunkZ = $newPosition->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2811 if($oldChunkX !== $newChunkX || $oldChunkZ !== $newChunkZ){
2812 $oldChunkHash = World::chunkHash($oldChunkX, $oldChunkZ);
2813 if(isset($this->entitiesByChunk[$oldChunkHash][$entity->getId()])){
2814 if(count($this->entitiesByChunk[$oldChunkHash]) === 1){
2815 unset($this->entitiesByChunk[$oldChunkHash]);
2817 unset($this->entitiesByChunk[$oldChunkHash][$entity->getId()]);
2821 $newViewers = $this->getViewersForPosition($newPosition);
2822 foreach($entity->getViewers() as $player){
2823 if(!isset($newViewers[spl_object_id($player)])){
2824 $entity->despawnFrom($player);
2826 unset($newViewers[spl_object_id($player)]);
2829 foreach($newViewers as $player){
2830 $entity->spawnTo($player);
2833 $newChunkHash = World::chunkHash($newChunkX, $newChunkZ);
2834 $this->entitiesByChunk[$newChunkHash][$entity->getId()] = $entity;
2836 $this->entityLastKnownPositions[$entity->getId()] = $newPosition->asVector3();
2843 public function addTile(Tile $tile) : void{
2844 if($tile->isClosed()){
2845 throw new \InvalidArgumentException(
"Attempted to add a garbage closed Tile to world");
2847 $pos = $tile->getPosition();
2848 if(!$pos->isValid() || $pos->getWorld() !== $this){
2849 throw new \InvalidArgumentException(
"Invalid Tile world");
2851 if(!$this->isInWorld($pos->getFloorX(), $pos->getFloorY(), $pos->getFloorZ())){
2852 throw new \InvalidArgumentException(
"Tile position is outside the world bounds");
2854 if(!TileFactory::getInstance()->isRegistered($tile::class)){
2855 throw new \LogicException(
"Tile " . $tile::class .
" is not registered for a save ID in TileFactory");
2858 $chunkX = $pos->getFloorX() >> Chunk::COORD_BIT_SIZE;
2859 $chunkZ = $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2861 if(isset($this->chunks[$hash = World::chunkHash($chunkX, $chunkZ)])){
2862 $this->chunks[$hash]->addTile($tile);
2864 throw new \InvalidArgumentException(
"Attempted to create tile " . get_class($tile) .
" in unloaded chunk $chunkX $chunkZ");
2868 $this->scheduleDelayedBlockUpdate($pos->
asVector3(), 1);
2875 public function removeTile(Tile $tile) : void{
2877 if(!$pos->isValid() || $pos->getWorld() !== $this){
2878 throw new \InvalidArgumentException(
"Invalid Tile world");
2881 $chunkX = $pos->getFloorX() >> Chunk::COORD_BIT_SIZE;
2882 $chunkZ = $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2884 if(isset($this->chunks[$hash = World::chunkHash($chunkX, $chunkZ)])){
2885 $this->chunks[$hash]->removeTile($tile);
2887 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2888 $listener->onBlockChanged($pos->
asVector3());
2892 public function isChunkInUse(
int $x,
int $z) : bool{
2893 return isset($this->chunkLoaders[$index = World::chunkHash($x, $z)]) && count($this->chunkLoaders[$index]) > 0;
2903 if(isset($this->chunks[$chunkHash =
World::chunkHash($x, $z)])){
2904 return $this->chunks[$chunkHash];
2906 if(isset($this->knownUngeneratedChunks[$chunkHash])){
2910 $this->timings->syncChunkLoad->startTiming();
2912 $this->cancelUnloadChunkRequest($x, $z);
2914 $this->timings->syncChunkLoadData->startTiming();
2916 $loadedChunkData =
null;
2919 $loadedChunkData = $this->provider->loadChunk($x, $z);
2920 }
catch(CorruptedChunkException $e){
2921 $this->logger->critical(
"Failed to load chunk x=$x z=$z: " . $e->getMessage());
2924 $this->timings->syncChunkLoadData->stopTiming();
2926 if($loadedChunkData ===
null){
2927 $this->timings->syncChunkLoad->stopTiming();
2928 $this->knownUngeneratedChunks[$chunkHash] =
true;
2932 $chunkData = $loadedChunkData->getData();
2933 $chunk =
new Chunk($chunkData->getSubChunks(), $chunkData->isPopulated());
2934 if(!$loadedChunkData->isUpgraded()){
2935 $chunk->clearTerrainDirtyFlags();
2937 $this->logger->debug(
"Chunk $x $z has been upgraded, will be saved at the next autosave opportunity");
2939 $this->chunks[$chunkHash] = $chunk;
2941 $this->blockCacheSize -= count($this->blockCache[$chunkHash] ?? []);
2942 unset($this->blockCache[$chunkHash]);
2943 unset($this->blockCollisionBoxCache[$chunkHash]);
2945 $this->initChunk($x, $z, $chunkData, $chunk);
2947 if(ChunkLoadEvent::hasHandlers()){
2948 (
new ChunkLoadEvent($this, $x, $z, $this->chunks[$chunkHash],
false))->call();
2951 if(!$this->isChunkInUse($x, $z)){
2952 $this->logger->debug(
"Newly loaded chunk $x $z has no loaders registered, will be unloaded at next available opportunity");
2953 $this->unloadChunkRequest($x, $z);
2955 foreach($this->getChunkListeners($x, $z) as $listener){
2956 $listener->onChunkLoaded($x, $z, $this->chunks[$chunkHash]);
2958 $this->markTickingChunkForRecheck($x, $z);
2960 $this->timings->syncChunkLoad->stopTiming();
2962 return $this->chunks[$chunkHash];
2965 private function initChunk(
int $chunkX,
int $chunkZ, ChunkData $chunkData, Chunk $chunk) : void{
2966 $logger = new \
PrefixedLogger($this->logger,
"Loading chunk $chunkX $chunkZ");
2968 if(count($chunkData->getEntityNBT()) !== 0){
2969 $this->timings->syncChunkLoadEntities->startTiming();
2970 $entityFactory = EntityFactory::getInstance();
2972 $deletedEntities = [];
2973 foreach($chunkData->getEntityNBT() as $k => $nbt){
2975 $entity = $entityFactory->createFromData($this, $nbt);
2976 }catch(SavedDataLoadingException $e){
2977 $logger->error(
"Bad entity data at list position $k: " . $e->getMessage());
2978 $logger->logException($e);
2981 if($entity === null){
2982 $saveIdTag = $nbt->getTag(
"identifier") ?? $nbt->getTag(
"id");
2983 $saveId =
"<unknown>";
2984 if($saveIdTag instanceof StringTag){
2985 $saveId = $saveIdTag->getValue();
2986 }elseif($saveIdTag instanceof IntTag){
2987 $saveId =
"legacy(" . $saveIdTag->getValue() .
")";
2989 $deletedEntities[$saveId] = ($deletedEntities[$saveId] ?? 0) + 1;
2995 foreach(Utils::promoteKeys($deletedEntities) as $saveId => $count){
2996 $logger->warning(
"Deleted unknown entity type $saveId x$count");
2998 $this->timings->syncChunkLoadEntities->stopTiming();
3001 if(count($chunkData->getTileNBT()) !== 0){
3002 $this->timings->syncChunkLoadTileEntities->startTiming();
3003 $tileFactory = TileFactory::getInstance();
3006 foreach($chunkData->getTileNBT() as $k => $nbt){
3008 $tile = $tileFactory->createFromData($this, $nbt);
3009 }catch(SavedDataLoadingException $e){
3010 $logger->error(
"Bad tile entity data at list position $k: " . $e->getMessage());
3011 $logger->logException($e);
3015 $saveId = $nbt->getString(
"id",
"<unknown>");
3016 $deletedTiles[$saveId] = ($deletedTiles[$saveId] ?? 0) + 1;
3020 $tilePosition = $tile->getPosition();
3021 if(!$this->isChunkLoaded($tilePosition->getFloorX() >> Chunk::COORD_BIT_SIZE, $tilePosition->getFloorZ() >> Chunk::COORD_BIT_SIZE)){
3022 $logger->error(
"Found tile saved on wrong chunk - unable to fix due to correct chunk not loaded");
3023 }elseif(!$this->isInWorld($tilePosition->getFloorX(), $tilePosition->getFloorY(), $tilePosition->getFloorZ())){
3024 $logger->error(
"Cannot add tile with position outside the world bounds: x=$tilePosition->x,y=$tilePosition->y,z=$tilePosition->z");
3025 }elseif($this->getTile($tilePosition) !== null){
3026 $logger->error(
"Cannot add tile at x=$tilePosition->x,y=$tilePosition->y,z=$tilePosition->z: Another tile is already at that position");
3028 $this->addTile($tile);
3030 $expectedStateId = $chunk->getBlockStateId($tilePosition->getFloorX() & Chunk::COORD_MASK, $tilePosition->getFloorY(), $tilePosition->getFloorZ() & Chunk::COORD_MASK);
3031 $actualStateId = $this->getBlock($tilePosition)->getStateId();
3032 if($expectedStateId !== $actualStateId){
3037 $chunk->setBlockStateId($tilePosition->getFloorX() & Chunk::COORD_MASK, $tilePosition->getFloorY(), $tilePosition->getFloorZ() & Chunk::COORD_MASK, $actualStateId);
3038 $this->logger->debug(
"Tile " . $tile::class .
" at x=$tilePosition->x,y=$tilePosition->y,z=$tilePosition->z updated block state ID from $expectedStateId to $actualStateId");
3042 foreach(Utils::promoteKeys($deletedTiles) as $saveId => $count){
3043 $logger->warning(
"Deleted unknown tile entity type $saveId x$count");
3046 $this->timings->syncChunkLoadTileEntities->stopTiming();
3050 private function queueUnloadChunk(
int $x,
int $z) : void{
3051 $this->unloadQueue[World::chunkHash($x, $z)] = microtime(true);
3054 public function unloadChunkRequest(
int $x,
int $z,
bool $safe =
true) : bool{
3055 if(($safe && $this->isChunkInUse($x, $z)) || $this->isSpawnChunk($x, $z)){
3059 $this->queueUnloadChunk($x, $z);
3064 public function cancelUnloadChunkRequest(
int $x,
int $z) : void{
3065 unset($this->unloadQueue[World::chunkHash($x, $z)]);
3068 public function unloadChunk(
int $x,
int $z,
bool $safe =
true,
bool $trySave =
true) : bool{
3069 if($safe && $this->isChunkInUse($x, $z)){
3073 if(!$this->isChunkLoaded($x, $z)){
3077 $this->timings->doChunkUnload->startTiming();
3079 $chunkHash = World::chunkHash($x, $z);
3081 $chunk = $this->chunks[$chunkHash] ??
null;
3083 if($chunk !==
null){
3084 if(ChunkUnloadEvent::hasHandlers()){
3085 $ev =
new ChunkUnloadEvent($this, $x, $z, $chunk);
3087 if($ev->isCancelled()){
3088 $this->timings->doChunkUnload->stopTiming();
3094 if($trySave && $this->getAutoSave()){
3095 $this->timings->syncChunkSave->startTiming();
3097 $this->provider->saveChunk($x, $z,
new ChunkData(
3098 $chunk->getSubChunks(),
3099 $chunk->isPopulated(),
3100 array_map(fn(Entity $e) => $e->saveNBT(), array_values(array_filter($this->getChunkEntities($x, $z), fn(Entity $e) => $e->canSaveWithChunk()))),
3101 array_map(fn(Tile $t) => $t->saveNBT(), array_values($chunk->getTiles())),
3102 ), $chunk->getTerrainDirtyFlags());
3104 $this->timings->syncChunkSave->stopTiming();
3108 foreach($this->getChunkListeners($x, $z) as $listener){
3109 $listener->onChunkUnloaded($x, $z, $chunk);
3112 foreach($this->getChunkEntities($x, $z) as $entity){
3113 if($entity instanceof Player){
3122 unset($this->chunks[$chunkHash]);
3123 $this->blockCacheSize -= count($this->blockCache[$chunkHash] ?? []);
3124 unset($this->blockCache[$chunkHash]);
3125 unset($this->blockCollisionBoxCache[$chunkHash]);
3126 unset($this->changedBlocks[$chunkHash]);
3127 unset($this->registeredTickingChunks[$chunkHash]);
3128 $this->markTickingChunkForRecheck($x, $z);
3130 if(array_key_exists($chunkHash, $this->chunkPopulationRequestMap)){
3131 $this->logger->debug(
"Rejecting population promise for chunk $x $z");
3132 $this->chunkPopulationRequestMap[$chunkHash]->reject();
3133 unset($this->chunkPopulationRequestMap[$chunkHash]);
3134 if(isset($this->activeChunkPopulationTasks[$chunkHash])){
3135 $this->logger->debug(
"Marking population task for chunk $x $z as orphaned");
3136 $this->activeChunkPopulationTasks[$chunkHash] =
false;
3140 $this->timings->doChunkUnload->stopTiming();
3149 $spawn = $this->getSpawnLocation();
3150 $spawnX = $spawn->x >> Chunk::COORD_BIT_SIZE;
3151 $spawnZ = $spawn->z >> Chunk::COORD_BIT_SIZE;
3153 return abs($X - $spawnX) <= 1 && abs($Z - $spawnZ) <= 1;
3166 $spawn ??= $this->getSpawnLocation();
3171 $this->requestChunkPopulation($spawn->getFloorX() >> Chunk::COORD_BIT_SIZE, $spawn->getFloorZ() >> Chunk::COORD_BIT_SIZE,
null)->onCompletion(
3172 function() use ($spawn, $resolver) :
void{
3173 $spawn = $this->getSafeSpawn($spawn);
3174 $resolver->resolve($spawn);
3176 function() use ($resolver) : void{
3177 $resolver->reject();
3181 return $resolver->getPromise();
3191 if(!($spawn instanceof
Vector3) || $spawn->y <= $this->minY){
3192 $spawn = $this->getSpawnLocation();
3196 $v = $spawn->floor();
3197 $chunk = $this->getOrLoadChunkAtPosition($v);
3198 if($chunk ===
null){
3199 throw new WorldException(
"Cannot find a safe spawn point in non-generated terrain");
3203 $y = (int) min($max - 2, $v->y);
3204 $wasAir = $this->getBlockAt($x, $y - 1, $z)->getTypeId() === BlockTypeIds::AIR;
3205 for(; $y > $this->minY; --$y){
3206 if($this->getBlockAt($x, $y, $z)->isFullCube()){
3216 for(; $y >= $this->minY && $y < $max; ++$y){
3217 if(!$this->getBlockAt($x, $y + 1, $z)->isFullCube()){
3218 if(!$this->getBlockAt($x, $y, $z)->isFullCube()){
3219 return new Position($spawn->x, $y === (
int) $spawn->y ? $spawn->y : $y, $spawn->z, $this);
3226 return new Position($spawn->x, $y, $spawn->z, $this);
3240 return $this->time % self::TIME_FULL;
3248 return $this->displayName;
3257 $this->displayName = $name;
3258 $this->provider->getWorldData()->setName($name);
3265 return $this->folderName;
3272 $this->time = $time;
3280 $this->stopTime = true;
3288 $this->stopTime = false;
3296 return $this->provider->getWorldData()->getSeed();
3307 public function getDifficulty() : int{
3308 return $this->provider->getWorldData()->getDifficulty();
3311 public function setDifficulty(
int $difficulty) : void{
3312 if($difficulty < 0 || $difficulty > 3){
3313 throw new \InvalidArgumentException(
"Invalid difficulty level $difficulty");
3315 (
new WorldDifficultyChangeEvent($this, $this->getDifficulty(), $difficulty))->call();
3316 $this->provider->getWorldData()->setDifficulty($difficulty);
3318 foreach($this->players as $player){
3319 $player->getNetworkSession()->syncWorldDifficulty($this->getDifficulty());
3323 private function addChunkHashToPopulationRequestQueue(
int $chunkHash) : void{
3324 if(!isset($this->chunkPopulationRequestQueueIndex[$chunkHash])){
3325 $this->chunkPopulationRequestQueue->enqueue($chunkHash);
3326 $this->chunkPopulationRequestQueueIndex[$chunkHash] =
true;
3333 private function enqueuePopulationRequest(
int $chunkX,
int $chunkZ, ?ChunkLoader $associatedChunkLoader) : Promise{
3334 $chunkHash = World::chunkHash($chunkX, $chunkZ);
3335 $this->addChunkHashToPopulationRequestQueue($chunkHash);
3337 $resolver = $this->chunkPopulationRequestMap[$chunkHash] =
new PromiseResolver();
3338 if($associatedChunkLoader ===
null){
3339 $temporaryLoader =
new ChunkLoader();
3340 $this->registerChunkLoader($temporaryLoader, $chunkX, $chunkZ);
3341 $resolver->getPromise()->onCompletion(
3342 fn() => $this->unregisterChunkLoader($temporaryLoader, $chunkX, $chunkZ),
3343 static function() :
void{}
3346 return $resolver->getPromise();
3349 private function drainPopulationRequestQueue() : void{
3351 while(count($this->activeChunkPopulationTasks) < $this->maxConcurrentChunkPopulationTasks && !$this->chunkPopulationRequestQueue->isEmpty()){
3352 $nextChunkHash = $this->chunkPopulationRequestQueue->dequeue();
3353 unset($this->chunkPopulationRequestQueueIndex[$nextChunkHash]);
3354 World::getXZ($nextChunkHash, $nextChunkX, $nextChunkZ);
3355 if(isset($this->chunkPopulationRequestMap[$nextChunkHash])){
3356 assert(!($this->activeChunkPopulationTasks[$nextChunkHash] ??
false),
"Population for chunk $nextChunkX $nextChunkZ already running");
3358 !$this->orderChunkPopulation($nextChunkX, $nextChunkZ,
null)->isResolved() &&
3359 !isset($this->activeChunkPopulationTasks[$nextChunkHash])
3361 $failed[] = $nextChunkHash;
3368 foreach($failed as $hash){
3369 $this->addChunkHashToPopulationRequestQueue($hash);
3378 private function checkChunkPopulationPreconditions(
int $chunkX,
int $chunkZ) : array{
3379 $chunkHash = World::chunkHash($chunkX, $chunkZ);
3380 $resolver = $this->chunkPopulationRequestMap[$chunkHash] ??
null;
3381 if($resolver !==
null && isset($this->activeChunkPopulationTasks[$chunkHash])){
3383 return [$resolver,
false];
3386 $temporaryChunkLoader =
new ChunkLoader();
3387 $this->registerChunkLoader($temporaryChunkLoader, $chunkX, $chunkZ);
3388 $chunk = $this->loadChunk($chunkX, $chunkZ);
3389 $this->unregisterChunkLoader($temporaryChunkLoader, $chunkX, $chunkZ);
3390 if($chunk !==
null && $chunk->isPopulated()){
3392 $resolver ??=
new PromiseResolver();
3393 unset($this->chunkPopulationRequestMap[$chunkHash]);
3394 $resolver->resolve($chunk);
3395 return [$resolver,
false];
3397 return [$resolver,
true];
3412 [$resolver, $proceedWithPopulation] = $this->checkChunkPopulationPreconditions($chunkX, $chunkZ);
3413 if(!$proceedWithPopulation){
3414 return $resolver?->getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3417 if(count($this->activeChunkPopulationTasks) >= $this->maxConcurrentChunkPopulationTasks){
3419 return $resolver?->getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3421 return $this->internalOrderChunkPopulation($chunkX, $chunkZ, $associatedChunkLoader, $resolver);
3435 [$resolver, $proceedWithPopulation] = $this->checkChunkPopulationPreconditions($chunkX, $chunkZ);
3436 if(!$proceedWithPopulation){
3437 return $resolver?->getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3440 return $this->internalOrderChunkPopulation($chunkX, $chunkZ, $associatedChunkLoader, $resolver);
3447 private function internalOrderChunkPopulation(
int $chunkX,
int $chunkZ, ?ChunkLoader $associatedChunkLoader, ?
PromiseResolver $resolver) :
Promise{
3448 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
3450 $timings = $this->timings->chunkPopulationOrder;
3451 $timings->startTiming();
3454 for($xx = -1; $xx <= 1; ++$xx){
3455 for($zz = -1; $zz <= 1; ++$zz){
3456 if($this->isChunkLocked($chunkX + $xx, $chunkZ + $zz)){
3458 return $resolver?->
getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3463 $this->activeChunkPopulationTasks[$chunkHash] =
true;
3464 if($resolver ===
null){
3465 $resolver =
new PromiseResolver();
3466 $this->chunkPopulationRequestMap[$chunkHash] = $resolver;
3469 $chunkPopulationLockId =
new ChunkLockId();
3471 $temporaryChunkLoader =
new ChunkLoader();
3472 for($xx = -1; $xx <= 1; ++$xx){
3473 for($zz = -1; $zz <= 1; ++$zz){
3474 $this->lockChunk($chunkX + $xx, $chunkZ + $zz, $chunkPopulationLockId);
3475 $this->registerChunkLoader($temporaryChunkLoader, $chunkX + $xx, $chunkZ + $zz);
3479 $centerChunk = $this->loadChunk($chunkX, $chunkZ);
3480 $adjacentChunks = $this->getAdjacentChunks($chunkX, $chunkZ);
3482 $this->generatorExecutor->populate(
3487 function(Chunk $centerChunk, array $adjacentChunks) use ($chunkPopulationLockId, $chunkX, $chunkZ, $temporaryChunkLoader) :
void{
3488 if(!$this->isLoaded()){
3492 $this->generateChunkCallback($chunkPopulationLockId, $chunkX, $chunkZ, $centerChunk, $adjacentChunks, $temporaryChunkLoader);
3498 $timings->stopTiming();
3506 private function generateChunkCallback(ChunkLockId $chunkLockId,
int $x,
int $z, Chunk $chunk, array $adjacentChunks, ChunkLoader $temporaryChunkLoader) : void{
3507 $timings = $this->timings->chunkPopulationCompletion;
3508 $timings->startTiming();
3511 for($xx = -1; $xx <= 1; ++$xx){
3512 for($zz = -1; $zz <= 1; ++$zz){
3513 $this->unregisterChunkLoader($temporaryChunkLoader, $x + $xx, $z + $zz);
3514 if(!$this->unlockChunk($x + $xx, $z + $zz, $chunkLockId)){
3520 $index = World::chunkHash($x, $z);
3521 if(!isset($this->activeChunkPopulationTasks[$index])){
3522 throw new AssumptionFailedError(
"This should always be set, regardless of whether the task was orphaned or not");
3524 if(!$this->activeChunkPopulationTasks[$index]){
3525 $this->logger->debug(
"Discarding orphaned population result for chunk x=$x,z=$z");
3526 unset($this->activeChunkPopulationTasks[$index]);
3528 if($dirtyChunks === 0){
3529 $oldChunk = $this->loadChunk($x, $z);
3530 $this->setChunk($x, $z, $chunk);
3532 foreach($adjacentChunks as $relativeChunkHash => $adjacentChunk){
3533 World::getXZ($relativeChunkHash, $relativeX, $relativeZ);
3534 if($relativeX < -1 || $relativeX > 1 || $relativeZ < -1 || $relativeZ > 1){
3535 throw new AssumptionFailedError(
"Adjacent chunks should be in range -1 ... +1 coordinates");
3537 $this->setChunk($x + $relativeX, $z + $relativeZ, $adjacentChunk);
3540 if(($oldChunk ===
null || !$oldChunk->isPopulated()) && $chunk->isPopulated()){
3541 if(ChunkPopulateEvent::hasHandlers()){
3542 (
new ChunkPopulateEvent($this, $x, $z, $chunk))->call();
3545 foreach($this->getChunkListeners($x, $z) as $listener){
3546 $listener->onChunkPopulated($x, $z, $chunk);
3550 $this->logger->debug(
"Discarding population result for chunk x=$x,z=$z - terrain was modified on the main thread before async population completed");
3559 unset($this->activeChunkPopulationTasks[$index]);
3561 if($dirtyChunks === 0){
3562 $promise = $this->chunkPopulationRequestMap[$index] ??
null;
3563 if($promise !==
null){
3564 unset($this->chunkPopulationRequestMap[$index]);
3565 $promise->resolve($chunk);
3568 $this->logger->debug(
"Unable to resolve population promise for chunk x=$x,z=$z - populated chunk was forcibly unloaded while setting modified chunks");
3574 $this->addChunkHashToPopulationRequestQueue($index);
3577 $this->drainPopulationRequestQueue();
3579 $timings->stopTiming();
3582 public function doChunkGarbageCollection() : void{
3583 $this->timings->doChunkGC->startTiming();
3585 foreach($this->chunks as $index => $chunk){
3586 if(!isset($this->unloadQueue[$index])){
3587 World::getXZ($index, $X, $Z);
3588 if(!$this->isSpawnChunk($X, $Z)){
3589 $this->unloadChunkRequest($X, $Z,
true);
3592 $chunk->collectGarbage();
3595 $this->provider->doGarbageCollection();
3597 $this->timings->doChunkGC->stopTiming();
3600 public function unloadChunks(
bool $force =
false) : void{
3601 if(count($this->unloadQueue) > 0){
3603 $now = microtime(
true);
3604 foreach($this->unloadQueue as $index => $time){
3605 World::getXZ($index, $X, $Z);
3608 if($maxUnload <= 0){
3610 }elseif($time > ($now - 30)){
3616 if($this->unloadChunk($X, $Z,
true)){
3617 unset($this->unloadQueue[$index]);