Skip to content

Chat

player-message.chat

The chat module is responsible for separating chat rooms, their functionality and display.

You can customize the chat list in config.yml in the player-message.chat.list list

(example) 3 chats: local, global, custom
yaml
    chat:
      list:
        local: # chat name 
          enable: true
          priority: 0
          features: [swear-protection, patterns, formatting]
          worlds: []
          format: "<player_name_display>&&2: <message>"

          range: 100

          no-recipients:
            enable: true

          prefix:
            cleared: true
            trigger: ""

          set-cancelled: true

        global: # chat name 
          enable: true
          priority: 5
          features: [swear-protection, patterns, formatting, mention]
          worlds: []
          format: "<player_name_display>&&2 » <message>"

          range: 0

          no-recipients:
            enable: true

          prefix:
            cleared: true
            trigger: "!"

          set-cancelled: false
        custom: # chat name 
          enable: true
          priority: 5
          features: []
          worlds: []
          format: "<player_name_display>&c » <message>"

          range: 0

          no-recipients:
            enable: true

          prefix:
            cleared: true
            trigger: "!"

          set-cancelled: false
        #...
    chat:
      list:
        local: # chat name 
          enable: true
          priority: 0
          features: [swear-protection, patterns, formatting]
          worlds: []
          format: "<player_name_display>&&2: <message>"

          range: 100

          no-recipients:
            enable: true

          prefix:
            cleared: true
            trigger: ""

          set-cancelled: true

        global: # chat name 
          enable: true
          priority: 5
          features: [swear-protection, patterns, formatting, mention]
          worlds: []
          format: "<player_name_display>&&2 » <message>"

          range: 0

          no-recipients:
            enable: true

          prefix:
            cleared: true
            trigger: "!"

          set-cancelled: false
        custom: # chat name 
          enable: true
          priority: 5
          features: []
          worlds: []
          format: "<player_name_display>&c » <message>"

          range: 0

          no-recipients:
            enable: true

          prefix:
            cleared: true
            trigger: "!"

          set-cancelled: false
        #...

Important

The most suitable chat by priority and trigger is selected for the player's message
If no chat is found, the message player-message.chat.not-found will be displayed.

Customizing chats

ParameterDescriptionType
enableenable chatboolean
prioritychat priority (the higher the higher the priority)number
featureslist of features that work in chatstring[]
worldsList of names of worlds where chat is available (works if range = 0)string[]
formatformat of the message from the playerstring
rangechat range (in blocks)
0 = server-wide
number
no-recipients.enableEnable message that no one has received a messageboolean
prefix.triggerA character which, when detected, will send a message to the associated chat
An empty string ("") means any message
string
prefix.clearedremove prefix from messageboolean
set-cancelledcancel event messages (for other plugins)boolean