List of the Activators

Activators of ExecutableItems

Here you have the list of activators available with their description and some examples. The activators allow you to execute custom actions, it can have conditions, run commands, have cooldown, etc.

Premium activators are labelled with the tag: PREMIUM

Activator features are features that are exclusive to that activator.

PLAYER_RIGHT_CLICK_ON

• Info: Activator that gets triggered when the player right click on the furniture.

PLAYER_LEFT_CLICK_ON

• Info: Activator that gets triggered when the player left click on the furniture.

PLAYER_ALL_CLICK_ON

• Info: Activator that gets triggered when the player right or left click on the furniture.

PLAYER_BREAK

• Info: Activator that gets triggered when the player broke the furniture.

PLAYER_PLACE

• Info: Activator that gets triggered when the player placed the furniture.

PLAYER_SCROLL_DOWN_BY_TARGETING

• Info: Activator that gets triggered when the player scroll down with this mouse while targeting the furniture.

PLAYER_SCROLL_UP_BY_TARGETING

• Info: Activator that gets triggered when the player scroll up with this mouse while targeting the furniture.

LOOP PREMIUM

• Info: Run commands for the furniture repeatedly at a configurable interval (in ticks).

Display Commands

Display commands are special commands that can be used in activator displayCommands to control the furniture's visual behavior.

RUN_ANIMATION

• Info: Starts a Blockbench animation on the furniture. The static model is hidden and replaced by animated bone entities.
• Usage: RUN_ANIMATION <modelName> <animationName>
• Parameters:
  • <modelName> — The .bbmodel file name without extension (must be in plugins/MyFurniture/animations/)
  • <animationName> — The animation name as defined in Blockbench, or the index (0, 1, 2...)
• Example:

displayCommands:
  - "RUN_ANIMATION ceiling_fan spin"

STOP_ANIMATION

• Info: Stops the currently running animation on the furniture. Removes bone entities and shows the static model again.
• Usage: STOP_ANIMATION
• Example:

displayCommands:
  - "STOP_ANIMATION"

AROUND and MOB_AROUND

• Info: AROUND and MOB_AROUND work in displayCommands, centred on the furniture, in its world. With a LOOP activator, a furniture can have an aura: effects on the players or on the mobs around it.
• Example: every 4 seconds, the players within 5 blocks get Regeneration I, and the zombies, skeletons, creepers and spiders within 6 blocks get Weakness I.

activators:
  aura:
    option: LOOP
    delay: 4
    delayInTick: false
    displayCommands:
      - "AROUND distance:5 displayMsgIfNoPlayer:false effect give %around_target% regeneration 5 0 true"
      - "MOB_AROUND distance:6 displayMsgIfNoEntity:false WHITELIST(ZOMBIE,SKELETON,CREEPER,SPIDER) effect give %around_target_uuid% weakness 5 0 true"

Animation Activator Example

A typical animated furniture setup with right-click to start and left-click to stop:

activators:
  start_animation:
    option: PLAYER_RIGHT_CLICK_ON
    displayName: '&eStart Animation'
    displayCommands:
      - "RUN_ANIMATION ceiling_fan spin"
  stop_animation:
    option: PLAYER_LEFT_CLICK_ON
    displayName: '&cStop Animation'
    displayCommands:
      - "STOP_ANIMATION"