ProbeVolumeScenarioManager

1.5.0+

Manage probe volume scenarios.

Creation

Scenarios must be loaded using:

const scenario = await engine.probeVolumeScenarios.load('scenario.data.bin');

Scenario files are generated by the Wonderland Editor.

Static Members

• .constructor(engine) ⇒ ProbeVolumeScenarioManager

Methods

• .find(filename) ⇒ null | ProbeVolumeScenario
• .load(filename) ⇒ Promise<ProbeVolumeScenario>

---

Constructor

.constructor(engine: WonderlandEngine) ⇒ ProbeVolumeScenarioManager

Param	Type	Description
engine	WonderlandEngine

---

Methods

.find(filename: string) ⇒ null | ProbeVolumeScenario

Retrieve a scenario by filename.

Returns: The scenario if found, null otherwise.

Param	Type	Description
filename	string	The string containing the filename.

---

.load(filename: string) ⇒ Promise<ProbeVolumeScenario>

Load the probe volume scenario

Note: The scenario is loaded but not applied. To select it, use probeVolumeScenario.

Param	Type	Description
filename	string	Relative URL from the main scene .bin file to the scenario, e.g., ‘scenarios/day.data.bin’.

---