Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.VoiceChatReplicationInfo

Extends
ReplicationInfo
Modifiers
config abstract notplaceable native nativereplication 

Core.Object
|   
+-- Engine.Actor
   |   
   +-- Engine.Info
      |   
      +-- Engine.ReplicationInfo
         |   
         +-- Engine.VoiceChatReplicationInfo

Direct Known Subclasses:

UnrealVoiceReplicationInfo
Constants Summary
NUMPROPS=6

Variables Summary
boolbAllowLocalBroadcast
boolbEnableVoiceChat
boolbPrivateChat
boolbRefresh
floatBroadcastRadius
array<VoiceChatRoom>Channels
class<VoiceChatRoom>ChatRoomClass
floatDefaultBroadcastRadius
intDefaultChannel
GameReplicationInfoGRI
array<VoiceChatCodec>InstalledCodec
floatLocalBroadcastRange
intLocalMask
intMaxChatters
array<string>PublicChannelNames
intPublicMask
stringVCDescText[NUMPROPS]
stringVCDisplayText[NUMPROPS]
array<string>VoIPInternetCodecs
array<string>VoIPLANCodecs
Inherited Variables from Engine.Info
BotsGroup, ChatGroup, GameGroup, KickVoteGroup, MapVoteGroup, RulesGroup, ServerGroup

Structures Summary
VoiceChatCodec
Codec, CodecName, CodecDescription

Functions Summary
functionVoiceChatRoom AddVoiceChannel (optional PlayerReplicationInfo PRI)
function AddVoiceChatter (PlayerReplicationInfo NewPRI)
functionbool CanJoinChannel (string ChannelTitle, PlayerReplicationInfo PRI)
function CheckChannels ()
functionVoiceChatRoom CreateNewVoiceChannel (optional PlayerReplicationInfo PRI)
function DestroyVoiceChannel (VoiceChatRoom Channel)
function FillPlayInfo (PlayInfo PlayInfo)
functionVoiceChatRoom GetChannel (string ChatRoomName, optional int TeamIndex)
functionVoiceChatRoom GetChannelAt (int Index)
eventint GetChannelCount ()
eventint GetChannelIndex (string ChannelTitle, optional int TeamIndex)
functionarray<int> GetChannelMembers (string ChatRoomName, optional int TeamIndex)
functionarray<int> GetChannelMembersAt (int Index)
functionarray<VoiceChatRoom> GetChannels ()
functionbool GetCodecInfo (string Codec, out string CodecName, out string CodecDescription)
functionstring GetDefaultChannel ()
eventstring GetDescriptionText (string PropName)
function GetInstalledCodecs (out array<string> Codecs)
functionint GetMask (VoiceChatRoom Room)
functionarray<int> GetMemberChannels (PlayerReplicationInfo PRI)
functionint GetPlayerChannelCount ()
functionarray<VoiceChatRoom> GetPlayerChannels ()
functionint GetPublicChannelCount (optional bool bSingleTeam)
functionarray<VoiceChatRoom> GetPublicChannels ()
functionstring GetTitle (VoiceChatRoom Room)
function InitChannels ()
functionbool IsMember (PlayerReplicationInfo TestPRI, int ChannelIndex, optional bool bNoCascade)
functionVoiceChatRoom.EJoinChatResult JoinChannel (string ChannelTitle, PlayerReplicationInfo PRI, string Password)
functionVoiceChatRoom.EJoinChatResult JoinChannelAt (int ChannelIndex, PlayerReplicationInfo PRI, string Password)
functionbool LeaveChannel (string ChannelTitle, PlayerReplicationInfo PRI)
function NotifyTeamChange (PlayerReplicationInfo PRI, int TeamIndex)
event PostBeginPlay ()
event PostNetBeginPlay ()
functionbool RemoveVoiceChannel (PlayerReplicationInfo PRI)
function RemoveVoiceChatter (PlayerReplicationInfo PRI)
function SetMask (VoiceChatRoom Room, int NewMask)
event Timer ()
functionbool ValidRoom (VoiceChatRoom Room)
Inherited Functions from Engine.Info
AcceptPlayInfoProperty, AllowClassRemoval, FillPlayInfo, GetDescriptionText, GetSecurityLevel

Constants Detail

NUMPROPS Source code

const NUMPROPS = 6;

Variables Detail

bAllowLocalBroadcast Source code

var globalconfig bool bAllowLocalBroadcast;

bEnableVoiceChat Source code

var globalconfig bool bEnableVoiceChat;

bPrivateChat Source code

var bool bPrivateChat;

bRefresh Source code

var bool bRefresh;

BroadcastRadius Source code

var float BroadcastRadius;

Channels Source code

var protected array<VoiceChatRoom> Channels;

ChatRoomClass Source code

var class<VoiceChatRoom> ChatRoomClass;

DefaultBroadcastRadius Source code

var globalconfig float DefaultBroadcastRadius;

DefaultChannel Source code

var int DefaultChannel;

GRI Source code

var GameReplicationInfo GRI;

InstalledCodec Source code

var array<VoiceChatCodec> InstalledCodec;

LocalBroadcastRange Source code

var globalconfig float LocalBroadcastRange;

LocalMask Source code

var int LocalMask;

MaxChatters Source code

var globalconfig int MaxChatters;

PublicChannelNames Source code

var localized array<string> PublicChannelNames;

PublicMask Source code

var int PublicMask;

VCDescText[NUMPROPS] Source code

var localized string VCDescText[NUMPROPS];

VCDisplayText[NUMPROPS] Source code

