UE2:VoiceChatRoom (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to navigation Jump to search
UT2004 Object >> Actor >> Info >> VoiceChatRoom
Package: 
Engine

Contains information about a single voice chat room on the server

If public channel - owner will be GameInfo.VoiceReplicationInfo If private channel - owner is client's PlayerReplicationInfo

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

Properties

bLocal

Type: bool

- not yet implemented

ChannelIndex

Type: int


Default value: -1

Children

Type: array<VoiceChatRoom>


GRI

Type: GameReplicationInfo


Parent

Type: VoiceChatRoom


Password

Type: string


TeamIndex

Type: int

Modifiers: private


Default value: 255

VoiceChatManager

Type: VoiceChatReplicationInfo


Enums

EJoinChatResult

JCR_Invalid 
Unspecified error (replication hasn't finished, etc.)
JCR_Member 
Already a member
JCR_NeedPassword 
Password protected
JCR_WrongPassword 
Incorrect password specified in join request
JCR_Banned 
Player is banned from this channel
JCR_Full 
Channel is full
JCR_NotAllowed 
Improper join (opposite teams, etc.)
JCR_Success 
Successful join

Functions

Events

IsMember

simulated event bool IsMember (PlayerReplicationInfo PRI, optional bool bNoCascade)


Other instance functions

AddChild

simulated function bool AddChild (VoiceChatRoom NewChild)


AddMember

function AddMember (PlayerReplicationInfo PRI)


CanJoinChannel

simulated function bool CanJoinChannel (PlayerReplicationInfo PRI)


GetMask

simulated function int GetMask ()


GetMaxChatters

simulated function int GetMaxChatters ()


GetMembers

simulated function array<PlayerReplicationInfoGetMembers ()


GetPassword

simulated function string GetPassword ()


GetTeam

simulated function int GetTeam ()


GetTitle

simulated function string GetTitle ()


IsFull

simulated function bool IsFull ()


IsPrivateChannel

simulated function bool IsPrivateChannel ()


IsPublicChannel

simulated function bool IsPublicChannel ()


IsTeamChannel

simulated function bool IsTeamChannel ()


JoinChannel

function EJoinChatResult JoinChannel (PlayerReplicationInfo NewPRI, string InPassword)


LeaveChannel

function bool LeaveChannel (PlayerReplicationInfo LeavingPRI)


NotifyTeamChange

simulated function bool NotifyTeamChange (PlayerReplicationInfo PRI, int NewTeamIndex)


RemoveChild

simulated function bool RemoveChild (VoiceChatRoom Child)


RemoveMember

function RemoveMember (PlayerReplicationInfo PRI)


SetChannelPassword

simulated function SetChannelPassword (string InPassword)


SetMemberMask

simulated function SetMemberMask (int NewMask)


SetTeam

simulated function SetTeam (int NewTeam)


ValidMask

simulated function bool ValidMask ()