steel_core/player/lifecycle/

spawn_sync.rs

use super::{
    Arc, BlockBreakingManager, CContainerClose, CGameEvent, CRespawn, CSetDefaultSpawnPosition,
    CSetHeldSlot, CSetPassengers, DVec3, Entity, GameEventType, GameType, MenuRemovalStatus,
    MobEffectSyncChange, MobEffectSyncPacket, Player, RegistryEntry, RelativeMovement, ResetReason,
    World,
};

impl Player {
    /// Resets the player's transient state and prepares them for a new world.
    ///
    /// This is the shared "clean slate" path used by initial join and world
    /// changes that preserve the player incarnation. If the player is currently
    /// in a different world, they are removed from the old world first.
    pub(crate) fn reset(self: &Arc<Self>, new_world: Arc<World>, reason: ResetReason) {
        self.reset_inner_after(new_world, reason, false, || {});
    }

    /// Resets a player already detached from its source domain and restores target-domain state.
    pub(crate) fn reset_after_detached_domain_restore<F>(
        self: &Arc<Self>,
        new_world: Arc<World>,
        restore_state: F,
    ) where
        F: FnOnce(),
    {
        self.reset_inner_after(new_world, ResetReason::WorldChange, true, || {
            restore_state();
            // Damage timestamps belong to the source domain's clock.
            self.living_base.clear_last_damage_source();
        });
    }

    fn reset_inner_after<F>(
        self: &Arc<Self>,
        new_world: Arc<World>,
        reason: ResetReason,
        source_world_detached: bool,
        restore_state: F,
    ) where
        F: FnOnce(),
    {
        if reason != ResetReason::InitialJoin {
            assert_eq!(
                self.remove_all_menus(),
                MenuRemovalStatus::Complete,
                "player reset menu removal must run outside a menu callback"
            );
        }
        if matches!(reason, ResetReason::Respawn | ResetReason::EndCredits) {
            // Vanilla creates a fresh ServerPlayer and inventory menu for these paths.
            self.inventory_menu
                .lock()
                .behavior_mut()
                .reset_quick_craft();
        }

        let old_world = self.get_world();
        let switching_worlds = !Arc::ptr_eq(&old_world, &new_world);

        if switching_worlds {
            self.send_packet(CContainerClose { container_id: 0 });
            if !source_world_detached {
                old_world.remove_player_for_world_change(self);
            }
            self.set_world(new_world.clone());
        } else if !source_world_detached {
            old_world.chunk_map.remove_player(self);
        }

        self.set_client_loaded(false);
        self.set_velocity(DVec3::ZERO);
        self.movement.lock().reset_last_known_client_movement();
        self.set_on_ground(false);
        self.reset_entity_state();
        *self.block_breaking.lock() = BlockBreakingManager::new();

        restore_state();

        if reason != ResetReason::InitialJoin {
            self.send_respawn_packet(&new_world, reason);
        }
    }

    /// Prepares a newly allocated player for a death or End-credits respawn.
    pub(crate) fn prepare_respawn_replacement(&self, reason: ResetReason) {
        debug_assert!(matches!(
            reason,
            ResetReason::Respawn | ResetReason::EndCredits
        ));
        self.set_client_loaded(false);
        self.send_respawn_packet(&self.get_world(), reason);
    }

    fn send_respawn_packet(&self, world: &World, reason: ResetReason) {
        // 0x01 = keep attributes, 0x02 = keep entity data
        let data_kept = reason.respawn_data_kept();

        self.send_packet(CRespawn {
            dimension_type: world.dimension_type.id() as i32,
            dimension_name: world.key.clone(),
            hashed_seed: world.obfuscated_seed(),
            gamemode: self.game_mode() as u8,
            previous_gamemode: nullable_game_mode_id(self.previous_game_mode()),
            is_debug: false,
            is_flat: world.is_flat,
            has_death_location: false,
            death_dimension_name: None,
            death_location: None,
            portal_cooldown_ticks: self.portal_cooldown(),
            sea_level: world.sea_level,
            data_kept,
        });
    }

