ProbeVolumeScenarioManager
1.5.0+
Manage probe volume scenarios.
Creation
Scenarios must be loaded using:
1const scenario = await engine.probeVolumeScenarios.load('scenario.data.bin');Scenario files are generated by the Wonderland Editor.
- ProbeVolumeScenarioManager
- .constructor(engine) ⇒ ProbeVolumeScenarioManager
- .find(filename) ⇒ null | ProbeVolumeScenario
- .load(filename) ⇒ Promise<ProbeVolumeScenario>
.constructor(engine: WonderlandEngine) ⇒ ProbeVolumeScenarioManager
| Param | Type | Description |
|---|---|---|
| engine | WonderlandEngine |
.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’. |