Always snap to grid

UE2:VoiceChatReplicationInfo (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT2004 Object >> Actor >> Info >> ReplicationInfo >> VoiceChatReplicationInfo

Contents

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

[edit] Constants

[edit] NUMPROPS

Value: 6


[edit] Properties

[edit] bAllowLocalBroadcast

Type: bool

Modifiers: globalconfig

Whether this server allows local channels

Default value: True

[edit] bEnableVoiceChat

Type: bool

Modifiers: globalconfig

Whether voice over IP is enabled on this server

Default value: True

[edit] bPrivateChat

Type: bool

Set by UnrealMPGameInfo.InitVoiceReplicationInfo()

[edit] bRefresh

Type: bool

Indicates a chat room has destroyed itself

[edit] BroadcastRadius

Type: float


[edit] Channels

Type: array<VoiceChatRoom>

Modifiers: protected


[edit] ChatRoomClass

Type: class<VoiceChatRoom>


Default value: Class'Engine.VoiceChatRoom'

[edit] DefaultBroadcastRadius

Type: float

Modifiers: globalconfig

Distance at which broadcast volume begins to fade

Default value: 20.0

[edit] DefaultChannel

Type: int

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

[edit] GRI

Type: GameReplicationInfo


[edit] InstalledCodec

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"

[edit] LocalBroadcastRange

Type: float

Modifiers: globalconfig

Maximum distance a local broadcast can be heard

Default value: 1000.0

[edit] LocalMask

Type: int


[edit] MaxChatters

Type: int

Modifiers: globalconfig

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

[edit] PublicChannelNames

Type: array<string>

Modifiers: localized


Default value, index 0: "Public"

Default value, index 1: "Local"

[edit] PublicMask

Type: int


[edit] VCDescText

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

[edit] VCDisplayText

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"

[edit] VoIPInternetCodecs

Type: array<string>

Modifiers: globalconfig


Default value: "CODEC_48NB"

[edit] VoIPLANCodecs

Type: array<string>

Modifiers: globalconfig


Default value, index 0: "CODEC_48NB"

Default value, index 1: "CODEC_96WB"

[edit] Default values

Property Value
NetPriority 3.001

[edit] Structs

[edit] VoiceChatCodec

Modifiers: native

string Codec 
string CodecName 
string CodecDescription 

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

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


[edit] GetInstalledCodecs

static function GetInstalledCodecs (out array<stringCodecs)


[edit] Events

[edit] GetChannelCount

simulated event int GetChannelCount ()


[edit] GetChannelIndex

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


[edit] PostBeginPlay

event PostBeginPlay ()

Overrides: Actor.PostBeginPlay


[edit] PostNetBeginPlay

simulated event PostNetBeginPlay ()

Overrides: Actor.PostNetBeginPlay


[edit] Timer

event Timer ()

Overrides: Actor.Timer


[edit] Other instance functions

[edit] AddVoiceChannel

simulated function VoiceChatRoom AddVoiceChannel (optional PlayerReplicationInfo PRI)


[edit] AddVoiceChatter

simulated function AddVoiceChatter (PlayerReplicationInfo NewPRI)


[edit] CanJoinChannel

simulated function bool CanJoinChannel (string ChannelTitle, PlayerReplicationInfo PRI)


[edit] CheckChannels

simulated private function CheckChannels ()


[edit] CreateNewVoiceChannel

simulated protected function VoiceChatRoom CreateNewVoiceChannel (optional PlayerReplicationInfo PRI)


[edit] DestroyVoiceChannel

simulated protected function DestroyVoiceChannel (VoiceChatRoom Channel)


[edit] GetChannel

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


[edit] GetChannelAt

simulated function VoiceChatRoom GetChannelAt (int Index)


[edit] GetChannelMembers

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


[edit] GetChannelMembersAt

simulated function array<intGetChannelMembersAt (int Index)


[edit] GetChannels

simulated function array<VoiceChatRoomGetChannels ()


[edit] GetDefaultChannel

simulated function string GetDefaultChannel ()


[edit] GetMask

simulated function int GetMask (VoiceChatRoom Room)


[edit] GetMemberChannels

simulated function array<intGetMemberChannels (PlayerReplicationInfo PRI)


[edit] GetPlayerChannelCount

simulated function int GetPlayerChannelCount ()


[edit] GetPlayerChannels

simulated function array<VoiceChatRoomGetPlayerChannels ()


[edit] GetPublicChannelCount

simulated function int GetPublicChannelCount (optional bool bSingleTeam)


[edit] GetPublicChannels

simulated function array<VoiceChatRoomGetPublicChannels ()


[edit] GetTitle

simulated function string GetTitle (VoiceChatRoom Room)


[edit] InitChannels

simulated function InitChannels ()


[edit] IsMember

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


[edit] JoinChannel

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


[edit] JoinChannelAt

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


[edit] LeaveChannel

function bool LeaveChannel (string ChannelTitle, PlayerReplicationInfo PRI)


[edit] NotifyTeamChange

simulated function NotifyTeamChange (PlayerReplicationInfo PRI, int TeamIndex)


[edit] RemoveVoiceChannel

simulated function bool RemoveVoiceChannel (PlayerReplicationInfo PRI)


[edit] RemoveVoiceChatter

simulated function RemoveVoiceChatter (PlayerReplicationInfo PRI)


[edit] SetMask

function SetMask (VoiceChatRoom Room, int NewMask)


[edit] ValidRoom

simulated function bool ValidRoom (VoiceChatRoom Room)