Scene¶

class · namespace Hazel

The active simulation scene: its entities, components, and settings. Find entities, read or set the SimulationMode, and drive playback from scripts.

Inherits Asset<Scene>

public sealed class Scene : Asset<Scene>

Properties¶

ActionGateSettleSteps¶

static

public static int ActionGateSettleSteps { get; }

Settle ticks after each reset before the External Action Gate re-arms. Configurable per scene in the External Action Gate settings; default 20.

ControlRunnerHz¶

static

public static double ControlRunnerHz { get; }

Frequency (Hz) of the time runner the External Action Gate / AgentService.Step advances. One gated Step is exactly 1/this seconds of sim time. 0 if unavailable.

SimulationMode¶

static

public static SimulationMode SimulationMode { get; set; }

Gets or sets the simulation timing mode. Use SimulationMode.DeterministicHighPerf for RL training to run faster than real-time.

TimeScale¶

static

public static float TimeScale { set; }

Methods¶

CreateEntity(string)¶

static

public static Entity CreateEntity(string tag = "Unnamed")

DestroyAllChildren(Entity)¶

static

public static void DestroyAllChildren(Entity entity)

DestroyEntity(Entity)¶

static

public static void DestroyEntity(Entity entity)

FindEntityByID(ulong)¶

static

public static Entity? FindEntityByID(ulong entityID)

FindEntityByTag(string)¶

static

public static Entity? FindEntityByTag(string tag)

GetEntities()¶

static

public static Entity[] GetEntities()

InstantiatePrefab(Prefab)¶

static

public static Entity? InstantiatePrefab(Prefab prefab)

InstantiatePrefab(Prefab, Transform)¶

static

public static Entity? InstantiatePrefab(Prefab prefab, Transform transform)

InstantiatePrefab(Prefab, Vector3)¶

static

public static Entity? InstantiatePrefab(Prefab prefab, Vector3 translation)

InstantiatePrefab(Prefab, Vector3, Vector3)¶

static

public static Entity? InstantiatePrefab(Prefab prefab, Vector3 translation, Vector3 rotation)

InstantiatePrefab(Prefab, Vector3, Vector3, Vector3)¶

static

public static Entity? InstantiatePrefab(Prefab prefab, Vector3 translation, Vector3 rotation, Vector3 scale)

InstantiatePrefabWithParent(Prefab, Entity)¶

static

public static Entity? InstantiatePrefabWithParent(Prefab prefab, Entity parent)

InstantiatePrefabWithParent(Prefab, Transform, Entity)¶

static

public static Entity? InstantiatePrefabWithParent(Prefab prefab, Transform transform, Entity parent)

InstantiatePrefabWithParent(Prefab, Vector3, Entity)¶

static

public static Entity? InstantiatePrefabWithParent(Prefab prefab, Vector3 translation, Entity parent)

InstantiatePrefabWithParent(Prefab, Vector3, Vector3, Entity)¶

static

public static Entity? InstantiatePrefabWithParent(Prefab prefab, Vector3 translation, Vector3 rotation, Entity parent)

InstantiatePrefabWithParent(Prefab, Vector3, Vector3, Vector3, Entity)¶

static

public static Entity? InstantiatePrefabWithParent(Prefab prefab, Vector3 translation, Vector3 rotation, Vector3 scale, Entity parent)

Source: Hazel/Scene/Scene.cs