Mostly Harmless

UE2:BroadcastHandler (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2004 Object >> Actor >> Info >> BroadcastHandler
Package: 
Engine
Direct subclasses:
UnrealChatHandler, LMSBroadcastHandler
This class in other games:
U2, U2XMP, UE2Runtime, UT2003, UDK, 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.

Constants[edit]

PROPNUM[edit]

Value: 2


Properties[edit]

BHDescText[edit]

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[edit]

Type: string

Array size: 2 (PROPNUM)

Modifiers: localized


Default value, index 0: "Mute Spectators"

Default value, index 1: "Partition Spectators"

bMuteSpectators[edit]

Type: bool

Modifiers: globalconfig

Whether spectators are allowed to speak.

bPartitionSpectators[edit]

Type: bool

Modifiers: globalconfig

Whether spectators are can only speak to spectators.

NextBroadcastHandler[edit]

Type: BroadcastHandler


NextBroadcastHandlerClass[edit]

Type: class<BroadcastHandler>


SentText[edit]

Type: int


Functions[edit]

Static events[edit]

GetDescriptionText[edit]

static event string GetDescriptionText (string PropName)

Overrides: Info.GetDescriptionText


Other static functions[edit]

FillPlayInfo[edit]

static function FillPlayInfo (PlayInfo PlayInfo)

Overrides: Info.FillPlayInfo


Events[edit]

AllowBroadcastLocalized[edit]

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


Destroyed[edit]

event Destroyed ()

Overrides: Actor.Destroyed


Other instance functions[edit]

AcceptBroadcastLocalized[edit]

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


AcceptBroadcastSpeech[edit]

function bool AcceptBroadcastSpeech (PlayerController Receiver, PlayerReplicationInfo SenderPRI)


AcceptBroadcastText[edit]

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


AcceptBroadcastVoice[edit]

function bool AcceptBroadcastVoice (PlayerController Receiver, PlayerReplicationInfo SenderPRI)


AllowsBroadcast[edit]

function bool AllowsBroadcast (Actor broadcaster, int Len)


Broadcast[edit]

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


BroadcastLocalized[edit]

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


BroadcastTeam[edit]

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


BroadcastText[edit]

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


HandlerAllowsBroadcast[edit]

function bool HandlerAllowsBroadcast (Actor Broadcaster, int SentTextNum)


RegisterBroadcastHandler[edit]

function RegisterBroadcastHandler (BroadcastHandler NewBH)


UpdateSentText[edit]

function UpdateSentText ()