EngineSingleton

Access to basic engine properties.

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

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Functions

getAuthorInfo
Dictionary getAuthorInfo()

Returns engine author information in a Dictionary. "lead_developers" - Array of Strings, lead developer names "founders" - Array of Strings, founder names "project_managers" - Array of Strings, project manager names "developers" - Array of Strings, developer names

getCopyrightInfo
Array getCopyrightInfo()

Returns an Array of copyright information Dictionaries. "name" - String, component name "parts" - Array of Dictionaries {"files", "copyright", "license"} describing subsections of the component

getDonorInfo
Dictionary getDonorInfo()

Returns a Dictionary of Arrays of donor names. {"platinum_sponsors", "gold_sponsors", "mini_sponsors", "gold_donors", "silver_donors", "bronze_donors"}

getFramesDrawn
long getFramesDrawn()

Returns the total number of frames drawn.

getFramesPerSecond
double getFramesPerSecond()

Returns the frames per second of the running game.

getIterationsPerSecond
long getIterationsPerSecond()
getLicenseInfo
Dictionary getLicenseInfo()

Returns Dictionary of licenses used by Godot and included third party components.

getLicenseText
String getLicenseText()

Returns Godot license text.

getMainLoop
MainLoop getMainLoop()

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

getPhysicsJitterFix
double getPhysicsJitterFix()
getSingleton
GodotObject getSingleton(StringArg0 name)
getTargetFps
long getTargetFps()
getTimeScale
double getTimeScale()
getVersionInfo
Dictionary getVersionInfo()

Returns the current engine version information in a Dictionary. "major" - Holds the major version number as an int "minor" - Holds the minor version number as an int "patch" - Holds the patch version number as an int "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

hasSingleton
bool hasSingleton(StringArg0 name)
isEditorHint
bool isEditorHint()
isInPhysicsFrame
bool isInPhysicsFrame()

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

opAssign
EngineSingleton opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(EngineSingleton other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
setEditorHint
void setEditorHint(bool enabled)
setIterationsPerSecond
void setIterationsPerSecond(long iterations_per_second)
setPhysicsJitterFix
void setPhysicsJitterFix(double physics_jitter_fix)
setTargetFps
void setTargetFps(long target_fps)
setTimeScale
void setTimeScale(double time_scale)

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

editorHint
bool editorHint [@property getter]
bool editorHint [@property setter]

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

iterationsPerSecond
long iterationsPerSecond [@property getter]
long iterationsPerSecond [@property setter]

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

physicsJitterFix
double physicsJitterFix [@property setter]
physicsJitterFix
double physicsJitterFix [@property getter]
targetFps
long targetFps [@property getter]
long targetFps [@property setter]

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

timeScale
double timeScale [@property getter]
double timeScale [@property setter]

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 functions

_new
EngineSingleton _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
ToRef as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta