Composite Scenes System
battle_composite_scenes_system objects facilitates the interaction with composite scenes instances. A handle to a composite scene system object may be obtained through the battle:composite_scenes_system function.
| Loaded in Campaign |
|
| Loaded in Battle |
|
| Loaded in Frontend |
|
-
composite_scenes_system:terrain_composite_scenes() -
Returns a list of all terrain composite scenes on the map.
Returns:
-
composite_scenes_system:composite_scenes_by_scene_name(scene_namestring) -
Returns a list of all terrain composite scenes with the given scene name.
Parameters:
1
scene_name
Returns:
battle_composite_scenes_list
-
composite_scenes_system:composite_scenes_by_parent_script_id(parent_script_idstring) -
Returns a list of all terrain composite scenes who have this parent script id.
Parameters:
1
parent_script_id
Returns:
battle_composite_scenes_list
-
composite_scenes_system:composite_scene_by_script_id(script idstring) -
Returns a terrain composite scene with the given script id.
Parameters:
1
script id
Returns:
battle_composite_scene
Composite Scenes List
A battle_composite_scenes_list object represents an array of composite scenes instances.
Handles to composite scenes list objects may be obtained through the battle_composite_scenes_system interface.
-
composite_scenes_list:item(indexnumber) -
Returns the composite scene in the given position in the list.
Parameters:
1
index
Returns:
battle_composite_scene
-
composite_scenes_list:search_by_script_id(script_idstring) -
Returns the composite scene with the given script id.
Parameters:
1
script_id
Returns:
battle_composite_scene
-
composite_scenes_list:search_by_parent_script_id(script_idstring) -
Returns the composite scene which this parent script id.
Parameters:
1
script_id
Returns:
battle_composite_scene
-
composite_scenes_list:search_by_scene_name(scene_namestring) -
Returns a composite scene list of composite scenes with the given scene name.
Parameters:
1
scene_name
Returns:
battle_composite_scenes_list
-
composite_scenes_list:enable([enableboolean], [loopboolean]) -
Enables/disable the all composite scenes in the list.
Parameters:
1
optional, default value=true
enable
2
optional, default value=true
loop
Returns:
nil
-
composite_scenes_list:count() -
Returns the number composite scenes in the list.
Returns:
number
Composite Scene
A battle_composite_scene object represents a composite scene instance.
Handles to composite scene objects may be obtained through the battle_composite_scenes_system and battle_composite_scenes_list interfaces.
-
composite_scene:enabled() -
Returns whether the composite scene instance is enabled.
Returns:
boolean
-
composite_scene:enable([enableboolean], [loopboolean]) -
Enables/disable the composite scene.
Parameters:
1
optional, default value=true
enable
2
optional, default value=true
loop
Returns:
nil
-
composite_scene:scene_name() -
Returns the scene name of the composite scene.
Returns:
string
-
composite_scene:script_id() -
Returns the script id of the composite scene.
Returns:
string