TaleWorlds.MountAndBlade.ChatBox Class Reference

Inherits TaleWorlds.Core.GameHandler.

Public Member Functions
override void	OnBeforeSave ()
override void	OnAfterSave ()
void	SendMessageToAll (string message)
void	SendMessageToAll (string message, List< VirtualPlayer > receiverList)
void	SendMessageToTeam (string message)
void	SendMessageToTeam (string message, List< VirtualPlayer > receiverList)
void	SendMessageToWhisperTarget (string message, string platformName, string whisperTarget)
void	ResetMuteList ()
void	SetPlayerMuted (PlayerId playerID, bool isMuted)
void	SetPlayerMutedFromPlatform (PlayerId playerID, bool isMuted)
bool	IsPlayerMuted (PlayerId player)
	Returns if given player is muted from the game or platform. More...
bool	IsPlayerMutedFromPlatform (PlayerId player)
bool	IsPlayerMutedFromGame (PlayerId player)
void	SetChatFilterLists (string[] profanityList, string[] allowList)
void	InitializeForMultiplayer ()
void	InitializeForSinglePlayer ()
void	OnLogin ()
abstract void	OnBeforeSave ()
abstract void	OnAfterSave ()
void	OnInitialize ()
void	OnFinalize ()

Static Public Member Functions
static void	ServerSendServerMessageToEveryone (string message)
static void	AddWhisperMessage (string fromUserName, string messageBody)
static void	AddErrorWhisperMessage (string toUserName)

Public Attributes
Action< NetworkCommunicator, string >	OnMessageReceivedAtDedicatedServer

Protected Member Functions
override void	OnGameStart ()
override void	OnGameEnd ()
override void	OnGameNetworkBegin ()
override void	OnGameNetworkEnd ()
override void	OnTick (float dt)
Protected Member Functions inherited from TaleWorlds.Core.GameHandler
virtual void	OnInitialize ()
virtual void	OnFinalize ()

Properties
bool	IsContentRestricted = false [get]
bool	NetworkReady [get]

Events
PlayerMessageReceivedDelegate	PlayerMessageReceived
WhisperMessageSentDelegate	WhisperMessageSent
WhisperMessageReceivedDelegate	WhisperMessageReceived
ErrorWhisperMessageReceivedDelegate	ErrorWhisperMessageReceived
ServerMessageDelegate	ServerMessage
PlayerMutedDelegate	OnPlayerMuteChanged

Member Function Documentation

OnGameStart()

override void TaleWorlds.MountAndBlade.ChatBox.OnGameStart ( )

protectedvirtual

Reimplemented from TaleWorlds.Core.GameHandler.

OnBeforeSave()

override void TaleWorlds.MountAndBlade.ChatBox.OnBeforeSave ( )

virtual

Implements TaleWorlds.Core.GameHandler.

OnAfterSave()

override void TaleWorlds.MountAndBlade.ChatBox.OnAfterSave ( )

virtual

Implements TaleWorlds.Core.GameHandler.

OnGameEnd()

override void TaleWorlds.MountAndBlade.ChatBox.OnGameEnd ( )

protectedvirtual

Reimplemented from TaleWorlds.Core.GameHandler.

SendMessageToAll() [1/2]

void TaleWorlds.MountAndBlade.ChatBox.SendMessageToAll

(

string

message

)

SendMessageToAll() [2/2]

void TaleWorlds.MountAndBlade.ChatBox.SendMessageToAll	(	string	message,
		List< VirtualPlayer >	receiverList
	)

SendMessageToTeam() [1/2]

void TaleWorlds.MountAndBlade.ChatBox.SendMessageToTeam

(

string

message

)

SendMessageToTeam() [2/2]

void TaleWorlds.MountAndBlade.ChatBox.SendMessageToTeam	(	string	message,
		List< VirtualPlayer >	receiverList
	)

SendMessageToWhisperTarget()

void TaleWorlds.MountAndBlade.ChatBox.SendMessageToWhisperTarget	(	string	message,
		string	platformName,
		string	whisperTarget
	)

OnGameNetworkBegin()

