GameSettings

Inherits from SystemSettings

Summary

Constructors

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

Properties

Name Type
maxPlayerCount int
maxSpectatorCount int
layerInclusionTable SubWorldInclusion | nil
logFileCollisionMode LogFileCollisionMode
logFileRotationHistoryLength int
level string
defaultLayerInclusion string
inputConfiguration InputConfigurationAsset[]
defaultTeamId TeamId
levelWarmUpTime float
timeToWaitForQuitTaskCompletion float
platform GamePlatform
version VersionData | nil
pS3ContentRatingAge int
difficultyIndex int
timeBeforeSpawnIsAllowed float
soldierWeaponSwitching SoldierWeaponSwitchingData | nil
logHistory int
difficultySettings DifficultyDatas | nil
metadataContainers BlueprintBundleMetadataContainer[]
currentSKU SKU
player PlayerData | nil
logFileEnable bool
rotateLogs bool
enableLoadingProfile bool
adjustVehicleCenterOfMass bool
autoAimEnabled bool
hasUnlimitedAmmo bool
hasUnlimitedMags bool
resourceRefreshAlwaysAllowed bool
useSpeedBasedDetailedCollision bool
aimAssistEnabled bool
aimAssistUsePolynomials bool
forceFreeStreaming bool
forceDisableFreeStreaming bool
isGodMode bool
isJesusMode bool
isJesusModeAi bool
useSingleWeaponSelector bool
gameAdministrationEnabled bool
allowDestructionOutsideCombatArea bool

Static members

Name Type
GameSettings.typeInfo TypeInformation

Constructors

GameSettings

GameSettings()

Creates a new GameSettings frostbite instance.

GameSettings

GameSettings(guid: Guid)

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

Parameters

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

GameSettings

GameSettings(other: SystemSettings)

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

Parameters

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

GameSettings

GameSettings(other: DataContainer)

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

Parameters

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

Properties

maxPlayerCount

int

maxSpectatorCount

int

layerInclusionTable

SubWorldInclusion | nil

logFileCollisionMode

LogFileCollisionMode

logFileRotationHistoryLength

int

level

string

defaultLayerInclusion

string

inputConfiguration

InputConfigurationAsset[]

defaultTeamId

TeamId

levelWarmUpTime

float

timeToWaitForQuitTaskCompletion

float

platform

GamePlatform

version

VersionData | nil

pS3ContentRatingAge

int

difficultyIndex

int

timeBeforeSpawnIsAllowed

float

soldierWeaponSwitching

SoldierWeaponSwitchingData | nil

logHistory

int

difficultySettings

DifficultyDatas | nil

metadataContainers

BlueprintBundleMetadataContainer[]

currentSKU

SKU

player

PlayerData | nil

logFileEnable

bool

rotateLogs

bool

enableLoadingProfile

bool

adjustVehicleCenterOfMass

bool

autoAimEnabled

bool

hasUnlimitedAmmo

bool

hasUnlimitedMags

bool

resourceRefreshAlwaysAllowed

bool

useSpeedBasedDetailedCollision

bool

aimAssistEnabled

bool

aimAssistUsePolynomials

bool

forceFreeStreaming

bool

forceDisableFreeStreaming

bool

isGodMode

bool

isJesusMode

bool

isJesusModeAi

bool

useSingleWeaponSelector

bool

gameAdministrationEnabled

bool

allowDestructionOutsideCombatArea

bool

Static members

typeInfo

TypeInformation

The type information for the GameSettings type.

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