Mostly Harmless

UE2:VoiceChatRoom (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT2004 Object >> Actor >> Info >> VoiceChatRoom

Contents

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

[edit] Properties

[edit] bLocal

Type: bool

- not yet implemented

[edit] ChannelIndex

Type: int


Default value: -1

[edit] Children

Type: array<VoiceChatRoom>


[edit] GRI

Type: GameReplicationInfo


[edit] Parent

Type: VoiceChatRoom


[edit] Password

Type: string


[edit] TeamIndex

Type: int

Modifiers: private


Default value: 255

[edit] VoiceChatManager

Type: VoiceChatReplicationInfo


[edit] Enums

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

[edit] Functions

[edit] Events

[edit] IsMember

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


[edit] Other instance functions

[edit] AddChild

simulated function bool AddChild (VoiceChatRoom NewChild)


[edit] AddMember

function AddMember (PlayerReplicationInfo PRI)


[edit] CanJoinChannel

simulated function bool CanJoinChannel (PlayerReplicationInfo PRI)


[edit] GetMask

simulated function int GetMask ()


[edit] GetMaxChatters

simulated function int GetMaxChatters ()


[edit] GetMembers

simulated function array<PlayerReplicationInfoGetMembers ()


[edit] GetPassword

simulated function string GetPassword ()


[edit] GetTeam

simulated function int GetTeam ()


[edit] GetTitle

simulated function string GetTitle ()


[edit] IsFull

simulated function bool IsFull ()


[edit] IsPrivateChannel

simulated function bool IsPrivateChannel ()


[edit] IsPublicChannel

simulated function bool IsPublicChannel ()


[edit] IsTeamChannel

simulated function bool IsTeamChannel ()


[edit] JoinChannel

function EJoinChatResult JoinChannel (PlayerReplicationInfo NewPRI, string InPassword)


[edit] LeaveChannel

function bool LeaveChannel (PlayerReplicationInfo LeavingPRI)


[edit] NotifyTeamChange

simulated function bool NotifyTeamChange (PlayerReplicationInfo PRI, int NewTeamIndex)


[edit] RemoveChild

simulated function bool RemoveChild (VoiceChatRoom Child)


[edit] RemoveMember

function RemoveMember (PlayerReplicationInfo PRI)


[edit] SetChannelPassword

simulated function SetChannelPassword (string InPassword)


[edit] SetMemberMask

simulated function SetMemberMask (int NewMask)


[edit] SetTeam

simulated function SetTeam (int NewTeam)


[edit] ValidMask

simulated function bool ValidMask ()