Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ XR Studio

Special assignment prefixes

  • Last UpdatedDec 06, 2023
  • 2 minute read

Special assignment prefixes to use when using Assignment by parameter value.

Prefix

Use

Example

lang

Refers to the value of a localized text in currently selected language.

text=“@lang:nodeText@”

def

Refers to the value of a define. Particularly used in node definition.

mode=“@def:missione.scoregraphMode@”

exists

Checks if a node or a field exists. Returns True or False.

condition=“[@exists:[@%items%.elementAt(0).action\\inspect\\state]”

enumerateNodes

Gets a MSTRING list of node names. It accepts all, items, type:nodeType, group:groupName, itemContains:text, and groupContains:text as parameters.

  • When all, it returns all the nodes.

  • When items, it returns all the nodes of Item type.

  • When using type, it returns all nodes of the specified nodeType.

  • When using group, it returns all the items included in the groupName, if any.

  • When using itemContains, it returns all items whose name contains the given text.

  • When using groupContains, it returns all items whose group name contains the given text.

value=“@enumerateNodes:all@”

value=“@enumerateNodes:items@”

value=“@enumerateNodes:type:aNodeType@“

value=“@enumerateNodes:group:aGroup@”

value=“@enumerateNodes:itemContains:aText@“

value=“@enumerateNodes:groupContains:aText@”

enumerateGroups

Gets a MSTRING list of group names. It accepts all, groupContains:text or groupContainsActive:text as parameters.

  • When using all, it returns all the different group names. If an item has no group its name is returned as group.

  • Using groupContains:text restricts the returned list to those whose group name (or name if no group is set) contains a certain text.

  • Last option groupContainsActive:text works as the previous one, but restricts the returned list to active items or items with showItemWhenInactive set to True.

value=”@enumerateGroups:all@” value=“@enumerateGroups:groupContains:PG@ value=”@enumerateGroups:groupContainsActive:PG@“

enumerateFields

Gets a MSTRING list of field names. It requires two parameters divided by a comma. The first parameter is the node name, the second is used to restrict the fields. For the second parameter the possible values are all, action, or type:fieldType.

  • When using all, it returns all the fields of the node.

  • When using action, it returns all the action fields of the node, both standard and user defined.

  • When using type:fieldType, it returns all and only the fields of the specified type.

value=”@enumerateFields:gauge_P803,action@“

value=”@enumerateFields:gauge_P803,type:svec3@“

fileExists

Returns true or false depending on existence of file on disk. It can check absolute or relative path within the project working directory.

condition="[@fileExists:GameData/Logic/user/graphic_context_logic.xml]"

pluginExists

Verifies whether a specific plugin has been loaded by providing its name. It can be used both at parsing and running time.

Optionally, the check can involve the plugin version. By default, it checks if the version is exactly the passed one. Append + at the end for a higher equal check or – for a lower equal check.

condition="[@pluginExists:Sample]"

condition="[@pluginExists:Sample:1.0.0.0]"

condition="[@pluginExists:Sample:1.0+]"

condition="[@pluginExists:Sample:2.0-]"

Related Links
TitleResults for “How to create a CRG?”Also Available in