Class andexdb_ModifiedChatMessageSendBeforeEvent

An event that fires before a modified chat message is sent.

This is triggered by the chat ranks system of the add-on, if the chat ranks system is disabled this event will never fire.

Implements

ChatSendBeforeEvent

Index

Constructors

constructor

Properties

cancel formatOptions message nameTag originalMessage sender targets? tokenData

Constructors

constructor

new andexdb_ModifiedChatMessageSendBeforeEvent(
data: andexdb_ModifiedChatMessageSendBeforeEvent,
strict?: boolean,
): andexdb_ModifiedChatMessageSendBeforeEvent
Creates a new andexdb_ModifiedChatMessageSendBeforeEvent instance.
Parameters
- data: andexdb_ModifiedChatMessageSendBeforeEvent
  The data for the event.
- Optionalstrict: boolean = true
  Whether to enable strict mode. In strict mode, the event will throw an error if invalid data is provided. Defaults to true.
Returns andexdb_ModifiedChatMessageSendBeforeEvent
Throws
If the number of arguments passed to this constructor is not 1.

Throws
If the data parameter is null.

Throws
If the data parameter is not an object.

Throws
If the cancel property in data is not a boolean.

Throws
If the message property in data is not a string.

Throws
If the sender property in data is not an instance of Player.

Throws
If the newMessage property in data is not a string.

Throws
If the cancel property in data is not a boolean.

Throws
If the message property in data is not a string.

Throws
If the sender property in data is not an instance of Player.

Throws
If the newMessage property in data is not a string.

Throws
If the targets property in data is not undefined or an array.

Implements
- Defined in init/classes/events.ts:5172

Properties

cancel

cancel: boolean

Remarks

If set to true, the message will not be sent.

Default

false

`Readonly`formatOptions

formatOptions: TagChatMessageFormat & {
    allowEval: boolean;
    dimension:
        | "overworld"
        | "nether"
        | "the_end"
        | "minecraft:overworld"
        | "minecraft:nether"
        | "minecraft:the_end";
    isPlaceholderPlayer?: boolean;
    player?: Player;
    playerPersonalSettings: {
        chatNameAndMessageSeparator?: string;
        chatRankPrefix?: string;
        defaultMessageFormatting?: string;
        defaultNameFormatting?: string;
        defaultSeparatorFormatting?: string;
        hideChatDisplayTimeStamp?: boolean;
        nameDisplayPrefix?: string;
        nameDisplaySuffix?: string;
        rankDisplayPrefix?: string;
        rankDisplaySeparator?: string;
        rankDisplaySuffix?: string;
    };
    ranks?: string[];
    tags?: string[];
    time?: number;
}

Type declaration

ReadonlyallowEval: boolean
Remarks
Whether eval was allowed.
Default
```
true
```
Readonlydimension:
    | "overworld"
    | "nether"
    | "the_end"
    | "minecraft:overworld"
    | "minecraft:nether"
    | "minecraft:the_end"
The type ID of the dimension that the player was in.
Optional ReadonlyisPlaceholderPlayer?: boolean
Remarks
Whether the sender was a placeholder player.
Optional Readonlyplayer?: Player
Remarks
The sender.
ReadonlyplayerPersonalSettings: {
    chatNameAndMessageSeparator?: string;
    chatRankPrefix?: string;
    defaultMessageFormatting?: string;
    defaultNameFormatting?: string;
    defaultSeparatorFormatting?: string;
    hideChatDisplayTimeStamp?: boolean;
    nameDisplayPrefix?: string;
    nameDisplaySuffix?: string;
    rankDisplayPrefix?: string;
    rankDisplaySeparator?: string;
    rankDisplaySuffix?: string;
}
The personal settings for the player that were used.
- Optional ReadonlychatNameAndMessageSeparator?: string
  The players default name and message separator that was used.
  
  If it was specified it was used instead of the global chat name and message separator.
  See
  config.chatRanks.chatNameAndMessageSeparator
  Default
```
undefined
```
- Optional ReadonlychatRankPrefix?: string
  The players default chat rank prefix that was used.
  
  If it was specified it was used instead of the global chat rank prefix.
  See
  config.chatRanks.chatRankPrefix
  Default
```
undefined
```
- Optional ReadonlydefaultMessageFormatting?: string
  The default message formatting for the player that was used.
  
  This was be used if no other message formatting was found.
  Default
```
undefined
```
- Optional ReadonlydefaultNameFormatting?: string
  The default name formatting for the player that was used.
  
  This was be used if no other message formatting was found.
  Default
```
undefined
```
- Optional ReadonlydefaultSeparatorFormatting?: string
  The default separator formatting for the player that was used.
  
  This was be used if no other message formatting was found.
  Default
```
undefined
```
- Optional ReadonlyhideChatDisplayTimeStamp?: boolean
  If it was set to true, the player's message time stamp was hidden.
- Optional ReadonlynameDisplayPrefix?: string
  The players default name display prefix that was used.
  
  If it was specified it was used instead of the global chat name display prefix.
  See
  config.chatRanks.nameDisplayPrefix
  Default
```
undefined
```
- Optional ReadonlynameDisplaySuffix?: string
  The players default name display suffix that was used.
  
  If it was specified it was used instead of the global chat name display suffix.
  See
  config.chatRanks.nameDisplaySuffix
  Default
```
undefined
```
- Optional ReadonlyrankDisplayPrefix?: string
  The players default rank display prefix that was used.
  
  If it was specified it was used instead of the global chat rank display prefix.
  See
  config.chatRanks.rankDisplayPrefix
  Default
