Skip to content

Feature - Emotes API#286

Open
ItsNature wants to merge 2 commits into
version/1.2.7from
feature/emotes
Open

Feature - Emotes API#286
ItsNature wants to merge 2 commits into
version/1.2.7from
feature/emotes

Conversation

@ItsNature
Copy link
Copy Markdown
Collaborator

@ItsNature ItsNature commented May 28, 2026

Overview

Description:
Adds NPC emote support to the Cosmetic module, allowing servers to play, stop, and reset emotes on NPC entities. Also adds a copyLocalCosmetics option to the NPC equip flow so an NPC can mirror each recipient's own equipped
cosmetics.

Changes:

  • New Emote builder (id & metadata).
  • New CosmeticModule API:
    • startNpcEmote(Recipients, UUID, Emote)
    • stopNpcEmote(Recipients, UUID)
    • resetNpcEmotes(Recipients)
    • equipNpcCosmetics(Recipients, UUID, List<Cosmetic>, boolean copyLocalCosmetics)

Code Example:
Equip cosmetics on an NPC, copying the recipient's own cosmetics

public void equipNpcCosmeticsCopyLocalExample(UUID npcUuid) {
    this.cosmeticModule.equipNpcCosmetics(Recipients.ofEveryone(), npcUuid, new ArrayList<>(), true);
}

Start an emote on an NPC

public void startNpcEmoteExample(UUID npcUuid) {
    Emote emote = Emote.builder()
        .id(56)
        .build();

    this.cosmeticModule.startNpcEmote(Recipients.ofEveryone(), npcUuid, emote);
}

Review Request Checklist

  • Your code follows the style guidelines of this project.
  • I have performed a self-review of my code.
  • I have tested this change myself. (If applicable)
  • I have made corresponding changes to the documentation. (If applicable)
  • The branch name follows the projects naming conventions. (e.g. feature/add-module & bugfix/fix-issue)

@ItsNature ItsNature added type: Documentation Documentation improvement or issue type: Enhancement Feature improvement or addition labels May 28, 2026
@ItsNature ItsNature mentioned this pull request May 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: Documentation Documentation improvement or issue type: Enhancement Feature improvement or addition

Development

Successfully merging this pull request may close these issues.

2 participants