Page tree
Skip to end of metadata
Go to start of metadata



Introduced in

Version:2.12

Description

Description:

Defines the load balancing setting for Simulation Clients. Simulation Clients (SCs) are separate instances of VBS2 processes, that are used to spread the servers workload, and are created using the -simulationClient command-line option).

Once the number of entities handled by an SC (units, vehicles, and PhysX objects) exceeds the specified threshold, they are transferred ("balanced") to either another SC or a Dedicated Server (DS).

Syntax

Syntax:setBalancingThreshold limit
Parameters:
  • limit: Number - Factor by which an SC entity count has to exceed the average, before being balanced (average is calculated from all the connected SCs). A value of 1 means no threshold at all (workload is distributed equally among all SCs), and a value of 2 means there have to be twice as many entities on an SC before they get redistributed (default: 1.1).
Return Value:Nothing

Examples

Examples:
setBalancingThreshold 1.3

Additional Information

See also: setBalancingOffload
Multiplayer:
Problems:

Notes