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

UE2:VoiceChatRoom (UT2004)

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

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

bLocal[edit]

Type: bool

- not yet implemented

ChannelIndex[edit]

Type: int


Default value: -1

Children[edit]

Type: array<VoiceChatRoom>


GRI[edit]

Type: GameReplicationInfo


Parent[edit]

Type: VoiceChatRoom


Password[edit]

Type: string


TeamIndex[edit]

Type: int

Modifiers: private


Default value: 255

VoiceChatManager[edit]

Type: VoiceChatReplicationInfo


Enums[edit]

EJoinChatResult[edit]

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

Events[edit]

IsMember[edit]

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


Other instance functions[edit]

AddChild[edit]

simulated function bool AddChild (VoiceChatRoom NewChild)


AddMember[edit]

function AddMember (PlayerReplicationInfo PRI)


CanJoinChannel[edit]

simulated function bool CanJoinChannel (PlayerReplicationInfo PRI)


GetMask[edit]

simulated function int GetMask ()


GetMaxChatters[edit]

simulated function int GetMaxChatters ()


GetMembers[edit]

simulated function array<PlayerReplicationInfoGetMembers ()


GetPassword[edit]

simulated function string GetPassword ()


GetTeam[edit]

simulated function int GetTeam ()


GetTitle[edit]

simulated function string GetTitle ()


IsFull[edit]

simulated function bool IsFull ()


IsPrivateChannel[edit]

simulated function bool IsPrivateChannel ()


IsPublicChannel[edit]

simulated function bool IsPublicChannel ()


IsTeamChannel[edit]

simulated function bool IsTeamChannel ()


JoinChannel[edit]

function EJoinChatResult JoinChannel (PlayerReplicationInfo NewPRI, string InPassword)


LeaveChannel[edit]

function bool LeaveChannel (PlayerReplicationInfo LeavingPRI)


NotifyTeamChange[edit]

simulated function bool NotifyTeamChange (PlayerReplicationInfo PRI, int NewTeamIndex)


RemoveChild[edit]

simulated function bool RemoveChild (VoiceChatRoom Child)


RemoveMember[edit]

function RemoveMember (PlayerReplicationInfo PRI)


SetChannelPassword[edit]

simulated function SetChannelPassword (string InPassword)


SetMemberMask[edit]

simulated function SetMemberMask (int NewMask)


SetTeam[edit]

simulated function SetTeam (int NewTeam)


ValidMask[edit]

simulated function bool ValidMask ()