Barotrauma.Networking.OrderChatMessage Class Reference

Inheritance diagram for Barotrauma.Networking.OrderChatMessage:

Classes
struct	OrderMessageInfo

Public Member Functions
	OrderChatMessage (Order order, Character targetCharacter, Character sender, bool isNewOrder=true)
	Same as calling OrderChatMessage.OrderChatMessage(Order, string, int, string, ISpatialEntity, Character, Character), but the text parameter is set using Order.GetChatMessage(string, string, bool, string)
	OrderChatMessage (Order order, string text, Character targetCharacter, Entity sender, bool isNewOrder=true)
Public Member Functions inherited from Barotrauma.Networking.ChatMessage
string	ApplyDistanceEffect (Character listener)
int	EstimateLengthBytesClient ()

Static Public Member Functions
static string	NameFromEntityOrNull (Entity entity)
static void	WriteOrder (IWriteMessage msg, Order order, Entity targetCharacter, bool isNewOrder)
static OrderMessageInfo	ReadOrder (IReadMessage msg)
Static Public Member Functions inherited from Barotrauma.Networking.ChatMessage
static string	GetTimeStamp ()
static ChatMessage	Create (string senderName, string text, ChatMessageType type, Entity 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 ).
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)

Public Attributes
readonly Order	Order
readonly Character	TargetCharacter
Public Attributes inherited from Barotrauma.Networking.ChatMessage
string	Text
ChatMessageType	Type
PlayerConnectionChangeType	ChangeType
string	IconStyle
readonly Entity	Sender
readonly Client	SenderClient
readonly string	SenderName

Properties
ISpatialEntity	TargetEntity [get]
Identifier	OrderOption [get]
int	OrderPriority [get]
int?	WallSectionIndex [get]
	Used when the order targets a wall.
bool	IsNewOrder [get]
Properties inherited from Barotrauma.Networking.ChatMessage
string	TranslatedText [get]
Character	SenderCharacter [get]
Color	Color [get, set]
string	TextWithSender [get]
UInt16	NetStateID [get, set]
ChatMode	ChatMode = ChatMode.None [get, set]

Additional Inherited Members
Static Public Attributes inherited from Barotrauma.Networking.ChatMessage
const int	MaxLength = 200
const int	MaxMessagesPerPacket = 10
const float	SpeakRange = 2000.0f
const float	SpeakRangeVOIP = 1000.0f
	This is shorter than the text chat speak range, because the voice chat is still intelligible (just quiet) close to the maximum range, while the text chat (which drops letters from the message) becomes unintelligible sooner.
static Color[]	MessageColor
static UInt16	LastID = 0
Protected Member Functions inherited from Barotrauma.Networking.ChatMessage
	ChatMessage (string senderName, string text, ChatMessageType type, Entity sender, Client client, PlayerConnectionChangeType changeType=PlayerConnectionChangeType.None, Color? textColor=null)

Constructor & Destructor Documentation

OrderChatMessage() [1/2]

Barotrauma.Networking.OrderChatMessage.OrderChatMessage	(	Order	order,
		Character	targetCharacter,
		Character	sender,
		bool	isNewOrder = true )

Same as calling OrderChatMessage.OrderChatMessage(Order, string, int, string, ISpatialEntity, Character, Character), but the text parameter is set using Order.GetChatMessage(string, string, bool, string)

OrderChatMessage() [2/2]

Barotrauma.Networking.OrderChatMessage.OrderChatMessage	(	Order	order,
		string	text,
		Character	targetCharacter,
		Entity	sender,
		bool	isNewOrder = true )

Member Function Documentation

NameFromEntityOrNull()

static string Barotrauma.Networking.OrderChatMessage.NameFromEntityOrNull ( Entity entity )

static

ReadOrder()

static OrderMessageInfo Barotrauma.Networking.OrderChatMessage.ReadOrder ( IReadMessage msg )

static

WriteOrder()

static void Barotrauma.Networking.OrderChatMessage.WriteOrder ( IWriteMessage msg, Order order, Entity targetCharacter, bool isNewOrder )

static

Member Data Documentation

Order

readonly Order Barotrauma.Networking.OrderChatMessage.Order

TargetCharacter

readonly Character Barotrauma.Networking.OrderChatMessage.TargetCharacter

Property Documentation

IsNewOrder

bool Barotrauma.Networking.OrderChatMessage.IsNewOrder

get

OrderOption

Identifier Barotrauma.Networking.OrderChatMessage.OrderOption

get

OrderPriority

int Barotrauma.Networking.OrderChatMessage.OrderPriority

get

TargetEntity

ISpatialEntity Barotrauma.Networking.OrderChatMessage.TargetEntity

get

WallSectionIndex

int? Barotrauma.Networking.OrderChatMessage.WallSectionIndex

get

Used when the order targets a wall.

---

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

• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Networking/OrderChatMessage.cs