host.anzo.eossdk.eos.sdk.platform.options

Class EOS_Platform_Options

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.platform.options.EOS_Platform_Options

Direct Known Subclasses:

EOS_Platform_Options.ByReference, EOS_Platform_Options.ByValue

@Structure.FieldOrder(value={"ApiVersion","Reserved","ProductId","SandboxId","ClientCredentials","IsServer","EncryptionKey","OverrideCountryCode","OverrideLocaleCode","DeploymentId","Flags","CacheDirectory","TickBudgetInMilliseconds","RTCOptions","IntegratedPlatformOptionsContainerHandle","SystemSpecificOptions","TaskNetworkTimeoutSeconds"})
public class EOS_Platform_Options
extends com.sun.jna.Structure

Platform options for EOS_Platform_Create

Since:

8/5/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Platform_Options.ByReference
static class	EOS_Platform_Options.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
int	ApiVersion API Version: Set this to EOS_PLATFORM_OPTIONS_API_LATEST.
java.lang.String	CacheDirectory Used by Player Data Storage and Title Storage.
EOS_Platform_ClientCredentials	ClientCredentials Set of service permissions associated with the running application
java.lang.String	DeploymentId The deployment ID for the running application, found on the dev portal.
java.lang.String	EncryptionKey Used by Player Data Storage and Title Storage.
static int	EOS_PLATFORM_OPTIONS_API_LATEST The most recent version of the EOS_Platform_Options API.
EOS_Platform_Create_Flag	Flags Platform creation flags, e.g.
EOS_IntegratedPlatformOptionsContainer	IntegratedPlatformOptionsContainerHandle A handle that contains all the options for setting up integrated platforms.
EOS_Bool	IsServer Set this to EOS_Bool.EOS_FALSE if the application is running as a client with a local user, otherwise set to EOS_Bool.EOS_TRUE (e.g. for a dedicated game server)
java.lang.String	OverrideCountryCode The override country code to use for the logged in user.
java.lang.String	OverrideLocaleCode The override locale code to use for the logged in user.
java.lang.String	ProductId The product ID for the running application, found on the dev portal.
com.sun.jna.Pointer	Reserved A reserved field that should always be nulled.
EOS_Platform_RTCOptions.ByReference	RTCOptions RTC options.
java.lang.String	SandboxId The sandbox ID for the running application, found on the dev portal.
com.sun.jna.Pointer	SystemSpecificOptions Pointer to EOS_"PLATFORM_NAME"_SystemSpecificOptions.
com.sun.jna.ptr.DoubleByReference	TaskNetworkTimeoutSeconds Number of seconds for a task to wait for the network to become available before timing out with an EOS_TimedOut error.
int	TickBudgetInMilliseconds A budget, measured in milliseconds, for EOS_Platform_Tick to do its work.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
EOS_Platform_Options()
EOS_Platform_Options(@NotNull EOSBaseOptions options)
EOS_Platform_Options(com.sun.jna.Pointer peer)

Method Summary

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EOS_PLATFORM_OPTIONS_API_LATEST

public static int EOS_PLATFORM_OPTIONS_API_LATEST

The most recent version of the EOS_Platform_Options API.

ApiVersion

public int ApiVersion

API Version: Set this to EOS_PLATFORM_OPTIONS_API_LATEST.

Reserved

public com.sun.jna.Pointer Reserved

A reserved field that should always be nulled.

ProductId

public java.lang.String ProductId

The product ID for the running application, found on the dev portal. Max length is EOS_PLATFORM_OPTIONS_PRODUCTID_MAX_LENGTH.

SandboxId

public java.lang.String SandboxId

The sandbox ID for the running application, found on the dev portal. Max length is EOS_PLATFORM_OPTIONS_SANDBOXID_MAX_LENGTH.

ClientCredentials

public EOS_Platform_ClientCredentials ClientCredentials

Set of service permissions associated with the running application

IsServer

public EOS_Bool IsServer

Set this to EOS_Bool.EOS_FALSE if the application is running as a client with a local user, otherwise set to EOS_Bool.EOS_TRUE (e.g. for a dedicated game server)

EncryptionKey

public java.lang.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; EOS_PLATFORM_OPTIONS_ENCRYPTIONKEY_LENGTH hex chars.

OverrideCountryCode

public java.lang.String OverrideCountryCode

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

OverrideLocaleCode

public java.lang.String OverrideLocaleCode

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

DeploymentId

public java.lang.String DeploymentId

The deployment ID for the running application, found on the dev portal. Max length is EOS_PLATFORM_OPTIONS_DEPLOYMENTID_MAX_LENGTH.

Flags

public EOS_Platform_Create_Flag Flags

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

CacheDirectory

public java.lang.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.

TickBudgetInMilliseconds

public int 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

public EOS_Platform_RTCOptions.ByReference RTCOptions

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

IntegratedPlatformOptionsContainerHandle

public EOS_IntegratedPlatformOptionsContainer IntegratedPlatformOptionsContainerHandle

A handle that contains all the options for setting up integrated platforms. When set to NULL, the EOS Integrated Platform behavior for the host platform will be disabled.

SystemSpecificOptions

public com.sun.jna.Pointer SystemSpecificOptions

Pointer to EOS_"PLATFORM_NAME"_SystemSpecificOptions. This structure will be located in "PLATFORM_NAME"/eos_"PLATFORM_NAME".h

TaskNetworkTimeoutSeconds

public com.sun.jna.ptr.DoubleByReference TaskNetworkTimeoutSeconds

Number of seconds for a task to wait for the network to become available before timing out with an EOS_TimedOut error. This timeout period applies when the network status is not EOS_NS_Online. Tasks that need the network will queue for up to this timeout until EOS_Platform_SetNetworkStatus is used to set the network status to online.

Pass a null pointer to use the default. Otherwise, pass a pointer to a double containing the number of seconds for tasks that are waiting for network to time out.

See Also:

EOS_Platform_Interface.setNetworkStatus(EOS_ENetworkStatus), EOS_ENetworkStatus

Constructor Detail

EOS_Platform_Options

public EOS_Platform_Options()

EOS_Platform_Options

public EOS_Platform_Options(com.sun.jna.Pointer peer)

EOS_Platform_Options

public EOS_Platform_Options(@NotNull
                            @NotNull EOSBaseOptions options)