UE2:BroadcastHandler (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site

Package:: Engine
Direct subclasses:: LMSBroadcastHandler, UnrealChatHandler
This class in other games:: U2, U2XMP, UDK, UE2Runtime, UT2003, UT3

BroadcastHandler

Message broadcasting is delegated to BroadCastHandler by the GameInfo. The BroadCastHandler handles both text messages (typed by a player) and localized messages (which are identified by a LocalMessage class and id). GameInfos produce localized messages using their DeathMessageClass and GameMessageClass classes.

This is a built-in Unreal class and it shouldn't be modified.

[edit] Constants

[edit] PROPNUM

Value: 2

[edit] Properties

[edit] BHDescText

Type: string

Array size: 2 (PROPNUM)

Modifiers: localized

Default value, index 0: "Check this option to prevent spectators from chatting during the game."

Default value, index 1: "Check this option to separate spectator chat from player chat."

[edit] BHDisplayText

Type: string

Array size: 2 (PROPNUM)

Modifiers: localized

Default value, index 0: "Mute Spectators"

Default value, index 1: "Partition Spectators"

[edit] bMuteSpectators

Type: bool

Modifiers: globalconfig

Whether spectators are allowed to speak.

[edit] bPartitionSpectators

Type: bool

Modifiers: globalconfig

Whether spectators are can only speak to spectators.

[edit] NextBroadcastHandler

Type: BroadcastHandler

[edit] NextBroadcastHandlerClass

Type: class<BroadcastHandler>

[edit] SentText

Type: int

[edit] Functions

[edit] Static events

[edit] GetDescriptionText

static event string GetDescriptionText (string PropName)

Overrides: Info.GetDescriptionText

[edit] Other static functions

[edit] FillPlayInfo

static function FillPlayInfo (PlayInfo PlayInfo)

Overrides: Info.FillPlayInfo

[edit] Events

[edit] AllowBroadcastLocalized

event AllowBroadcastLocalized (Actor Sender, class<LocalMessage> Message, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)

[edit] Destroyed

event Destroyed ()

Overrides: Actor.Destroyed

[edit] Other instance functions

[edit] AcceptBroadcastLocalized

function bool AcceptBroadcastLocalized (PlayerController Receiver, Actor Sender, class<LocalMessage> Message, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object Obj)

[edit] AcceptBroadcastSpeech

function bool AcceptBroadcastSpeech (PlayerController Receiver, PlayerReplicationInfo SenderPRI)

[edit] AcceptBroadcastText

function bool AcceptBroadcastText (PlayerController Receiver, PlayerReplicationInfo SenderPRI, out string Msg, optional name Type)

[edit] AcceptBroadcastVoice

function bool AcceptBroadcastVoice (PlayerController Receiver, PlayerReplicationInfo SenderPRI)

[edit] AllowsBroadcast

function bool AllowsBroadcast (Actor broadcaster, int Len)

[edit] Broadcast

function Broadcast (Actor Sender, coerce string Msg, optional name Type)

[edit] BroadcastLocalized

function BroadcastLocalized (Actor Sender, PlayerController Receiver, class<LocalMessage> Message, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)

[edit] BroadcastTeam

function BroadcastTeam (Controller Sender, coerce string Msg, optional name Type)

[edit] BroadcastText

function BroadcastText (PlayerReplicationInfo SenderPRI, PlayerController Receiver, coerce string Msg, optional name Type)

[edit] HandlerAllowsBroadcast

function bool HandlerAllowsBroadcast (Actor Broadcaster, int SentTextNum)

[edit] RegisterBroadcastHandler

function RegisterBroadcastHandler (BroadcastHandler NewBH)

[edit] UpdateSentText

function UpdateSentText ()