CryEngine.Engine

Wraps CryEngine's gEnv variable for global access to main modules. Initializes all C# sided handler and wrapper classes. Interfaces should be removed from here once a managed wrapper (such as Input) exists. More...

Static Public Member Functions

static void Shutdown ()
Shuts the engine down, or exits game-mode while in the Sandbox. More...

Static Public Attributes

static string EngineRootDirectory => Global.GetEnginePath().c_str()
Root directory of the engine. More...
static string DataDirectory => Global.GetGameFolder().c_str() + "/"
Path where application data should be stored. More...

Properties

static IConsole Console [get]
static ICryFont Font [get]
static ISystem System [get]
static ParticleManager ParticleManager [get]
static I3DEngine Engine3D [get]
static IGameFramework GameFramework [get]
static ITimer Timer [get]
static Common.CryAudio.IAudioSystem AudioSystem [get]
static IRenderAuxGeom AuxRenderer [get]
static IPhysicalWorld PhysicalWorld [get]
static bool IsSandbox [get]
Indicates whether this T:CryEngine.Engine is running in the Sandbox. More...
static bool IsSandboxGameMode [get]
True if the application is currently running in the sandbox and GameMode has been started. More...
static bool IsDedicatedServer [get]
True if the T:CryEngine.Engine is currently running as a dedicated server. This means that certain systems like the T:CryEngine.Renderer and T:CryEngine.Input and input are not initialized. More...

Detailed Description

Wraps CryEngine's gEnv variable for global access to main modules. Initializes all C# sided handler and wrapper classes. Interfaces should be removed from here once a managed wrapper (such as Input) exists.

Member Function Documentation

◆ Shutdown()

static void CryEngine.Engine.Shutdown ( )
inline
static

Shuts the engine down, or exits game-mode while in the Sandbox.

Member Data Documentation

◆ DataDirectory

string CryEngine.Engine.DataDirectory => Global.GetGameFolder().c_str() + "/"
static

Path where application data should be stored.

The data directory.

◆ EngineRootDirectory

string CryEngine.Engine.EngineRootDirectory => Global.GetEnginePath().c_str()
static

Root directory of the engine.

The engine root directory.

Property Documentation

◆ AudioSystem

Common.CryAudio.IAudioSystem CryEngine.Engine.AudioSystem
static
get

◆ AuxRenderer

IRenderAuxGeom CryEngine.Engine.AuxRenderer
static
get

◆ Console

IConsole CryEngine.Engine.Console
static
get

◆ Engine3D

I3DEngine CryEngine.Engine.Engine3D
static
get

◆ Font

ICryFont CryEngine.Engine.Font
static
get

◆ GameFramework

IGameFramework CryEngine.Engine.GameFramework
static
get

◆ IsDedicatedServer

bool CryEngine.Engine.IsDedicatedServer
static
get

True if the T:CryEngine.Engine is currently running as a dedicated server. This means that certain systems like the T:CryEngine.Renderer and T:CryEngine.Input and input are not initialized.

true if is dedicated server; otherwise, false.

◆ IsSandbox

bool CryEngine.Engine.IsSandbox
static
get

Indicates whether this T:CryEngine.Engine is running in the Sandbox.

true if this is running in the Sandbox; otherwise, false.

◆ IsSandboxGameMode

bool CryEngine.Engine.IsSandboxGameMode
static
get

True if the application is currently running in the sandbox and GameMode has been started.

true if in GameMode; otherwise, false.

◆ ParticleManager

ParticleManager CryEngine.Engine.ParticleManager
static
get

◆ PhysicalWorld

IPhysicalWorld CryEngine.Engine.PhysicalWorld
static
get

◆ System

ISystem CryEngine.Engine.System
static
get

◆ Timer

ITimer CryEngine.Engine.Timer
static
get