Struct SignBlockEntity 

pub struct SignBlockEntity {
    base: BlockEntityBase,
    sign: SyncMutex<SignState>,
}

Sign block entity.

Stores text on both front and back sides of the sign.

Fields

base: BlockEntityBase

sign: SyncMutex<SignState>

Implementations

impl SignBlockEntity

pub fn new(level: Weak<World>, pos: BlockPos, state: BlockStateId) -> Self

Creates a new sign block entity.

pub fn new_hanging( level: Weak<World>, pos: BlockPos, state: BlockStateId, ) -> Self

Creates a new hanging sign block entity.

pub fn with_type( level: Weak<World>, block_entity_type: BlockEntityTypeRef, pos: BlockPos, state: BlockStateId, ) -> Self

Creates a sign block entity with a specific type.

pub fn get_player_who_may_edit(&self) -> Option<Uuid>

Gets the UUID of the player currently allowed to edit this sign.

pub fn set_player_who_may_edit(&self, player: Option<Uuid>)

Sets the player allowed to edit this sign.

pub fn is_other_player_editing(&self, player_uuid: Uuid) -> bool

Checks if another player (not the given one) is currently editing this sign.

pub fn get_text(&self, slot: SignTextSlot) -> SignText

Gets the text for a side.

pub fn is_waxed(&self) -> bool

Returns whether this sign is waxed.

pub fn wax(&self) -> bool

Makes this sign waxed, returning whether its state changed.

pub fn set_glowing(&self, slot: SignTextSlot, glowing: bool) -> bool

Sets whether a side’s text glows, returning whether its state changed.

pub fn set_color(&self, slot: SignTextSlot, color: DyeColor) -> bool

Sets the text color for a side, returning whether its state changed.

pub fn sign_interaction_failed_sound_event(&self) -> SoundEventRef

Returns the sound event to play when a player fails to interact with this waxed sign.

pub fn set_text(&self, text: SignText, slot: SignTextSlot)

Sets the text for a side.

Trait Implementations

impl BlockEntity for SignBlockEntity

fn base(&self) -> &BlockEntityBase

Returns the common metadata owned by this block entity.

fn load_additional(&self, nbt: &BorrowedNbtCompound<'_>)

Loads additional data from NBT.

fn apply_implicit_components( &self, components: &mut ImplicitComponentGetter<'_>, )

Reads the components this entity represents through its own fields.

fn save_additional(&self, nbt: &mut NbtCompound)

Saves additional data to NBT.

fn get_update_tag(&self) -> Option<NbtCompound>

Returns the NBT data to send to clients for initial sync.

fn tick(&self, world: &Arc<World>)

Called every game tick for ticking block entities.

fn get_type(&self) -> BlockEntityTypeRef

Returns the type of this block entity.

fn get_block_pos(&self) -> BlockPos

Returns the position of this block entity in the world.

fn get_block_state(&self) -> BlockStateId

Returns the current block state associated with this entity.

fn is_valid_block_state(&self, state: BlockStateId) -> bool

Returns whether this entity’s registered type accepts state.

fn on_block_state_changed(&self, _state: BlockStateId)

Called after the cached block state changes.

fn on_set_removed(&self)

Called after each invocation that marks this entity removed.

fn on_clear_removed(&self)

Called after this entity transitions from removed back to active.

fn set_changed(&self)

Called when the block entity’s data changes.

fn get_level(&self) -> Option<Arc<World>>

Gets the world reference if still valid.

fn trigger_event(&self, _param_a: i32, _param_b: i32) -> bool

Handles a block event delegated by the owning block behavior.

fn as_spawner(&self) -> Option<&dyn Spawner>

Returns this block entity as a spawner.

fn pre_remove_side_effects(&self, pos: BlockPos, state: BlockStateId)

Called before the block entity is removed to handle side effects.

fn load_with_components(&self, nbt: &BorrowedNbtCompound<'_>)

Loads entity-specific data and the base block-entity component map.

fn collect_implicit_components(&self, _components: &mut DataComponentMap)

Adds the components this entity represents through its own fields.

fn apply_components_from_item_stack(&self, stack: &ItemStack)

Applies the placed stack’s components: implicit ones through Self::apply_implicit_components, the rest into the stored component map.

fn collect_components(&self) -> DataComponentMap

Returns the stored components together with the implicit ones.

fn load_with_owned_components(&self, nbt: &NbtCompound) -> Result<(), Error>

Loads entity data from an owned command/runtime compound.

fn save_custom_only(&self) -> NbtCompound

Saves only entity-specific data, excluding vanilla type and position metadata.

fn save_without_metadata(&self) -> NbtCompound

Saves entity-specific data and stored components without position/type metadata.

fn save_with_full_metadata(&self) -> NbtCompound

Saves command-visible data together with vanilla block-entity metadata.

fn container_ref(&self) -> Option<ContainerRef>

Returns the independently lockable container capability owned by this entity.

fn game_event_listener(&self) -> Option<SharedGameEventListener>

Returns this entity’s fixed game-event listener, if it provides one.

impl DowncastType for SignBlockEntity

const TYPE_KEY: DowncastTypeKey

The process-wide key for this concrete type.