The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE2:VoiceChatReplicationInfo (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2004 Object >> Actor >> Info >> ReplicationInfo >> VoiceChatReplicationInfo
Package: 
Engine
Direct subclass:
UnrealVoiceReplicationInfo

Contains information about the existing voice chat channels on the server. This class is simply a placeholder for the VoiceReplicationInfo, and should be implemented in a multi-player capable subclass.

Created by Ron Prestenback © 2003, Epic Games, Inc. All Rights Reserved

Constants[edit]

NUMPROPS[edit]

Value: 6


Properties[edit]

bAllowLocalBroadcast[edit]

Type: bool

Modifiers: globalconfig

Whether this server allows local channels

Default value: True

bEnableVoiceChat[edit]

Type: bool

Modifiers: globalconfig

Whether voice over IP is enabled on this server

Default value: True

bPrivateChat[edit]

Type: bool

Set by UnrealMPGameInfo.InitVoiceReplicationInfo()

bRefresh[edit]

Type: bool

Indicates a chat room has destroyed itself

BroadcastRadius[edit]

Type: float


Channels[edit]

Type: array<VoiceChatRoom>

Modifiers: protected


ChatRoomClass[edit]

Type: class<VoiceChatRoom>


Default value: Class'Engine.VoiceChatRoom'

DefaultBroadcastRadius[edit]

Type: float

Modifiers: globalconfig

Distance at which broadcast volume begins to fade

Default value: 20.0

DefaultChannel[edit]

Type: int

Channel that should be the default active channel for incoming clients that don't specify a default active channel

GRI[edit]

Type: GameReplicationInfo


InstalledCodec[edit]

Type: array<VoiceChatCodec>


Default value, index 0:

Member Value
Codec "CODEC_48NB"
CodecDescription "(4.8kbps) - Uses less bandwidth, but sound is not as clear."
CodecName "Less Bandwidth"

Default value, index 1:

Member Value
Codec "CODEC_96WB"
CodecDescription "(9.6kbps) - Uses more bandwidth, but sound is much clearer."
CodecName "Better Quality"

LocalBroadcastRange[edit]

Type: float

Modifiers: globalconfig

Maximum distance a local broadcast can be heard

Default value: 1000.0

LocalMask[edit]

Type: int


MaxChatters[edit]

Type: int

Modifiers: globalconfig

Max number of chatters allowed in a chatroom (0 - unlimited)

PublicChannelNames[edit]

Type: array<string>

Modifiers: localized


Default value, index 0: "Public"

Default value, index 1: "Local"

PublicMask[edit]

Type: int


VCDescText[edit]

Type: string

Array size: 6 (NUMPROPS)

Modifiers: localized


Default value, index 0: "Enable voice chat on the server."

Default value, index 1: "Determines whether the \"local\" voice chat channel is created, which allows players to broadcast voice transmissions to all players in the immediate vicinity."

Default value, index 2: "Maximum distance at which a broadcast on the local channel may be heard"

Default value, index 3: "Distance at which local broadcasts begin to fade"

Default value, index 4: "Configure which codecs exist on the server and should be used in Internet games."

Default value, index 5: "Configure which codecs exist on the server and should be used in LAN games."

VCDisplayText[edit]

Type: string

Array size: 6 (NUMPROPS)

Modifiers: localized


Default value, index 0: "Enable Voice Chat"

Default value, index 1: "Enable local Channel"

Default value, index 2: "Local Chat Range"

Default value, index 3: "Local Chat Radius"

Default value, index 4: "Allowed VoIP Codecs"

Default value, index 5: "Allowed VoIP LAN Codecs"

VoIPInternetCodecs[edit]

Type: array<string>

Modifiers: globalconfig


Default value: "CODEC_48NB"

VoIPLANCodecs[edit]

Type: array<string>

Modifiers: globalconfig


Default value, index 0: "CODEC_48NB"

Default value, index 1: "CODEC_96WB"

Default values[edit]

Property Value
NetPriority 3.001

Structs[edit]

VoiceChatCodec[edit]

Modifiers: native

string Codec 
string CodecName 
string CodecDescription 

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


GetCodecInfo[edit]

static function bool GetCodecInfo (string Codec, out string CodecName, out string CodecDescription)


GetInstalledCodecs[edit]

static function GetInstalledCodecs (out array<stringCodecs)


Events[edit]

GetChannelCount[edit]

simulated event int GetChannelCount ()


GetChannelIndex[edit]

simulated event int GetChannelIndex (string ChannelTitle, optional int TeamIndex)


PostBeginPlay[edit]

event PostBeginPlay ()

Overrides: Actor.PostBeginPlay


PostNetBeginPlay[edit]

simulated event PostNetBeginPlay ()

Overrides: Actor.PostNetBeginPlay


Timer[edit]

event Timer ()

Overrides: Actor.Timer


Other instance functions[edit]

AddVoiceChannel[edit]

simulated function VoiceChatRoom AddVoiceChannel (optional PlayerReplicationInfo PRI)


AddVoiceChatter[edit]

simulated function AddVoiceChatter (PlayerReplicationInfo NewPRI)


CanJoinChannel[edit]

simulated function bool CanJoinChannel (string ChannelTitle, PlayerReplicationInfo PRI)


CheckChannels[edit]

simulated private function CheckChannels ()


CreateNewVoiceChannel[edit]

simulated protected function VoiceChatRoom CreateNewVoiceChannel (optional PlayerReplicationInfo PRI)


DestroyVoiceChannel[edit]

simulated protected function DestroyVoiceChannel (VoiceChatRoom Channel)


GetChannel[edit]

simulated function VoiceChatRoom GetChannel (string ChatRoomName, optional int TeamIndex)


GetChannelAt[edit]

simulated function VoiceChatRoom GetChannelAt (int Index)


GetChannelMembers[edit]

simulated function array<intGetChannelMembers (string ChatRoomName, optional int TeamIndex)


GetChannelMembersAt[edit]

simulated function array<intGetChannelMembersAt (int Index)


GetChannels[edit]

simulated function array<VoiceChatRoomGetChannels ()


GetDefaultChannel[edit]

simulated function string GetDefaultChannel ()


GetMask[edit]

simulated function int GetMask (VoiceChatRoom Room)


GetMemberChannels[edit]

simulated function array<intGetMemberChannels (PlayerReplicationInfo PRI)


GetPlayerChannelCount[edit]

simulated function int GetPlayerChannelCount ()


GetPlayerChannels[edit]

simulated function array<VoiceChatRoomGetPlayerChannels ()


GetPublicChannelCount[edit]

simulated function int GetPublicChannelCount (optional bool bSingleTeam)


GetPublicChannels[edit]

simulated function array<VoiceChatRoomGetPublicChannels ()


GetTitle[edit]

simulated function string GetTitle (VoiceChatRoom Room)


InitChannels[edit]

simulated function InitChannels ()


IsMember[edit]

simulated function bool IsMember (PlayerReplicationInfo TestPRI, int ChannelIndex, optional bool bNoCascade)


JoinChannel[edit]

function VoiceChatRoom.EJoinChatResult JoinChannel (string ChannelTitle, PlayerReplicationInfo PRI, string Password)


JoinChannelAt[edit]

function VoiceChatRoom.EJoinChatResult JoinChannelAt (int ChannelIndex, PlayerReplicationInfo PRI, string Password)


LeaveChannel[edit]

function bool LeaveChannel (string ChannelTitle, PlayerReplicationInfo PRI)


NotifyTeamChange[edit]

simulated function NotifyTeamChange (PlayerReplicationInfo PRI, int TeamIndex)


RemoveVoiceChannel[edit]

simulated function bool RemoveVoiceChannel (PlayerReplicationInfo PRI)


RemoveVoiceChatter[edit]

simulated function RemoveVoiceChatter (PlayerReplicationInfo PRI)


SetMask[edit]

function SetMask (VoiceChatRoom Room, int NewMask)


ValidRoom[edit]

simulated function bool ValidRoom (VoiceChatRoom Room)