152 private static int $worldIdCounter = 1;
154 public const Y_MAX = 320;
155 public const Y_MIN = -64;
157 public const TIME_DAY = 1000;
158 public const TIME_NOON = 6000;
159 public const TIME_SUNSET = 12000;
160 public const TIME_NIGHT = 13000;
161 public const TIME_MIDNIGHT = 18000;
162 public const TIME_SUNRISE = 23000;
164 public const TIME_FULL = 24000;
166 public const DIFFICULTY_PEACEFUL = 0;
167 public const DIFFICULTY_EASY = 1;
168 public const DIFFICULTY_NORMAL = 2;
169 public const DIFFICULTY_HARD = 3;
171 public const DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK = 3;
174 private const BLOCK_CACHE_SIZE_CAP = 2048;
180 private array $players = [];
186 private array $entities = [];
191 private array $entityLastKnownPositions = [];
197 private array $entitiesByChunk = [];
203 public array $updateEntities = [];
205 private bool $inDynamicStateRecalculation =
false;
210 private array $blockCache = [];
211 private int $blockCacheSize = 0;
216 private array $blockCollisionBoxCache = [];
218 private int $sendTimeTicker = 0;
220 private int $worldId;
222 private int $providerGarbageCollectionTicker = 0;
231 private array $registeredTickingChunks = [];
239 private array $validTickingChunks = [];
246 private array $recheckTickingChunks = [];
252 private array $chunkLoaders = [];
258 private array $chunkListeners = [];
263 private array $playerChunkListeners = [];
269 private array $packetBuffersByChunk = [];
275 private array $unloadQueue = [];
278 public bool $stopTime =
false;
280 private float $sunAnglePercentage = 0.0;
281 private int $skyLightReduction = 0;
283 private string $folderName;
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;
488 $this->folderName = $name;
489 $this->worldId = self::$worldIdCounter++;
491 $this->displayName = $this->provider->getWorldData()->getName();
492 $this->logger = new \PrefixedLogger($server->getLogger(),
"World: $this->displayName");
494 $this->blockStateRegistry = RuntimeBlockStateRegistry::getInstance();
495 $this->minY = $this->provider->getWorldMinY();
496 $this->maxY = $this->provider->getWorldMaxY();
498 $this->
server->getLogger()->info($this->
server->getLanguage()->translate(KnownTranslationFactory::pocketmine_level_preparing($this->displayName)));
499 $generator = GeneratorManager::getInstance()->getGenerator($this->provider->getWorldData()->getGenerator()) ??
500 throw new AssumptionFailedError(
"WorldManager should already have checked that the generator exists");
501 $generator->validateGeneratorOptions($this->provider->getWorldData()->getGeneratorOptions());
504 worldMinY: $this->minY,
505 worldMaxY: $this->maxY,
506 generatorSeed: $this->getSeed(),
507 generatorClass: $generator->getGeneratorClass(),
508 generatorSettings: $this->provider->getWorldData()->getGeneratorOptions()
510 $this->generatorExecutor = $generator->isFast() ?
515 $executorSetupParameters,
519 $this->chunkPopulationRequestQueue = new \SplQueue();
520 $this->addOnUnloadCallback(
function() :
void{
521 $this->logger->debug(
"Cancelling unfulfilled generation requests");
523 foreach($this->chunkPopulationRequestMap as $chunkHash => $promise){
525 unset($this->chunkPopulationRequestMap[$chunkHash]);
527 if(count($this->chunkPopulationRequestMap) !== 0){
535 $this->scheduledBlockUpdateQueue->setExtractFlags(\SplPriorityQueue::EXTR_BOTH);
537 $this->neighbourBlockUpdateQueue = new \SplQueue();
539 $this->time = $this->provider->getWorldData()->getTime();
541 $cfg = $this->
server->getConfigGroup();
542 $this->chunkTickRadius = min($this->
server->getViewDistance(), max(0, $cfg->getPropertyInt(YmlServerProperties::CHUNK_TICKING_TICK_RADIUS, 4)));
543 if($cfg->getPropertyInt(
"chunk-ticking.per-tick", 40) <= 0){
545 $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.");
546 $this->chunkTickRadius = 0;
548 $this->tickedBlocksPerSubchunkPerTick = $cfg->getPropertyInt(YmlServerProperties::CHUNK_TICKING_BLOCKS_PER_SUBCHUNK_PER_TICK, self::DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK);
549 $this->maxConcurrentChunkPopulationTasks = $cfg->getPropertyInt(YmlServerProperties::CHUNK_GENERATION_POPULATION_QUEUE_SIZE, 2);
551 $this->initRandomTickBlocksFromConfig($cfg);
557 $dontTickBlocks = [];
558 $parser = StringToItemParser::getInstance();
559 foreach($cfg->getProperty(YmlServerProperties::CHUNK_TICKING_DISABLE_BLOCK_TICKING, []) as $name){
560 $name = (string) $name;
561 $item = $parser->parse($name);
563 $block = $item->getBlock();
564 }elseif(preg_match(
"/^-?\d+$/", $name) === 1){
567 $blockStateData = GlobalBlockStateHandlers::getUpgrader()->upgradeIntIdMeta((
int) $name, 0);
568 }
catch(BlockStateDeserializeException){
571 $block = $this->blockStateRegistry->fromStateId(GlobalBlockStateHandlers::getDeserializer()->deserialize($blockStateData));
577 if($block->getTypeId() !== BlockTypeIds::AIR){
578 $dontTickBlocks[$block->getTypeId()] = $name;
582 foreach($this->blockStateRegistry->getAllKnownStates() as $state){
583 $dontTickName = $dontTickBlocks[$state->getTypeId()] ??
null;
584 if($dontTickName ===
null && $state->ticksRandomly()){
585 $this->randomTickBlocks[$state->getStateId()] =
true;
590 public function getTickRateTime() : float{
591 return $this->tickRateTime;
594 public function getServer() : Server{
598 public function getLogger() : \
Logger{
599 return $this->logger;
602 final public function getProvider() : WritableWorldProvider{
603 return $this->provider;
609 final public function getId() : int{
610 return $this->worldId;
613 public function isLoaded() : bool{
614 return !$this->unloaded;
620 public function onUnload() : void{
622 throw new \LogicException(
"Tried to close a world which is already closed");
625 foreach($this->unloadCallbacks as $callback){
628 $this->unloadCallbacks = [];
630 foreach($this->chunks as $chunkHash => $chunk){
631 self::getXZ($chunkHash, $chunkX, $chunkZ);
632 $this->unloadChunk($chunkX, $chunkZ,
false);
634 $this->knownUngeneratedChunks = [];
635 foreach($this->entitiesByChunk as $chunkHash => $entities){
636 self::getXZ($chunkHash, $chunkX, $chunkZ);
639 foreach($entities as $entity){
640 if(!$entity->isFlaggedForDespawn()){
645 if($leakedEntities !== 0){
646 $this->logger->warning(
"$leakedEntities leaked entities found in ungenerated chunk $chunkX $chunkZ during unload, they won't be saved!");
652 $this->generatorExecutor->shutdown();
654 $this->provider->close();
655 $this->blockCache = [];
656 $this->blockCacheSize = 0;
657 $this->blockCollisionBoxCache = [];
659 $this->unloaded =
true;
664 $this->unloadCallbacks[spl_object_id($callback)] = $callback;
669 unset($this->unloadCallbacks[spl_object_id($callback)]);
680 private function filterViewersForPosition(
Vector3 $pos, array $allowed) : array{
681 $candidates = $this->getViewersForPosition($pos);
683 foreach($allowed as $player){
684 $k = spl_object_id($player);
685 if(isset($candidates[$k])){
686 $filtered[$k] = $candidates[$k];
697 $players ??= $this->getViewersForPosition($pos);
699 if(WorldSoundEvent::hasHandlers()){
702 if($ev->isCancelled()){
706 $sound = $ev->getSound();
707 $players = $ev->getRecipients();
710 $pk = $sound->
encode($pos);
712 if($players === $this->getViewersForPosition($pos)){
714 $this->broadcastPacketToViewers($pos, $e);
717 NetworkBroadcastUtils::broadcastPackets($this->filterViewersForPosition($pos, $players), $pk);
726 $players ??= $this->getViewersForPosition($pos);
728 if(WorldParticleEvent::hasHandlers()){
731 if($ev->isCancelled()){
735 $particle = $ev->getParticle();
736 $players = $ev->getRecipients();
739 $pk = $particle->
encode($pos);
741 if($players === $this->getViewersForPosition($pos)){
743 $this->broadcastPacketToViewers($pos, $e);
746 NetworkBroadcastUtils::broadcastPackets($this->filterViewersForPosition($pos, $players), $pk);
751 public function getAutoSave() : bool{
752 return $this->autoSave;
755 public function setAutoSave(
bool $value) : void{
756 $this->autoSave = $value;
769 return $this->playerChunkListeners[
World::chunkHash($chunkX, $chunkZ)] ?? [];
779 return $this->chunkLoaders[
World::chunkHash($chunkX, $chunkZ)] ?? [];
789 return $this->getChunkPlayers($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE);
796 $this->broadcastPacketToPlayersUsingChunk($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE, $packet);
799 private function broadcastPacketToPlayersUsingChunk(
int $chunkX,
int $chunkZ,
ClientboundPacket $packet) : void{
800 if(!isset($this->packetBuffersByChunk[$index =
World::chunkHash($chunkX, $chunkZ)])){
801 $this->packetBuffersByChunk[$index] = [$packet];
803 $this->packetBuffersByChunk[$index][] = $packet;
807 public function registerChunkLoader(ChunkLoader $loader,
int $chunkX,
int $chunkZ,
bool $autoLoad =
true) : void{
808 $loaderId = spl_object_id($loader);
810 if(!isset($this->chunkLoaders[$chunkHash = World::chunkHash($chunkX, $chunkZ)])){
811 $this->chunkLoaders[$chunkHash] = [];
812 }elseif(isset($this->chunkLoaders[$chunkHash][$loaderId])){
816 $this->chunkLoaders[$chunkHash][$loaderId] = $loader;
818 $this->cancelUnloadChunkRequest($chunkX, $chunkZ);
821 $this->loadChunk($chunkX, $chunkZ);
825 public function unregisterChunkLoader(ChunkLoader $loader,
int $chunkX,
int $chunkZ) : void{
826 $chunkHash = World::chunkHash($chunkX, $chunkZ);
827 $loaderId = spl_object_id($loader);
828 if(isset($this->chunkLoaders[$chunkHash][$loaderId])){
829 if(count($this->chunkLoaders[$chunkHash]) === 1){
830 unset($this->chunkLoaders[$chunkHash]);
831 $this->unloadChunkRequest($chunkX, $chunkZ,
true);
832 if(isset($this->chunkPopulationRequestMap[$chunkHash]) && !isset($this->activeChunkPopulationTasks[$chunkHash])){
833 $this->chunkPopulationRequestMap[$chunkHash]->reject();
834 unset($this->chunkPopulationRequestMap[$chunkHash]);
837 unset($this->chunkLoaders[$chunkHash][$loaderId]);
846 $hash =
World::chunkHash($chunkX, $chunkZ);
847 if(isset($this->chunkListeners[$hash])){
848 $this->chunkListeners[$hash][spl_object_id($listener)] = $listener;
850 $this->chunkListeners[$hash] = [spl_object_id($listener) => $listener];
852 if($listener instanceof
Player){
853 $this->playerChunkListeners[$hash][spl_object_id($listener)] = $listener;
863 $hash =
World::chunkHash($chunkX, $chunkZ);
864 if(isset($this->chunkListeners[$hash])){
865 if(count($this->chunkListeners[$hash]) === 1){
866 unset($this->chunkListeners[$hash]);
867 unset($this->playerChunkListeners[$hash]);
869 unset($this->chunkListeners[$hash][spl_object_id($listener)]);
870 unset($this->playerChunkListeners[$hash][spl_object_id($listener)]);
879 foreach($this->chunkListeners as $hash => $listeners){
880 World::getXZ($hash, $chunkX, $chunkZ);
881 $this->unregisterChunkListener($listener, $chunkX, $chunkZ);
892 return $this->chunkListeners[
World::chunkHash($chunkX, $chunkZ)] ?? [];
898 public function sendTime(
Player ...$targets) : void{
899 if(count($targets) === 0){
900 $targets = $this->players;
902 foreach($targets as $player){
903 $player->getNetworkSession()->syncWorldTime($this->time);
907 public function isDoingTick() : bool{
908 return $this->doingTick;
914 public function doTick(
int $currentTick) : void{
916 throw new \LogicException(
"Attempted to tick a world which has been closed");
919 $this->timings->doTick->startTiming();
920 $this->doingTick =
true;
922 $this->actuallyDoTick($currentTick);
924 $this->doingTick =
false;
925 $this->timings->doTick->stopTiming();
929 protected function actuallyDoTick(
int $currentTick) : void{
930 if(!$this->stopTime){
932 if($this->time === PHP_INT_MAX){
933 $this->time = PHP_INT_MIN;
939 $this->sunAnglePercentage = $this->computeSunAnglePercentage();
940 $this->skyLightReduction = $this->computeSkyLightReduction();
942 if(++$this->sendTimeTicker === 200){
944 $this->sendTimeTicker = 0;
947 $this->unloadChunks();
948 if(++$this->providerGarbageCollectionTicker >= 6000){
949 $this->provider->doGarbageCollection();
950 $this->providerGarbageCollectionTicker = 0;
953 $this->timings->scheduledBlockUpdates->startTiming();
955 while($this->scheduledBlockUpdateQueue->count() > 0 && $this->scheduledBlockUpdateQueue->current()[
"priority"] <= $currentTick){
957 $vec = $this->scheduledBlockUpdateQueue->extract()[
"data"];
958 unset($this->scheduledBlockUpdateQueueIndex[World::blockHash($vec->x, $vec->y, $vec->z)]);
959 if(!$this->isInLoadedTerrain($vec)){
962 $block = $this->getBlock($vec);
963 $block->onScheduledUpdate();
965 $this->timings->scheduledBlockUpdates->stopTiming();
967 $this->timings->neighbourBlockUpdates->startTiming();
969 while($this->neighbourBlockUpdateQueue->count() > 0){
970 $index = $this->neighbourBlockUpdateQueue->dequeue();
971 unset($this->neighbourBlockUpdateQueueIndex[$index]);
972 World::getBlockXYZ($index, $x, $y, $z);
973 if(!$this->isChunkLoaded($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)){
977 $block = $this->getBlockAt($x, $y, $z);
979 if(BlockUpdateEvent::hasHandlers()){
980 $ev =
new BlockUpdateEvent($block);
982 if($ev->isCancelled()){
986 foreach($this->getNearbyEntities(AxisAlignedBB::one()->offset($x, $y, $z)) as $entity){
987 $entity->onNearbyBlockChange();
989 $block->onNearbyBlockChange();
992 $this->timings->neighbourBlockUpdates->stopTiming();
994 $this->timings->entityTick->startTiming();
996 foreach($this->updateEntities as $id => $entity){
997 if($entity->isClosed() || $entity->isFlaggedForDespawn() || !$entity->onUpdate($currentTick)){
998 unset($this->updateEntities[$id]);
1000 if($entity->isFlaggedForDespawn()){
1004 $this->timings->entityTick->stopTiming();
1006 $this->timings->randomChunkUpdates->startTiming();
1007 $this->tickChunks();
1008 $this->timings->randomChunkUpdates->stopTiming();
1010 $this->executeQueuedLightUpdates();
1012 if(count($this->changedBlocks) > 0){
1013 if(count($this->players) > 0){
1014 foreach($this->changedBlocks as $index => $blocks){
1015 if(count($blocks) === 0){
1018 World::getXZ($index, $chunkX, $chunkZ);
1019 if(!$this->isChunkLoaded($chunkX, $chunkZ)){
1023 if(count($blocks) > 512){
1024 $chunk = $this->getChunk($chunkX, $chunkZ) ??
throw new AssumptionFailedError(
"We already checked that the chunk is loaded");
1025 foreach($this->getChunkPlayers($chunkX, $chunkZ) as $p){
1026 $p->onChunkChanged($chunkX, $chunkZ, $chunk);
1029 foreach($this->createBlockUpdatePackets($blocks) as $packet){
1030 $this->broadcastPacketToPlayersUsingChunk($chunkX, $chunkZ, $packet);
1036 $this->changedBlocks = [];
1040 if($this->sleepTicks > 0 && --$this->sleepTicks <= 0){
1041 $this->checkSleep();
1044 foreach($this->packetBuffersByChunk as $index => $entries){
1045 World::getXZ($index, $chunkX, $chunkZ);
1046 $chunkPlayers = $this->getChunkPlayers($chunkX, $chunkZ);
1047 if(count($chunkPlayers) > 0){
1048 NetworkBroadcastUtils::broadcastPackets($chunkPlayers, $entries);
1052 $this->packetBuffersByChunk = [];
1055 public function checkSleep() : void{
1056 if(count($this->players) === 0){
1061 foreach($this->getPlayers() as $p){
1062 if(!$p->isSleeping()){
1069 $time = $this->getTimeOfDay();
1071 if($time >= World::TIME_NIGHT && $time < World::TIME_SUNRISE){
1072 $this->setTime($this->getTime() + World::TIME_FULL - $time);
1074 foreach($this->getPlayers() as $p){
1081 public function setSleepTicks(
int $ticks) : void{
1082 $this->sleepTicks = $ticks;
1094 $blockTranslator = TypeConverter::getInstance()->getBlockTranslator();
1096 foreach($blocks as $b){
1098 throw new \TypeError(
"Expected Vector3 in blocks array, got " . (is_object($b) ? get_class($b) : gettype($b)));
1101 $fullBlock = $this->getBlockAt($b->x, $b->y, $b->z);
1102 $blockPosition = BlockPosition::fromVector3($b);
1104 $tile = $this->getTileAt($b->x, $b->y, $b->z);
1106 $expectedClass = $fullBlock->getIdInfo()->getTileClass();
1107 if($expectedClass !==
null && $tile instanceof $expectedClass && count($fakeStateProperties = $tile->getRenderUpdateBugWorkaroundStateProperties($fullBlock)) > 0){
1108 $originalStateData = $blockTranslator->internalIdToNetworkStateData($fullBlock->getStateId());
1110 $originalStateData->getName(),
1111 array_merge($originalStateData->getStates(), $fakeStateProperties),
1112 $originalStateData->getVersion()
1114 $packets[] = UpdateBlockPacket::create(
1116 $blockTranslator->getBlockStateDictionary()->lookupStateIdFromData($fakeStateData) ??
throw new AssumptionFailedError(
"Unmapped fake blockstate data: " . $fakeStateData->toNbt()),
1117 UpdateBlockPacket::FLAG_NETWORK,
1118 UpdateBlockPacket::DATA_LAYER_NORMAL
1122 $packets[] = UpdateBlockPacket::create(
1124 $blockTranslator->internalIdToNetworkId($fullBlock->getStateId()),
1125 UpdateBlockPacket::FLAG_NETWORK,
1126 UpdateBlockPacket::DATA_LAYER_NORMAL
1130 $packets[] = BlockActorDataPacket::create($blockPosition, $tile->getSerializedSpawnCompound());
1137 public function clearCache(
bool $force =
false) : void{
1139 $this->blockCache = [];
1140 $this->blockCacheSize = 0;
1141 $this->blockCollisionBoxCache = [];
1144 $this->blockCacheSize = 0;
1145 foreach($this->blockCache as $list){
1146 $this->blockCacheSize += count($list);
1147 if($this->blockCacheSize > self::BLOCK_CACHE_SIZE_CAP){
1148 $this->blockCache = [];
1149 $this->blockCacheSize = 0;
1155 foreach($this->blockCollisionBoxCache as $list){
1156 $count += count($list);
1157 if($count > self::BLOCK_CACHE_SIZE_CAP){
1159 $this->blockCollisionBoxCache = [];
1166 private function trimBlockCache() : void{
1167 $before = $this->blockCacheSize;
1170 foreach($this->blockCache as $chunkHash => $blocks){
1171 unset($this->blockCache[$chunkHash]);
1172 $this->blockCacheSize -= count($blocks);
1173 if($this->blockCacheSize < self::BLOCK_CACHE_SIZE_CAP){
1184 return $this->randomTickBlocks;
1187 public function addRandomTickedBlock(
Block $block) : void{
1189 throw new \InvalidArgumentException(
"Cannot do random-tick on unknown block");
1191 $this->randomTickBlocks[$block->getStateId()] =
true;
1194 public function removeRandomTickedBlock(Block $block) : void{
1195 unset($this->randomTickBlocks[$block->getStateId()]);
1203 return $this->chunkTickRadius;
1211 $this->chunkTickRadius = $radius;
1222 return array_keys($this->validTickingChunks);
1230 $chunkPosHash =
World::chunkHash($chunkX, $chunkZ);
1231 $this->registeredTickingChunks[$chunkPosHash][spl_object_id($ticker)] = $ticker;
1232 $this->recheckTickingChunks[$chunkPosHash] = $chunkPosHash;
1240 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
1241 $tickerId = spl_object_id($ticker);
1242 if(isset($this->registeredTickingChunks[$chunkHash][$tickerId])){
1243 if(count($this->registeredTickingChunks[$chunkHash]) === 1){
1245 $this->registeredTickingChunks[$chunkHash],
1246 $this->recheckTickingChunks[$chunkHash],
1247 $this->validTickingChunks[$chunkHash]
1250 unset($this->registeredTickingChunks[$chunkHash][$tickerId]);
1255 private function tickChunks() : void{
1256 if($this->chunkTickRadius <= 0 || count($this->registeredTickingChunks) === 0){
1260 if(count($this->recheckTickingChunks) > 0){
1261 $this->timings->randomChunkUpdatesChunkSelection->startTiming();
1263 $chunkTickableCache = [];
1265 foreach($this->recheckTickingChunks as $hash => $_){
1266 World::getXZ($hash, $chunkX, $chunkZ);
1267 if($this->isChunkTickable($chunkX, $chunkZ, $chunkTickableCache)){
1268 $this->validTickingChunks[$hash] = $hash;
1271 $this->recheckTickingChunks = [];
1273 $this->timings->randomChunkUpdatesChunkSelection->stopTiming();
1276 foreach($this->validTickingChunks as $index => $_){
1277 World::getXZ($index, $chunkX, $chunkZ);
1279 $this->tickChunk($chunkX, $chunkZ);
1289 private function isChunkTickable(
int $chunkX,
int $chunkZ, array &$cache) : bool{
1290 for($cx = -1; $cx <= 1; ++$cx){
1291 for($cz = -1; $cz <= 1; ++$cz){
1292 $chunkHash = World::chunkHash($chunkX + $cx, $chunkZ + $cz);
1293 if(isset($cache[$chunkHash])){
1294 if(!$cache[$chunkHash]){
1299 if($this->isChunkLocked($chunkX + $cx, $chunkZ + $cz)){
1300 $cache[$chunkHash] =
false;
1303 $adjacentChunk = $this->getChunk($chunkX + $cx, $chunkZ + $cz);
1304 if($adjacentChunk ===
null || !$adjacentChunk->isPopulated()){
1305 $cache[$chunkHash] =
false;
1308 $lightPopulatedState = $adjacentChunk->isLightPopulated();
1309 if($lightPopulatedState !==
true){
1310 if($lightPopulatedState ===
false){
1311 $this->orderLightPopulation($chunkX + $cx, $chunkZ + $cz);
1313 $cache[$chunkHash] =
false;
1317 $cache[$chunkHash] =
true;
1333 private function markTickingChunkForRecheck(
int $chunkX,
int $chunkZ) : void{
1334 for($cx = -1; $cx <= 1; ++$cx){
1335 for($cz = -1; $cz <= 1; ++$cz){
1336 $chunkHash = World::chunkHash($chunkX + $cx, $chunkZ + $cz);
1337 unset($this->validTickingChunks[$chunkHash]);
1338 if(isset($this->registeredTickingChunks[$chunkHash])){
1339 $this->recheckTickingChunks[$chunkHash] = $chunkHash;
1341 unset($this->recheckTickingChunks[$chunkHash]);
1347 private function orderLightPopulation(
int $chunkX,
int $chunkZ) : void{
1348 $chunkHash = World::chunkHash($chunkX, $chunkZ);
1349 $lightPopulatedState = $this->chunks[$chunkHash]->isLightPopulated();
1350 if($lightPopulatedState ===
false){
1351 $this->chunks[$chunkHash]->setLightPopulated(
null);
1352 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
1354 $this->workerPool->submitTask(
new LightPopulationTask(
1355 $this->chunks[$chunkHash],
1356 function(array $blockLight, array $skyLight, array $heightMap) use ($chunkX, $chunkZ) :
void{
1363 if($this->unloaded || ($chunk = $this->getChunk($chunkX, $chunkZ)) ===
null || $chunk->isLightPopulated() ===
true){
1368 $chunk->setHeightMapArray($heightMap);
1369 foreach($blockLight as $y => $lightArray){
1370 $chunk->getSubChunk($y)->setBlockLightArray($lightArray);
1372 foreach($skyLight as $y => $lightArray){
1373 $chunk->getSubChunk($y)->setBlockSkyLightArray($lightArray);
1375 $chunk->setLightPopulated(
true);
1376 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
1382 private function tickChunk(
int $chunkX,
int $chunkZ) : void{
1383 $chunk = $this->getChunk($chunkX, $chunkZ);
1384 if($chunk ===
null){
1388 foreach($this->getChunkEntities($chunkX, $chunkZ) as $entity){
1389 $entity->onRandomUpdate();
1392 $blockFactory = $this->blockStateRegistry;
1393 foreach($chunk->getSubChunks() as $Y => $subChunk){
1394 if(!$subChunk->isEmptyFast()){
1396 for($i = 0; $i < $this->tickedBlocksPerSubchunkPerTick; ++$i){
1399 $k = mt_rand(0, (1 << 60) - 1);
1401 $x = $k & SubChunk::COORD_MASK;
1402 $y = ($k >> SubChunk::COORD_BIT_SIZE) & SubChunk::COORD_MASK;
1403 $z = ($k >> (SubChunk::COORD_BIT_SIZE * 2)) & SubChunk::COORD_MASK;
1404 $k >>= (SubChunk::COORD_BIT_SIZE * 3);
1406 $state = $subChunk->getBlockStateId($x, $y, $z);
1408 if(isset($this->randomTickBlocks[$state])){
1409 $block = $blockFactory->fromStateId($state);
1410 $block->position($this, $chunkX * Chunk::EDGE_LENGTH + $x, ($Y << SubChunk::COORD_BIT_SIZE) + $y, $chunkZ * Chunk::EDGE_LENGTH + $z);
1411 $block->onRandomTick();
1425 public function save(
bool $force =
false) : bool{
1427 if(!$this->getAutoSave() && !$force){
1431 (
new WorldSaveEvent($this))->call();
1433 $timings = $this->timings->syncDataSave;
1434 $timings->startTiming();
1436 $this->provider->getWorldData()->setTime($this->time);
1437 $this->saveChunks();
1438 $this->provider->getWorldData()->save();
1440 $timings->stopTiming();
1445 public function saveChunks() : void{
1446 $this->timings->syncChunkSave->startTiming();
1448 foreach($this->chunks as $chunkHash => $chunk){
1449 self::getXZ($chunkHash, $chunkX, $chunkZ);
1450 $this->provider->saveChunk($chunkX, $chunkZ,
new ChunkData(
1451 $chunk->getSubChunks(),
1452 $chunk->isPopulated(),
1453 array_map(fn(Entity $e) => $e->saveNBT(), array_values(array_filter($this->getChunkEntities($chunkX, $chunkZ), fn(Entity $e) => $e->canSaveWithChunk()))),
1454 array_map(fn(Tile $t) => $t->saveNBT(), array_values($chunk->getTiles())),
1455 ), $chunk->getTerrainDirtyFlags());
1456 $chunk->clearTerrainDirtyFlags();
1459 $this->timings->syncChunkSave->stopTiming();
1469 !$this->isInWorld($pos->x, $pos->y, $pos->z) ||
1470 (isset($this->scheduledBlockUpdateQueueIndex[$index =
World::blockHash($pos->x, $pos->y, $pos->z)]) && $this->scheduledBlockUpdateQueueIndex[$index] <= $delay)
1474 $this->scheduledBlockUpdateQueueIndex[$index] = $delay;
1475 $this->scheduledBlockUpdateQueue->insert(
new Vector3((
int) $pos->x, (
int) $pos->y, (
int) $pos->z), $delay + $this->server->getTick());
1478 private function tryAddToNeighbourUpdateQueue(
int $x,
int $y,
int $z) : void{
1479 if($this->isInWorld($x, $y, $z)){
1480 $hash = World::blockHash($x, $y, $z);
1481 if(!isset($this->neighbourBlockUpdateQueueIndex[$hash])){
1482 $this->neighbourBlockUpdateQueue->enqueue($hash);
1483 $this->neighbourBlockUpdateQueueIndex[$hash] =
true;
1494 private function internalNotifyNeighbourBlockUpdate(
int $x,
int $y,
int $z) : void{
1495 $this->tryAddToNeighbourUpdateQueue($x, $y, $z);
1496 foreach(Facing::OFFSET as [$dx, $dy, $dz]){
1497 $this->tryAddToNeighbourUpdateQueue($x + $dx, $y + $dy, $z + $dz);
1509 $this->internalNotifyNeighbourBlockUpdate($pos->getFloorX(), $pos->getFloorY(), $pos->getFloorZ());
1517 $minX = (int) floor($bb->minX - 1);
1518 $minY = (int) floor($bb->minY - 1);
1519 $minZ = (int) floor($bb->minZ - 1);
1520 $maxX = (int) floor($bb->maxX + 1);
1521 $maxY = (int) floor($bb->maxY + 1);
1522 $maxZ = (int) floor($bb->maxZ + 1);
1526 $collisionInfo = $this->blockStateRegistry->collisionInfo;
1528 for($z = $minZ; $z <= $maxZ; ++$z){
1529 $zOverflow = $z === $minZ || $z === $maxZ;
1530 for($x = $minX; $x <= $maxX; ++$x){
1531 $zxOverflow = $zOverflow || $x === $minX || $x === $maxX;
1532 for($y = $minY; $y <= $maxY; ++$y){
1533 $overflow = $zxOverflow || $y === $minY || $y === $maxY;
1535 $stateCollisionInfo = $this->getBlockCollisionInfo($x, $y, $z, $collisionInfo);
1537 $stateCollisionInfo === RuntimeBlockStateRegistry::COLLISION_MAY_OVERFLOW && $this->getBlockAt($x, $y, $z)->collidesWithBB($bb) :
1538 match ($stateCollisionInfo) {
1539 RuntimeBlockStateRegistry::COLLISION_CUBE =>
true,
1540 RuntimeBlockStateRegistry::COLLISION_NONE =>
false,
1541 default => $this->getBlockAt($x, $y, $z)->collidesWithBB($bb)
1544 return [$this->getBlockAt($x, $y, $z)];
1551 for($z = $minZ; $z <= $maxZ; ++$z){
1552 $zOverflow = $z === $minZ || $z === $maxZ;
1553 for($x = $minX; $x <= $maxX; ++$x){
1554 $zxOverflow = $zOverflow || $x === $minX || $x === $maxX;
1555 for($y = $minY; $y <= $maxY; ++$y){
1556 $overflow = $zxOverflow || $y === $minY || $y === $maxY;
1558 $stateCollisionInfo = $this->getBlockCollisionInfo($x, $y, $z, $collisionInfo);
1560 $stateCollisionInfo === RuntimeBlockStateRegistry::COLLISION_MAY_OVERFLOW && $this->getBlockAt($x, $y, $z)->collidesWithBB($bb) :
1561 match ($stateCollisionInfo) {
1562 RuntimeBlockStateRegistry::COLLISION_CUBE =>
true,
1563 RuntimeBlockStateRegistry::COLLISION_NONE =>
false,
1564 default => $this->getBlockAt($x, $y, $z)->collidesWithBB($bb)
1567 $collides[] = $this->getBlockAt($x, $y, $z);
1581 private function getBlockCollisionInfo(
int $x,
int $y,
int $z, array $collisionInfo) : int{
1582 if(!$this->isInWorld($x, $y, $z)){
1583 return RuntimeBlockStateRegistry::COLLISION_NONE;
1585 $chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE);
1586 if($chunk ===
null){
1587 return RuntimeBlockStateRegistry::COLLISION_NONE;
1590 ->getSubChunk($y >> SubChunk::COORD_BIT_SIZE)
1592 $x & SubChunk::COORD_MASK,
1593 $y & SubChunk::COORD_MASK,
1594 $z & SubChunk::COORD_MASK
1596 return $collisionInfo[$stateId];
1610 private function getBlockCollisionBoxesForCell(
int $x,
int $y,
int $z, array $collisionInfo) : array{
1611 $stateCollisionInfo = $this->getBlockCollisionInfo($x, $y, $z, $collisionInfo);
1612 $boxes = match($stateCollisionInfo){
1613 RuntimeBlockStateRegistry::COLLISION_NONE => [],
1614 RuntimeBlockStateRegistry::COLLISION_CUBE => [AxisAlignedBB::one()->offset($x, $y, $z)],
1615 default => $this->getBlockAt($x, $y, $z)->getCollisionBoxes()
1619 if($stateCollisionInfo !== RuntimeBlockStateRegistry::COLLISION_CUBE){
1621 foreach(Facing::OFFSET as [$dx, $dy, $dz]){
1622 $offsetX = $x + $dx;
1623 $offsetY = $y + $dy;
1624 $offsetZ = $z + $dz;
1625 $stateCollisionInfo = $this->getBlockCollisionInfo($offsetX, $offsetY, $offsetZ, $collisionInfo);
1626 if($stateCollisionInfo === RuntimeBlockStateRegistry::COLLISION_MAY_OVERFLOW){
1628 $cellBB ??= AxisAlignedBB::one()->offset($x, $y, $z);
1629 $extraBoxes = $this->getBlockAt($offsetX, $offsetY, $offsetZ)->getCollisionBoxes();
1630 foreach($extraBoxes as $extraBox){
1631 if($extraBox->intersectsWith($cellBB)){
1632 $boxes[] = $extraBox;
1647 $minX = (int) floor($bb->minX);
1648 $minY = (int) floor($bb->minY);
1649 $minZ = (int) floor($bb->minZ);
1650 $maxX = (int) floor($bb->maxX);
1651 $maxY = (int) floor($bb->maxY);
1652 $maxZ = (int) floor($bb->maxZ);
1656 $collisionInfo = $this->blockStateRegistry->collisionInfo;
1658 for($z = $minZ; $z <= $maxZ; ++$z){
1659 for($x = $minX; $x <= $maxX; ++$x){
1660 $chunkPosHash = World::chunkHash($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE);
1661 for($y = $minY; $y <= $maxY; ++$y){
1662 $relativeBlockHash = World::chunkBlockHash($x, $y, $z);
1664 $boxes = $this->blockCollisionBoxCache[$chunkPosHash][$relativeBlockHash] ??= $this->getBlockCollisionBoxesForCell($x, $y, $z, $collisionInfo);
1666 foreach($boxes as $blockBB){
1667 if($blockBB->intersectsWith($bb)){
1668 $collides[] = $blockBB;
1686 $collides = $this->getBlockCollisionBoxes($bb);
1689 foreach($this->getCollidingEntities($bb->
expandedCopy(0.25, 0.25, 0.25), $entity) as $ent){
1690 $collides[] = clone $ent->boundingBox;
1702 $timeProgress = ($this->time % self::TIME_FULL) / self::TIME_FULL;
1705 $sunProgress = $timeProgress + ($timeProgress < 0.25 ? 0.75 : -0.25);
1709 $diff = (((1 - ((cos($sunProgress * M_PI) + 1) / 2)) - $sunProgress) / 3);
1711 return $sunProgress + $diff;
1718 return $this->sunAnglePercentage;
1725 return $this->sunAnglePercentage * 2 * M_PI;
1732 return $this->sunAnglePercentage * 360.0;
1740 $percentage = max(0, min(1, -(cos($this->getSunAngleRadians()) * 2 - 0.5)));
1744 return (
int) ($percentage * 11);
1751 return $this->skyLightReduction;
1759 $floorX = $pos->getFloorX();
1760 $floorY = $pos->getFloorY();
1761 $floorZ = $pos->getFloorZ();
1762 return $this->getFullLightAt($floorX, $floorY, $floorZ);
1770 $skyLight = $this->getRealBlockSkyLightAt($x, $y, $z);
1772 return max($skyLight, $this->getBlockLightAt($x, $y, $z));
1783 return $this->getHighestAdjacentLight($x, $y, $z, $this->getFullLightAt(...));
1791 $floorX = $pos->getFloorX();
1792 $floorY = $pos->getFloorY();
1793 $floorZ = $pos->getFloorZ();
1794 return $this->getPotentialLightAt($floorX, $floorY, $floorZ);
1802 return max($this->getPotentialBlockSkyLightAt($x, $y, $z), $this->getBlockLightAt($x, $y, $z));
1810 return $this->getHighestAdjacentLight($x, $y, $z, $this->getPotentialLightAt(...));
1820 if(!$this->isInWorld($x, $y, $z)){
1821 return $y >= self::Y_MAX ? 15 : 0;
1823 if(($chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)) !==
null && $chunk->isLightPopulated() ===
true){
1824 return $chunk->getSubChunk($y >> Chunk::COORD_BIT_SIZE)->getBlockSkyLightArray()->get($x & SubChunk::COORD_MASK, $y & SubChunk::COORD_MASK, $z & SubChunk::COORD_MASK);
1835 $light = $this->getPotentialBlockSkyLightAt($x, $y, $z) - $this->skyLightReduction;
1836 return $light < 0 ? 0 : $light;
1845 if(!$this->isInWorld($x, $y, $z)){
1848 if(($chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)) !==
null && $chunk->isLightPopulated() ===
true){
1849 return $chunk->getSubChunk($y >> Chunk::COORD_BIT_SIZE)->getBlockLightArray()->get($x & SubChunk::COORD_MASK, $y & SubChunk::COORD_MASK, $z & SubChunk::COORD_MASK);
1854 public function updateAllLight(
int $x,
int $y,
int $z) : void{
1855 if(($chunk = $this->getChunk($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE)) === null || $chunk->isLightPopulated() !== true){
1859 $blockFactory = $this->blockStateRegistry;
1860 $this->timings->doBlockSkyLightUpdates->startTiming();
1861 if($this->skyLightUpdate ===
null){
1862 $this->skyLightUpdate =
new SkyLightUpdate(
new SubChunkExplorer($this), $blockFactory->lightFilter, $blockFactory->blocksDirectSkyLight);
1864 $this->skyLightUpdate->recalculateNode($x, $y, $z);
1865 $this->timings->doBlockSkyLightUpdates->stopTiming();
1867 $this->timings->doBlockLightUpdates->startTiming();
1868 if($this->blockLightUpdate ===
null){
1869 $this->blockLightUpdate =
new BlockLightUpdate(
new SubChunkExplorer($this), $blockFactory->lightFilter, $blockFactory->light);
1871 $this->blockLightUpdate->recalculateNode($x, $y, $z);
1872 $this->timings->doBlockLightUpdates->stopTiming();
1878 private function getHighestAdjacentLight(
int $x,
int $y,
int $z, \Closure $lightGetter) : int{
1880 foreach(Facing::OFFSET as [$offsetX, $offsetY, $offsetZ]){
1881 $x1 = $x + $offsetX;
1882 $y1 = $y + $offsetY;
1883 $z1 = $z + $offsetZ;
1885 !$this->isInWorld($x1, $y1, $z1) ||
1886 ($chunk = $this->getChunk($x1 >> Chunk::COORD_BIT_SIZE, $z1 >> Chunk::COORD_BIT_SIZE)) ===
null ||
1887 $chunk->isLightPopulated() !==
true
1891 $max = max($max, $lightGetter($x1, $y1, $z1));
1900 return $this->getHighestAdjacentLight($x, $y, $z, $this->getPotentialBlockSkyLightAt(...));
1908 return $this->getHighestAdjacentPotentialBlockSkyLight($x, $y, $z) - $this->skyLightReduction;
1915 return $this->getHighestAdjacentLight($x, $y, $z, $this->getBlockLightAt(...));
1918 private function executeQueuedLightUpdates() : void{
1919 if($this->blockLightUpdate !== null){
1920 $this->timings->doBlockLightUpdates->startTiming();
1921 $this->blockLightUpdate->execute();
1922 $this->blockLightUpdate =
null;
1923 $this->timings->doBlockLightUpdates->stopTiming();
1926 if($this->skyLightUpdate !==
null){
1927 $this->timings->doBlockSkyLightUpdates->startTiming();
1928 $this->skyLightUpdate->execute();
1929 $this->skyLightUpdate =
null;
1930 $this->timings->doBlockSkyLightUpdates->stopTiming();
1937 $y < $this->maxY && $y >= $this->minY &&
1953 return $this->getBlockAt((int) floor($pos->x), (int) floor($pos->y), (int) floor($pos->z), $cached, $addToCache);
1965 public function getBlockAt(
int $x,
int $y,
int $z,
bool $cached =
true,
bool $addToCache =
true) :
Block{
1966 $relativeBlockHash = null;
1967 $chunkHash = World::chunkHash($x >> Chunk::COORD_BIT_SIZE, $z >> Chunk::COORD_BIT_SIZE);
1969 if($this->isInWorld($x, $y, $z)){
1970 $relativeBlockHash = World::chunkBlockHash($x, $y, $z);
1972 if($cached && isset($this->blockCache[$chunkHash][$relativeBlockHash])){
1973 return $this->blockCache[$chunkHash][$relativeBlockHash];
1976 $chunk = $this->chunks[$chunkHash] ??
null;
1977 if($chunk !==
null){
1978 $block = $this->blockStateRegistry->fromStateId($chunk->getBlockStateId($x & Chunk::COORD_MASK, $y, $z & Chunk::COORD_MASK));
1980 $addToCache =
false;
1981 $block = VanillaBlocks::AIR();
1984 $block = VanillaBlocks::AIR();
1987 $block->position($this, $x, $y, $z);
1989 if($this->inDynamicStateRecalculation){
1993 $addToCache =
false;
1995 $this->inDynamicStateRecalculation =
true;
1996 $replacement = $block->readStateFromWorld();
1997 if($replacement !== $block){
1998 $replacement->position($this, $x, $y, $z);
1999 $block = $replacement;
2001 $this->inDynamicStateRecalculation =
false;
2004 if($addToCache && $relativeBlockHash !==
null){
2005 $this->blockCache[$chunkHash][$relativeBlockHash] = $block;
2007 if(++$this->blockCacheSize >= self::BLOCK_CACHE_SIZE_CAP){
2008 $this->trimBlockCache();
2021 $this->setBlockAt((int) floor($pos->x), (int) floor($pos->y), (int) floor($pos->z), $block, $update);
2032 public function setBlockAt(
int $x,
int $y,
int $z,
Block $block,
bool $update =
true) : void{
2033 if(!$this->isInWorld($x, $y, $z)){
2034 throw new \InvalidArgumentException(
"Pos x=$x,y=$y,z=$z is outside of the world bounds");
2036 $chunkX = $x >> Chunk::COORD_BIT_SIZE;
2037 $chunkZ = $z >> Chunk::COORD_BIT_SIZE;
2038 if($this->loadChunk($chunkX, $chunkZ) ===
null){
2039 throw new WorldException(
"Cannot set a block in un-generated terrain");
2043 $stateId = $block->getStateId();
2044 if(!$this->blockStateRegistry->hasStateId($stateId)){
2045 throw new \LogicException(
"Block state ID not known to RuntimeBlockStateRegistry (probably not registered)");
2047 if(!GlobalBlockStateHandlers::getSerializer()->isRegistered($block)){
2048 throw new \LogicException(
"Block not registered with GlobalBlockStateHandlers serializer");
2051 $this->timings->setBlock->startTiming();
2053 $this->unlockChunk($chunkX, $chunkZ,
null);
2055 $block = clone $block;
2057 $block->position($this, $x, $y, $z);
2058 $block->writeStateToWorld();
2059 $pos =
new Vector3($x, $y, $z);
2061 $chunkHash = World::chunkHash($chunkX, $chunkZ);
2062 $relativeBlockHash = World::chunkBlockHash($x, $y, $z);
2064 unset($this->blockCache[$chunkHash][$relativeBlockHash]);
2065 $this->blockCacheSize--;
2066 unset($this->blockCollisionBoxCache[$chunkHash][$relativeBlockHash]);
2069 foreach(Facing::OFFSET as [$offsetX, $offsetY, $offsetZ]){
2070 $sideChunkPosHash = World::chunkHash(($x + $offsetX) >> Chunk::COORD_BIT_SIZE, ($z + $offsetZ) >> Chunk::COORD_BIT_SIZE);
2071 $sideChunkBlockHash = World::chunkBlockHash($x + $offsetX, $y + $offsetY, $z + $offsetZ);
2072 unset($this->blockCollisionBoxCache[$sideChunkPosHash][$sideChunkBlockHash]);
2075 if(!isset($this->changedBlocks[$chunkHash])){
2076 $this->changedBlocks[$chunkHash] = [];
2078 $this->changedBlocks[$chunkHash][$relativeBlockHash] = $pos;
2080 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2081 $listener->onBlockChanged($pos);
2085 $this->updateAllLight($x, $y, $z);
2086 $this->internalNotifyNeighbourBlockUpdate($x, $y, $z);
2089 $this->timings->setBlock->stopTiming();
2092 public function dropItem(Vector3 $source, Item $item, ?Vector3 $motion =
null,
int $delay = 10) : ?ItemEntity{
2093 if($item->isNull()){
2097 $itemEntity =
new ItemEntity(Location::fromObject($source, $this, Utils::getRandomFloat() * 360, 0), $item);
2099 $itemEntity->setPickupDelay($delay);
2100 $itemEntity->setMotion($motion ??
new Vector3(Utils::getRandomFloat() * 0.2 - 0.1, 0.2, Utils::getRandomFloat() * 0.2 - 0.1));
2101 $itemEntity->spawnToAll();
2115 foreach(ExperienceOrb::splitIntoOrbSizes($amount) as $split){
2116 $orb =
new ExperienceOrb(Location::fromObject($pos, $this, Utils::getRandomFloat() * 360, 0), $split);
2118 $orb->setMotion(
new Vector3((Utils::getRandomFloat() * 0.2 - 0.1) * 2, Utils::getRandomFloat() * 0.4, (Utils::getRandomFloat() * 0.2 - 0.1) * 2));
2135 public function useBreakOn(
Vector3 $vector, ?
Item &$item =
null, ?
Player $player =
null,
bool $createParticles =
false, array &$returnedItems = []) : bool{
2136 $vector = $vector->floor();
2138 $chunkX = $vector->getFloorX() >> Chunk::COORD_BIT_SIZE;
2139 $chunkZ = $vector->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2140 if(!$this->isChunkLoaded($chunkX, $chunkZ) || $this->isChunkLocked($chunkX, $chunkZ)){
2144 $target = $this->getBlock($vector);
2145 $affectedBlocks = $target->getAffectedBlocks();
2148 $item = VanillaItems::AIR();
2152 if($player ===
null || $player->hasFiniteResources()){
2153 $drops = array_merge(...array_map(fn(Block $block) => $block->getDrops($item), $affectedBlocks));
2157 if($player !==
null && $player->hasFiniteResources()){
2158 $xpDrop = array_sum(array_map(fn(Block $block) => $block->getXpDropForTool($item), $affectedBlocks));
2161 if($player !==
null){
2162 $ev =
new BlockBreakEvent($player, $target, $item, $player->isCreative(), $drops, $xpDrop);
2164 if($target instanceof Air || ($player->isSurvival() && !$target->getBreakInfo()->isBreakable()) || $player->isSpectator()){
2168 if($player->isAdventure(
true) && !$ev->isCancelled()){
2170 $itemParser = LegacyStringToItemParser::getInstance();
2171 foreach($item->getCanDestroy() as $v){
2172 $entry = $itemParser->parse($v);
2173 if($entry->getBlock()->hasSameTypeId($target)){
2185 if($ev->isCancelled()){
2189 $drops = $ev->getDrops();
2190 $xpDrop = $ev->getXpDropAmount();
2192 }elseif(!$target->getBreakInfo()->isBreakable()){
2196 foreach($affectedBlocks as $t){
2197 $this->destroyBlockInternal($t, $item, $player, $createParticles, $returnedItems);
2200 $item->onDestroyBlock($target, $returnedItems);
2202 if(count($drops) > 0){
2203 $dropPos = $vector->add(0.5, 0.5, 0.5);
2204 foreach($drops as $drop){
2205 if(!$drop->isNull()){
2206 $this->dropItem($dropPos, $drop);
2212 $this->dropExperience($vector->add(0.5, 0.5, 0.5), $xpDrop);
2221 private function destroyBlockInternal(Block $target, Item $item, ?Player $player,
bool $createParticles, array &$returnedItems) : void{
2222 if($createParticles){
2223 $this->addParticle($target->getPosition()->add(0.5, 0.5, 0.5),
new BlockBreakParticle($target));
2226 $target->onBreak($item, $player, $returnedItems);
2228 $tile = $this->getTile($target->getPosition());
2230 $tile->onBlockDestroyed();
2241 public function useItemOn(
Vector3 $vector,
Item &$item,
int $face, ?
Vector3 $clickVector =
null, ?
Player $player =
null,
bool $playSound =
false, array &$returnedItems = []) : bool{
2242 $blockClicked = $this->getBlock($vector);
2243 $blockReplace = $blockClicked->getSide($face);
2245 if($clickVector ===
null){
2246 $clickVector =
new Vector3(0.0, 0.0, 0.0);
2249 min(1.0, max(0.0, $clickVector->x)),
2250 min(1.0, max(0.0, $clickVector->y)),
2251 min(1.0, max(0.0, $clickVector->z))
2255 if(!$this->isInWorld($blockReplace->getPosition()->x, $blockReplace->getPosition()->y, $blockReplace->getPosition()->z)){
2259 $chunkX = $blockReplace->getPosition()->getFloorX() >> Chunk::COORD_BIT_SIZE;
2260 $chunkZ = $blockReplace->getPosition()->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2261 if(!$this->isChunkLoaded($chunkX, $chunkZ) || $this->isChunkLocked($chunkX, $chunkZ)){
2265 if($blockClicked->getTypeId() === BlockTypeIds::AIR){
2269 if($player !==
null){
2270 $ev = new PlayerInteractEvent($player, $item, $blockClicked, $clickVector, $face, PlayerInteractEvent::RIGHT_CLICK_BLOCK);
2271 if($player->isSneaking()){
2272 $ev->setUseItem(false);
2273 $ev->setUseBlock($item->isNull());
2275 if($player->isSpectator()){
2280 if(!$ev->isCancelled()){
2281 if($ev->useBlock() && $blockClicked->onInteract($item, $face, $clickVector, $player, $returnedItems)){
2286 $result = $item->onInteractBlock($player, $blockReplace, $blockClicked, $face, $clickVector, $returnedItems);
2287 if($result !== ItemUseResult::NONE){
2288 return $result === ItemUseResult::SUCCESS;
2294 }elseif($blockClicked->onInteract($item, $face, $clickVector, $player, $returnedItems)){
2298 if($item->isNull() || !$item->canBePlaced()){
2306 $item->getPlacementTransaction($blockClicked, $blockClicked, Facing::UP, $clickVector, $player) ??
2307 $item->getPlacementTransaction($blockReplace, $blockClicked, $face, $clickVector, $player);
2313 foreach($tx->getBlocks() as [$x, $y, $z, $block]){
2314 $block->position($this, $x, $y, $z);
2315 foreach($block->getCollisionBoxes() as $collisionBox){
2316 if(count($this->getCollidingEntities($collisionBox)) > 0){
2322 if($player !==
null){
2323 $ev =
new BlockPlaceEvent($player, $tx, $blockClicked, $item);
2324 if($player->isSpectator()){
2328 if($player->isAdventure(
true) && !$ev->isCancelled()){
2330 $itemParser = LegacyStringToItemParser::getInstance();
2332 $entry = $itemParser->parse($v);
2333 if($entry->getBlock()->hasSameTypeId($blockClicked)){
2345 if($ev->isCancelled()){
2354 foreach($tx->getBlocks() as [$x, $y, $z, $_]){
2355 $tile = $this->getTileAt($x, $y, $z);
2358 $tile->copyDataFromItem($item);
2361 $placed = $this->getBlockAt($x, $y, $z);
2362 $placed->onPostPlace();
2363 if($first && $playSound){
2364 $this->addSound($placed->getPosition(),
new BlockPlaceSound($placed));
2374 public function getEntity(
int $entityId) : ?Entity{
2375 return $this->entities[$entityId] ?? null;
2385 return $this->entities;
2401 foreach($this->getNearbyEntities($bb, $entity) as $ent){
2402 if($ent->canBeCollidedWith() && ($entity ===
null || $entity->canCollideWith($ent))){
2419 $minX = ((int) floor($bb->minX - 2)) >> Chunk::COORD_BIT_SIZE;
2420 $maxX = ((int) floor($bb->maxX + 2)) >> Chunk::COORD_BIT_SIZE;
2421 $minZ = ((int) floor($bb->minZ - 2)) >> Chunk::COORD_BIT_SIZE;
2422 $maxZ = ((int) floor($bb->maxZ + 2)) >> Chunk::COORD_BIT_SIZE;
2424 for($x = $minX; $x <= $maxX; ++$x){
2425 for($z = $minZ; $z <= $maxZ; ++$z){
2426 foreach($this->getChunkEntities($x, $z) as $ent){
2427 if($ent !== $entity && $ent->boundingBox->intersectsWith($bb)){
2449 assert(is_a($entityType,
Entity::class, true));
2451 $minX = ((int) floor($pos->x - $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2452 $maxX = ((int) floor($pos->x + $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2453 $minZ = ((int) floor($pos->z - $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2454 $maxZ = ((int) floor($pos->z + $maxDistance)) >> Chunk::COORD_BIT_SIZE;
2456 $currentTargetDistSq = $maxDistance ** 2;
2462 $currentTarget =
null;
2464 for($x = $minX; $x <= $maxX; ++$x){
2465 for($z = $minZ; $z <= $maxZ; ++$z){
2466 foreach($this->getChunkEntities($x, $z) as $entity){
2467 if(!($entity instanceof $entityType) || $entity->isFlaggedForDespawn() || (!$includeDead && !$entity->isAlive())){
2470 $distSq = $entity->getPosition()->distanceSquared($pos);
2471 if($distSq < $currentTargetDistSq){
2472 $currentTargetDistSq = $distSq;
2473 $currentTarget = $entity;
2479 return $currentTarget;
2489 return $this->players;
2499 return $this->getTileAt((int) floor($pos->x), (int) floor($pos->y), (int) floor($pos->z));
2506 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;
2509 public function getBiomeId(
int $x,
int $y,
int $z) : int{
2510 if(($chunk = $this->loadChunk($x >>
Chunk::COORD_BIT_SIZE, $z >>
Chunk::COORD_BIT_SIZE)) !== null){
2511 return $chunk->getBiomeId($x & Chunk::COORD_MASK, $y & Chunk::COORD_MASK, $z & Chunk::COORD_MASK);
2513 return BiomeIds::OCEAN;
2516 public function getBiome(
int $x,
int $y,
int $z) : Biome{
2517 return BiomeRegistry::getInstance()->getBiome($this->getBiomeId($x, $y, $z));
2520 public function setBiomeId(
int $x,
int $y,
int $z,
int $biomeId) : void{
2521 $chunkX = $x >> Chunk::COORD_BIT_SIZE;
2522 $chunkZ = $z >> Chunk::COORD_BIT_SIZE;
2523 $this->unlockChunk($chunkX, $chunkZ,
null);
2524 if(($chunk = $this->loadChunk($chunkX, $chunkZ)) !==
null){
2525 $chunk->setBiomeId($x & Chunk::COORD_MASK, $y & Chunk::COORD_MASK, $z & Chunk::COORD_MASK, $biomeId);
2528 throw new WorldException(
"Cannot set biome in a non-generated chunk");
2537 return $this->chunks;
2540 public function getChunk(
int $chunkX,
int $chunkZ) : ?
Chunk{
2541 return $this->chunks[
World::chunkHash($chunkX, $chunkZ)] ?? null;
2549 return $this->entitiesByChunk[
World::chunkHash($chunkX, $chunkZ)] ?? [];
2556 return $this->loadChunk($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE);
2567 for($xx = -1; $xx <= 1; ++$xx){
2568 for($zz = -1; $zz <= 1; ++$zz){
2569 if($xx === 0 && $zz === 0){
2572 $result[World::chunkHash($xx, $zz)] = $this->loadChunk($x + $xx, $z + $zz);
2594 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
2595 if(isset($this->chunkLock[$chunkHash])){
2596 throw new \InvalidArgumentException(
"Chunk $chunkX $chunkZ is already locked");
2598 $this->chunkLock[$chunkHash] = $lockId;
2599 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
2611 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
2612 if(isset($this->chunkLock[$chunkHash]) && ($lockId ===
null || $this->chunkLock[$chunkHash] === $lockId)){
2613 unset($this->chunkLock[$chunkHash]);
2614 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
2626 return isset($this->chunkLock[
World::chunkHash($chunkX, $chunkZ)]);
2629 public function setChunk(
int $chunkX,
int $chunkZ,
Chunk $chunk) : void{
2630 foreach($chunk->getSubChunks() as $subChunk){
2631 foreach($subChunk->getBlockLayers() as $blockLayer){
2632 foreach($blockLayer->getPalette() as $blockStateId){
2633 if(!$this->blockStateRegistry->hasStateId($blockStateId)){
2634 throw new \InvalidArgumentException(
"Provided chunk contains unknown/unregistered blocks (found unknown state ID $blockStateId)");
2640 $chunkHash = World::chunkHash($chunkX, $chunkZ);
2641 $oldChunk = $this->loadChunk($chunkX, $chunkZ);
2642 if($oldChunk !==
null && $oldChunk !== $chunk){
2644 $transferredTiles = 0;
2645 foreach($oldChunk->getTiles() as $oldTile){
2646 $tilePosition = $oldTile->getPosition();
2647 $localX = $tilePosition->getFloorX() & Chunk::COORD_MASK;
2648 $localY = $tilePosition->getFloorY();
2649 $localZ = $tilePosition->getFloorZ() & Chunk::COORD_MASK;
2651 $newBlock = $this->blockStateRegistry->fromStateId($chunk->getBlockStateId($localX, $localY, $localZ));
2652 $expectedTileClass = $newBlock->getIdInfo()->getTileClass();
2654 $expectedTileClass ===
null ||
2655 !($oldTile instanceof $expectedTileClass) ||
2656 (($newTile = $chunk->getTile($localX, $localY, $localZ)) !==
null && $newTile !== $oldTile)
2661 $transferredTiles++;
2662 $chunk->addTile($oldTile);
2663 $oldChunk->removeTile($oldTile);
2666 if($deletedTiles > 0 || $transferredTiles > 0){
2667 $this->logger->debug(
"Replacement of chunk $chunkX $chunkZ caused deletion of $deletedTiles obsolete/conflicted tiles, and transfer of $transferredTiles");
2671 $this->chunks[$chunkHash] = $chunk;
2672 unset($this->knownUngeneratedChunks[$chunkHash]);
2674 $this->blockCacheSize -= count($this->blockCache[$chunkHash] ?? []);
2675 unset($this->blockCache[$chunkHash]);
2676 unset($this->blockCollisionBoxCache[$chunkHash]);
2677 unset($this->changedBlocks[$chunkHash]);
2678 $chunk->setTerrainDirty();
2679 $this->markTickingChunkForRecheck($chunkX, $chunkZ);
2681 if(!$this->isChunkInUse($chunkX, $chunkZ)){
2682 $this->unloadChunkRequest($chunkX, $chunkZ);
2685 if($oldChunk ===
null){
2686 if(ChunkLoadEvent::hasHandlers()){
2687 (
new ChunkLoadEvent($this, $chunkX, $chunkZ, $chunk,
true))->call();
2690 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2691 $listener->onChunkLoaded($chunkX, $chunkZ, $chunk);
2694 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2695 $listener->onChunkChanged($chunkX, $chunkZ, $chunk);
2699 for($cX = -1; $cX <= 1; ++$cX){
2700 for($cZ = -1; $cZ <= 1; ++$cZ){
2701 foreach($this->getChunkEntities($chunkX + $cX, $chunkZ + $cZ) as $entity){
2702 $entity->onNearbyBlockChange();
2715 if(($chunk = $this->loadChunk($x >>
Chunk::COORD_BIT_SIZE, $z >>
Chunk::COORD_BIT_SIZE)) !== null){
2716 return $chunk->getHighestBlockAt($x & Chunk::COORD_MASK, $z & Chunk::COORD_MASK);
2718 throw new WorldException(
"Cannot get highest block in an ungenerated chunk");
2725 return $this->isChunkLoaded($pos->getFloorX() >>
Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >>
Chunk::COORD_BIT_SIZE);
2728 public function isChunkLoaded(
int $x,
int $z) : bool{
2729 return isset($this->chunks[
World::chunkHash($x, $z)]);
2732 public function isChunkGenerated(
int $x,
int $z) : bool{
2733 return $this->loadChunk($x, $z) !== null;
2736 public function isChunkPopulated(
int $x,
int $z) : bool{
2737 $chunk = $this->loadChunk($x, $z);
2738 return $chunk !==
null && $chunk->isPopulated();
2745 return
Position::fromObject($this->provider->getWorldData()->getSpawn(), $this);
2752 $previousSpawn = $this->getSpawnLocation();
2753 $this->provider->getWorldData()->setSpawn($pos);
2756 $location = Position::fromObject($pos, $this);
2757 foreach($this->players as $player){
2758 $player->getNetworkSession()->syncWorldSpawnPoint($location);
2766 if($entity->isClosed()){
2767 throw new \InvalidArgumentException(
"Attempted to add a garbage closed Entity to world");
2769 if($entity->getWorld() !== $this){
2770 throw new \InvalidArgumentException(
"Invalid Entity world");
2772 if(array_key_exists($entity->getId(), $this->entities)){
2773 if($this->entities[$entity->getId()] === $entity){
2774 throw new \InvalidArgumentException(
"Entity " . $entity->getId() .
" has already been added to this world");
2776 throw new AssumptionFailedError(
"Found two different entities sharing entity ID " . $entity->getId());
2779 if(!EntityFactory::getInstance()->isRegistered($entity::class) && !$entity instanceof Player){
2782 throw new \LogicException(
"Entity " . $entity::class .
" is not registered for a save ID in EntityFactory");
2784 $pos = $entity->getPosition()->asVector3();
2785 $this->entitiesByChunk[World::chunkHash($pos->getFloorX() >> Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE)][$entity->getId()] = $entity;
2786 $this->entityLastKnownPositions[$entity->getId()] = $pos;
2788 if($entity instanceof Player){
2789 $this->players[$entity->getId()] = $entity;
2791 $this->entities[$entity->getId()] = $entity;
2800 if($entity->getWorld() !== $this){
2801 throw new \InvalidArgumentException(
"Invalid Entity world");
2803 if(!array_key_exists($entity->getId(), $this->entities)){
2804 throw new \InvalidArgumentException(
"Entity is not tracked by this world (possibly already removed?)");
2806 $pos = $this->entityLastKnownPositions[$entity->getId()];
2807 $chunkHash = World::chunkHash($pos->getFloorX() >> Chunk::COORD_BIT_SIZE, $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE);
2808 if(isset($this->entitiesByChunk[$chunkHash][$entity->getId()])){
2809 if(count($this->entitiesByChunk[$chunkHash]) === 1){
2810 unset($this->entitiesByChunk[$chunkHash]);
2812 unset($this->entitiesByChunk[$chunkHash][$entity->getId()]);
2815 unset($this->entityLastKnownPositions[$entity->getId()]);
2817 if($entity instanceof Player){
2818 unset($this->players[$entity->getId()]);
2819 $this->checkSleep();
2822 unset($this->entities[$entity->getId()]);
2823 unset($this->updateEntities[$entity->getId()]);
2829 public function onEntityMoved(Entity $entity) : void{
2830 if(!array_key_exists($entity->getId(), $this->entityLastKnownPositions)){
2834 $oldPosition = $this->entityLastKnownPositions[$entity->getId()];
2835 $newPosition = $entity->getPosition();
2837 $oldChunkX = $oldPosition->getFloorX() >> Chunk::COORD_BIT_SIZE;
2838 $oldChunkZ = $oldPosition->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2839 $newChunkX = $newPosition->getFloorX() >> Chunk::COORD_BIT_SIZE;
2840 $newChunkZ = $newPosition->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2842 if($oldChunkX !== $newChunkX || $oldChunkZ !== $newChunkZ){
2843 $oldChunkHash = World::chunkHash($oldChunkX, $oldChunkZ);
2844 if(isset($this->entitiesByChunk[$oldChunkHash][$entity->getId()])){
2845 if(count($this->entitiesByChunk[$oldChunkHash]) === 1){
2846 unset($this->entitiesByChunk[$oldChunkHash]);
2848 unset($this->entitiesByChunk[$oldChunkHash][$entity->getId()]);
2852 $newViewers = $this->getViewersForPosition($newPosition);
2854 if(!isset($newViewers[spl_object_id($player)])){
2857 unset($newViewers[spl_object_id($player)]);
2860 foreach($newViewers as $player){
2861 $entity->spawnTo($player);
2864 $newChunkHash = World::chunkHash($newChunkX, $newChunkZ);
2865 $this->entitiesByChunk[$newChunkHash][$entity->getId()] = $entity;
2867 $this->entityLastKnownPositions[$entity->getId()] = $newPosition->asVector3();
2874 public function addTile(Tile $tile) : void{
2875 if($tile->isClosed()){
2876 throw new \InvalidArgumentException(
"Attempted to add a garbage closed Tile to world");
2878 $pos = $tile->getPosition();
2879 if(!$pos->isValid() || $pos->getWorld() !== $this){
2880 throw new \InvalidArgumentException(
"Invalid Tile world");
2882 if(!$this->isInWorld($pos->getFloorX(), $pos->getFloorY(), $pos->getFloorZ())){
2883 throw new \InvalidArgumentException(
"Tile position is outside the world bounds");
2885 if(!TileFactory::getInstance()->isRegistered($tile::class)){
2886 throw new \LogicException(
"Tile " . $tile::class .
" is not registered for a save ID in TileFactory");
2889 $chunkX = $pos->getFloorX() >> Chunk::COORD_BIT_SIZE;
2890 $chunkZ = $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2892 if(isset($this->chunks[$hash = World::chunkHash($chunkX, $chunkZ)])){
2893 $this->chunks[$hash]->addTile($tile);
2895 throw new \InvalidArgumentException(
"Attempted to create tile " . get_class($tile) .
" in unloaded chunk $chunkX $chunkZ");
2899 $this->scheduleDelayedBlockUpdate($pos->
asVector3(), 1);
2906 public function removeTile(Tile $tile) : void{
2908 if(!$pos->isValid() || $pos->getWorld() !== $this){
2909 throw new \InvalidArgumentException(
"Invalid Tile world");
2912 $chunkX = $pos->getFloorX() >> Chunk::COORD_BIT_SIZE;
2913 $chunkZ = $pos->getFloorZ() >> Chunk::COORD_BIT_SIZE;
2915 if(isset($this->chunks[$hash = World::chunkHash($chunkX, $chunkZ)])){
2916 $this->chunks[$hash]->removeTile($tile);
2918 foreach($this->getChunkListeners($chunkX, $chunkZ) as $listener){
2919 $listener->onBlockChanged($pos->
asVector3());
2923 public function isChunkInUse(
int $x,
int $z) : bool{
2924 return isset($this->chunkLoaders[$index = World::chunkHash($x, $z)]) && count($this->chunkLoaders[$index]) > 0;
2934 if(isset($this->chunks[$chunkHash =
World::chunkHash($x, $z)])){
2935 return $this->chunks[$chunkHash];
2937 if(isset($this->knownUngeneratedChunks[$chunkHash])){
2941 $this->timings->syncChunkLoad->startTiming();
2943 $this->cancelUnloadChunkRequest($x, $z);
2945 $this->timings->syncChunkLoadData->startTiming();
2947 $loadedChunkData =
null;
2950 $loadedChunkData = $this->provider->loadChunk($x, $z);
2951 }
catch(CorruptedChunkException $e){
2952 $this->logger->critical(
"Failed to load chunk x=$x z=$z: " . $e->getMessage());
2955 $this->timings->syncChunkLoadData->stopTiming();
2957 if($loadedChunkData ===
null){
2958 $this->timings->syncChunkLoad->stopTiming();
2959 $this->knownUngeneratedChunks[$chunkHash] =
true;
2963 $chunkData = $loadedChunkData->getData();
2964 $chunk =
new Chunk($chunkData->getSubChunks(), $chunkData->isPopulated());
2965 if(!$loadedChunkData->isUpgraded()){
2966 $chunk->clearTerrainDirtyFlags();
2968 $this->logger->debug(
"Chunk $x $z has been upgraded, will be saved at the next autosave opportunity");
2970 $this->chunks[$chunkHash] = $chunk;
2972 $this->blockCacheSize -= count($this->blockCache[$chunkHash] ?? []);
2973 unset($this->blockCache[$chunkHash]);
2974 unset($this->blockCollisionBoxCache[$chunkHash]);
2976 $this->initChunk($x, $z, $chunkData, $chunk);
2978 if(ChunkLoadEvent::hasHandlers()){
2979 (
new ChunkLoadEvent($this, $x, $z, $this->chunks[$chunkHash],
false))->call();
2982 if(!$this->isChunkInUse($x, $z)){
2983 $this->logger->debug(
"Newly loaded chunk $x $z has no loaders registered, will be unloaded at next available opportunity");
2984 $this->unloadChunkRequest($x, $z);
2986 foreach($this->getChunkListeners($x, $z) as $listener){
2987 $listener->onChunkLoaded($x, $z, $this->chunks[$chunkHash]);
2989 $this->markTickingChunkForRecheck($x, $z);
2991 $this->timings->syncChunkLoad->stopTiming();
2993 return $this->chunks[$chunkHash];
2996 private function initChunk(
int $chunkX,
int $chunkZ, ChunkData $chunkData, Chunk $chunk) : void{
2997 $logger = new \
PrefixedLogger($this->logger,
"Loading chunk $chunkX $chunkZ");
2999 if(count($chunkData->getEntityNBT()) !== 0){
3000 $this->timings->syncChunkLoadEntities->startTiming();
3001 $entityFactory = EntityFactory::getInstance();
3003 $deletedEntities = [];
3004 foreach($chunkData->getEntityNBT() as $k => $nbt){
3006 $entity = $entityFactory->createFromData($this, $nbt);
3007 }catch(SavedDataLoadingException $e){
3008 $logger->error(
"Bad entity data at list position $k: " . $e->getMessage());
3009 $logger->logException($e);
3012 if($entity === null){
3013 $saveIdTag = $nbt->getTag(
"identifier") ?? $nbt->getTag(
"id");
3014 $saveId =
"<unknown>";
3015 if($saveIdTag instanceof StringTag){
3016 $saveId = $saveIdTag->getValue();
3017 }elseif($saveIdTag instanceof IntTag){
3018 $saveId =
"legacy(" . $saveIdTag->getValue() .
")";
3020 $deletedEntities[$saveId] = ($deletedEntities[$saveId] ?? 0) + 1;
3026 foreach(Utils::promoteKeys($deletedEntities) as $saveId => $count){
3027 $logger->warning(
"Deleted unknown entity type $saveId x$count");
3029 $this->timings->syncChunkLoadEntities->stopTiming();
3032 if(count($chunkData->getTileNBT()) !== 0){
3033 $this->timings->syncChunkLoadTileEntities->startTiming();
3034 $tileFactory = TileFactory::getInstance();
3037 foreach($chunkData->getTileNBT() as $k => $nbt){
3039 $tile = $tileFactory->createFromData($this, $nbt);
3040 }catch(SavedDataLoadingException $e){
3041 $logger->error(
"Bad tile entity data at list position $k: " . $e->getMessage());
3042 $logger->logException($e);
3046 $saveId = $nbt->getString(
"id",
"<unknown>");
3047 $deletedTiles[$saveId] = ($deletedTiles[$saveId] ?? 0) + 1;
3051 $tilePosition = $tile->getPosition();
3052 if(!$this->isChunkLoaded($tilePosition->getFloorX() >> Chunk::COORD_BIT_SIZE, $tilePosition->getFloorZ() >> Chunk::COORD_BIT_SIZE)){
3053 $logger->error(
"Found tile saved on wrong chunk - unable to fix due to correct chunk not loaded");
3054 }elseif(!$this->isInWorld($tilePosition->getFloorX(), $tilePosition->getFloorY(), $tilePosition->getFloorZ())){
3055 $logger->error(
"Cannot add tile with position outside the world bounds: x=$tilePosition->x,y=$tilePosition->y,z=$tilePosition->z");
3056 }elseif($this->getTile($tilePosition) !== null){
3057 $logger->error(
"Cannot add tile at x=$tilePosition->x,y=$tilePosition->y,z=$tilePosition->z: Another tile is already at that position");
3059 $this->addTile($tile);
3061 $expectedStateId = $chunk->getBlockStateId($tilePosition->getFloorX() & Chunk::COORD_MASK, $tilePosition->getFloorY(), $tilePosition->getFloorZ() & Chunk::COORD_MASK);
3062 $actualStateId = $this->getBlock($tilePosition)->getStateId();
3063 if($expectedStateId !== $actualStateId){
3068 $chunk->setBlockStateId($tilePosition->getFloorX() & Chunk::COORD_MASK, $tilePosition->getFloorY(), $tilePosition->getFloorZ() & Chunk::COORD_MASK, $actualStateId);
3069 $this->logger->debug(
"Tile " . $tile::class .
" at x=$tilePosition->x,y=$tilePosition->y,z=$tilePosition->z updated block state ID from $expectedStateId to $actualStateId");
3073 foreach(Utils::promoteKeys($deletedTiles) as $saveId => $count){
3074 $logger->warning(
"Deleted unknown tile entity type $saveId x$count");
3077 $this->timings->syncChunkLoadTileEntities->stopTiming();
3081 private function queueUnloadChunk(
int $x,
int $z) : void{
3082 $this->unloadQueue[World::chunkHash($x, $z)] = microtime(true);
3085 public function unloadChunkRequest(
int $x,
int $z,
bool $safe =
true) : bool{
3086 if(($safe && $this->isChunkInUse($x, $z)) || $this->isSpawnChunk($x, $z)){
3090 $this->queueUnloadChunk($x, $z);
3095 public function cancelUnloadChunkRequest(
int $x,
int $z) : void{
3096 unset($this->unloadQueue[World::chunkHash($x, $z)]);
3099 public function unloadChunk(
int $x,
int $z,
bool $safe =
true,
bool $trySave =
true) : bool{
3100 if($safe && $this->isChunkInUse($x, $z)){
3104 if(!$this->isChunkLoaded($x, $z)){
3108 $this->timings->doChunkUnload->startTiming();
3110 $chunkHash = World::chunkHash($x, $z);
3112 $chunk = $this->chunks[$chunkHash] ??
null;
3114 if($chunk !==
null){
3115 if(ChunkUnloadEvent::hasHandlers()){
3116 $ev =
new ChunkUnloadEvent($this, $x, $z, $chunk);
3118 if($ev->isCancelled()){
3119 $this->timings->doChunkUnload->stopTiming();
3125 if($trySave && $this->getAutoSave()){
3126 $this->timings->syncChunkSave->startTiming();
3128 $this->provider->saveChunk($x, $z,
new ChunkData(
3129 $chunk->getSubChunks(),
3130 $chunk->isPopulated(),
3131 array_map(fn(Entity $e) => $e->saveNBT(), array_values(array_filter($this->getChunkEntities($x, $z), fn(Entity $e) => $e->canSaveWithChunk()))),
3132 array_map(fn(Tile $t) => $t->saveNBT(), array_values($chunk->getTiles())),
3133 ), $chunk->getTerrainDirtyFlags());
3135 $this->timings->syncChunkSave->stopTiming();
3139 foreach($this->getChunkListeners($x, $z) as $listener){
3140 $listener->onChunkUnloaded($x, $z, $chunk);
3143 foreach($this->getChunkEntities($x, $z) as $entity){
3144 if($entity instanceof Player){
3153 unset($this->chunks[$chunkHash]);
3154 $this->blockCacheSize -= count($this->blockCache[$chunkHash] ?? []);
3155 unset($this->blockCache[$chunkHash]);
3156 unset($this->blockCollisionBoxCache[$chunkHash]);
3157 unset($this->changedBlocks[$chunkHash]);
3158 unset($this->registeredTickingChunks[$chunkHash]);
3159 $this->markTickingChunkForRecheck($x, $z);
3161 if(array_key_exists($chunkHash, $this->chunkPopulationRequestMap)){
3162 $this->logger->debug(
"Rejecting population promise for chunk $x $z");
3163 $this->chunkPopulationRequestMap[$chunkHash]->reject();
3164 unset($this->chunkPopulationRequestMap[$chunkHash]);
3165 if(isset($this->activeChunkPopulationTasks[$chunkHash])){
3166 $this->logger->debug(
"Marking population task for chunk $x $z as orphaned");
3167 $this->activeChunkPopulationTasks[$chunkHash] =
false;
3171 $this->timings->doChunkUnload->stopTiming();
3180 $spawn = $this->getSpawnLocation();
3181 $spawnX = $spawn->x >> Chunk::COORD_BIT_SIZE;
3182 $spawnZ = $spawn->z >> Chunk::COORD_BIT_SIZE;
3184 return abs($X - $spawnX) <= 1 && abs($Z - $spawnZ) <= 1;
3197 $spawn ??= $this->getSpawnLocation();
3202 $this->requestChunkPopulation($spawn->getFloorX() >> Chunk::COORD_BIT_SIZE, $spawn->getFloorZ() >> Chunk::COORD_BIT_SIZE,
null)->onCompletion(
3203 function() use ($spawn, $resolver) :
void{
3204 $spawn = $this->getSafeSpawn($spawn);
3205 $resolver->resolve($spawn);
3207 function() use ($resolver) : void{
3208 $resolver->reject();
3212 return $resolver->getPromise();
3222 if(!($spawn instanceof
Vector3) || $spawn->y <= $this->minY){
3223 $spawn = $this->getSpawnLocation();
3227 $v = $spawn->floor();
3228 $chunk = $this->getOrLoadChunkAtPosition($v);
3229 if($chunk ===
null){
3230 throw new WorldException(
"Cannot find a safe spawn point in non-generated terrain");
3234 $y = (int) min($max - 2, $v->y);
3235 $wasAir = $this->getBlockAt($x, $y - 1, $z)->getTypeId() === BlockTypeIds::AIR;
3236 for(; $y > $this->minY; --$y){
3237 if($this->getBlockAt($x, $y, $z)->isFullCube()){
3247 for(; $y >= $this->minY && $y < $max; ++$y){
3248 if(!$this->getBlockAt($x, $y + 1, $z)->isFullCube()){
3249 if(!$this->getBlockAt($x, $y, $z)->isFullCube()){
3250 return new Position($spawn->x, $y === (
int) $spawn->y ? $spawn->y : $y, $spawn->z, $this);
3257 return new Position($spawn->x, $y, $spawn->z, $this);
3271 return $this->time % self::TIME_FULL;
3279 return $this->displayName;
3288 $this->displayName = $name;
3289 $this->provider->getWorldData()->setName($name);
3296 return $this->folderName;
3303 $this->time = $time;
3311 $this->stopTime = true;
3319 $this->stopTime = false;
3327 return $this->provider->getWorldData()->getSeed();
3338 public function getDifficulty() : int{
3339 return $this->provider->getWorldData()->getDifficulty();
3342 public function setDifficulty(
int $difficulty) : void{
3343 if($difficulty < 0 || $difficulty > 3){
3344 throw new \InvalidArgumentException(
"Invalid difficulty level $difficulty");
3346 (
new WorldDifficultyChangeEvent($this, $this->getDifficulty(), $difficulty))->call();
3347 $this->provider->getWorldData()->setDifficulty($difficulty);
3349 foreach($this->players as $player){
3350 $player->getNetworkSession()->syncWorldDifficulty($this->getDifficulty());
3354 private function addChunkHashToPopulationRequestQueue(
int $chunkHash) : void{
3355 if(!isset($this->chunkPopulationRequestQueueIndex[$chunkHash])){
3356 $this->chunkPopulationRequestQueue->enqueue($chunkHash);
3357 $this->chunkPopulationRequestQueueIndex[$chunkHash] =
true;
3364 private function enqueuePopulationRequest(
int $chunkX,
int $chunkZ, ?ChunkLoader $associatedChunkLoader) : Promise{
3365 $chunkHash = World::chunkHash($chunkX, $chunkZ);
3366 $this->addChunkHashToPopulationRequestQueue($chunkHash);
3368 $resolver = $this->chunkPopulationRequestMap[$chunkHash] =
new PromiseResolver();
3369 if($associatedChunkLoader ===
null){
3370 $temporaryLoader =
new class implements ChunkLoader{};
3371 $this->registerChunkLoader($temporaryLoader, $chunkX, $chunkZ);
3372 $resolver->getPromise()->onCompletion(
3373 fn() => $this->unregisterChunkLoader($temporaryLoader, $chunkX, $chunkZ),
3374 static function() :
void{}
3377 return $resolver->getPromise();
3380 private function drainPopulationRequestQueue() : void{
3382 while(count($this->activeChunkPopulationTasks) < $this->maxConcurrentChunkPopulationTasks && !$this->chunkPopulationRequestQueue->isEmpty()){
3383 $nextChunkHash = $this->chunkPopulationRequestQueue->dequeue();
3384 unset($this->chunkPopulationRequestQueueIndex[$nextChunkHash]);
3385 World::getXZ($nextChunkHash, $nextChunkX, $nextChunkZ);
3386 if(isset($this->chunkPopulationRequestMap[$nextChunkHash])){
3387 assert(!($this->activeChunkPopulationTasks[$nextChunkHash] ??
false),
"Population for chunk $nextChunkX $nextChunkZ already running");
3389 !$this->orderChunkPopulation($nextChunkX, $nextChunkZ,
null)->isResolved() &&
3390 !isset($this->activeChunkPopulationTasks[$nextChunkHash])
3392 $failed[] = $nextChunkHash;
3399 foreach($failed as $hash){
3400 $this->addChunkHashToPopulationRequestQueue($hash);
3409 private function checkChunkPopulationPreconditions(
int $chunkX,
int $chunkZ) : array{
3410 $chunkHash = World::chunkHash($chunkX, $chunkZ);
3411 $resolver = $this->chunkPopulationRequestMap[$chunkHash] ??
null;
3412 if($resolver !==
null && isset($this->activeChunkPopulationTasks[$chunkHash])){
3414 return [$resolver,
false];
3417 $temporaryChunkLoader =
new class implements ChunkLoader{};
3418 $this->registerChunkLoader($temporaryChunkLoader, $chunkX, $chunkZ);
3419 $chunk = $this->loadChunk($chunkX, $chunkZ);
3420 $this->unregisterChunkLoader($temporaryChunkLoader, $chunkX, $chunkZ);
3421 if($chunk !==
null && $chunk->isPopulated()){
3423 $resolver ??=
new PromiseResolver();
3424 unset($this->chunkPopulationRequestMap[$chunkHash]);
3425 $resolver->resolve($chunk);
3426 return [$resolver,
false];
3428 return [$resolver,
true];
3443 [$resolver, $proceedWithPopulation] = $this->checkChunkPopulationPreconditions($chunkX, $chunkZ);
3444 if(!$proceedWithPopulation){
3445 return $resolver?->getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3448 if(count($this->activeChunkPopulationTasks) >= $this->maxConcurrentChunkPopulationTasks){
3450 return $resolver?->getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3452 return $this->internalOrderChunkPopulation($chunkX, $chunkZ, $associatedChunkLoader, $resolver);
3466 [$resolver, $proceedWithPopulation] = $this->checkChunkPopulationPreconditions($chunkX, $chunkZ);
3467 if(!$proceedWithPopulation){
3468 return $resolver?->getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3471 return $this->internalOrderChunkPopulation($chunkX, $chunkZ, $associatedChunkLoader, $resolver);
3478 private function internalOrderChunkPopulation(
int $chunkX,
int $chunkZ, ?ChunkLoader $associatedChunkLoader, ?
PromiseResolver $resolver) :
Promise{
3479 $chunkHash =
World::chunkHash($chunkX, $chunkZ);
3481 $timings = $this->timings->chunkPopulationOrder;
3482 $timings->startTiming();
3485 for($xx = -1; $xx <= 1; ++$xx){
3486 for($zz = -1; $zz <= 1; ++$zz){
3487 if($this->isChunkLocked($chunkX + $xx, $chunkZ + $zz)){
3489 return $resolver?->
getPromise() ?? $this->enqueuePopulationRequest($chunkX, $chunkZ, $associatedChunkLoader);
3494 $this->activeChunkPopulationTasks[$chunkHash] =
true;
3495 if($resolver ===
null){
3496 $resolver =
new PromiseResolver();
3497 $this->chunkPopulationRequestMap[$chunkHash] = $resolver;
3500 $chunkPopulationLockId =
new ChunkLockId();
3502 $temporaryChunkLoader =
new class implements ChunkLoader{
3504 for($xx = -1; $xx <= 1; ++$xx){
3505 for($zz = -1; $zz <= 1; ++$zz){
3506 $this->lockChunk($chunkX + $xx, $chunkZ + $zz, $chunkPopulationLockId);
3507 $this->registerChunkLoader($temporaryChunkLoader, $chunkX + $xx, $chunkZ + $zz);
3511 $centerChunk = $this->loadChunk($chunkX, $chunkZ);
3512 $adjacentChunks = $this->getAdjacentChunks($chunkX, $chunkZ);
3514 $this->generatorExecutor->populate(
3519 function(Chunk $centerChunk, array $adjacentChunks) use ($chunkPopulationLockId, $chunkX, $chunkZ, $temporaryChunkLoader) :
void{
3520 if(!$this->isLoaded()){
3524 $this->generateChunkCallback($chunkPopulationLockId, $chunkX, $chunkZ, $centerChunk, $adjacentChunks, $temporaryChunkLoader);
3530 $timings->stopTiming();
3538 private function generateChunkCallback(ChunkLockId $chunkLockId,
int $x,
int $z, Chunk $chunk, array $adjacentChunks, ChunkLoader $temporaryChunkLoader) : void{
3539 $timings = $this->timings->chunkPopulationCompletion;
3540 $timings->startTiming();
3543 for($xx = -1; $xx <= 1; ++$xx){
3544 for($zz = -1; $zz <= 1; ++$zz){
3545 $this->unregisterChunkLoader($temporaryChunkLoader, $x + $xx, $z + $zz);
3546 if(!$this->unlockChunk($x + $xx, $z + $zz, $chunkLockId)){
3552 $index = World::chunkHash($x, $z);
3553 if(!isset($this->activeChunkPopulationTasks[$index])){
3554 throw new AssumptionFailedError(
"This should always be set, regardless of whether the task was orphaned or not");
3556 if(!$this->activeChunkPopulationTasks[$index]){
3557 $this->logger->debug(
"Discarding orphaned population result for chunk x=$x,z=$z");
3558 unset($this->activeChunkPopulationTasks[$index]);
3560 if($dirtyChunks === 0){
3561 $oldChunk = $this->loadChunk($x, $z);
3562 $this->setChunk($x, $z, $chunk);
3564 foreach($adjacentChunks as $relativeChunkHash => $adjacentChunk){
3565 World::getXZ($relativeChunkHash, $relativeX, $relativeZ);
3566 if($relativeX < -1 || $relativeX > 1 || $relativeZ < -1 || $relativeZ > 1){
3567 throw new AssumptionFailedError(
"Adjacent chunks should be in range -1 ... +1 coordinates");
3569 $this->setChunk($x + $relativeX, $z + $relativeZ, $adjacentChunk);
3572 if(($oldChunk ===
null || !$oldChunk->isPopulated()) && $chunk->isPopulated()){
3573 if(ChunkPopulateEvent::hasHandlers()){
3574 (
new ChunkPopulateEvent($this, $x, $z, $chunk))->call();
3577 foreach($this->getChunkListeners($x, $z) as $listener){
3578 $listener->onChunkPopulated($x, $z, $chunk);
3582 $this->logger->debug(
"Discarding population result for chunk x=$x,z=$z - terrain was modified on the main thread before async population completed");
3591 unset($this->activeChunkPopulationTasks[$index]);
3593 if($dirtyChunks === 0){
3594 $promise = $this->chunkPopulationRequestMap[$index] ??
null;
3595 if($promise !==
null){
3596 unset($this->chunkPopulationRequestMap[$index]);
3597 $promise->resolve($chunk);
3600 $this->logger->debug(
"Unable to resolve population promise for chunk x=$x,z=$z - populated chunk was forcibly unloaded while setting modified chunks");
3606 $this->addChunkHashToPopulationRequestQueue($index);
3609 $this->drainPopulationRequestQueue();
3611 $timings->stopTiming();
3614 public function doChunkGarbageCollection() : void{
3615 $this->timings->doChunkGC->startTiming();
3617 foreach($this->chunks as $index => $chunk){
3618 if(!isset($this->unloadQueue[$index])){
3619 World::getXZ($index, $X, $Z);
3620 if(!$this->isSpawnChunk($X, $Z)){
3621 $this->unloadChunkRequest($X, $Z,
true);
3624 $chunk->collectGarbage();
3627 $this->provider->doGarbageCollection();
3629 $this->timings->doChunkGC->stopTiming();
3632 public function unloadChunks(
bool $force =
false) : void{
3633 if(count($this->unloadQueue) > 0){
3635 $now = microtime(
true);
3636 foreach($this->unloadQueue as $index => $time){
3637 World::getXZ($index, $X, $Z);
3640 if($maxUnload <= 0){
3642 }elseif($time > ($now - 30)){
3648 if($this->unloadChunk($X, $Z,
true)){
3649 unset($this->unloadQueue[$index]);