Skip to content

Commit

Permalink
world docs: corrected to 'world', not 'server' (#191)
Browse files Browse the repository at this point in the history
These functions access only the world itself's current players, and thus
the old documentation was incorrect saying that it accesses the server's
online players.
  • Loading branch information
lokka30 authored Oct 26, 2024
1 parent 29b3c82 commit 5a1c245
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions pumpkin/src/world/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ impl World {

/// Broadcasts a packet to all connected players within the world.
///
/// Sends the specified packet to every player currently logged in to the server.
/// Sends the specified packet to every player currently logged in to the world.
///
/// **Note:** This function acquires a lock on the `current_players` map, ensuring thread safety.
pub async fn broadcast_packet_all<P>(&self, packet: &P)
Expand All @@ -89,7 +89,7 @@ impl World {

/// Broadcasts a packet to all connected players within the world, excluding the specified players.
///
/// Sends the specified packet to every player currently logged in to the server, excluding the players listed in the `except` parameter.
/// Sends the specified packet to every player currently logged in to the world, excluding the players listed in the `except` parameter.
///
/// **Note:** This function acquires a lock on the `current_players` map, ensuring thread safety.
pub async fn broadcast_packet_expect<P>(&self, except: &[uuid::Uuid], packet: &P)
Expand Down

0 comments on commit 5a1c245

Please sign in to comment.