SetMapEngineFrameRate

From Spheriki

Sets the speed of the map engine.

Contents 1 Usage 2 Examples 3 Notes 4 See also

Usage

SetMapEngineFrameRate(fps);

• fps Number, positive. The frames per second for the map engine to run at.

Examples

Place the following in a map entry script, using the Sphere IDE map editor.

SetMapEngineFrameRate(40);

This will cause the map engine to run slower than usual (40 frames per second), even if the fps used for the MapEngine() call was higher.

Notes

• This function will not work if the map engine is not running.

• Frames per second is a widely used method to describe the speed at which redraws of the screen take place. For the map engine, it also determines how fast or slow map updates are performed. Sixty (60) is a typical figure; higher values will make the map engine run faster, and lower values cause the map engine to run more slowly.

• The number given by the fps parameter is the desired framerate. The actual framerate will depend on the speed of the system, and can be displayed in the map engine by pressing F11.

• The throttle can be overriden by the player by pressing F1, which will cause the map engine to run as fast as it can without skipping frames.

See also

• GetMapEngineFrameRate()
• MapEngine()