override void TaleWorlds.MountAndBlade.ChatBox.OnGameNetworkBegin ( )

protectedvirtual

Reimplemented from TaleWorlds.Core.GameHandler.

OnGameNetworkEnd()

override void TaleWorlds.MountAndBlade.ChatBox.OnGameNetworkEnd ( )

protectedvirtual

Reimplemented from TaleWorlds.Core.GameHandler.

ServerSendServerMessageToEveryone()

static void TaleWorlds.MountAndBlade.ChatBox.ServerSendServerMessageToEveryone ( string  message )

static

ResetMuteList()

void TaleWorlds.MountAndBlade.ChatBox.ResetMuteList

(

)

AddWhisperMessage()

static void TaleWorlds.MountAndBlade.ChatBox.AddWhisperMessage ( string  fromUserName, string  messageBody  )

static

AddErrorWhisperMessage()

static void TaleWorlds.MountAndBlade.ChatBox.AddErrorWhisperMessage ( string  toUserName )

static

SetPlayerMuted()

void TaleWorlds.MountAndBlade.ChatBox.SetPlayerMuted	(	PlayerId	playerID,
		bool	isMuted
	)

SetPlayerMutedFromPlatform()

void TaleWorlds.MountAndBlade.ChatBox.SetPlayerMutedFromPlatform	(	PlayerId	playerID,
		bool	isMuted
	)

IsPlayerMuted()

bool TaleWorlds.MountAndBlade.ChatBox.IsPlayerMuted

(

PlayerId

player

)

Parameters

player

Queried player's ID

Returns

If the player is muted from either the Platform(PS / Xbox social menus) or Game(scoreboard, report).

IsPlayerMutedFromPlatform()

bool TaleWorlds.MountAndBlade.ChatBox.IsPlayerMutedFromPlatform

(

PlayerId

player

)

IsPlayerMutedFromGame()

bool TaleWorlds.MountAndBlade.ChatBox.IsPlayerMutedFromGame

(

PlayerId

player

)

SetChatFilterLists()

void TaleWorlds.MountAndBlade.ChatBox.SetChatFilterLists	(	string[]	profanityList,
		string[]	allowList
	)

InitializeForMultiplayer()

void TaleWorlds.MountAndBlade.ChatBox.InitializeForMultiplayer

(

)

InitializeForSinglePlayer()

void TaleWorlds.MountAndBlade.ChatBox.InitializeForSinglePlayer

(

)

OnLogin()

void TaleWorlds.MountAndBlade.ChatBox.OnLogin

(

)

OnTick()

override void TaleWorlds.MountAndBlade.ChatBox.OnTick ( float  dt )

protectedvirtual

Reimplemented from TaleWorlds.Core.GameHandler.

Member Data Documentation

OnMessageReceivedAtDedicatedServer

Action<NetworkCommunicator, string> TaleWorlds.MountAndBlade.ChatBox.OnMessageReceivedAtDedicatedServer

Property Documentation

IsContentRestricted

bool TaleWorlds.MountAndBlade.ChatBox.IsContentRestricted = false

get

NetworkReady

bool TaleWorlds.MountAndBlade.ChatBox.NetworkReady

get

Event Documentation

PlayerMessageReceived

PlayerMessageReceivedDelegate TaleWorlds.MountAndBlade.ChatBox.PlayerMessageReceived

WhisperMessageSent

WhisperMessageSentDelegate TaleWorlds.MountAndBlade.ChatBox.WhisperMessageSent

WhisperMessageReceived

WhisperMessageReceivedDelegate TaleWorlds.MountAndBlade.ChatBox.WhisperMessageReceived

ErrorWhisperMessageReceived

ErrorWhisperMessageReceivedDelegate TaleWorlds.MountAndBlade.ChatBox.ErrorWhisperMessageReceived

ServerMessage

ServerMessageDelegate TaleWorlds.MountAndBlade.ChatBox.ServerMessage

OnPlayerMuteChanged

PlayerMutedDelegate TaleWorlds.MountAndBlade.ChatBox.OnPlayerMuteChanged