void SetUpdateFrequency(float value)

Changes how frequently a simulation update is called. The default of 1 means 16 FPS. Regardless what frequency is used, each simulation update will advance game time by 0.0625 unless SetSpeedFactor() is also used.

• float value the frequency with which simulation updates are called. Supported values are [1/4, 1/2, 1, 2].

DCEI.SetUpdateFrequency(2)

• SetSpeedFactor(float value)

void ClearUpdateFrequency()

Resets update frequency to the default frequency of 1, meaning 16 FPS.

DCEI.ClearUpdateFrequency()

float GetUpdateFrequency()

Returns the update frequency.

DCEI.LogMessage(DCEI.GetUpdateFrequency())

void SetSpeedFactor(float value)

Sets the speed factor for the simulation. The speed factor applies a multiplier to delta time in simulation updates, affecting how much time is processed in each simulation update. This will affect simulation results so it's recommended to only use it for slow motion effects with values like 1/64, 1/128, etc. Simulation update rate is now defaulted to 16 FPS with exactly 0.0625 delta time between updates.

• float value the multiplier for how much time is processed on each game update.

DCEI.SetSpeedFactor(0.5)

• SetUpdateFrequency(float value)

float GetSpeedFactor()

Returns the speed factor.

DCEI.LogMessage(DCEI.GetSpeedFactor())

void SetVictory()

Ends the game in a victory.

DCEI.SetVictory()

void SetDefeat()

Ends the game in a defeat.

DCEI.SetDefeat()

void SetVictoryForPlayer(int player, string result)

End the game in a victory for given player, with the given result.

• int player integer corresponding to the player.
• string result the result.

DCEI.SetVictoryForPlayer(1, "Win")

void SetDefeatForPlayer(int player, string result)

End the game in a defeat for given player, with the given result.

• int player integer corresponding to the player.
• string result the result.

DCEI.SetVictoryForPlayer(1, "Lose")