OnlineSettings

Inherits from SystemSettings

Summary

Constructors

OnlineSettings()
OnlineSettings(guid: Guid)
OnlineSettings(other: SystemSettings)
OnlineSettings(other: DataContainer)

Properties

Name Type
backend BackendType
peerBackend BackendType
environment OnlineEnvironment
matchmakingToken string
provider OnlineProviderAsset | nil
richPresence RichPresenceData | nil
chatSettings ChatSettings | nil
matchmakingOptions string
region string
negativeUserCacheRefreshPeriod int
matchmakingMode string
country string
isSecure bool
supportHostMigration bool
matchmakeImmediately bool

Static members

Name Type
OnlineSettings.typeInfo TypeInformation

Constructors

OnlineSettings

OnlineSettings()

Creates a new OnlineSettings frostbite instance.

OnlineSettings

OnlineSettings(guid: Guid)

Creates a new OnlineSettings frostbite instance and assigns it the provided Guid.

Parameters

Name Type Description
guid Guid The Guid to assign to the newly created instance.

OnlineSettings

OnlineSettings(other: SystemSettings)

Casts an instance of type SystemSettings to OnlineSettings. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other SystemSettings The instance to cast to OnlineSettings.

OnlineSettings

OnlineSettings(other: DataContainer)

Casts an instance of type DataContainer to OnlineSettings. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other DataContainer The instance to cast to OnlineSettings.

Properties

backend

BackendType

peerBackend

BackendType

environment

OnlineEnvironment

matchmakingToken

string

provider

OnlineProviderAsset | nil

richPresence

RichPresenceData | nil

chatSettings

ChatSettings | nil

matchmakingOptions

string

region

string

negativeUserCacheRefreshPeriod

int

matchmakingMode

string

country

string

isSecure

bool

supportHostMigration

bool

matchmakeImmediately

bool

Static members

typeInfo

TypeInformation

The type information for the OnlineSettings type.

Last modified April 26, 2020: Update frostbite type documentation (8b14351)