var localized string VCDisplayText[NUMPROPS];

VoIPInternetCodecs Source code

var globalconfig array<string> VoIPInternetCodecs;

VoIPLANCodecs Source code

var globalconfig array<string> VoIPLANCodecs;

Structures Detail

VoiceChatCodec Source code

struct VoiceChatCodec
{
var string Codec;
var localized string CodecDescription;
var localized string CodecName;
};


Functions Detail

AddVoiceChannel Source code

simulated function VoiceChatRoom AddVoiceChannel ( optional PlayerReplicationInfo PRI )

AddVoiceChatter Source code

simulated function AddVoiceChatter ( PlayerReplicationInfo NewPRI )

CanJoinChannel Source code

simulated function bool CanJoinChannel ( string ChannelTitle, PlayerReplicationInfo PRI )

CheckChannels Source code

simulated private function CheckChannels ( )

CreateNewVoiceChannel Source code

simulated protected function VoiceChatRoom CreateNewVoiceChannel ( optional PlayerReplicationInfo PRI )

DestroyVoiceChannel Source code

simulated protected function DestroyVoiceChannel ( VoiceChatRoom Channel )

FillPlayInfo Source code

static function FillPlayInfo ( PlayInfo PlayInfo )

GetChannel Source code

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

GetChannelAt Source code

simulated function VoiceChatRoom GetChannelAt ( int Index )

GetChannelCount Source code

simulated event int GetChannelCount ( )

GetChannelIndex Source code

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

GetChannelMembers Source code

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

GetChannelMembersAt Source code

simulated function array<int> GetChannelMembersAt ( int Index )

GetChannels Source code

simulated function array<VoiceChatRoom> GetChannels ( )

GetCodecInfo Source code

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

GetDefaultChannel Source code

simulated function string GetDefaultChannel ( )

GetDescriptionText Source code

static event string GetDescriptionText ( string PropName )

GetInstalledCodecs Source code

static function GetInstalledCodecs ( out array<string> Codecs )

GetMask Source code

simulated function int GetMask ( VoiceChatRoom Room )

GetMemberChannels Source code

simulated function array<int> GetMemberChannels ( PlayerReplicationInfo PRI )

GetPlayerChannelCount Source code

simulated function int GetPlayerChannelCount ( )

GetPlayerChannels Source code

simulated function array<VoiceChatRoom> GetPlayerChannels ( )

GetPublicChannelCount Source code

simulated function int GetPublicChannelCount ( optional bool bSingleTeam )

GetPublicChannels Source code

simulated function array<VoiceChatRoom> GetPublicChannels ( )

GetTitle Source code

simulated function string GetTitle ( VoiceChatRoom Room )

InitChannels Source code

simulated function InitChannels ( )

IsMember Source code

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

JoinChannel Source code

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

JoinChannelAt Source code

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

LeaveChannel Source code

function bool LeaveChannel ( string ChannelTitle, PlayerReplicationInfo PRI )

NotifyTeamChange Source code

simulated function NotifyTeamChange ( PlayerReplicationInfo PRI, int TeamIndex )

PostBeginPlay Source code

event PostBeginPlay ( )

PostNetBeginPlay Source code

simulated event PostNetBeginPlay ( )

RemoveVoiceChannel Source code

simulated function bool RemoveVoiceChannel ( PlayerReplicationInfo PRI )

RemoveVoiceChatter Source code

simulated function RemoveVoiceChatter ( PlayerReplicationInfo PRI )

SetMask Source code

function SetMask ( VoiceChatRoom Room, int NewMask )

Timer Source code

event Timer ( )

ValidRoom Source code

simulated function bool ValidRoom ( VoiceChatRoom Room )

Defaultproperties 

defaultproperties
{
     PublicChannelNames(0)="Public"
     PublicChannelNames(1)="Local"
     VCDisplayText(0)="Enable Voice Chat"
     VCDisplayText(1)="Enable local Channel"
     VCDisplayText(2)="Local Chat Range"
     VCDisplayText(3)="Local Chat Radius"
     VCDisplayText(4)="Allowed VoIP Codecs"
     VCDisplayText(5)="Allowed VoIP LAN Codecs"
     VCDescText(0)="Enable voice chat on the server."
     VCDescText(1)="Determines whether the "local" voice chat channel is created, which allows players to broadcast voice transmissions to all players in the immediate vicinity."
     VCDescText(2)="Maximum distance at which a broadcast on the local channel may be heard"
     VCDescText(3)="Distance at which local broadcasts begin to fade"
     VCDescText(4)="Configure which codecs exist on the server and should be used in Internet games."
     VCDescText(5)="Configure which codecs exist on the server and should be used in LAN games."
     ChatRoomClass=Class'Engine.VoiceChatRoom'
     InstalledCodec(0)=(Codec="CODEC_48NB",CodecName="Less Bandwidth",CodecDescription="(4.8kbps) - Uses less bandwidth, but sound is not as clear.")
     InstalledCodec(1)=(Codec="CODEC_96WB",CodecName="Better Quality",CodecDescription="(9.6kbps) - Uses more bandwidth, but sound is much clearer.")
     VoIPInternetCodecs(0)="CODEC_48NB"
     VoIPLANCodecs(0)="CODEC_48NB"
     VoIPLANCodecs(1)="CODEC_96WB"
     bEnableVoiceChat=True
     bAllowLocalBroadcast=True
     LocalBroadcastRange=1000.000000
     DefaultBroadcastRadius=20.000000
     NetPriority=3.001000
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: Wed 7/2/2007 19:16:25.203 - Created with UnCodeX