EOS_Platform_Options

EOS API reference page for EOS_Platform_Options

Choose your implementation method:

C

C#

Remarks

Platform options for EOS_Platform_Create.

Properties

EOS_Platform_Options

Property

Value

int32_t ApiVersion

API Version: Set this to EOS_PLATFORM_OPTIONS_API_LATEST.

void* Reserved

A reserved field that should always be nulled.

const char* ProductId

The product ID for the running application, found on the dev portal

const char* SandboxId

The sandbox ID for the running application, found on the dev portal

EOS_Platform_ClientCredentials ClientCredentials

Set of service permissions associated with the running application

EOS_Bool bIsServer

Is this running as a server

const char* EncryptionKey

Used by Player Data Storage and Title Storage. Must be null initialized if unused. 256-bit Encryption Key for file encryption in hexadecimal format (64 hex chars)

const char* OverrideCountryCode

The override country code to use for the logged in user. (EOS_COUNTRYCODE_MAX_LENGTH)

const char* OverrideLocaleCode

The override locale code to use for the logged in user. This follows ISO 639. (EOS_LOCALECODE_MAX_LENGTH)

const char* DeploymentId

The deployment ID for the running application, found on the dev portal

uint64_t Flags

Platform creation flags, e.g. EOS_PF_LOADING_IN_EDITOR. This is a bitwise-or union of the defined flags.

const char* CacheDirectory

Used by Player Data Storage and Title Storage. Must be null initialized if unused. Cache directory path. Absolute path to the folder that is going to be used for caching temporary data. The path is created if it's missing.

uint32_t TickBudgetInMilliseconds

A budget, measured in milliseconds, for EOS_Platform_Tick to do its work. When the budget is met or exceeded (or if no work is available), EOS_Platform_Tick will return. This allows your game to amortize the cost of SDK work across multiple frames in the event that a lot of work is queued for processing. Zero is interpreted as "perform all available work".

const EOS_Platform_RTCOptions* RTCOptions

RTC options. Setting to NULL will disable RTC features (e.g. voice)

Related API Members

Remarks

Platform options for EOS_Platform_Create.

Properties

Platform.Options

Property

Value

int ApiVersion

API Version: Set this to EOS_PLATFORM_OPTIONS_API_LATEST.

System.IntPtr Reserved

A reserved field that should always be nulled.

string ProductId

The product ID for the running application, found on the dev portal

string SandboxId

The sandbox ID for the running application, found on the dev portal

ClientCredentials ClientCredentials

Set of service permissions associated with the running application

bool IsServer

Is this running as a server

string EncryptionKey

Used by Player Data Storage and Title Storage. Must be null initialized if unused. 256-bit Encryption Key for file encryption in hexadecimal format (64 hex chars)

string OverrideCountryCode

The override country code to use for the logged in user. (EOS_COUNTRYCODE_MAX_LENGTH)

string OverrideLocaleCode

The override locale code to use for the logged in user. This follows ISO 639. (EOS_LOCALECODE_MAX_LENGTH)

string DeploymentId

The deployment ID for the running application, found on the dev portal

PlatformFlags Flags

Platform creation flags, e.g. EOS_PF_LOADING_IN_EDITOR. This is a bitwise-or union of the defined flags.

string CacheDirectory

Used by Player Data Storage and Title Storage. Must be null initialized if unused. Cache directory path. Absolute path to the folder that is going to be used for caching temporary data. The path is created if it's missing.

uint TickBudgetInMilliseconds

A budget, measured in milliseconds, for EOS_Platform_Tick to do its work. When the budget is met or exceeded (or if no work is available), EOS_Platform_Tick will return. This allows your game to amortize the cost of SDK work across multiple frames in the event that a lot of work is queued for processing. Zero is interpreted as "perform all available work".

RTCOptions RTCOptions

RTC options. Setting to NULL will disable RTC features (e.g. voice)

Related API Members