Vixen
c7401864
csharp
public record class ChatChannelDefinition

A chat channel: who hears it, how it gets there, and what it costs to speak.

Read the guide page for this →

Remarks

Authored, so a game adds a channel by writing a .vxdef. A trade channel, a recruitment channel, a language-specific zone channel and a role-play emote are all this type with different numbers.

⚠ Every member is settable, for the YAML binder's reason — see ModifierDefinition.

Fields and properties (10)

  • public string DisplayName

    What a client shows it as — Guild.

  • public string Command

    What somebody types — /g.

  • public ChatRoute Route

    Which way it goes.

  • public ChatAudienceKind Audience

    How its audience is found.

  • public float Radius

    How far it carries, in metres. Zero for a channel that is not spatial.

  • public int MaximumLength

    The longest message it takes.

  • public int RateLimit

    How many messages one player may send on it in RateWindow. Zero for no limit.

  • public float RateWindow

    How long that window is, in seconds.

  • public string Permission

    A tag the sender must have to speak on it — Guild.Permission.Speak. Empty for none.

  • public List<RequirementDefinition> Requirements

    What else has to be true to speak on it — a level floor against a trade channel.

Methods (1)

  • public override void CollectTags(ICollection<string> tags)

    Every tag this definition mentions, so the content build can bake the tag table.

Used by (8)

  • RealmTestsMmo.Realm.Tests
  • ChatChannelVixen.Gameplay.Chat
  • ChatLibraryVixen.Gameplay.Chat
  • ChatLibraryTestsVixen.Gameplay.Chat.Tests
  • ChatModuleVixen.Gameplay.Chat
  • ContentVixen.Gameplay.Chat.Tests
  • TypeRegistrationVixen.Gameplay.Chat
  • Vixen_Gameplay_Chat_ChatChannelDefinitionSerializerVixen.Gameplay.Chat