ClientSettings

Inherits from SystemSettings

Summary

Constructors

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

Properties

Name Type
loadedTimeout float
outgoingRate int
loadingTimeout float
incomingFrequency float
incomingRate int
duplicationChance float
team int
maxDropDuration float
reorderingChance float
dropSpikeChance float
minDropDuration float
maxIncomingLatency float
packetDrops float
maxLatency float
minIncomingLatency float
corruptionChance float
serverIp string
screenshotSuffix string
spawnPointIndex int
minLatency float
screenshotFilename string
ingameTimeout float
aimScale float
secondaryServerIp string
skipFastLevelLoad bool
screenshotToFile bool
ignoreClientFireRateMultiplier bool
inputEnable bool
loadMenu bool
pauseGameOnStartUp bool
debugMenuOnLThumb bool
invertPitch bool
occludersEnabled bool
isPresenceEnabled bool
invertFreeCamera bool
scheme2FlipY bool
invertYaw bool
lipSyncEnabled bool
isInternetSimulationEnabled bool
onDamageSpottingEnabled bool
emittersEnabled bool
padRumbleEnabled bool
overgrowthEnabled bool
effectsEnabled bool
terrainEnabled bool
waterPhysicsEnabled bool
vegetationEnabled bool
worldRenderEnabled bool
renderTags bool
debrisClusterEnabled bool
havokVisualDebugger bool
havokVDBShowsEffectsWorld bool
havokCaptureToFile bool
useMouseAndKeyboardSystem bool
useGlobalGamePadInput bool
threadedLoadingEnable bool
showBuildId bool
extractPersistenceInformation bool
enableRestTool bool
localVehicleSimulationEnabled bool
asyncClientBulletEntity bool
autoUnspawnDynamicObjects bool
vsyncEnable bool
visualFrameInterpolation bool
invertPadPcRightStick bool
scheme0FlipY bool
isSpectator bool
scheme1FlipY bool
quitGameOnServerDisconnect bool

Static members

Name Type
ClientSettings.typeInfo TypeInformation

Constructors

ClientSettings

ClientSettings()

Creates a new ClientSettings frostbite instance.

ClientSettings

ClientSettings(guid: Guid)

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

Parameters

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

ClientSettings

ClientSettings(other: SystemSettings)

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

Parameters

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

ClientSettings

ClientSettings(other: DataContainer)

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

Parameters

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

Properties

loadedTimeout

float

outgoingRate

int

loadingTimeout

float

incomingFrequency

float

incomingRate

int

duplicationChance

float

team

int

maxDropDuration

float

reorderingChance

float

dropSpikeChance

float

minDropDuration

float

maxIncomingLatency

float

packetDrops

float

maxLatency

float

minIncomingLatency

float

corruptionChance

float

serverIp

string

screenshotSuffix

string

spawnPointIndex

int

minLatency

float

screenshotFilename

string

ingameTimeout

float

aimScale

float

secondaryServerIp

string

skipFastLevelLoad

bool

screenshotToFile

bool

ignoreClientFireRateMultiplier

bool

inputEnable

bool

loadMenu

bool

pauseGameOnStartUp

bool

debugMenuOnLThumb

bool

invertPitch

bool

occludersEnabled

bool

isPresenceEnabled

bool

invertFreeCamera

bool

scheme2FlipY

bool

invertYaw

bool

lipSyncEnabled

bool

isInternetSimulationEnabled

bool

onDamageSpottingEnabled

bool

emittersEnabled

bool

padRumbleEnabled

bool

overgrowthEnabled

bool

effectsEnabled

bool

terrainEnabled

bool

waterPhysicsEnabled

bool

vegetationEnabled

bool

worldRenderEnabled

bool

renderTags

bool

debrisClusterEnabled

bool

havokVisualDebugger

bool

havokVDBShowsEffectsWorld

bool

havokCaptureToFile

bool

useMouseAndKeyboardSystem

bool

useGlobalGamePadInput

bool

threadedLoadingEnable

bool

showBuildId

bool

extractPersistenceInformation

bool

enableRestTool

bool

localVehicleSimulationEnabled

bool

asyncClientBulletEntity

bool

autoUnspawnDynamicObjects

bool

vsyncEnable

bool

visualFrameInterpolation

bool

invertPadPcRightStick

bool

scheme0FlipY

bool

isSpectator

bool

scheme1FlipY

bool

quitGameOnServerDisconnect

bool

Static members

typeInfo

TypeInformation

The type information for the ClientSettings type.

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