Barotrauma Client Doc
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Properties | List of all members
Barotrauma.Networking.ChatMessage Class Reference
Inheritance diagram for Barotrauma.Networking.ChatMessage:
Barotrauma.Networking.OrderChatMessage Barotrauma.Networking.OrderChatMessage

Public Member Functions

string ApplyDistanceEffect (Character listener)
 
int EstimateLengthBytesClient ()
 
virtual void ClientWrite (in SegmentTableWriter< ClientNetSegment > segmentTableWriter, IWriteMessage msg)
 

Static Public Member Functions

static string GetTimeStamp ()
 
static ChatMessage Create (string senderName, string text, ChatMessageType type, Character sender, Client client=null, PlayerConnectionChangeType changeType=PlayerConnectionChangeType.None, Color? textColor=null)
 
static string GetChatMessageCommand (string message, out string messageWithoutCommand)
 
static float GetGarbleAmount (Entity listener, Entity sender, float range, float obstructionMultiplier=2.0f)
 How much messages sent by sender should get garbled. Takes the distance between the entities and optionally the obstructions between them into account (see obstructionMultiplier ). More...
 
static string ApplyDistanceEffect (Entity listener, Entity sender, string text, float range, float obstructionMultiplier=2.0f)
 
static string ApplyDistanceEffect (string text, float garbleAmount)
 
static string ApplyDistanceEffect (string message, ChatMessageType type, Character sender, Character receiver)
 
static bool CanUseRadio (Character sender, bool ignoreJamming=false)
 
static bool CanUseRadio (Character sender, out WifiComponent radio, bool ignoreJamming=false)
 
static void ClientRead (IReadMessage msg)
 

Public Attributes

string Text
 
ChatMessageType Type
 
PlayerConnectionChangeType ChangeType
 
string IconStyle
 
Character Sender
 
Client SenderClient
 
readonly string SenderName
 

Static Public Attributes

const int MaxLength = 200
 
const int MaxMessagesPerPacket = 10
 
const float SpeakRange = 2000.0f
 
static Color[] MessageColor
 
static UInt16 LastID = 0
 

Protected Member Functions

 ChatMessage (string senderName, string text, ChatMessageType type, Character sender, Client client, PlayerConnectionChangeType changeType=PlayerConnectionChangeType.None, Color? textColor=null)
 

Properties

string TranslatedText [get]
 
Color Color [get, set]
 
string? TextWithSender [get]
 
UInt16 NetStateID [get, set]
 
ChatMode ChatMode = ChatMode.None [get, set]
 

Detailed Description

Definition at line 27 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

Constructor & Destructor Documentation

◆ ChatMessage()

Barotrauma.Networking.ChatMessage.ChatMessage ( string  senderName,
string  text,
ChatMessageType  type,
Character  sender,
Client  client,
PlayerConnectionChangeType  changeType = PlayerConnectionChangeType.None,
Color?  textColor = null 
)
protected

Definition at line 117 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

Member Function Documentation

◆ ApplyDistanceEffect() [1/4]

string Barotrauma.Networking.ChatMessage.ApplyDistanceEffect ( Character  listener)

Definition at line 192 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ ApplyDistanceEffect() [2/4]

static string Barotrauma.Networking.ChatMessage.ApplyDistanceEffect ( Entity  listener,
Entity  sender,
string  text,
float  range,
float  obstructionMultiplier = 2.0f 
)
static

Definition at line 199 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ ApplyDistanceEffect() [3/4]

static string Barotrauma.Networking.ChatMessage.ApplyDistanceEffect ( string  message,
ChatMessageType  type,
Character  sender,
Character  receiver 
)
static

Definition at line 220 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ ApplyDistanceEffect() [4/4]

static string Barotrauma.Networking.ChatMessage.ApplyDistanceEffect ( string  text,
float  garbleAmount 
)
static

Definition at line 204 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ CanUseRadio() [1/2]

static bool Barotrauma.Networking.ChatMessage.CanUseRadio ( Character  sender,
bool  ignoreJamming = false 
)
static

Definition at line 280 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ CanUseRadio() [2/2]

static bool Barotrauma.Networking.ChatMessage.CanUseRadio ( Character  sender,
out WifiComponent  radio,
bool  ignoreJamming = false 
)
static

Definition at line 285 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ ClientRead()

