Show / Hide Table of Contents

Class MessagingCommands

Messaging commands related to chat itself, also mail and notification commands

Inheritance
System.Object
MessagingCommands
Namespace: Eco.Gameplay.Systems.Messaging.Chat.Commands
Assembly: Eco.Gameplay.dll
Syntax
[ChatCommandHandler]
public static class MessagingCommands : Object

Methods

ChannelSend(User, String, Channel, User)

Declaration
[ChatSubCommand]
public static void ChannelSend(User user, string text, Channel channel, User fromUser)
Parameters
Type Name Description
User user
System.String text
Channel channel
User fromUser

Chat()

Declaration
[ChatCommand]
public static void Chat()

ChatInteraction(User, Boolean, Single, Boolean)

Declaration
[ChatSubCommand]
public static void ChatInteraction(User user, bool enableGeneralMessages, float timeBtwMessages = 1F, bool enableWhisperMessages = false)
Parameters
Type Name Description
User user
System.Boolean enableGeneralMessages

Enable sending messages from a test user to the general channel periodically.

System.Single timeBtwMessages

Specify the delay time between messages.

System.Boolean enableWhisperMessages

Enable sending messages from a test user to the current user periodically.

ClearHistoryOlderThan(User, Int32)

Declaration
[ChatSubCommand]
public static void ClearHistoryOlderThan(User user, int preserveDays)
Parameters
Type Name Description
User user
System.Int32 preserveDays

Help(IChatClient, SupportedLanguage, String)

Declaration
[ChatCommand]
public static void Help(IChatClient chatClient, SupportedLanguage language, string text = "")
Parameters
Type Name Description
IChatClient chatClient
SupportedLanguage language
System.String text

Helpful(IChatClient, SupportedLanguage)

Declaration
[ChatCommand("Shows all help, including sub commands.")]
public static void Helpful(IChatClient chatClient, SupportedLanguage language)
Parameters
Type Name Description
IChatClient chatClient
SupportedLanguage language

Mail(User, String, User)

Declaration
[ChatSubCommand]
public static void Mail(User user, string text, User targetUser = null)
Parameters
Type Name Description
User user
System.String text
User targetUser

Notifications()

Declaration
[ChatCommand]
public static void Notifications()

PrivateSend(User, String, User)

Declaration
[ChatSubCommand]
public static void PrivateSend(User user, string text, User fromUser)
Parameters
Type Name Description
User user
System.String text
User fromUser
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