GROUP

Creates a group of objects to manage them together as a single entity. Grouping can be useful for persistency, copy/paste etc.

Attributes brief detailed show all inherited

	Name	Description
	object_ids	List of identifiers of objects to be part of the group
	object_aliases	List of aliases used for the objects in the groupThe aliases are used in place of object ids when the group is serialized. So it is possible to load and save data from other groups if the same aliases are used for compatible object types
	name	Displayed named of the group
	comment	Comment about the group
Events
	value_changed	the event is fired anytime the value of one of the objects in the group has changed
Common attributes
	id	Identifier of the elementThe id of an element has to be globally unique. Don't start with a digit for AngelScript compatibility.

	Name	Value type	Default	Description	Comment
	object_ids	';' separated identifiers	empty	List of identifiers of objects to be part of the group
	object_aliases	';' separated identifiers	empty	List of aliases used for the objects in the group	The aliases are used in place of object ids when the group is serialized. So it is possible to load and save data from other groups if the same aliases are used for compatible object types
	name	string	empty	Displayed named of the group
	comment	string	empty	Comment about the group
Events
	value_changed	event		the event is fired anytime the value of one of the objects in the group has changed
Common attributes
	id	identifier	empty	Identifier of the element	The id of an element has to be globally unique. Don't start with a digit for AngelScript compatibility.

Examples

You can use GROUP to load/save settings as a whole or to trigger an action upon any change in the group.

<STRING id="demo_string_1" default="1176" />
<STRING id="demo_string_2" default="Compressor" />
<PARAM id="demo_param_1" min="0" max="7" default="1" />
<PARAM id="demo_param_2" min="0" max="7" default="5" />
<GROUP id="data_group"
object_ids="demo_string_1;demo_string_2;demo_param_1;demo_param_2"
object_aliases="name;type;attack;release" />
<ACTION_TRIGGER event_id="data_group.value_changed"
script="color_widget.background_color.r = rand(0,1);
color_widget.background_color.g = rand(0,1);
color_widget.background_color.b = rand(0,1);"
requires="color_widget.background_color.*" />
<TABLE>
<TABLE_ROW>
<TEXT value="demo_string_1: " />
<TEXT_EDIT_BOX string_id="demo_string_1" width="100" change_on_type="true" />
</TABLE_ROW>
<TABLE_ROW>
<TEXT value="demo_string_2: " />
<TEXT_EDIT_BOX string_id="demo_string_2" width="100" change_on_type="true" />
</TABLE_ROW>
<TABLE_ROW>
<TEXT value="demo_param_1: " />
<PARAM_TEXT_EDIT_BOX param_id="demo_param_1" width="100" />
</TABLE_ROW>
<TABLE_ROW>
<TEXT value="demo_param_2: " />
<PARAM_TEXT_EDIT_BOX param_id="demo_param_2" width="100" />
</TABLE_ROW>
</TABLE>
<WIDGET id="color_widget" background_color="#DD0000" width="220" height="2" />
<ROW>
<SYSTEM_ACTION_BUTTON action_id="load_data" />
<SYSTEM_ACTION_BUTTON action_id="save_data" />
</ROW>
<ACTION type="DisplayObjectLoadDialog"
id="load_data"
object_id="data_group"
file_types="*.xml"
default_path="$PLUGIN_USER_DOCUMENTS_PATH$/Temp"
applicative_type="DemoConfig"
name="Load"
/>
<ACTION type="DisplayObjectSaveDialog"
id="save_data"
object_id="data_group"
file_types="*.xml"
default_path="$PLUGIN_USER_DOCUMENTS_PATH$/Temp"
applicative_type="DemoConfig"
name="Save as..."
/>

If we take a look at "demo_data.xml" from the example above, we'll see that the data is saved like this:

<?xml version="1.0" encoding="UTF-8"?>
<Export applicative_type="DemoConfig" data_type="{0779F8E6-34E0-4DA5-9307-ECC37BE0FA8A}">
<content release="5" attack="7" type="Delay" name="Echoboy"/>
</Export>

Comments

Please, authorize to view and post comments.