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 Campaign
Loaded in Battle Loaded in Battle
Loaded in Frontend Loaded in Frontend
Back to top

Functionality

composite_scenes_system:terrain_composite_scenes()
Returns a list of all terrain composite scenes on the map.

Returns:

  1. battle_composite_scenes_list list

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 331

composite_scenes_system:composite_scenes_by_scene_name(string scene_name)

Returns a list of all terrain composite scenes with the given scene name.

Parameters:

1

string

scene_name

Returns:

  1. battle_composite_scenes_list selected composite scenes

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 346

composite_scenes_system:composite_scenes_by_parent_script_id(string parent_script_id)

Returns a list of all terrain composite scenes who have this parent script id.

Parameters:

1

string

parent_script_id

Returns:

  1. battle_composite_scenes_list selected composite scenes

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 364

composite_scenes_system:composite_scene_by_script_id(string script id)

Returns a terrain composite scene with the given script id.

Parameters:

1

string

script id

Returns:

  1. battle_composite_scene selected composite scene

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 382

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.

Back to top

Functionality

composite_scenes_list:item(number index)

Returns the composite scene in the given position in the list.

Parameters:

1

number

index

Returns:

  1. battle_composite_scene selected composite scene

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 70

composite_scenes_list:search_by_script_id(string script_id)

Returns the composite scene with the given script id.

Parameters:

1

string

script_id

Returns:

  1. battle_composite_scene selected composite scene

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 90

composite_scenes_list:search_by_parent_script_id(string script_id)

Returns the composite scene which this parent script id.

Parameters:

1

string

script_id

Returns:

  1. battle_composite_scene selected composite scene

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 110

composite_scenes_list:search_by_scene_name(string scene_name)

Returns a composite scene list of composite scenes with the given scene name.

Parameters:

1

string

scene_name

Returns:

  1. battle_composite_scenes_list selected composite scenes

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 127

composite_scenes_list:enable([boolean enable], [boolean loop])

Enables/disable the all composite scenes in the list.

Parameters:

1

boolean

optional, default value=true

enable

2

boolean

optional, default value=true

loop

Returns:

  1. nil

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 145

composite_scenes_list:count()
Returns the number composite scenes in the list.

Returns:

  1. number list size

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 163

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.

Back to top

Functionality

composite_scene:enabled()
Returns whether the composite scene instance is enabled.

Returns:

  1. boolean true/false

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 226

composite_scene:enable([boolean enable], [boolean loop])

Enables/disable the composite scene.

Parameters:

1

boolean

optional, default value=true

enable

2

boolean

optional, default value=true

loop

Returns:

  1. nil

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 244

composite_scene:scene_name()
Returns the scene name of the composite scene.

Returns:

  1. string scene name

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 259

composite_scene:script_id()
Returns the script id of the composite scene.

Returns:

  1. string script id

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptCompositeScenes.cpp, line 278

Last updated 12/08/2022 11:56:59