Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

PlayerSettings.XboxOne.SetSocketDefinition

Switch to Manual
public static function SetSocketDefinition(name: string, port: string, protocol: int, usages: int[], templateName: string, sessionRequirment: int, deviceUsages: int[]): void;

Parameters

nameThe name of the socket description.
portThe port or port range the socket can use.
protocolThe protocol the socket uses.
usagesThe allowed usage flags for this socket description.
templateNameThe name of the device association template.
sessionRequirmentMutiplayer requirement setting for the device association template.
deviceUsagesThe allowed usage flags for the device association template.

Description

Set the values for the socket description with the given name.

The name must be a value found in the PlayerSettings.XboxOne.SocketNames array. Please see the Secure Device Socket Description section in the Xbox One Player Settings documentation for more details on the parameters.