UE2:BroadcastHandler (UT2004)

Object >> Actor >> Info >> BroadcastHandler

Package:

Engine

Direct subclasses:

UnrealChatHandler, LMSBroadcastHandler

This class in other games:

U2, U2XMP, UE2Runtime, UT2003, UT3, UDK

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.

Constants

PROPNUM

Value: 2

Properties

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."

BHDisplayText

Type: string

Array size: 2 (PROPNUM)

Modifiers: localized

Default value, index 0: "Mute Spectators"

Default value, index 1: "Partition Spectators"

bMuteSpectators

Type: bool

Modifiers: globalconfig

Whether spectators are allowed to speak.

bPartitionSpectators

Type: bool

Modifiers: globalconfig

Whether spectators are can only speak to spectators.

NextBroadcastHandler

Type: BroadcastHandler

NextBroadcastHandlerClass

Type: class<BroadcastHandler>

SentText

Type: int

Functions

Static events

GetDescriptionText

static event string GetDescriptionText (string PropName)

Overrides: Info.GetDescriptionText

Other static functions

FillPlayInfo

static function FillPlayInfo (PlayInfo PlayInfo)

Overrides: Info.FillPlayInfo

Events

AllowBroadcastLocalized

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

Destroyed

event Destroyed ()

Overrides: Actor.Destroyed

Other instance functions

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)

AcceptBroadcastSpeech

function bool AcceptBroadcastSpeech (PlayerController Receiver, PlayerReplicationInfo SenderPRI)

AcceptBroadcastText

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

AcceptBroadcastVoice

function bool AcceptBroadcastVoice (PlayerController Receiver, PlayerReplicationInfo SenderPRI)

AllowsBroadcast

function bool AllowsBroadcast (Actor broadcaster, int Len)

Broadcast

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

BroadcastLocalized

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

BroadcastTeam

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

BroadcastText

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

HandlerAllowsBroadcast

function bool HandlerAllowsBroadcast (Actor Broadcaster, int SentTextNum)

RegisterBroadcastHandler

function RegisterBroadcastHandler (BroadcastHandler NewBH)

UpdateSentText

function UpdateSentText ()