Edit

PartyTextChatOptions

  • Article

Text chat options.

Syntax

enum class PartyTextChatOptions    
{  
    None = 0x0,  
    TranslateToLocalLanguage = 0x1,  
    FilterOffensiveText = 0x2,  
}

Constants

Constant Description
None No options are selected.
TranslateToLocalLanguage Incoming text chat will be translated to the local chat control's language.

The language specified via PartyLocalChatControl::GetLanguage() is the language to which the incoming text chat will be translated. The translations will be provided in addition to the original text chat via a PartyChatTextReceivedStateChange.

If translation is enabled, a translation corresponding to the local chat control's language will always be provided in each resulting PartyChatTextReceivedStateChange. If the source chat control's language is the same as the local chat control's language, the chat text and translation strings will be identical.
FilterOffensiveText Offensive terms will be filtered out of incoming text chat.

For incoming chat text detected as English, the filtering level may be adjusted using the PartyOption::TextChatFilterLevel option in PartyManager::SetOption(). The default level is family-friendly.

Requirements

Header: Party.h

See also

Party members
PartyLocalChatControl::SetTextChatOptions
PartyLocalChatControl::GetLanguage
PartyChatTextReceivedStateChange