static void Barotrauma.Networking.ChatMessage.ClientRead ( IReadMessage  msg)
static

Definition at line 18 of file BarotraumaClient/ClientSource/Networking/ChatMessage.cs.

◆ ClientWrite()

virtual void Barotrauma.Networking.ChatMessage.ClientWrite ( in SegmentTableWriter< ClientNetSegment >  segmentTableWriter,
IWriteMessage  msg 
)
virtual

Reimplemented in Barotrauma.Networking.OrderChatMessage.

Definition at line 9 of file BarotraumaClient/ClientSource/Networking/ChatMessage.cs.

◆ Create()

static ChatMessage Barotrauma.Networking.ChatMessage.Create ( string  senderName,
string  text,
ChatMessageType  type,
Character  sender,
Client  client = null,
PlayerConnectionChangeType  changeType = PlayerConnectionChangeType.None,
Color?  textColor = null 
)
static

Definition at line 131 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ EstimateLengthBytesClient()

int Barotrauma.Networking.ChatMessage.EstimateLengthBytesClient ( )

Definition at line 271 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ GetChatMessageCommand()

static string Barotrauma.Networking.ChatMessage.GetChatMessageCommand ( string  message,
out string  messageWithoutCommand 
)
static

Definition at line 136 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ GetGarbleAmount()

static float Barotrauma.Networking.ChatMessage.GetGarbleAmount ( Entity  listener,
Entity  sender,
float  range,
float  obstructionMultiplier = 2.0f 
)
static

How much messages sent by sender should get garbled. Takes the distance between the entities and optionally the obstructions between them into account (see obstructionMultiplier ).

Parameters
obstructionMultiplierValues greater than or equal to 1 cause the message to get garbled more heavily when there's some obstruction between the characters. Values smaller than 1 mean the garbling only depends on distance.

Definition at line 166 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ GetTimeStamp()

static string Barotrauma.Networking.ChatMessage.GetTimeStamp ( )
static

Definition at line 94 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

Member Data Documentation

◆ ChangeType

PlayerConnectionChangeType Barotrauma.Networking.ChatMessage.ChangeType

Definition at line 74 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ IconStyle

string Barotrauma.Networking.ChatMessage.IconStyle

Definition at line 75 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ LastID

UInt16 Barotrauma.Networking.ChatMessage.LastID = 0
static

Definition at line 107 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ MaxLength

const int Barotrauma.Networking.ChatMessage.MaxLength = 200
static

Definition at line 29 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ MaxMessagesPerPacket

const int Barotrauma.Networking.ChatMessage.MaxMessagesPerPacket = 10
static

Definition at line 31 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ MessageColor

Color [] Barotrauma.Networking.ChatMessage.MessageColor
static
Initial value:
=
{
new Color(190, 198, 205),
new Color(204, 74, 78),
new Color(136, 177, 255),
new Color(157, 225, 160),
new Color(238, 208, 0),
new Color(64, 240, 89),
new Color(255, 255, 255),
new Color(255, 255, 255),
new Color(255, 128, 0)
}

Definition at line 37 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ Sender

Character Barotrauma.Networking.ChatMessage.Sender

Definition at line 77 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ SenderClient

Client Barotrauma.Networking.ChatMessage.SenderClient

Definition at line 78 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ SenderName

readonly string Barotrauma.Networking.ChatMessage.SenderName

Definition at line 80 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ SpeakRange

const float Barotrauma.Networking.ChatMessage.SpeakRange = 2000.0f
static

Definition at line 33 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ Text

string Barotrauma.Networking.ChatMessage.Text

Definition at line 50 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ Type

ChatMessageType Barotrauma.Networking.ChatMessage.Type

Definition at line 73 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

Property Documentation

◆ ChatMode

ChatMode Barotrauma.Networking.ChatMessage.ChatMode = ChatMode.None
getset

Definition at line 115 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ Color

Color Barotrauma.Networking.ChatMessage.Color
getset

Definition at line 84 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ NetStateID

UInt16 Barotrauma.Networking.ChatMessage.NetStateID
getset

Definition at line 109 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ TextWithSender

string? Barotrauma.Networking.ChatMessage.TextWithSender
get

Definition at line 99 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.

◆ TranslatedText

string Barotrauma.Networking.ChatMessage.TranslatedText
get

Definition at line 53 of file BarotraumaShared/SharedSource/Networking/ChatMessage.cs.