Struct Player 

pub struct Player {
    pub name: String,
}

An online player, by name: every action whose first field is player.

Fields

name: String

Implementations

impl Player

pub fn new(name: impl Into<String>) -> Player

pub fn entity(&self) -> Option<Entity>

The player as an entity (its uuid asked of the server); None offline.

impl Player

pub fn tellraw(&self, json: impl Arg<String>) -> bool

Sends json (a text component) to player’s chat.

impl Player

pub fn title( &self, title: impl Arg<String>, subtitle: impl Arg<String>, fade_in: impl Arg<i32>, stay: impl Arg<i32>, fade_out: impl Arg<i32>, ) -> bool

Shows a title (and subtitle) to player; times in ticks.

impl Player

pub fn actionbar(&self, message: impl Arg<String>) -> bool

Shows message above player’s hotbar.

impl Player

pub fn actionbar_json(&self, json: impl Arg<String>) -> bool

Shows a text component above player’s hotbar.

impl Player

pub fn send_to_player( &self, channel: impl Arg<String>, payload: impl Arg<Vec<u8>>, ) -> bool

Sends payload on channel to player (server side).

impl Player

pub fn give_item(&self, item: impl Arg<String>, count: impl Arg<u32>) -> bool

Gives player count of item.

impl Player

pub fn teleport(&self, pos: impl Arg<Point>) -> bool

Moves player in its dimension.

impl Player

pub fn teleport_to_dim( &self, dim: impl Arg<String>, pos: impl Arg<Point>, ) -> bool

Moves player to pos in dim.

impl Player

pub fn kick(&self, reason: impl Arg<String>) -> bool

Disconnects player.

impl Player

pub fn set_gamemode(&self, mode: impl Arg<String>) -> bool

Sets player’s game mode (survival, creative, …).

impl Player

pub fn inventory(&self) -> Vec<SlotStack>

player’s inventory: its stacks, by slot.

impl Player

pub fn set_slot( &self, slot: impl Arg<u32>, item: impl Arg<String>, count: impl Arg<u32>, ) -> bool

Sets inventory slot of player.

impl Player

pub fn held_item_nbt(&self) -> Option<String>

The custom data (SNBT) of what player holds.

impl Player

pub fn set_held_item_nbt(&self, snbt: impl Arg<String>) -> bool

Sets the custom data of what player holds.

impl Player

pub fn offhand_item_nbt(&self) -> Option<String>

The custom data (SNBT) of player’s offhand stack.

impl Player

pub fn set_offhand_item_nbt(&self, snbt: impl Arg<String>) -> bool

Sets the custom data of player’s offhand stack.

impl Player

pub fn slot_item(&self, slot: impl Arg<u32>) -> Option<Stack>

The stack in slot.

impl Player

pub fn set_slot_item( &self, slot: impl Arg<u32>, item: impl Arg<String>, count: impl Arg<u32>, snbt: impl Arg<String>, ) -> bool

Sets the stack in slot, with custom data.

impl Player

pub fn add_xp(&self, amount: impl Arg<i32>) -> bool

Gives player experience points.

impl Player

pub fn set_may_fly(&self, may_fly: impl Arg<bool>) -> bool

Lets player fly (or not).

impl Player

pub fn info(&self) -> Option<PlayerInfo>

player’s state.

impl Player

pub fn set_item_cooldown( &self, item: impl Arg<String>, ticks: impl Arg<i32>, ) -> bool

Puts item on cooldown for player.

impl Player

pub fn place_block_from_slot( &self, slot: impl Arg<u32>, dim: impl Arg<String>, pos: impl Arg<BlockPos>, ) -> bool

Places the block of slot’s stack at pos, as player would.

impl Player

pub fn play_to_player( &self, sound: impl Arg<String>, volume: impl Arg<f32>, pitch: impl Arg<f32>, ) -> bool

Plays sound to player only.

Trait Implementations

impl Clone for Player

fn clone(&self) -> Player

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Player

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for Player

impl Hash for Player

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Player

fn eq(&self, other: &Player) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Player