SimApi Control setRate

From SIMboxWiki
Jump to navigation Jump to search



Icon attributes.pngstatic bool SimApi::Control::setRate(const double newRate)

    Description

    Sets new simulation rate (X4, X8 etc.).

    Parameters

    newRate - The new simulation rate

    Return

    Type: bool   Description: True, if succeeded; otherwise, false.

    Remarks
    

Sets a new rate of the simulation events. By default the rate is 1 (X1). Setting the rate to 2 will cause the simulation to play 2 times faster. The rate values can be 0 < rate < 16.