    /// Spawns the player into their current world at the given position.
    ///
    /// This is the shared "enter world" path used by initial join, respawn, and
    /// world change. Sends position sync, abilities, inventory, time, weather,
    /// and adds the player to the world as appropriate for the given reason.
    ///
    /// # Panics
    /// Panics if the `advance_time` gamerule is not a bool.
    #[must_use]
    pub(crate) fn spawn(
        self: &Arc<Self>,
        position: DVec3,
        rotation: (f32, f32),
        reason: ResetReason,
    ) -> bool {
        self.spawn_with_velocity(position, rotation, DVec3::ZERO, reason)
    }

    #[must_use]
    pub(crate) fn spawn_with_velocity(
        self: &Arc<Self>,
        position: DVec3,
        rotation: (f32, f32),
        velocity: DVec3,
        reason: ResetReason,
    ) -> bool {
        self.spawn_with_velocity_packet(
            position,
            rotation,
            velocity,
            reason,
            position,
            rotation,
            velocity,
            RelativeMovement::NONE,
        )
    }

    #[must_use]
    #[expect(
        clippy::too_many_arguments,
        reason = "packet-relative teleports must keep resolved and protocol values separate"
    )]
    pub(crate) fn spawn_with_velocity_packet(
        self: &Arc<Self>,
        position: DVec3,
        rotation: (f32, f32),
        velocity: DVec3,
        reason: ResetReason,
        packet_position: DVec3,
        packet_rotation: (f32, f32),
        packet_velocity: DVec3,
        relatives: RelativeMovement,
    ) -> bool {
        let world = self.synchronize_spawn_with_velocity_packet(
            position,
            velocity,
            rotation,
            packet_position,
            packet_velocity,
            packet_rotation,
            relatives,
            true,
        );

        // Add to world / re-enter chunk tracking
        match reason {
            ResetReason::InitialJoin | ResetReason::WorldChange => {
                if reason == ResetReason::WorldChange {
                    log::info!(
                        "Player {} changed world to {}",
                        self.gameprofile.name,
                        world.key
                    );
                }
                world.add_player(self.clone(), reason)
            }
            ResetReason::Respawn | ResetReason::EndCredits => {
                if world.players.get_by_entity_id(self.id()).is_none() {
                    return world.add_respawned_player(self.clone());
                }

                // Same world — re-enter chunk tracking
                world.chunk_map.remove_player(self);
                world.player_area_map.remove_by_entity_id(self.id());
                world.entity_tracker().on_player_leave(self);

                self.send_packet(CGameEvent {
                    event: GameEventType::LevelChunksLoadStart,
                    data: 0.0,
                });
                world.register_respawned_player_entity(self);
                true
            }
        }
    }

    /// Sends the spawn synchronization for a fresh respawn replacement without
    /// inserting it into world indexes. The replacement transaction owns that step.
    pub(crate) fn synchronize_respawn_replacement(
        self: &Arc<Self>,
        position: DVec3,
        rotation: (f32, f32),
    ) {
        self.synchronize_spawn_with_velocity_packet(
            position,
            DVec3::ZERO,
            rotation,
            position,
            DVec3::ZERO,
            rotation,
            RelativeMovement::NONE,
            false,
        );
    }

    #[expect(
        clippy::too_many_arguments,
        reason = "packet-relative teleports must keep resolved and protocol values separate"
    )]
    fn synchronize_spawn_with_velocity_packet(
        self: &Arc<Self>,
        position: DVec3,
        velocity: DVec3,
        rotation: (f32, f32),
        packet_position: DVec3,
        packet_velocity: DVec3,
        packet_rotation: (f32, f32),
        relatives: RelativeMovement,
        resend_player_context: bool,
    ) -> Arc<World> {
        let world = self.get_world();

        self.base.set_position_local(position);
        self.set_rotation(rotation);
        self.set_old_position_to_current();
        self.movement.lock().reset_for_position_sync(position);

        if let Err(error) = self.teleport_with_velocity_packet(
            position,
            velocity,
            rotation,
            packet_position,
            packet_velocity,
            packet_rotation,
            relatives,
        ) {
            panic!(
                "failed to synchronize player {} spawn position: {error}",
                self.id()
            );
        }
        self.reset_flying_ticks();
        self.send_spawn_state_packets(&world);
        self.reset_sent_info();
        if resend_player_context {
            self.server().resend_player_context(self);
        }
        self.send_active_effects_for_self();
        world
    }

    fn send_spawn_state_packets(&self, world: &World) {
        self.send_abilities();
        self.send_packet(CSetHeldSlot {
            slot: i32::from(self.inventory.lock().get_selected_slot()),
        });
        self.send_time_sync(world);
        self.send_packet(world.initialize_border_packet());
        self.send_default_spawn_position(world);
        self.send_weather_sync(world);
    }

    fn send_time_sync(&self, world: &World) {
        self.send_packet(world.time_sync_packet());
    }

    fn send_default_spawn_position(&self, world: &World) {
        if let Some(server) = self.server.upgrade() {
            match server.respawn_data_for_domain(world.domain()) {
                Ok(respawn_data) => {
                    self.send_packet(CSetDefaultSpawnPosition {
                        global_pos: respawn_data.global_pos,
                        yaw: respawn_data.yaw,
                        pitch: respawn_data.pitch,
                    });
                }
                Err(error) => {
                    log::error!(
                        "Failed to send default spawn position to player {}: {error}",
                        self.gameprofile.name
                    );
                }
            }
        }
    }

    fn send_weather_sync(&self, world: &World) {
        if !world.can_have_weather() || !world.is_raining() {
            return;
        }

        let (rain_level, thunder_level) = {
            let weather = world.weather.lock();
            (weather.rain_level, weather.thunder_level)
        };

        self.send_packet(CGameEvent {
            event: GameEventType::StartRaining,
            data: 0.0,
        });
        self.send_packet(CGameEvent {
            event: GameEventType::RainLevelChange,
            data: rain_level,
        });
        self.send_packet(CGameEvent {
            event: GameEventType::ThunderLevelChange,
            data: thunder_level,
        });
    }

    pub(in crate::player) fn passenger_ids_for_packet(entity: &dyn Entity) -> Vec<i32> {
        entity
            .passengers()
            .iter()
            .map(|passenger| passenger.id())
            .collect()
    }

    pub(in crate::player) fn send_mob_effect_sync_packet(&self, packet: MobEffectSyncPacket) {
        match packet {
            MobEffectSyncPacket::Update(packet) => self.send_packet(packet),
            MobEffectSyncPacket::Remove(packet) => self.send_packet(packet),
        }
    }

    fn send_active_effects_for_self(&self) {
        for effect in self.living_base.active_mob_effects() {
            self.send_mob_effect_sync_packet(
                MobEffectSyncChange::Update {
                    effect,
                    blend_for_self: false,
                }
                .packet(self.id(), true),
            );
        }
    }

    pub(in crate::player) fn send_active_effects_for_vehicle(&self, vehicle: &dyn Entity) {
        let Some(living_vehicle) = vehicle.as_living_entity() else {
            return;
        };
        for effect in living_vehicle.active_mob_effects() {
            self.send_mob_effect_sync_packet(
                MobEffectSyncChange::Update {
                    effect,
                    blend_for_self: false,
                }
                .packet(vehicle.id(), false),
            );
        }
    }

    pub(crate) fn send_restored_vehicle_mount_sync(&self, vehicle: &dyn Entity) {
        self.send_active_effects_for_vehicle(vehicle);
        self.send_packet(CSetPassengers::new(
            vehicle.id(),
            Self::passenger_ids_for_packet(vehicle),
        ));
    }

    pub(in crate::player) fn remove_active_effects_for_vehicle(&self, vehicle: &dyn Entity) {
        let Some(living_vehicle) = vehicle.as_living_entity() else {
            return;
        };
        for effect in living_vehicle.active_mob_effects() {
            self.send_mob_effect_sync_packet(
                MobEffectSyncChange::Remove {
                    effect: effect.effect(),
                }
                .packet(vehicle.id(), false),
            );
        }
    }
}

pub(in crate::player) fn nullable_game_mode_id(game_mode: Option<GameType>) -> i8 {
    game_mode.map_or(-1, |game_mode| game_mode as i8)
}