```
undefined
```
- Optional ReadonlyrankDisplaySeparator?: string
  The players default rank display separator that was used.
  
  If it was specified it was used instead of the global chat rank display separator.
  See
  config.chatRanks.rankDisplaySeparator
  Default
```
undefined
```
- Optional ReadonlyrankDisplaySuffix?: string
  The players default rank display suffix that was used.
  
  If it was specified it was used instead of the global chat rank display suffix.
  See
  config.chatRanks.rankDisplaySuffix
  Default
```
undefined
```
Optional Readonlyranks?: string[]
The ranks that the player had.
Optional Readonlytags?: string[]
The tags that the player had.
Optional Readonlytime?: number
The time that the message was sent.

This was used for the message time stamp.

Remarks

The options that were used to format the message, see TagChatMessageFormat.

message

message: string

Remarks

The fully modified chat message, including ranks, prefixes, etc.

Modifications to this property will change what is sent.

The final message printed to the chat will be exactly what this string is set to.

`Readonly`nameTag

nameTag: {
    hidden: boolean;
    sourceType: "name" | "hidden" | "sudo" | "nameTag";
    value?: string;
}

Type declaration

Readonlyhidden: boolean
Whether the name tag was hidden.
ReadonlysourceType: "name" | "hidden" | "sudo" | "nameTag"
The type of the name tag that was used.

hidden - The name tag was hidden.

sudo - The name tag was from the player's sudo tag.

nameTag - The name tag was the player's name tag.

name - The name tag was the player's name.
Optional Readonlyvalue?: string
The player's evaluated name tag string that was used.

Remarks

The sender's evaluated name tag that was used.

`Readonly`originalMessage

originalMessage: string

Remarks

The original chat message.

`Readonly`sender

sender: Player

Remarks

Player that sent the chat message.

`Optional` `Readonly`targets

targets?: Player[]

Remarks

Optional list of players that will receive this message. If defined, this message is directly targeted to one or more players (i.e., is not broadcast.)

`Readonly`tokenData

tokenData: chatSendMessageEvaluator_prePlayersOutput

Remarks

The evaluated message format token data that was used.

Class andexdb_ModifiedChatMessageSendBeforeEvent

Implements

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns andexdb_ModifiedChatMessageSendBeforeEvent

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Implements

Properties

cancel

Remarks

Default

ReadonlyformatOptions

Type declaration

ReadonlyallowEval: boolean

Remarks

Default

Readonlydimension: | "overworld" | "nether" | "the_end" | "minecraft:overworld" | "minecraft:nether" | "minecraft:the_end"

Optional ReadonlyisPlaceholderPlayer?: boolean

Remarks

Optional Readonlyplayer?: Player

Remarks

Optional ReadonlychatNameAndMessageSeparator?: string

See

Default

Optional ReadonlychatRankPrefix?: string

See

Default

Optional ReadonlydefaultMessageFormatting?: string

Default

Optional ReadonlydefaultNameFormatting?: string

Default

Optional ReadonlydefaultSeparatorFormatting?: string

Default

Optional ReadonlyhideChatDisplayTimeStamp?: boolean

Optional ReadonlynameDisplayPrefix?: string

See

Default

Optional ReadonlynameDisplaySuffix?: string

See

Default

Optional ReadonlyrankDisplayPrefix?: string

See

Default

Optional ReadonlyrankDisplaySeparator?: string

See

Default

Optional ReadonlyrankDisplaySuffix?: string

See

Default

Optional Readonlyranks?: string[]

Optional Readonlytags?: string[]

Optional Readonlytime?: number

Remarks

message

Remarks

ReadonlynameTag

Type declaration

Readonlyhidden: boolean

ReadonlysourceType: "name" | "hidden" | "sudo" | "nameTag"

Optional Readonlyvalue?: string

Remarks

ReadonlyoriginalMessage

Remarks

Readonlysender

Remarks

`Readonly`formatOptions

`Readonly`allowEval: boolean

`Readonly`dimension:
| "overworld"
| "nether"
| "the_end"
| "minecraft:overworld"
| "minecraft:nether"
| "minecraft:the_end"

`Optional` `Readonly`isPlaceholderPlayer?: boolean

`Optional` `Readonly`player?: Player

`Optional` `Readonly`chatNameAndMessageSeparator?: string

`Optional` `Readonly`chatRankPrefix?: string

`Optional` `Readonly`defaultMessageFormatting?: string

`Optional` `Readonly`defaultNameFormatting?: string

`Optional` `Readonly`defaultSeparatorFormatting?: string

`Optional` `Readonly`hideChatDisplayTimeStamp?: boolean

`Optional` `Readonly`nameDisplayPrefix?: string

`Optional` `Readonly`nameDisplaySuffix?: string

`Optional` `Readonly`rankDisplayPrefix?: string

`Optional` `Readonly`rankDisplaySeparator?: string

`Optional` `Readonly`rankDisplaySuffix?: string

`Optional` `Readonly`ranks?: string[]

`Optional` `Readonly`tags?: string[]

`Optional` `Readonly`time?: number

`Readonly`nameTag

`Readonly`hidden: boolean

`Readonly`sourceType: "name" | "hidden" | "sudo" | "nameTag"

`Optional` `Readonly`value?: string

`Readonly`originalMessage

`Readonly`sender

`Optional` `Readonly`targets

`Readonly`tokenData