Members
(readonly) batchSize :number
The number of scenes that exist within the current batch, i.e. how many
Scene objects currently exist in memory. Note that a batch can contain
multiple scenes, but only one scene can be selected at a time.
Type:
- number
- Source:
(readonly) selected :rune.scene.Scene
The currently selected scene.
Type:
- Source:
Methods
find(name) → {rune.scene.Scene}
Searches for a specific scene in the current batch of scene objects. The
search is based on scene name.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | The name of the searched scene. |
- Source:
Returns:
- Type
- rune.scene.Scene
findAndSelect(name) → {boolean}
Searching for a specific scene. The scene is automatically activated
if it is found.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | The name of the searched scene. |
- Source:
Returns:
- Type
- boolean
load(batch) → {undefined}
Activates a batch of scenes. This process removes any previous scenes and
frees up allocated memory, hence the process can not be undone.
Parameters:
| Name | Type | Description |
|---|---|---|
batch |
Array.<rune.scene.Scene> | Batch to be loaded. |
- Source:
Throws:
-
If the specified batch is invalid.
- Type
- Error
Returns:
- Type
- undefined
select(index) → {undefined}
Select a scene from the current batch. Note that only the selected scene is
rendered. Inactive scenes remain unchanged during their time as inactive.
Parameters:
| Name | Type | Description |
|---|---|---|
index |
number | List index of requested scene. |
- Source:
Throws:
-
On invalid list index.
- Type
- RangeError
Returns:
- Type
- undefined