Access to basic engine properties.
    public static class Engine

The Engine class allows you to query and modify the game’s run-time parameters, such as frames per second, time scale, and others.

Inheritance Chain

Static Properties

    public static bool EditorHint { get; set; }

If true, it is running inside the editor. Useful for tool scripts.

    public static int IterationsPerSecond { get; set; }

The number of fixed iterations per second (for fixed process and physics).

    public static int TargetFps { get; set; }

The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit.

    public static float TimeScale { get; set; }

Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed.

Static Methods

    public static int GetFramesDrawn()

Returns the total number of frames drawn.

    public static float GetFramesPerSecond()

Returns the frames per second of the running game.

    public static int GetIterationsPerSecond()

Getter for IterationsPerSecond

    public static MainLoop GetMainLoop()

Returns the main loop object (see MainLoop and SceneTree).

    public static Object GetSingleton(string name)

    public static int GetTargetFps()

Getter for TargetFps

    public static float GetTimeScale()

Getter for TimeScale

    public static Dictionary<object, object> GetVersionInfo()

Returns the current engine version information in a Dictionary.

“major” - Holds the major version number as a String

“minor” - Holds the minor version number as a String

“patch” - Holds the patch version number as a String

“status” - Holds the status (e.g. “beta”, “rc1”, “rc2”, … “stable”) as a String

“build” - Holds the build name (e.g. “custom-build”) as a String

“string” - major + minor + patch + status + build in a single String

    public static bool HasSingleton(string name)

    public static bool IsEditorHint()

Getter for EditorHint

    public static bool IsInPhysicsFrame()

Returns true if the game is inside the fixed process and physics phase of the game loop.

    public static void SetEditorHint(bool enabled)

Setter for EditorHint

    public static void SetIterationsPerSecond(int iterationsPerSecond)

Setter for IterationsPerSecond

    public static void SetTargetFps(int targetFps)

Setter for TargetFps

    public static void SetTimeScale(float timeScale)

Setter for TimeScale

Tags: