Skip to main content

MerchantRef

Struct MerchantRef 

pub struct MerchantRef(/* private fields */);
Expand description

A villager or wandering trader (vanilla’s AbstractVillager, a Merchant), narrowed from an entity with host.merchant(entity). If a villager’s saved profession is unresolved, offers read empty and merchant mutations are refused until its profession is available again; saved offers are retained.

Implementations§

§

impl MerchantRef

pub fn offers(self, host: &dyn Host) -> Option<Vec<MerchantOffer>>

Side: server. AbstractVillager.getOffers, as they are now (a copy). Offers not rolled yet read as empty: they are rolled when a player first trades, or by add_offer; reading never draws a random.

In a mob’s goal tick (GoalContext::host) this reads the active mob or a disjoint live mob when available; player reads use the game host. Other unsupported reads retain their typed refusal.

pub fn trading_player(self, host: &dyn Host) -> Option<PlayerRef>

Side: server. Merchant.getTradingPlayer: the player whose trading screen is open on it. None when nobody trades, or the screen is the host window’s.

In a mob’s goal tick (GoalContext::host) this reads the active mob or a disjoint live mob when available; player reads use the game host. Other unsupported reads retain their typed refusal.

pub fn profession(self, host: &dyn Host) -> Option<String>

Side: server. VillagerData.profession, a registry id (minecraft:farmer; none is minecraft:none). None for a wandering trader.

In a mob’s goal tick (GoalContext::host) this reads the active mob or a disjoint live mob when available; player reads use the game host. Other unsupported reads retain their typed refusal.

pub fn level(self, host: &dyn Host) -> Option<i32>

Side: server. VillagerData.level, at least 1.

In a mob’s goal tick (GoalContext::host) this reads the active mob or a disjoint live mob when available; player reads use the game host. Other unsupported reads retain their typed refusal.

pub fn villager_type(self, host: &dyn Host) -> Option<String>

Side: server. VillagerData.type, a registry id (minecraft:plains).

In a mob’s goal tick (GoalContext::host) this reads the active mob or a disjoint live mob when available; player reads use the game host. Other unsupported reads retain their typed refusal.

pub fn xp(self, host: &dyn Host) -> Option<i32>

Side: server. Villager.getVillagerXp.

In a mob’s goal tick (GoalContext::host) this reads the active mob or a disjoint live mob when available; player reads use the game host. Other unsupported reads retain their typed refusal.

pub fn set_offer( self, host: &mut dyn ServerHost, index: u32, offer: MerchantOffer, ) -> Result<bool, StackWriteError>

Side: server. Replaces offer index (a player trading with it is sent the new offers). False for an index past the end, a stale handle, or an offer without a real item in base_cost_a or result (or cost_b when set). An invalid count, damage or component maximum refuses the whole write with a typed error.

pub fn add_offer( self, host: &mut dyn ServerHost, offer: MerchantOffer, ) -> Result<bool, StackWriteError>

Side: server. Appends an offer, as getOffers().add(offer) does. Offers not rolled yet are rolled first, as getOffers does for a player’s first trade (this draws the trade set’s world random sequence, as that does). False for a stale handle or an invalid offer (see set_offer).

pub fn remove_offer(self, host: &mut dyn ServerHost, index: u32) -> bool

Side: server. Removes offer index, the ones after it moving up. False for an index past the end or a stale handle.

pub fn set_profession(self, host: &mut dyn ServerHost, profession: &str) -> bool

Side: server. Villager.setVillagerData with a new profession: a different one forgets the offers, which roll again on the next trade. Clients see the new profession through entity data. False for an unknown id, a wandering trader, or a villager with a trading screen open.

pub fn set_level(self, host: &mut dyn ServerHost, level: i32) -> bool

Side: server. VillagerData.withLevel: Math.max(1, level), with no upper limit in vanilla. The offers stay as they are; the next level-up adds its trades (a level past 5 can’t level up). A trading guest’s session follows, and gets the sequences a level-up from the new level needs.

pub fn set_villager_type(self, host: &mut dyn ServerHost, kind: &str) -> bool

Side: server. VillagerData.withType: also the type a trading guest’s session rolls its next level-up offers with. False for an unknown id, a wandering trader, or a trade open where this can’t reach.

pub fn set_xp(self, host: &mut dyn ServerHost, xp: i32) -> bool

Side: server. Villager.setVillagerXp: assigned as given, as vanilla does.

§

impl MerchantRef

pub fn entity(self) -> EntityRef

The same entity as an EntityRef.

Trait Implementations§

§

impl Clone for MerchantRef

§

fn clone(&self) -> MerchantRef

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Copy for MerchantRef

§

impl Debug for MerchantRef

§

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

Formats the value using the given formatter. Read more
§

impl Eq for MerchantRef

§

impl Hash for MerchantRef

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
§

impl PartialEq for MerchantRef

§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
§

impl StructuralPartialEq for MerchantRef

§

impl Wire for MerchantRef

§

const MIN: usize

Minimum encoded size, used to reject impossible collection lengths.
§

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.
§

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.
§

fn take(input: &mut Reader<'_>) -> Result<MerchantRef, WireError>

Decodes one value, leaving any following bytes for the caller.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Put for T
where T: Wire,

§

fn put_to(&self, out: &mut Writer)

Writes it.
§

impl<T> Record for T
where T: Wire,

§

fn encode(&self, out: &mut Writer)

Writes the argument into a hook call.
§

fn apply(&mut self, bytes: &[u8]) -> Result<(), WireError>

Applies one complete reply, refusing malformed or trailing bytes atomically.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.