Class BeforeChatEvent`Beta`

Hierarchy (View Summary)

ChatEvent
- BeforeChatEvent

Index

Constructors

Properties

cancel message sender sendToTargets

Methods

getTargets setTargets

Constructors

`Protected`constructor

new BeforeChatEvent(): BeforeChatEvent
Beta
Returns BeforeChatEvent
Overrides ChatEvent.constructor

Properties

`Beta`cancel

cancel: boolean

Remarks

This property can't be edited in read-only mode.

`Beta`message

message: string

Remarks

This property can't be edited in read-only mode.

`Beta`sender

sender: Player

Remarks

This property can't be edited in read-only mode.

`Beta`sendToTargets

sendToTargets: boolean

Remarks

This property can't be edited in read-only mode.

Methods

getTargets

getTargets(): Player[]
Beta
Returns Player[]
Remarks
Returns a list of players that will receive this message.

This function can't be called in read-only mode.

Inherited from ChatEvent.getTargets

setTargets

setTargets(players: Player[]): void
Beta
Parameters
- players: Player[]
Returns void
Remarks
Updates a list of players that will receive this message.

This function can't be called in read-only mode.