Called when a chat message is about to be sent by an object. More...

Inheritance diagram for Anvil.API.Events.OnChatMessageSend:

Collaboration diagram for Anvil.API.Events.OnChatMessageSend:

Properties
ChatChannel	ChatChannel `[get]`
	Gets the chat channel that the message was sent to. More...

string	Message = null! `[get]`
	Gets the message to be sent. More...

NwObject?	Sender `[get]`
	Gets the sender of this message. More...

bool	Skip `[get, set]`
	Skips this chat message. More...

NwPlayer?	Target `[get]`
	Gets the target of this message. Returns null if there is no target. More...

Properties inherited from Anvil.API.Events.IEvent
NwObject?	Context `[get]`

Detailed Description

Called when a chat message is about to be sent by an object.

Property Documentation

ChatChannel Anvil.API.Events.OnChatMessageSend.ChatChannel

get

Gets the chat channel that the message was sent to.

string Anvil.API.Events.OnChatMessageSend.Message = null!

get

Gets the message to be sent.

NwObject? Anvil.API.Events.OnChatMessageSend.Sender

get

Gets the sender of this message.

May be null when the message is sent by the server, e.g. with the nwscript function SendMessageToAllDMs.

bool Anvil.API.Events.OnChatMessageSend.Skip

getset

Skips this chat message.

NwPlayer? Anvil.API.Events.OnChatMessageSend.Target

get

Gets the target of this message.
Returns null if there is no target.

The documentation for this class was generated from the following file: