SimApi Control getRate

From SIMboxWiki
Jump to navigation Jump to search



Icon attributes.pngstatic double SimApi::Control::getRate()

    Description

    Gets the current simulation rate.

    Return

    Type: double   Description: The current simulation rate.

    Remarks
    

The simulation can change the rate of events and interactions. The usual rate is X1 which means that all the events and attributes are changes according to the original time and pace. It is possible to change the rate of events up to X16 (16 times faster than the normal pace). The rate must be bigger than 0 and smaller or equal to 16.


    See Also

    setRate