Code Patterns

Copy-paste examples for common plugin tasks. Commands, events, ECS, GUI, and more.

All 225 Command 60 Damage 2 Ecs 27 Entity 5 Gui 75 Interaction 2 Inventory 4 Moderation 3 Permission 2 Player 9 Plugin 4 Storage 2 Teleport 3 Ui 22 Util 5
← Back to Patterns
ui

Play Sound

Play sounds to players using SoundUtil.

Example Code

java 
Player player = store.getComponent(ref, Player.getComponentType());
World world = player.getWorld();
EntityStore entityStore = world.getEntityStore();
Ref<EntityStore> playerRef = player.getReference();

// Get sound index
int soundIndex = SoundEvent.getAssetMap().getIndex("SFX_Cactus_Large_Hit");

world.execute(() -> {
    // Get player position
    TransformComponent transform = entityStore.getStore().getComponent(
        playerRef,
        EntityModule.get().getTransformComponentType()
    );

    // Play sound at player position
    SoundUtil.playSoundEvent3dToPlayer(
        playerRef,
        soundIndex,
        SoundCategory.UI,  // or SFX, Music, Ambient
        transform.getPosition(),
        entityStore.getStore()
    );
});

Thread Safety

Must run inside world.execute() block.

Common Mistakes

Playing sound outside world.execute(). Using wrong sound name.