API ReferenceSandbox

ChatMessageEventclass

A chat message event. Handlers can set `Sandbox.ChatMessageEvent.Suppress` to true to prevent the message from being delivered, or set `Sandbox.ChatMessageEvent.RecipientFilter` to control per-connection visibility.

object→ChatMessageEvent

Namespace: Sandbox
Assembly: Sandbox.Engine
Declaration: public class Sandbox.ChatMessageEvent

Constructors1

Showing 1 constructors

public ChatMessageEvent()PUBLICCONSTRUCTOR

Properties4

Showing 4 properties

public string Sandbox.ChatMessageEvent.Message { get; set; }PUBLICGETSET

The chat message text.

Returns:string—

public System.Func`2<Sandbox.Connection,bool> Sandbox.ChatMessageEvent.RecipientFilter { get; set; }PUBLICGETSET

Optional per-connection visibility predicate. Return false to prevent a specific connection from receiving the message.

Returns:Func<Connection,bool>—

public Sandbox.Connection Sandbox.ChatMessageEvent.Sender { get; set; }PUBLICGETSET

The connection that sent this message. Null for system messages.

Returns:Connection—

public bool Sandbox.ChatMessageEvent.Suppress { get; set; }PUBLICGETSET

Set to true to prevent this message from being delivered.

Returns:bool—

→Platform Chat

TryMoveWithStep()

Message

Constructors

public ChatMessageEvent()

Properties

public System.String Sandbox.ChatMessageEvent.Message { get; set; }

public System.Func`2<Sandbox.Connection,System.Boolean> Sandbox.ChatMessageEvent.RecipientFilter { get; set; }

public Sandbox.Connection Sandbox.ChatMessageEvent.Sender { get; set; }

public System.Boolean Sandbox.ChatMessageEvent.Suppress { get; set; }

Metadata

ChatMessageEventclass

Constructors1

Properties4

Related Guides

On this page