There is no spoon

UE3:OnlineSubsystemCommonImpl (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> OnlineSubsystem >> OnlineSubsystemCommonImpl
Package: 
IpDrv
Known classes within OnlineSubsystemCommonImpl:
OnlineGameInterfaceImpl
Direct subclass:
OnlineSubsystemPC
This class in other games:
UT3

Class that implements commonly needed members/features across all platforms

Properties[edit]

bIsUsingSpeechRecognition[edit]

Type: bool

Modifiers: config

Whether speech recognition is enabled

Default value: True

GameInterfaceImpl[edit]

Type: OnlineGameInterfaceImpl

The object that handles the game interface implementation across platforms

MaxLocalTalkers[edit]

Type: int

Modifiers: config

Holds the maximum number of local talkers allowed

Default value: 1

MaxRemoteTalkers[edit]

Type: int

Modifiers: config

Holds the maximum number of remote talkers allowed (clamped to 30 which is XHV max)

Default value: 16

VoiceEngine[edit]

Type: pointer{class FVoiceInterface}

Modifiers: const, native, transient

Holds the pointer to the platform specific FVoiceInterface implementation used for voice communication

Functions[edit]

Native functions[edit]

IsPlayerInSession[edit]

native function bool IsPlayerInSession (name SessionName, OnlineSubsystem.UniqueNetId PlayerId)

Determine if the player is registered in the specified session

Parameters:

  • PlayerId - the player to check if in session or not

Returns:

TRUE if the player is a registrant in the session

Events[edit]

GetPlayerNicknameFromIndex[edit]

event string GetPlayerNicknameFromIndex (int UserIndex)

Returns the name of the player for the specified index

Parameters:

  • UserIndex - the user to return the name of

Returns:

the name of the player at the specified index

GetPlayerUniqueNetIdFromIndex[edit]

event OnlineSubsystem.UniqueNetId GetPlayerUniqueNetIdFromIndex (int UserIndex)

Returns the unique id of the player for the specified index

Parameters:

  • UserIndex - the user to return the id of

Returns:

the unique id of the player at the specified index