ACTIONDB XML PROPERTIES
The action.actiondb file is an intermediate file used to define the available actions for one or more device inputs in the package sources. It is saved to the same location as the Input Profiles project or the aircraft project, and will be exported as an XML file along with the device XML when you create an input profile for use by an aircraft category or for a specific aircraft.
IMPORTANT! This is a reference page and you should not edit this file manually. Use the supplied Input Profile Editor or the Input tab of the SimObject Editor to edit this files contents.
For more information please see the following page:
The action.actiondb file has the following schematic structure using the XML format:
<?xml version= "1.0" encoding= "utf-8" ?>
<ActionDefinition>
<MetaContexts>
<MetaContext Name="METANAME">
<Context ID="ACTION_CONTEXT_NAME" />
<!-- further actions listed here for the given meta context -->
</MetaContext>
<!-- further meta contexts and their actions listed here -->
</MetaContexts>
<Actions>
<Action>
<Name>KEY_ACTION_NAME</Name>
<Context>CONTEXT</Context>
<Type>TYPE</Type>
<TT_Name>DISPLAY_NAME_HERE</TT_Name>
<TT_Function>SHORT_FUNCTIONAL_DESCRIPTION_HERE</TT_Description>
<TT_Category_Main>CATEGORY</TT_Category_Main>
<TT_Category_Sub>SUBCATEGORY</TT_Category_Sub>
<TT_Tag>TAG_NAME</TT_Tag>
</Action>
<!-- further action definitions here -->
</Actions>
<ActionDefinitions>
<ActionDefinition>
This is a container element where you will place one or more <MetaContexts> sub-elements. This element has no attributes.
<MetaContexts>
This element is a sub-element of <ActionDefinition> , has no attributes, and is used as container element for one or more <MetaContext> sub-elements.
<MetaContext>
This is a sub-element of <MetaContexts> and is used to define the different meta-contexts that the actions in the file belong to. Please see Available Contexts for more information.
It can have the following attributes:
| Attribute | Description | Type | Required |
|---|---|---|---|
Name |
The context name. | String | Yes |
<Context>
This is a sub-element of <MetaContext> and is used to define the icons to use for the actions in the file.
It can have the following attributes:
| Attribute | Description | Type | Required |
|---|---|---|---|
SourceIcons |
A combination of "keys" which represent specific in-sim actions. These "keys" will be bound to the target icon and text. See the section on keys below for more information. For multiple keys, they should be concatenated using the "&" symbol, for example: SourceIcons="R-STICK LEFT&R-STICK RIGHT" |
String | Yes |
TargetIcon |
This is the name of the SVG file that should be linked to the source icon key. The name is given without the file extension, for example, the file TargetIcon="R-STICK_1" |
String | Yes |
<Actions>
This is a container element where you will place one or more <Action> sub-elements. This element has no attributes.
<Action>
This element is a sub-element of <Actions> and is used to define a single input action. It has no attributes, and requires the following sub-elements:
<Name><Context><Type><TT_Name><TT_Description><TT_Function><TT_Category_Main><TT_Category_Sub><TT_Tag>
<Name>
This is where you can give a common name to the input event action. Names should be alpha-numeric only, although they can also contain the "_" and "-" symbols.
<Context>
This sub-element of <Action> has no attributes and is used to set the action context. For all user-created planes this must be set to simply "INPUT_EVENTS"
<Type>
This sub-element of <Action> has no attributes and is used to define the type of action to be associated with the input binding. Can only be one of the following:
- DIGITAL
- AXIS
<TT_Name>
This sub-element of <Action> has no attributes and is used to define a localized string ID for the action name. If you have a *.loc file then you can use the TT:[string] format, otherwise the name should be given in English.
<TT_Description>
This sub-element of <Action> has no attributes and is used to define a short localized string that describes the action. If you have a *.loc file then you can use the TT:[string] format, otherwise the description should be given in English. This element is only present when the profile is Transversal or for an Aircraft Category. For aircraft specific profiles, you should be using <TT_Function> and not this element.
<TT_Function>
This sub-element of <Action> has no attributes and is used to define a localized string that describes the action. If you have a *.loc file then you can use the TT:[string] format, otherwise the description should be given in English. This element is only present when the profile is for Aircraft Specific Input Profiles, and for transversal or aircraft category profiles, you should be using <TT_Description> and not this element.
<TT_Category_Main>
This sub-element of <Action> has no attributes and is used to define a localized string ID for the action category. This will be used to set the sort order of the controls in the simulation menu. If you have a *.loc file then you can use the TT:[string] format, otherwise the category should be given in English.
<TT_Category_Sub>
This sub-element of <Action> has no attributes and is used to define a localized string ID for the action sub-category. This will be used to set the sort order of the controls in the simulation menu. If you have a *.loc file then you can use the TT:[string] format, otherwise the sub-category should be given in English.
<TT_Tag>
This sub-element of <Action> has no attributes and is used to define a localized tag string. These tag strings are used to tell the simulation that certain inputs should be shown within certain menus and UI elements. The available tags are as follows:
- wip
- obsolete
- debug
Essentially these three tags all do the same thing - hide what is not functional or not intended for the user to see from the control settings in the simulation - and are named separately to help categorise inputs when working on your own profiles.
Related Topics