Welcome to the new docs site for Nucleus v2! Still on Nucleus v1? Visit the old site here.
« Return to Documentation Home Page // Notifications Module

Notifications Module

Introduction

The Notifications Module supports broadcasting, titles and action bar messages.

/broadcast customisation

The /broadcast message is prefixed and suffixed by the message templates defined at broadcast-message-template.prefix and broadcast-message-template.suffix. They work the same way as the chat module templates do, please see the Chat Module documentation for more information on creating the templates.

/plainbroadcast does not use these prefixes/suffixes.

/basictitle, /basicsubtitle and /basicactionbar

These commands allow for the use of ampersand encoded strings. They also accept the following flags:

  • -p [player]: The name of the player or a selector that defines who to send the message to. If omitted, sends to all on the server.
  • -i [seconds]: The amount of time taken by the fade in effect, in seconds (does not affect action bar messages).
  • -o [seconds]: The amount of time taken by the fade out effect, in seconds.
  • -t [seconds]: The amount of time taken the message remains on the screen, in seconds.

Tokens in notifications.

Adding a token (such as {{displayname}} or {{name}} to the message will now show each player a personalised message - the tokens will be parsed based on each player rather than the sender. The sender’s name is accessible through the {{sender}} token.

Console and Player

This does not affect how the tokens for the prefix/suffix work - they will still be based on the sender.

For the list of tokens available for use by default, please see this page

The following are incompatibilities that may occur with this module, along with how to resolve the problem. For the full mod/plugin incompatibility list, see the compatibility page.

No plugin incompatibilities have been reported.

/basicactionbar
Module: notification
Send an "Action Bar" message to players.

A message will be sent to the action bar of targeted players. Selectors may be used to target multiple players. The following flags are available:

* -i [time]: time for fade in effect, in seconds
* -o [time]: time for fade out effect, in seconds
* -t [time]: time message should remain on screen, in seconds
* -p [player/selector]: send message to the specified player(s)

Aliases: /basicactionbar

Usage: /basicactionbar [-t <t>] [-i <i>] [-o <o>] [-p <p>] <message…>

Default Role: admin

Basic Command Permission: nucleus.basicactionbar.base

Permissions

  • nucleus.basicactionbar.base - Default Role: admin
    Allows the user to run the command /basicactionbar
/basicsubtitle
Module: notification
Send a Subtitle message to players.

A subtitle message will be sent to the targeted players. Selectors may be used to target multiple players. The following flags are available:

* -i [time]: time for fade in effect, in seconds
* -o [time]: time for fade out effect, in seconds
* -t [time]: time message should remain on screen, in seconds
* -p [player/selector]: send message to the specified player(s)

Aliases: /basicsubtitle

Usage: /basicsubtitle [-t <t>] [-i <i>] [-o <o>] [-p <p>] <message…>

Default Role: admin

Basic Command Permission: nucleus.basicsubtitle.base

Permissions

  • nucleus.basicsubtitle.base - Default Role: admin
    Allows the user to run the command /basicsubtitle
  • nucleus.basicsubtitle.multiple - Default Role: admin
    Allows the user to target multiple players with the command /basicsubtitle
/basictitle
Module: notification
Send a Title message to players.

A title message will be sent to the targeted players. Selectors may be used to target multiple players. The following flags areavailable:

* -i [time]: time for fade in effect, in seconds
* -o [time]: time for fade out effect, in seconds
* -t [time]: time message should remain on screen, in seconds
* -p [player/selector]: send message to the specified player(s)

Aliases: /basictitle

Usage: /basictitle [-t <t>] [-i <i>] [-o <o>] [-p <p>] <message…>

Default Role: admin

Basic Command Permission: nucleus.basictitle.base

Permissions

  • nucleus.basictitle.base - Default Role: admin
    Allows the user to run the command /basictitle
  • nucleus.basictitle.multiple - Default Role: admin
    Allows the user to target multiple players with the command /basictitle
/broadcast
Module: notification
Broadcasts a message to the entire server.

Aliases: /broadcast, /bcast, /bc

Usage: /broadcast <message…>

Default Role: admin

Basic Command Permission: nucleus.broadcast.base

Permissions

  • nucleus.broadcast.base - Default Role: admin
    Allows the user to run the command /broadcast

This command is an equivalent to the following command(s) in Essentials: /broadcast, /bcast

/plainbroadcast
Module: notification
Allows the user to send a broadcast without prefixes or suffixes.

Aliases: /plainbroadcast, /pbcast, /pbc

Usage: /plainbroadcast <message…>

Default Role: admin

Basic Command Permission: nucleus.plainbroadcast.base

Permissions

  • nucleus.plainbroadcast.base - Default Role: admin
    Allows the user to run the command /plainbroadcast
Permission Suggested Role Description
nucleus.basicactionbar.base admin Allows the user to run the command /basicactionbar
nucleus.basicactionbar.multiple admin Allows the user to target multiple players with the command /basicactionbar
nucleus.basicsubtitle.base admin Allows the user to run the command /basicsubtitle
nucleus.basicsubtitle.multiple admin Allows the user to target multiple players with the command /basicsubtitle
nucleus.basictitle.base admin Allows the user to run the command /basictitle
nucleus.basictitle.multiple admin Allows the user to target multiple players with the command /basictitle
nucleus.broadcast.base admin Allows the user to run the command /broadcast
nucleus.plainbroadcast.base admin Allows the user to run the command /plainbroadcast
The following configuration is the default for this module:
                            # The prefix and suffix when sending a broadcast message. Accepts chat tokens such as {{displayname}}, {{name}}, etc.
broadcast-message-template {
    prefix="&a[Broadcast] "
    suffix=""
}
# The defaults when sending a title. All times are in seconds.
title-defaults {
    fade-in=1.0
    fade-out=1.0
    time-on-screen=5.0
}

                        
Search

Downloading search database, this won't take long...